mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-11-03 18:47:32 -05:00
357 lines
9.3 KiB
PHP
357 lines
9.3 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com)
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2020. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://opensource.org/licenses/AAL
|
|
*/
|
|
|
|
namespace App\Models;
|
|
|
|
use App\Models\Client;
|
|
use App\Models\Company;
|
|
use App\Models\Gateway;
|
|
use App\Models\GatewayType;
|
|
use App\Utils\Number;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
|
|
class CompanyGateway extends BaseModel
|
|
{
|
|
use SoftDeletes;
|
|
|
|
protected $casts = [
|
|
'fees_and_limits' => 'object',
|
|
'updated_at' => 'timestamp',
|
|
'created_at' => 'timestamp',
|
|
'deleted_at' => 'timestamp',
|
|
];
|
|
|
|
protected $fillable = [
|
|
'gateway_key',
|
|
'accepted_credit_cards',
|
|
'require_cvv',
|
|
'show_billing_address',
|
|
'show_shipping_address',
|
|
'update_details',
|
|
'config',
|
|
'fees_and_limits',
|
|
'custom_value1',
|
|
'custom_value2',
|
|
'custom_value3',
|
|
'custom_value4',
|
|
'token_billing',
|
|
'label',
|
|
];
|
|
|
|
public static $credit_cards = [
|
|
1 => ['card' => 'images/credit_cards/Test-Visa-Icon.png', 'text' => 'Visa'],
|
|
2 => ['card' => 'images/credit_cards/Test-MasterCard-Icon.png', 'text' => 'Master Card'],
|
|
4 => ['card' => 'images/credit_cards/Test-AmericanExpress-Icon.png', 'text' => 'American Express'],
|
|
8 => ['card' => 'images/credit_cards/Test-Diners-Icon.png', 'text' => 'Diners'],
|
|
16 => ['card' => 'images/credit_cards/Test-Discover-Icon.png', 'text' => 'Discover'],
|
|
];
|
|
|
|
// public function getFeesAndLimitsAttribute()
|
|
// {
|
|
// return json_decode($this->attributes['fees_and_limits']);
|
|
// }
|
|
|
|
protected $touches = [];
|
|
|
|
public function getEntityType()
|
|
{
|
|
return CompanyGateway::class;
|
|
}
|
|
|
|
public function company()
|
|
{
|
|
return $this->belongsTo(Company::class);
|
|
}
|
|
|
|
public function gateway()
|
|
{
|
|
return $this->belongsTo(Gateway::class, 'gateway_key', 'key');
|
|
}
|
|
|
|
public function getTypeAlias($gateway_type_id)
|
|
{
|
|
if ($gateway_type_id == 'token') {
|
|
$gateway_type_id = 1;
|
|
}
|
|
|
|
return GatewayType::find($gateway_type_id)->alias;
|
|
}
|
|
|
|
/* This is the public entry point into the payment superclass */
|
|
public function driver(Client $client)
|
|
{
|
|
$class = static::driver_class();
|
|
|
|
return new $class($this, $client);
|
|
}
|
|
|
|
private function driver_class()
|
|
{
|
|
$class = 'App\\PaymentDrivers\\' . $this->gateway->provider . 'PaymentDriver';
|
|
//$class = str_replace('\\', '', $class);
|
|
$class = str_replace('_', '', $class);
|
|
|
|
if (class_exists($class)) {
|
|
return $class;
|
|
} else {
|
|
return 'App\\PaymentDrivers\\BasePaymentDriver';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param $config
|
|
*/
|
|
public function setConfig($config)
|
|
{
|
|
$this->config = encrypt(json_encode($config));
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getConfig()
|
|
{
|
|
//return decrypt($this->config);
|
|
return json_decode(decrypt($this->config));
|
|
}
|
|
|
|
public function getConfigTransformed()
|
|
{
|
|
return $this->config ? decrypt($this->config) : '';
|
|
}
|
|
|
|
/**
|
|
* @param $field
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getConfigField($field)
|
|
{
|
|
return object_get($this->getConfig(), $field, false);
|
|
}
|
|
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getAchEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_ach'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getApplePayEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_apple_pay'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getAlipayEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_alipay'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getSofortEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_sofort'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getSepaEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_sepa'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getBitcoinEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_bitcoin'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getPayPalEnabled()
|
|
{
|
|
return ! empty($this->getConfigField('enable_pay_pal'));
|
|
}
|
|
|
|
public function feesEnabled()
|
|
{
|
|
return floatval($this->fee_amount) || floatval($this->fee_percent);
|
|
}
|
|
|
|
/**
|
|
* Returns the current test mode of the gateway
|
|
*
|
|
* @return boolean whether the gateway is in testmode or not.
|
|
*/
|
|
public function isTestMode() :bool
|
|
{
|
|
$config = $this->getConfig();
|
|
|
|
if($this->gateway->provider == 'Stripe' && strpos($config->publishableKey, 'test'))
|
|
return true;
|
|
|
|
if($config && property_exists($config, 'testMode') && $config->testMode)
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
/**
|
|
* Get Publishable Key
|
|
* Only works for STRIPE and PAYMILL
|
|
* @return string The Publishable key
|
|
*/
|
|
public function getPublishableKey() :string
|
|
{
|
|
return $this->getConfigField('publishableKey');
|
|
}
|
|
|
|
public function getFeesAndLimits()
|
|
{
|
|
if (is_null($this->fees_and_limits))
|
|
return false;
|
|
|
|
$fees_and_limits = new \stdClass;
|
|
|
|
foreach($this->fees_and_limits as $key => $value) {
|
|
$fees_and_limits = $this->fees_and_limits->{$key};
|
|
}
|
|
|
|
return $fees_and_limits;
|
|
}
|
|
|
|
/**
|
|
* Returns the formatted fee amount for the gateway
|
|
*
|
|
* @param float $amount The payment amount
|
|
* @param Client $client The client object
|
|
* @return string The fee amount formatted in the client currency
|
|
*/
|
|
public function calcGatewayFeeLabel($amount, Client $client) :string
|
|
{
|
|
$label = '';
|
|
|
|
if (!$this->feesEnabled()) {
|
|
return $label;
|
|
}
|
|
|
|
$fee = $this->calcGatewayFee($amount);
|
|
|
|
if ($fee > 0) {
|
|
$fee = Number::formatMoney(round($fee, 2), $client);
|
|
$label = ' - ' . $fee . ' ' . ctrans('texts.fee');
|
|
}
|
|
|
|
return $label;
|
|
}
|
|
|
|
public function calcGatewayFee($amount, $include_taxes = false)
|
|
{
|
|
|
|
$fees_and_limits = $this->getFeesAndLimits();
|
|
|
|
if(!$fees_and_limits)
|
|
return 0;
|
|
|
|
$fee = 0;
|
|
|
|
if ($fees_and_limits->fee_amount) {
|
|
$fee += $fees_and_limits->fee_amount;
|
|
info("fee after adding fee amount = {$fee}");
|
|
}
|
|
|
|
if ($fees_and_limits->fee_percent) {
|
|
$fee += $amount * $fees_and_limits->fee_percent / 100;
|
|
info("fee after adding fee percent = {$fee}");
|
|
}
|
|
|
|
/* Cap fee if we have to here. */
|
|
if($fees_and_limits->fee_cap > 0 && ($fee > $fees_and_limits->fee_cap))
|
|
$fee = $fees_and_limits->fee_cap;
|
|
|
|
$pre_tax_fee = $fee;
|
|
|
|
/**/
|
|
if($include_taxes)
|
|
{
|
|
if ($fees_and_limits->fee_tax_rate1) {
|
|
$fee += $pre_tax_fee * $fees_and_limits->fee_tax_rate1 / 100;
|
|
info("fee after adding fee tax 1 = {$fee}");
|
|
}
|
|
|
|
if ($fees_and_limits->fee_tax_rate2) {
|
|
$fee += $pre_tax_fee * $fees_and_limits->fee_tax_rate2 / 100;
|
|
info("fee after adding fee tax 2 = {$fee}");
|
|
}
|
|
|
|
if ($fees_and_limits->fee_tax_rate3) {
|
|
$fee += $pre_tax_fee * $fees_and_limits->fee_tax_rate3 / 100;
|
|
info("fee after adding fee tax 3 = {$fee}");
|
|
}
|
|
}
|
|
|
|
return $fee;
|
|
}
|
|
|
|
/**
|
|
* we need to average out the gateway fees across all the invoices
|
|
* so lets iterate.
|
|
*
|
|
* we MAY need to adjust the final fee to ensure our rounding makes sense!
|
|
*/
|
|
public function calcGatewayFeeObject($amount, $invoice_count)
|
|
{
|
|
$total_gateway_fee = $this->calcGatewayFee($amount);
|
|
|
|
$fee_object = new \stdClass;
|
|
|
|
$fees_and_limits = $this->getFeesAndLimits();
|
|
|
|
if(!$fees_and_limits)
|
|
return $fee_object;
|
|
|
|
$fee_component_amount = $fees_and_limits->fee_amount ?: 0;
|
|
$fee_component_percent = $fees_and_limits->fee_percent ? ($amount * $fees_and_limits->fee_percent / 100) : 0;
|
|
|
|
$combined_fee_component = $fee_component_amount + $fee_component_percent;
|
|
|
|
$fee_component_tax_name1 = $fees_and_limits->fee_tax_name1 ?: '';
|
|
$fee_component_tax_rate1 = $fees_and_limits->fee_tax_rate1 ? ($combined_fee_component * $fees_and_limits->fee_tax_rate1 / 100) : 0;
|
|
|
|
$fee_component_tax_name2 = $fees_and_limits->fee_tax_name2 ?: '';
|
|
$fee_component_tax_rate2 = $fees_and_limits->fee_tax_rate2 ? ($combined_fee_component * $fees_and_limits->fee_tax_rate2 / 100) : 0;
|
|
|
|
$fee_component_tax_name3 = $fees_and_limits->fee_tax_name3 ?: '';
|
|
$fee_component_tax_rate3 = $fees_and_limits->fee_tax_rate3 ? ($combined_fee_component * $fees_and_limits->fee_tax_rate3 / 100) : 0;
|
|
|
|
}
|
|
|
|
public function resolveRouteBinding($value)
|
|
{
|
|
return $this
|
|
->where('id', $this->decodePrimaryKey($value))->firstOrFail();
|
|
}
|
|
}
|