Viewing file:  Cashier.php (5.67 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Laravel\Cashier;
use Money\Currencies\ISOCurrencies;
use Money\Currency;
use Money\Formatter\IntlMoneyFormatter;
use Money\Money;
use NumberFormatter;
use Stripe\BaseStripeClient;
use Stripe\Customer as StripeCustomer;
use Stripe\StripeClient;
class Cashier
{
/**
* The Cashier library version.
*
* @var string
*/
const VERSION = '13.17.0';
/**
* The Stripe API version.
*
* @var string
*/
const STRIPE_VERSION = '2020-08-27';
/**
* The base URL for the Stripe API.
*
* @var string
*/
public static $apiBaseUrl = BaseStripeClient::DEFAULT_API_BASE;
/**
* The custom currency formatter.
*
* @var callable
*/
protected static $formatCurrencyUsing;
/**
* Indicates if Cashier migrations will be run.
*
* @var bool
*/
public static $runsMigrations = true;
/**
* Indicates if Cashier routes will be registered.
*
* @var bool
*/
public static $registersRoutes = true;
/**
* Indicates if Cashier will mark past due subscriptions as inactive.
*
* @var bool
*/
public static $deactivatePastDue = true;
/**
* Indicates if Cashier will automatically calculate taxes using Stripe Tax.
*
* @var bool
*/
public static $calculatesTaxes = false;
/**
* The default customer model class name.
*
* @var string
*/
public static $customerModel = 'App\\Models\\User';
/**
* The subscription model class name.
*
* @var string
*/
public static $subscriptionModel = Subscription::class;
/**
* The subscription item model class name.
*
* @var string
*/
public static $subscriptionItemModel = SubscriptionItem::class;
/**
* Get the customer instance by its Stripe ID.
*
* @param \Stripe\Customer|string|null $stripeId
* @return \Laravel\Cashier\Billable|null
*/
public static function findBillable($stripeId)
{
$stripeId = $stripeId instanceof StripeCustomer ? $stripeId->id : $stripeId;
return $stripeId ? (new static::$customerModel)->where('stripe_id', $stripeId)->first() : null;
}
/**
* Get the Stripe SDK client.
*
* @param array $options
* @return \Stripe\StripeClient
*/
public static function stripe(array $options = [])
{
return new StripeClient(array_merge([
'api_key' => $options['api_key'] ?? config('cashier.secret'),
'stripe_version' => static::STRIPE_VERSION,
'api_base' => static::$apiBaseUrl,
], $options));
}
/**
* Set the custom currency formatter.
*
* @param callable $callback
* @return void
*/
public static function formatCurrencyUsing(callable $callback)
{
static::$formatCurrencyUsing = $callback;
}
/**
* Format the given amount into a displayable currency.
*
* @param int $amount
* @param string|null $currency
* @param string|null $locale
* @param array $options
* @return string
*/
public static function formatAmount($amount, $currency = null, $locale = null, array $options = [])
{
if (static::$formatCurrencyUsing) {
return call_user_func(static::$formatCurrencyUsing, $amount, $currency, $locale, $options);
}
$money = new Money($amount, new Currency(strtoupper($currency ?? config('cashier.currency'))));
$locale = $locale ?? config('cashier.currency_locale');
$numberFormatter = new NumberFormatter($locale, NumberFormatter::CURRENCY);
if (isset($options['min_fraction_digits'])) {
$numberFormatter->setAttribute(NumberFormatter::MIN_FRACTION_DIGITS, $options['min_fraction_digits']);
}
$moneyFormatter = new IntlMoneyFormatter($numberFormatter, new ISOCurrencies());
return $moneyFormatter->format($money);
}
/**
* Configure Cashier to not register its migrations.
*
* @return static
*/
public static function ignoreMigrations()
{
static::$runsMigrations = false;
return new static;
}
/**
* Configure Cashier to not register its routes.
*
* @return static
*/
public static function ignoreRoutes()
{
static::$registersRoutes = false;
return new static;
}
/**
* Configure Cashier to maintain past due subscriptions as active.
*
* @return static
*/
public static function keepPastDueSubscriptionsActive()
{
static::$deactivatePastDue = false;
return new static;
}
/**
* Configure Cashier to automatically calculate taxes using Stripe Tax.
*
* @return static
*/
public static function calculateTaxes()
{
static::$calculatesTaxes = true;
return new static;
}
/**
* Set the customer model class name.
*
* @param string $customerModel
* @return void
*/
public static function useCustomerModel($customerModel)
{
static::$customerModel = $customerModel;
}
/**
* Set the subscription model class name.
*
* @param string $subscriptionModel
* @return void
*/
public static function useSubscriptionModel($subscriptionModel)
{
static::$subscriptionModel = $subscriptionModel;
}
/**
* Set the subscription item model class name.
*
* @param string $subscriptionItemModel
* @return void
*/
public static function useSubscriptionItemModel($subscriptionItemModel)
{
static::$subscriptionItemModel = $subscriptionItemModel;
}
}
|