mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-14 07:02:34 +01:00
215 lines
9.2 KiB
PHP
215 lines
9.2 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Models;
|
|
|
|
use App\Services\Subscription\SubscriptionService;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
|
|
/**
|
|
* App\Models\Subscription
|
|
*
|
|
* @property int $id
|
|
* @property int $user_id
|
|
* @property int|null $assigned_user_id
|
|
* @property int $company_id
|
|
* @property string|null $product_ids
|
|
* @property int|null $frequency_id
|
|
* @property string|null $auto_bill
|
|
* @property string|null $promo_code
|
|
* @property float $promo_discount
|
|
* @property int $is_amount_discount
|
|
* @property int $allow_cancellation
|
|
* @property int $per_seat_enabled
|
|
* @property int $min_seats_limit
|
|
* @property int $max_seats_limit
|
|
* @property int $trial_enabled
|
|
* @property int $trial_duration
|
|
* @property int $allow_query_overrides
|
|
* @property int $allow_plan_changes
|
|
* @property string|null $plan_map
|
|
* @property int|null $refund_period
|
|
* @property array $webhook_configuration
|
|
* @property int|null $deleted_at
|
|
* @property bool $is_deleted
|
|
* @property int|null $created_at
|
|
* @property int|null $updated_at
|
|
* @property int|null $currency_id
|
|
* @property string|null $recurring_product_ids
|
|
* @property string $name
|
|
* @property int|null $group_id
|
|
* @property string $price
|
|
* @property string $promo_price
|
|
* @property int $registration_required
|
|
* @property int $use_inventory_management
|
|
* @property string|null $optional_product_ids
|
|
* @property string|null $optional_recurring_product_ids
|
|
* @property-read \App\Models\Company $company
|
|
* @property-read mixed $hashed_id
|
|
* @property-read \App\Models\GroupSetting|null $group_settings
|
|
* @property-read \App\Models\User $user
|
|
* @method static \Illuminate\Database\Eloquent\Builder|BaseModel company()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|BaseModel exclude($columns)
|
|
* @method static \Database\Factories\SubscriptionFactory factory($count = null, $state = [])
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription filter(\App\Filters\QueryFilters $filters)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription newModelQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription newQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription onlyTrashed()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription query()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|BaseModel scope()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereAllowCancellation($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereAllowPlanChanges($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereAllowQueryOverrides($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereAssignedUserId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereAutoBill($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereCompanyId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereCreatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereCurrencyId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereDeletedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereFrequencyId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereGroupId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereIsAmountDiscount($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereIsDeleted($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereMaxSeatsLimit($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereMinSeatsLimit($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereName($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereOptionalProductIds($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereOptionalRecurringProductIds($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription wherePerSeatEnabled($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription wherePlanMap($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription wherePrice($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereProductIds($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription wherePromoCode($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription wherePromoDiscount($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription wherePromoPrice($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereRecurringProductIds($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereRefundPeriod($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereRegistrationRequired($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereTrialDuration($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereTrialEnabled($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereUpdatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereUseInventoryManagement($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereUserId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription whereWebhookConfiguration($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription withTrashed()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Subscription withoutTrashed()
|
|
* @mixin \Eloquent
|
|
*/
|
|
class Subscription extends BaseModel
|
|
{
|
|
use HasFactory, SoftDeletes, Filterable;
|
|
|
|
protected $hidden = [
|
|
'id',
|
|
'user_id',
|
|
'assigned_user_id',
|
|
'company_id',
|
|
'product_ids',
|
|
'recurring_product_ids',
|
|
'group_id',
|
|
];
|
|
|
|
protected $fillable = [
|
|
'assigned_user_id',
|
|
'product_ids',
|
|
'recurring_product_ids',
|
|
'frequency_id',
|
|
'auto_bill',
|
|
'promo_code',
|
|
'promo_discount',
|
|
'is_amount_discount',
|
|
'allow_cancellation',
|
|
'per_seat_enabled',
|
|
'max_seats_limit',
|
|
'trial_enabled',
|
|
'trial_duration',
|
|
'allow_query_overrides',
|
|
'allow_plan_changes',
|
|
'refund_period',
|
|
'webhook_configuration',
|
|
'currency_id',
|
|
'group_id',
|
|
'price',
|
|
'name',
|
|
'currency_id',
|
|
'registration_required',
|
|
'optional_product_ids',
|
|
'optional_recurring_product_ids',
|
|
'use_inventory_management',
|
|
];
|
|
|
|
protected $casts = [
|
|
'is_deleted' => 'boolean',
|
|
'webhook_configuration' => 'array',
|
|
'updated_at' => 'timestamp',
|
|
'created_at' => 'timestamp',
|
|
'deleted_at' => 'timestamp',
|
|
];
|
|
|
|
protected $with = [
|
|
'company',
|
|
];
|
|
|
|
public function service(): SubscriptionService
|
|
{
|
|
return new SubscriptionService($this);
|
|
}
|
|
|
|
public function company(): \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
{
|
|
return $this->belongsTo(Company::class);
|
|
}
|
|
|
|
public function user(): \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
{
|
|
return $this->belongsTo(User::class)->withTrashed();
|
|
}
|
|
|
|
public function group_settings()
|
|
{
|
|
return $this->belongsTo(GroupSetting::class, 'group_id', 'id');
|
|
}
|
|
|
|
public function nextDateByInterval($date, $frequency_id)
|
|
{
|
|
switch ($frequency_id) {
|
|
case RecurringInvoice::FREQUENCY_DAILY:
|
|
return $date->addDay();
|
|
case RecurringInvoice::FREQUENCY_WEEKLY:
|
|
return $date->addWeek();
|
|
case RecurringInvoice::FREQUENCY_TWO_WEEKS:
|
|
return $date->addWeeks(2);
|
|
case RecurringInvoice::FREQUENCY_FOUR_WEEKS:
|
|
return $date->addWeeks(4);
|
|
case RecurringInvoice::FREQUENCY_MONTHLY:
|
|
return $date->addMonthNoOverflow();
|
|
case RecurringInvoice::FREQUENCY_TWO_MONTHS:
|
|
return $date->addMonthsNoOverflow(2);
|
|
case RecurringInvoice::FREQUENCY_THREE_MONTHS:
|
|
return $date->addMonthsNoOverflow(3);
|
|
case RecurringInvoice::FREQUENCY_FOUR_MONTHS:
|
|
return $date->addMonthsNoOverflow(4);
|
|
case RecurringInvoice::FREQUENCY_SIX_MONTHS:
|
|
return $date->addMonthsNoOverflow(6);
|
|
case RecurringInvoice::FREQUENCY_ANNUALLY:
|
|
return $date->addYear();
|
|
case RecurringInvoice::FREQUENCY_TWO_YEARS:
|
|
return $date->addYears(2);
|
|
case RecurringInvoice::FREQUENCY_THREE_YEARS:
|
|
return $date->addYears(3);
|
|
default:
|
|
return null;
|
|
}
|
|
}
|
|
}
|