Users::isFirstSignup() - Code Metrics - Inspection of "Merge pull request #24 from bakaphp/hotfix-user-si..." - bakaphp/phalcon-api - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( ba5c19...4803d4 )

by Maximo

created 2018-12-26 19:58 UTC

Users::isFirstSignup() A

↳ Parent: Users

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	1
nc	2
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?php
declare(strict_types=1);

namespace Gewaer\Models;

use Gewaer\Traits\PermissionsTrait;
use Gewaer\Traits\SubscriptionPlanLimitTrait;
use Phalcon\Cashier\Billable;
use Gewaer\Exception\ServerErrorHttpException;
use Exception;
use Carbon\Carbon;

/**
 * Class Users
 *
 * @package Gewaer\Models
 *
 * @property Users $user
 * @property Config $config
 * @property Apps $app
 * @property Companies $defaultCompany
 * @property \Phalcon\Di $di
 */
class Users extends \Baka\Auth\Models\Users
{
    use PermissionsTrait;
    use Billable;

    use SubscriptionPlanLimitTrait;

    public $default_company_branch;
    public $roles_id;
    public $stripe_id;
    public $card_last_four;
    public $card_brand;
    public $trial_ends_at;

    /**
     * Provide the app plan id
     * if the user is signing up a new company
     *
     * @var integer
     */
    public $appPlanId = null;

    /**
     * Initialize method for model.
     */
    public function initialize()
    {
        $this->setSource('users');

        //overwrite parent relationships
        $this->hasOne('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'session']);
        $this->hasMany('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'sessions']);
        $this->hasMany('id', 'Baka\Auth\Models\SessionKeys', 'users_id', ['alias' => 'sessionKeys']);
        $this->hasMany('id', 'Baka\Auth\Models\Banlist', 'users_id', ['alias' => 'bans']);
        $this->hasMany('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'sessions']);
        $this->hasMany('id', 'Gewaer\Models\UserConfig', 'users_id', ['alias' => 'config']);
        $this->hasMany('id', 'Gewaer\Models\UserLinkedSources', 'users_id', ['alias' => 'sources']);
        $this->hasMany('id', 'Baka\Auth\Models\UsersAssociatedCompany', 'users_id', ['alias' => 'companies']);
        $this->hasOne('default_company', 'Gewaer\Models\Companies', 'id', ['alias' => 'defaultCompany']);

        $this->hasOne(
            'id',
            'Gewaer\Models\UserRoles',
            'users_id',
            ['alias' => 'permission']
        );

        $this->hasMany(
            'id',
            'Gewaer\Models\UserRoles',
            'users_id',
            ['alias' => 'permissions']
        );

        $this->hasManyToMany(
            'id',
            'Gewaer\Models\UserRoles',
            'users_id',
            'roles_id',
            'Gewaer\Models\Roles',
            'id',
            [
                'alias' => 'roles',
                'params' => [
                    'limit' => 1,
                    'conditions' => 'Gewaer\Models\UserRoles.apps_id = ' . $this->di->getConfig()->app->id,
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Gewaer\Models\Subscription',
            'user_id',
            [
                'alias' => 'allSubscriptions',
                'params' => [
                    'conditions' => 'apps_id = ?0',
                    'bind' => [$this->di->getApp()->getId()],
                    'order' => 'id DESC'
                ]
            ]
        );
    }

    /**
     * Returns table name mapped in the model.
     *
     * @return string
     */
    public function getSource() : string
    {
        return 'users';
    }

    /**
     * Get the User key for redis
     *
     * @return string
     */
    public function getKey() : string
    {
        return $this->id;
    }

    /**
     * A company owner is the first person that register this company
     * This only ocurres when signing up the first time, after that all users invites
     * come with a default_company id attached
     *
     * @return boolean
     */
    public function isFirstSignup(): bool
    {
        return empty($this->default_company) ? true : false;
    }

    /**
     * Does the user have a role assign to him?
     *
     * @return boolean
     */
    public function hasRole(): bool
    {
        return !empty($this->roles_id) ? true : false;
    }

    /**
     * Get all of the subscriptions for the user.
     */
    public function subscriptions()
    {
        $this->hasMany(
            'id',
            'Gewaer\Models\Subscription',
            'user_id',
            [
                'alias' => 'subscriptions',
                'params' => [
                    'conditions' => 'apps_id = ?0 and company_id = ?1',
                    'bind' => [$this->di->getApp()->getId(), $this->default_company],
                    'order' => 'id DESC'
                ]
            ]
        );

        return $this->getRelated('subscriptions');
    }

    /**
     * Strat a free trial
     *
     * @param Users $user
     * @return Subscription
     */
    public function startFreeTrial() : Subscription
    {
        $defaultPlan = AppsPlans::getDefaultPlan();

        $subscription = new Subscription();
        $subscription->user_id = $this->getId();
        $subscription->company_id = $this->default_company;
        $subscription->apps_id = $this->di->getApp()->getId();
        $subscription->apps_plans_id = $this->di->getApp()->default_apps_plan_id;
        $subscription->name = $defaultPlan->name;
        $subscription->stripe_id = $defaultPlan->stripe_id;
        $subscription->stripe_plan = $defaultPlan->stripe_plan;
        $subscription->quantity = 1;
        $subscription->trial_ends_at = Carbon::now()->addDays($this->di->getApp()->plan->free_trial_dates)->toDateTimeString();

        if (!$subscription->save()) {
            throw new ServerErrorHttpException((string)current($this->getMessages()));
        }

        $this->trial_ends_at = $subscription->trial_ends_at;
        $this->update();

        return $subscription;
    }

    /**
     * Before create
     *
     * @return void
     */
    public function beforeCreate()
    {
        parent::beforeCreate();

        //this is only empty when creating a new user
        if (!$this->isFirstSignup()) {
            //confirm if the app reach its limit
            $this->isAtLimit();
        }

        //Assign admin role to the system if we dont get a specify role
        if (!$this->hasRole()) {
            $role = Roles::findFirstByName('Admins');
            $this->roles_id = $role->getId();
        }
    }

    /**
     * What to do after the creation of a new users
     *  - Assign default role
     *
     * @return void
     */
    public function afterCreate()
    {
        //need to run it here, since we overwirte the default_company id and null this function objective
        $isFirstSignup = $this->isFirstSignup();

        /**
         * User signing up for a new app / plan
         * How do we know? well he doesnt have a default_company
         */
        if ($isFirstSignup) {
            $company = new Companies();
            $company->name = $this->defaultCompanyName;
            $company->users_id = $this->getId();

            if (!$company->save()) {
                throw new Exception(current($company->getMessages()));
            }

            $this->default_company = $company->getId();

            if (!$this->update()) {
                throw new ServerErrorHttpException((string) current($this->getMessages()));
            }

            $this->default_company_branch = $this->defaultCompany->branch->getId();
            $this->update();

            //update default subscription free trial
            $company->app->subscriptions_id = $this->startFreeTrial()->getId();
            $company->update();
        } else {
            //we have the company id
            if (empty($this->default_company_branch)) {
                $this->default_company_branch = $this->defaultCompany->branch->getId();
            }
        }

        //Create new company associated company
        $newUserAssocCompany = new UsersAssociatedCompany();
        $newUserAssocCompany->users_id = $this->id;
        $newUserAssocCompany->company_id = $this->default_company;
        $newUserAssocCompany->identify_id = 1;
        $newUserAssocCompany->user_active = 1;
        $newUserAssocCompany->user_role = $this->roles_id == 1 ? 'admins' : 'users';

        if (!$newUserAssocCompany->save()) {
            throw new ServerErrorHttpException((string)current($newUserAssocCompany->getMessages()));
        }

        //Insert record into user_roles
        $userRole = new UserRoles();
        $userRole->users_id = $this->id;
        $userRole->roles_id = $this->roles_id;
        $userRole->apps_id = $this->di->getApp()->getId();
        $userRole->company_id = $this->default_company;

        if (!$userRole->save()) {
            throw new ServerErrorHttpException((string)current($userRole->getMessages()));
        }

        //update user activity when its not a empty user
        if (!$isFirstSignup) {
            $this->updateAppActivityLimit();
        }
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Gewaer\Models;
5
6		use Gewaer\Traits\PermissionsTrait;
7		use Gewaer\Traits\SubscriptionPlanLimitTrait;
8		use Phalcon\Cashier\Billable;
9		use Gewaer\Exception\ServerErrorHttpException;
10		use Exception;
11		use Carbon\Carbon;
12
13		/**
14		* Class Users
15		*
16		* @package Gewaer\Models
17		*
18		* @property Users $user
19		* @property Config $config
20		* @property Apps $app
21		* @property Companies $defaultCompany
22		* @property \Phalcon\Di $di
23		*/
24		class Users extends \Baka\Auth\Models\Users
25		{
26		use PermissionsTrait;
27		use Billable;
		1 ignored issue – show introduced 2018-12-24 06:18 UTC by Report Bug Copy Issue Report The trait `Phalcon\Cashier\Billable` requires some properties which are not provided by `Gewaer\Models\Users`: `$stripe`, `$data`, `$brand`, `$last4`, `$paid`, `$customer`, `$secretKey`, `$card`, `$sources`, `$subscriptions` Loading history...
28		use SubscriptionPlanLimitTrait;
29
30		public $default_company_branch;
31		public $roles_id;
32		public $stripe_id;
33		public $card_last_four;
34		public $card_brand;
35		public $trial_ends_at;
36
37		/**
38		* Provide the app plan id
39		* if the user is signing up a new company
40		*
41		* @var integer
42		*/
43		public $appPlanId = null;
44
45		/**
46		* Initialize method for model.
47		*/
48	33	public function initialize()
49		{
50	33	$this->setSource('users');
51
52		//overwrite parent relationships
53	33	$this->hasOne('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'session']);
54	33	$this->hasMany('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'sessions']);
55	33	$this->hasMany('id', 'Baka\Auth\Models\SessionKeys', 'users_id', ['alias' => 'sessionKeys']);
56	33	$this->hasMany('id', 'Baka\Auth\Models\Banlist', 'users_id', ['alias' => 'bans']);
57	33	$this->hasMany('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'sessions']);
58	33	$this->hasMany('id', 'Gewaer\Models\UserConfig', 'users_id', ['alias' => 'config']);
59	33	$this->hasMany('id', 'Gewaer\Models\UserLinkedSources', 'users_id', ['alias' => 'sources']);
60	33	$this->hasMany('id', 'Baka\Auth\Models\UsersAssociatedCompany', 'users_id', ['alias' => 'companies']);
61	33	$this->hasOne('default_company', 'Gewaer\Models\Companies', 'id', ['alias' => 'defaultCompany']);
62
63	33	$this->hasOne(
64	33	'id',
65	33	'Gewaer\Models\UserRoles',
66	33	'users_id',
67	33	['alias' => 'permission']
68		);
69
70	33	$this->hasMany(
71	33	'id',
72	33	'Gewaer\Models\UserRoles',
73	33	'users_id',
74	33	['alias' => 'permissions']
75		);
76
77	33	$this->hasManyToMany(
78	33	'id',
79	33	'Gewaer\Models\UserRoles',
80	33	'users_id',
81	33	'roles_id',
82	33	'Gewaer\Models\Roles',
83	33	'id',
84		[
85	33	'alias' => 'roles',
86		'params' => [
87	33	'limit' => 1,
88	33	'conditions' => 'Gewaer\Models\UserRoles.apps_id = ' . $this->di->getConfig()->app->id,
89		]
90		]
91		);
92
93	33	$this->hasMany(
94	33	'id',
95	33	'Gewaer\Models\Subscription',
96	33	'user_id',
97		[
98	33	'alias' => 'allSubscriptions',
99		'params' => [
100	33	'conditions' => 'apps_id = ?0',
101	33	'bind' => [$this->di->getApp()->getId()],
102	33	'order' => 'id DESC'
103		]
104		]
105		);
106	33	}
107
108		/**
109		* Returns table name mapped in the model.
110		*
111		* @return string
112		*/
113	26	public function getSource() : string
114		{
115	26	return 'users';
116		}
117
118		/**
119		* Get the User key for redis
120		*
121		* @return string
122		*/
123		public function getKey() : string
124		{
125		return $this->id;
126		}
127
128		/**
129		* A company owner is the first person that register this company
130		* This only ocurres when signing up the first time, after that all users invites
131		* come with a default_company id attached
132		*
133		* @return boolean
134		*/
135	4	public function isFirstSignup(): bool
136		{
137	4	return empty($this->default_company) ? true : false;
138		}
139
140		/**
141		* Does the user have a role assign to him?
142		*
143		* @return boolean
144		*/
145	4	public function hasRole(): bool
146		{
147	4	return !empty($this->roles_id) ? true : false;
148		}
149
150		/**
151		* Get all of the subscriptions for the user.
152		*/
153	3	public function subscriptions()
154		{
155	3	$this->hasMany(
156	3	'id',
157	3	'Gewaer\Models\Subscription',
158	3	'user_id',
159		[
160	3	'alias' => 'subscriptions',
161		'params' => [
162	3	'conditions' => 'apps_id = ?0 and company_id = ?1',
163	3	'bind' => [$this->di->getApp()->getId(), $this->default_company],
164	3	'order' => 'id DESC'
165		]
166		]
167		);
168
169	3	return $this->getRelated('subscriptions');
170		}
171
172		/**
173		* Strat a free trial
174		*
175		* @param Users $user
176		* @return Subscription
177		*/
178	1	public function startFreeTrial() : Subscription
179		{
180	1	$defaultPlan = AppsPlans::getDefaultPlan();
181
182	1	$subscription = new Subscription();
183	1	$subscription->user_id = $this->getId();
184	1	$subscription->company_id = $this->default_company;
185	1	$subscription->apps_id = $this->di->getApp()->getId();
186	1	$subscription->apps_plans_id = $this->di->getApp()->default_apps_plan_id;
187	1	$subscription->name = $defaultPlan->name;
188	1	$subscription->stripe_id = $defaultPlan->stripe_id;
189	1	$subscription->stripe_plan = $defaultPlan->stripe_plan;
190	1	$subscription->quantity = 1;
191	1	$subscription->trial_ends_at = Carbon::now()->addDays($this->di->getApp()->plan->free_trial_dates)->toDateTimeString();
192
193	1	if (!$subscription->save()) {
194		throw new ServerErrorHttpException((string)current($this->getMessages()));
195		}
196
197	1	$this->trial_ends_at = $subscription->trial_ends_at;
198	1	$this->update();
199
200	1	return $subscription;
201		}
202
203		/**
204		* Before create
205		*
206		* @return void
207		*/
208	4	public function beforeCreate()
209		{
210	4	parent::beforeCreate();
211
212		//this is only empty when creating a new user
213	4	if (!$this->isFirstSignup()) {
214		//confirm if the app reach its limit
215	3	$this->isAtLimit();
216		}
217
218		//Assign admin role to the system if we dont get a specify role
219	3	if (!$this->hasRole()) {
220	1	$role = Roles::findFirstByName('Admins');
221	1	$this->roles_id = $role->getId();
222		}
223	3	}
224
225		/**
226		* What to do after the creation of a new users
227		* - Assign default role
228		*
229		* @return void
230		*/
231	3	public function afterCreate()
232		{
233		//need to run it here, since we overwirte the default_company id and null this function objective
234	3	$isFirstSignup = $this->isFirstSignup();
235
236		/**
237		* User signing up for a new app / plan
238		* How do we know? well he doesnt have a default_company
239		*/
240	3	if ($isFirstSignup) {
241	1	$company = new Companies();
242	1	$company->name = $this->defaultCompanyName;
243	1	$company->users_id = $this->getId();
244
245	1	if (!$company->save()) {
246		throw new Exception(current($company->getMessages()));
247		}
248
249	1	$this->default_company = $company->getId();
250
251	1	if (!$this->update()) {
252		throw new ServerErrorHttpException((string) current($this->getMessages()));
253		}
254
255	1	$this->default_company_branch = $this->defaultCompany->branch->getId();
256	1	$this->update();
257
258		//update default subscription free trial
259	1	$company->app->subscriptions_id = $this->startFreeTrial()->getId();
260	1	$company->update();
261		} else {
262		//we have the company id
263	2	if (empty($this->default_company_branch)) {
264		$this->default_company_branch = $this->defaultCompany->branch->getId();
265		}
266		}
267
268		//Create new company associated company
269	3	$newUserAssocCompany = new UsersAssociatedCompany();
270	3	$newUserAssocCompany->users_id = $this->id;
271	3	$newUserAssocCompany->company_id = $this->default_company;
272	3	$newUserAssocCompany->identify_id = 1;
273	3	$newUserAssocCompany->user_active = 1;
274	3	$newUserAssocCompany->user_role = $this->roles_id == 1 ? 'admins' : 'users';
275
276	3	if (!$newUserAssocCompany->save()) {
277		throw new ServerErrorHttpException((string)current($newUserAssocCompany->getMessages()));
278		}
279
280		//Insert record into user_roles
281	3	$userRole = new UserRoles();
282	3	$userRole->users_id = $this->id;
283	3	$userRole->roles_id = $this->roles_id;
284	3	$userRole->apps_id = $this->di->getApp()->getId();
285	3	$userRole->company_id = $this->default_company;
286
287	3	if (!$userRole->save()) {
288		throw new ServerErrorHttpException((string)current($userRole->getMessages()));
289		}
290
291		//update user activity when its not a empty user
292	3	if (!$isFirstSignup) {
293	2	$this->updateAppActivityLimit();
294		}
295	3	}
296		}
297

bakaphp / phalcon-api

Push — master ( ba5c19...4803d4 )

Users::isFirstSignup() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like