Subscription::validateByGracePeriod() - Code Metrics - Inspection of "Add subscription grace period verification" - bakaphp/canvas-core - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#250)

by Rafael

created 2019-11-06 14:18 UTC

Subscription::validateByGracePeriod() A

↳ Parent: Subscription

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
nc	3
nop	0
dl	0
loc	11
ccs	0
cts	0
cp	0
crap	20
rs	9.9
c	0
b	0
f	0

<?php

namespace Canvas\Models;

use Phalcon\Cashier\Subscription as PhalconSubscription;
use Canvas\Exception\ServerErrorHttpException;
use Phalcon\Di;
use Carbon\Carbon;

/**
 * Trait Subscription.
 *
 * @package Canvas\Models
 *
 * @property Users $user
 * @property AppsPlans $appPlan
 * @property CompanyBranches $branches
 * @property Companies $company
 * @property UserCompanyApps $app
 * @property \Phalcon\Di $di
 *
 */
class Subscription extends PhalconSubscription
{
    const DEFAULT_GRACE_PERIOD_DAYS = 5;
    /**
     *
     * @var integer
     */
    public $apps_plans_id = 0;


    /**
     *
     * @var integer
     */
    public $user_id;


    /**
     *
     * @var integer
     */
    public $companies_id;


    /**
     *
     * @var integer
     */
    public $apps_id;


    /**
     *
     * @var string
     */
    public $name;

    /**
     *
     * @var string
     */
    public $stripe_id;


    /**
     *
     * @var string
     */
    public $stripe_plan;


    /**
     *
     * @var integer
     */
    public $quantity;

    /**
     *
     * @var integer
     */
    public $payment_frequency_id;


    /**
     *
     * @var string
     */
    public $trial_ends_at;


    /**
     *
     * @var integer
     */
    public $trial_ends_days;


    /**
     *
     * @var integer
     */
    public $is_freetrial;


    /**
     *
     * @var integer
     */
    public $is_active;


    /**
     *
     * @var integer
     */
    public $paid;

    /**
     *
     * @var string
     */
    public $charge_date;


    /**
     *
     * @var string
     */
    public $ends_at;


    /**
     *
     * @var date
     */
    public $grace_period_ends;


    /**
     *
     * @var datetime
     */
    public $next_due_payment;


    /**
     *
     * @var integer
     */
    public $is_cancelled;


    /**
     *
     * @var string
     */
    public $created_at;


    /**
     *
     * @var string
     */
    public $updated_at;


    /**
     *
     * @var integer
     */
    public $is_deleted;


    /**
     * Initialize.
     *
     * @return void
     */
    public function initialize()
    {
        $this->belongsTo('user_id', 'Canvas\Models\Users', 'id', ['alias' => 'user']);

        $this->belongsTo(
            'companies_id',
            'Canvas\Models\Companies',
            'id',
            ['alias' => 'company']
        );

        $this->belongsTo(
            'apps_id',
            'Canvas\Models\Apps',
            'id',
            ['alias' => 'app']
        );

        $this->belongsTo(
            'apps_plans_id',
            'Canvas\Models\AppsPlans',
            'id',
            ['alias' => 'appPlan']
        );
    }

    /**
     * Get the active subscription for this company app.
     *
     * @return void

     */
    public static function getActiveForThisApp() : Subscription
    {
        $subscription = self::findFirst([
            'conditions' => 'companies_id = ?0 and apps_id = ?1 and is_deleted  = 0',
            'bind' => [Di::getDefault()->getUserData()->currentCompanyId(), Di::getDefault()->getApp()->getId()]
        ]);

        if (!is_object($subscription)) {
            throw new ServerErrorHttpException(_('No active subscription for this app ' . Di::getDefault()->getApp()->getId() . ' at the company ' . Di::getDefault()->getUserData()->currentCompanyId()));

        }

        return $subscription;
    }

    /**
     * Get subscription by user's default company;.
     * @param Users $user
     * @return Subscription
     */
    public static function getByDefaultCompany(Users $user): Subscription
    {
        $subscription = self::findFirst([
            'conditions' => 'user_id = ?0 and companies_id = ?1 and apps_id = ?2 and is_deleted  = 0',
            'bind' => [$user->getId(), $user->defaultCompany->getId(), Di::getDefault()->getApp()->getId()]
        ]);

        if (!is_object($subscription)) {
            throw new ServerErrorHttpException('No active subscription for default company');

        }

        return $subscription;
    }

    /**
     * Search current company's app setting with key paid to verify payment status for current company.
     *
     * @param Users $user
     * @return bool
     */
    public static function getPaymentStatus(Users $user): bool

    {
        //if its not subscription based return true to ignore any payment status
        if (!Di::getDefault()->getApp()->subscriptioBased()) {
            return true;
        }

        if (!$user->defaultCompany->get('paid')) {

            return false;
        }

        return true;
    }

    /**
     * Determine if the subscription is active.
     *
     * @return bool
     */
    public function active(): bool

    {
        return (bool) $this->is_active;
    }

    /**
     * Is the subscriptoin paid?
     *
     * @return boolean
     */
    public function paid(): bool

    {
        return (bool) $this->paid;
    }

    /**
     * Given a not active subscription activate it.
     *
     * @return void

     */
    public function activate(): bool

    {
        $this->is_active = 1;
        $this->paid = 1;
        $this->grace_period_ends = '';

        $this->ends_at = Carbon::now()->addDays(30)->toDateTimeString();
        $this->next_due_payment = $this->ends_at;
        $this->is_cancelled = 0;
        return $this->update();
    }

    /**
     * Determine if the subscription is within its trial period.
     *
     * @return bool
     */
    public function onTrial()

    {
        return (bool)$this->is_freetrial;
    }

    /**
     * Get actual subscription.
     */
    public static function getActiveSubscription(): self
    {
        $userSubscription = PhalconSubscription::findFirstOrFail([
            'conditions' => 'user_id = ?0 and companies_id = ?1 and apps_id = ?2 and is_deleted  = 0',
            'bind' => [Di::getDefault()->getUserData()->getId(), Di::getDefault()->getUserData()->currentCompanyId(), Di::getDefault()->getApp()->getId()]
        ]);

        return Di::getDefault()->getUserData()->subscription($userSubscription->name);
    }

    /**
     * Validate subscription status by grace period date and update grace period date.
     *
     * @return void
     */
    public function validateByGracePeriod(): void
    {
        if (isset($this->grace_period_ends)) {
            if (($this->charge_date == $this->grace_period_ends) && !$this->paid) {
                $this->is_active = 0;
                $this->grace_period_ends = Carbon::now()->addDays(Subscription::DEFAULT_GRACE_PERIOD_DAYS)->toDateTimeString();
            }
        } else {
            $this->grace_period_ends = Carbon::now()->addDays(Subscription::DEFAULT_GRACE_PERIOD_DAYS)->toDateTimeString();
        }
    }
}


1			<?php
2
3			namespace Canvas\Models;
4
5			use Phalcon\Cashier\Subscription as PhalconSubscription;
6			use Canvas\Exception\ServerErrorHttpException;
7			use Phalcon\Di;
8			use Carbon\Carbon;
9
10			/**
11			* Trait Subscription.
12			*
13			* @package Canvas\Models
14			*
15			* @property Users $user
16			* @property AppsPlans $appPlan
17			* @property CompanyBranches $branches
18			* @property Companies $company
19			* @property UserCompanyApps $app
20			* @property \Phalcon\Di $di
21			*
22			*/
23			class Subscription extends PhalconSubscription
24			{
25			const DEFAULT_GRACE_PERIOD_DAYS = 5;
26			/**
27			*
28			* @var integer
29			*/
30			public $apps_plans_id = 0;
			0 ignored issues – show Coding Style introduced 2019-09-18 14:29 UTC by Report Bug Copy Issue Report `$apps_plans_id` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
31
32			/**
33			*
34			* @var integer
35			*/
36			public $user_id;
			0 ignored issues – show Coding Style introduced 2019-09-18 14:29 UTC by Report Bug Copy Issue Report `$user_id` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
37
38			/**

bakaphp / canvas-core

Pull Request — master (#250)

Subscription::validateByGracePeriod() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like