Issues in Companies.php - New Issues - Inspection of "Feature crud companies info" - bakaphp/phalcon-api - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#20)

unknown

created 2018-12-27 15:56 UTC

library/Models/Companies.php (2 issues)

Labels

Severity

<?php
declare(strict_types=1);

namespace Gewaer\Models;

use Phalcon\Validation;
use Phalcon\Validation\Validator\PresenceOf;
use Gewaer\Exception\ServerErrorHttpException;
use Exception;

/**
 * Class Companies
 *
 * @package Gewaer\Models
 *
 * @property Users $user
 * @property CompaniesBranches $branch
 * @property CompaniesBranches $branches
 * @property Config $config
 * @property UserCompanyApps $app
 * @property \Phalcon\Di $di
 */
class Companies extends \Gewaer\CustomFields\AbstractCustomFieldsModel
{
    const DEFAULT_COMPANY = 'DefaulCompany';

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

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

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

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

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

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

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

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

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

    /**
     * Provide the app plan id
     *
     * @var integer
     */
    public $appPlanId = null;

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

        $this->belongsTo('users_id', 'Baka\Auth\Models\Users', 'id', ['alias' => 'user']);
        $this->hasMany('id', 'Baka\Auth\Models\CompanySettings', 'id', ['alias' => 'settings']);

        $this->belongsTo(
            'users_id',
            'Gewaer\Models\Users',
            'id',
            ['alias' => 'user']
        );

        $this->hasMany(
            'id',
            'Gewaer\Models\CompaniesBranches',
            'companies_id',
            ['alias' => 'branches']
        );

        $this->hasMany(
            'id',
            'Gewaer\Models\CompaniesCustomFields',
            'companies_id',
            ['alias' => 'fields']
        );

        $this->hasMany(
            'id',
            'Gewaer\CustomFields\CustomFields',
            'companies_id',
            ['alias' => 'custom-fields']
        );

        $this->hasMany(
            'id',
            'Gewaer\Models\UsersAssociatedCompany',
            'company_id',
            ['alias' => 'UsersAssociatedCompany']
        );

        $this->hasOne(
            'id',
            'Gewaer\Models\CompaniesBranches',
            'companies_id',
            [
                'alias' => 'branch',
            ]
        );

        $this->hasOne(
            'id',
            'Gewaer\Models\UserCompanyApps',
            'company_id',
            [
                'alias' => 'app',
                'params' => [
                    'conditions' => 'apps_id = ' . $this->di->getApp()->getId()
                ]
            ]
        );

        $this->hasOne(
            'id',
            'Gewaer\Models\UserCompanyApps',
            'company_id',
            [
                'alias' => 'apps',
                'params' => [
                    'conditions' => 'apps_id = ' . $this->di->getApp()->getId()
                ]
            ]
        );

        $this->hasOne(
            'id',
            'Gewaer\Models\Subscription',
            'company_id',
            [
                'alias' => 'subscription',
                'params' => [
                    'conditions' => 'apps_id = ' . $this->di->getApp()->getId() . ' AND ends_at is null AND is_deleted = 0 ',
                    'order' => 'id DESC'
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Gewaer\Models\Subscription',
            'company_id',
            [
                'alias' => 'subscriptions',
                'params' => [
                    'conditions' => 'apps_id = ' . $this->di->getApp()->getId() . ' AND is_deleted = 0',
                    'order' => 'id DESC'
                ]
            ]
        );
    }

    /**
     * Model validation
     *
     * @return void
     */
    public function validation()
    {
        $validator = new Validation();

        $validator->add(
            'name',
            new PresenceOf([
                'model' => $this,
                'required' => true,
            ])
        );

        return $this->validate($validator);
    }

    /**
    * Register a company given a user and name
    *
    * @param  Users  $user
    * @param  string $name
    * @return Companies
    */
    public static function register(Users $user, string $name): Companies
    {
        $company = new self();
        $company->name = $name;
        $company->users_id = $user->getId();

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

        return $company;
    }

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

    /**
     * Confirm if a user belongs to this current company
     *
     * @param Users $user
     * @return boolean
     */
    public function userAssociatedToCompany(Users $user): bool
    {
        return is_object($this->getUsersAssociatedCompany('users_id =' . $user->getId())) ? true : false;
    }

    /**
     * After creating the company
     *
     * @return void
     */
    public function afterCreate()
    {
        parent::afterCreate();

        //setup the user notificatoin setting
        $companySettings = new CompaniesSettings();
        $companySettings->companies_id = $this->getId();
        $companySettings->name = 'notifications';
        $companySettings->value = $this->user->email;
        if (!$companySettings->save()) {
            throw new Exception((string)current($companySettings->getMessages()));
        }

        //multi user asociation
        $usersAssociatedCompany = new UsersAssociatedCompany();
        $usersAssociatedCompany->users_id = $this->user->getId();
        $usersAssociatedCompany->company_id = $this->getId();
        $usersAssociatedCompany->identify_id = $this->user->getId();
        $usersAssociatedCompany->user_active = 1;
        $usersAssociatedCompany->user_role = 'admin';
        if (!$usersAssociatedCompany->save()) {
            throw new Exception((string)current($usersAssociatedCompany->getMessages()));
        }

        //now thta we setup de company and associated with the user we need to setup this as its default company
        if (!UserConfig::findFirst(['conditions' => 'users_id = ?0 and name = ?1', 'bind' => [$this->user->getId(), self::DEFAULT_COMPANY]])) {
            $userConfig = new UserConfig();
            $userConfig->users_id = $this->user->getId();
            $userConfig->name = self::DEFAULT_COMPANY;
            $userConfig->value = $this->getId();

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

        /**
         * @var CompaniesBranches
         */
        $branch = new CompaniesBranches();
        $branch->companies_id = $this->getId();
        $branch->users_id = $this->user->getId();
        $branch->name = 'Default';
        $branch->is_default = 1;
        $branch->description = '';
        if (!$branch->save()) {
            throw new ServerErrorHttpException((string)current($branch->getMessages()));
        }

        //look for the default plan for this app
        $companyApps = new UserCompanyApps();
        $companyApps->companies_id = $this->getId();

        $companyApps->apps_id = $this->di->getApp()->getId();
        $companyApps->subscriptions_id = 0;

        //we need to assign this company to a plan
        if (empty($this->appPlanId)) {
            $plan = AppsPlans::getDefaultPlan();
            $companyApps->stripe_id = $plan->stripe_id;
        }

        $companyApps->created_at = date('Y-m-d H:i:s');
        $companyApps->is_deleted = 0;

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

    /**
     * Get the default company the users has selected
     *
     * @param  Users  $user
     * @return Companies
     */
    public static function getDefaultByUser(Users $user): Companies
    {
        //verify the user has a default company
        $defaultCompany = UserConfig::findFirst([
            'conditions' => 'users_id = ?0 and name = ?1',
            'bind' => [$user->getId(), self::DEFAULT_COMPANY],
        ]);

        //found it
        if ($defaultCompany) {

            return self::findFirst($defaultCompany->value);
        }

        //second try
        $defaultCompany = UsersAssociatedCompany::findFirst([
            'conditions' => 'users_id = ?0 and user_active =?1',
            'bind' => [$user->getId(), 1],
        ]);

        if ($defaultCompany) {
            return self::findFirst($defaultCompany->company_id);
        }

        throw new Exception(_("User doesn't have an active company"));
    }

    /**
     * After the model was update we need to update its custom fields
     *
     * @return void
     */
    public function afterUpdate()
    {
        //only clean and change custom fields if they are been sent
        if (!empty($this->customFields)) {
            //replace old custom with new
            $allCustomFields = $this->getAllCustomFields();
            if (is_array($allCustomFields)) {
                foreach ($this->customFields as $key => $value) {
                    $allCustomFields[$key] = $value;
                }
            }

            if (!empty($allCustomFields)) {
                //set
                $this->setCustomFields($allCustomFields);
                //clean old
                $this->cleanCustomFields($this->getId());
                //save new
                $this->saveCustomFields();
            }
        }
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Gewaer\Models;
5
6		use Phalcon\Validation;
7		use Phalcon\Validation\Validator\PresenceOf;
8		use Gewaer\Exception\ServerErrorHttpException;
9		use Exception;
10
11		/**
12		* Class Companies
13		*
14		* @package Gewaer\Models
15		*
16		* @property Users $user
17		* @property CompaniesBranches $branch
18		* @property CompaniesBranches $branches
19		* @property Config $config
20		* @property UserCompanyApps $app
21		* @property \Phalcon\Di $di
22		*/
23		class Companies extends \Gewaer\CustomFields\AbstractCustomFieldsModel
24		{
25		const DEFAULT_COMPANY = 'DefaulCompany';
26
27		/**
28		*
29		* @var integer
30		*/
31		public $id;
32
33		/**
34		*
35		* @var string
36		*/
37		public $name;
38
39		/**
40		*
41		* @var string
42		*/
43		public $profile_image;
44
45		/**
46		*
47		* @var string
48		*/
49		public $website;
50
51		/**
52		*
53		* @var integer
54		*/
55		public $users_id;
56
57		/**
58		*
59		* @var integer
60		*/
61		public $has_activities;
62
63		/**
64		*
65		* @var string
66		*/
67		public $created_at;
68
69		/**
70		*
71		* @var string
72		*/
73		public $updated_at;
74
75		/**
76		*
77		* @var integer
78		*/
79		public $is_deleted;
80
81		/**
82		* Provide the app plan id
83		*
84		* @var integer
85		*/
86		public $appPlanId = null;
87
88		/**
89		* Initialize method for model.
90		*/
91	23	public function initialize()
92		{
93	23	$this->setSource('companies');
94
95	23	$this->belongsTo('users_id', 'Baka\Auth\Models\Users', 'id', ['alias' => 'user']);
96	23	$this->hasMany('id', 'Baka\Auth\Models\CompanySettings', 'id', ['alias' => 'settings']);
97
98	23	$this->belongsTo(
99	23	'users_id',
100	23	'Gewaer\Models\Users',
101	23	'id',
102	23	['alias' => 'user']
103		);
104
105	23	$this->hasMany(
106	23	'id',
107	23	'Gewaer\Models\CompaniesBranches',
108	23	'companies_id',
109	23	['alias' => 'branches']
110		);
111
112	23	$this->hasMany(
113	23	'id',
114	23	'Gewaer\Models\CompaniesCustomFields',
115	23	'companies_id',
116	23	['alias' => 'fields']
117		);
118
119	23	$this->hasMany(
120	23	'id',
121	23	'Gewaer\CustomFields\CustomFields',
122	23	'companies_id',
123	23	['alias' => 'custom-fields']
124		);
125
126	23	$this->hasMany(
127	23	'id',
128	23	'Gewaer\Models\UsersAssociatedCompany',
129	23	'company_id',
130	23	['alias' => 'UsersAssociatedCompany']
131		);
132
133	23	$this->hasOne(
134	23	'id',
135	23	'Gewaer\Models\CompaniesBranches',
136	23	'companies_id',
137		[
138	23	'alias' => 'branch',
139		]
140		);
141
142	23	$this->hasOne(
143	23	'id',
144	23	'Gewaer\Models\UserCompanyApps',
145	23	'company_id',
146		[
147	23	'alias' => 'app',
148		'params' => [
149	23	'conditions' => 'apps_id = ' . $this->di->getApp()->getId()
150		]
151		]
152		);
153
154	23	$this->hasOne(
155	23	'id',
156	23	'Gewaer\Models\UserCompanyApps',
157	23	'company_id',
158		[
159	23	'alias' => 'apps',
160		'params' => [
161	23	'conditions' => 'apps_id = ' . $this->di->getApp()->getId()
162		]
163		]
164		);
165
166	23	$this->hasOne(
167	23	'id',
168	23	'Gewaer\Models\Subscription',
169	23	'company_id',
170		[
171	23	'alias' => 'subscription',
172		'params' => [
173	23	'conditions' => 'apps_id = ' . $this->di->getApp()->getId() . ' AND ends_at is null AND is_deleted = 0 ',
174	23	'order' => 'id DESC'
175		]
176		]
177		);
178
179	23	$this->hasMany(
180	23	'id',
181	23	'Gewaer\Models\Subscription',
182	23	'company_id',
183		[
184	23	'alias' => 'subscriptions',
185		'params' => [
186	23	'conditions' => 'apps_id = ' . $this->di->getApp()->getId() . ' AND is_deleted = 0',
187	23	'order' => 'id DESC'
188		]
189		]
190		);
191	23	}
192
193		/**
194		* Model validation
195		*
196		* @return void
197		*/
198	4	public function validation()
199		{
200	4	$validator = new Validation();
201
202	4	$validator->add(
203	4	'name',
204	4	new PresenceOf([
205	4	'model' => $this,
206		'required' => true,
207		])
208		);
209
210	4	return $this->validate($validator);
211		}
212
213		/**
214		* Register a company given a user and name
215		*
216		* @param Users $user
217		* @param string $name
218		* @return Companies
219		*/
220		public static function register(Users $user, string $name): Companies
221		{
222		$company = new self();
223		$company->name = $name;
224		$company->users_id = $user->getId();
225
226		if (!$company->save()) {
227		throw new Exception(current($company->getMessages()));
228		}
229
230		return $company;
231		}
232
233		/**
234		* Returns table name mapped in the model.
235		*
236		* @return string
237		*/
238	17	public function getSource() : string
239		{
240	17	return 'companies';
241		}
242
243		/**
244		* Confirm if a user belongs to this current company
245		*
246		* @param Users $user
247		* @return boolean
248		*/
249		public function userAssociatedToCompany(Users $user): bool
250		{
251		return is_object($this->getUsersAssociatedCompany('users_id =' . $user->getId())) ? true : false;
252		}
253
254		/**
255		* After creating the company
256		*
257		* @return void
258		*/
259	3	public function afterCreate()
260		{
261	3	parent::afterCreate();
262
263		//setup the user notificatoin setting
264	3	$companySettings = new CompaniesSettings();
265	3	$companySettings->companies_id = $this->getId();
266	3	$companySettings->name = 'notifications';
267	3	$companySettings->value = $this->user->email;
268	3	if (!$companySettings->save()) {
269		throw new Exception((string)current($companySettings->getMessages()));
270		}
271
272		//multi user asociation
273	3	$usersAssociatedCompany = new UsersAssociatedCompany();
274	3	$usersAssociatedCompany->users_id = $this->user->getId();
275	3	$usersAssociatedCompany->company_id = $this->getId();
276	3	$usersAssociatedCompany->identify_id = $this->user->getId();
277	3	$usersAssociatedCompany->user_active = 1;
278	3	$usersAssociatedCompany->user_role = 'admin';
279	3	if (!$usersAssociatedCompany->save()) {
280		throw new Exception((string)current($usersAssociatedCompany->getMessages()));
281		}
282
283		//now thta we setup de company and associated with the user we need to setup this as its default company
284	3	if (!UserConfig::findFirst(['conditions' => 'users_id = ?0 and name = ?1', 'bind' => [$this->user->getId(), self::DEFAULT_COMPANY]])) {
285	2	$userConfig = new UserConfig();
286	2	$userConfig->users_id = $this->user->getId();
287	2	$userConfig->name = self::DEFAULT_COMPANY;
288	2	$userConfig->value = $this->getId();
289
290	2	if (!$userConfig->save()) {
291		throw new Exception((string)current($userConfig->getMessages()));
292		}
293		}
294
295		/**
296		* @var CompaniesBranches
297		*/
298	3	$branch = new CompaniesBranches();
299	3	$branch->companies_id = $this->getId();
300	3	$branch->users_id = $this->user->getId();
301	3	$branch->name = 'Default';
302	3	$branch->is_default = 1;
303	3	$branch->description = '';
304	3	if (!$branch->save()) {
305		throw new ServerErrorHttpException((string)current($branch->getMessages()));
306		}
307
308		//look for the default plan for this app
309	3	$companyApps = new UserCompanyApps();
310	3	$companyApps->companies_id = $this->getId();
		0 ignored issues – show Bug Best Practice introduced 2018-12-26 22:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `companies_id` does not exist on `Gewaer\Models\UserCompanyApps`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
311	3	$companyApps->apps_id = $this->di->getApp()->getId();
312	3	$companyApps->subscriptions_id = 0;
313
314		//we need to assign this company to a plan
315	3	if (empty($this->appPlanId)) {
316	3	$plan = AppsPlans::getDefaultPlan();
317	3	$companyApps->stripe_id = $plan->stripe_id;
318		}
319
320	3	$companyApps->created_at = date('Y-m-d H:i:s');
321	3	$companyApps->is_deleted = 0;
322
323	3	if (!$companyApps->save()) {
324		throw new ServerErrorHttpException((string)current($companyApps->getMessages()));
325		}
326	3	}
327
328		/**
329		* Get the default company the users has selected
330		*
331		* @param Users $user
332		* @return Companies
333		*/
334		public static function getDefaultByUser(Users $user): Companies
335		{
336		//verify the user has a default company
337		$defaultCompany = UserConfig::findFirst([
338		'conditions' => 'users_id = ?0 and name = ?1',
339		'bind' => [$user->getId(), self::DEFAULT_COMPANY],
340		]);
341
342		//found it
343		if ($defaultCompany) {
		0 ignored issues – show introduced 2018-12-26 15:55 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$defaultCompany` is of type `Phalcon\Mvc\Model`, thus it always evaluated to `true`. Loading history...
344		return self::findFirst($defaultCompany->value);
345		}
346
347		//second try
348		$defaultCompany = UsersAssociatedCompany::findFirst([
349		'conditions' => 'users_id = ?0 and user_active =?1',
350		'bind' => [$user->getId(), 1],
351		]);
352
353		if ($defaultCompany) {
354		return self::findFirst($defaultCompany->company_id);
355		}
356
357		throw new Exception(_("User doesn't have an active company"));
358		}
359
360		/**
361		* After the model was update we need to update its custom fields
362		*
363		* @return void
364		*/
365	2	public function afterUpdate()
366		{
367		//only clean and change custom fields if they are been sent
368	2	if (!empty($this->customFields)) {
369		//replace old custom with new
370	1	$allCustomFields = $this->getAllCustomFields();
371	1	if (is_array($allCustomFields)) {
372	1	foreach ($this->customFields as $key => $value) {
373	1	$allCustomFields[$key] = $value;
374		}
375		}
376
377	1	if (!empty($allCustomFields)) {
378		//set
379	1	$this->setCustomFields($allCustomFields);
380		//clean old
381	1	$this->cleanCustomFields($this->getId());
382		//save new
383	1	$this->saveCustomFields();
384		}
385		}
386	2	}
387		}
388

bakaphp / phalcon-api

Pull Request — master (#20)

library/Models/Companies.php (2 issues)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like