Save::save() - Code Metrics - Inspection of "upgrade scrutinizer to 8.3" - zemit-cms/core - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 507036...762659 )

by Julien

created 2024-10-31 18:21 UTC

Save::save() B

↳ Parent: Save

Complexity

Conditions	7
Paths	9

Size

Total Lines	51
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	7
eloc	29
c	3
b	0
f	0
nc	9
nop	0
dl	0
loc	51
ccs	0
cts	33
cp	0
crap	56
rs	8.5226

How to fix Long Method

<?php

/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit\Mvc\Controller\Traits\Query;

use Phalcon\Messages\Message;
use Phalcon\Mvc\ModelInterface;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractExpose;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractInjectable;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractModel;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractParams;
use Zemit\Mvc\Controller\Traits\Abstracts\AbstractQuery;
use Zemit\Mvc\Controller\Traits\Abstracts\Query\AbstractSave;
use Zemit\Mvc\Controller\Traits\Abstracts\Query\AbstractWith;
use Zemit\Mvc\Controller\Traits\Abstracts\Query\Fields\AbstractMapFields;
use Zemit\Mvc\Controller\Traits\Abstracts\Query\Fields\AbstractSaveFields;
use Zemit\Mvc\Model\Interfaces\EagerLoadInterface;

trait Save
{
    use AbstractSave;
    
    use AbstractExpose;
    use AbstractInjectable;
    use AbstractModel;
    use AbstractParams;
    use AbstractQuery;
    use AbstractWith;
    use AbstractMapFields;
    use AbstractSaveFields;
    
    /**
     * Saves the entity and returns the result as an array.
     * @todo handle dynamic and/or composed primary keys
     * @todo handle multiple entities
     * @todo segregate create vs update vs save
     * 
     * @return array The result of the save operation, including the saved status, messages,
     *               and optionally the saved entity data if the save was successful.
     */
    public function save(): array
    {
        $post = $this->getParams();
        $saveFields = $this->getSaveFields()?->toArray();
        $mapFields = $this->getMapFields()?->toArray();
        
        // @todo find what we should do here to handle: 1. dynamic and/or composed primary keys
        if (isset($post['id'])) {
            $model = $this->findFirst();
            if (!isset($model)) {
                return [
                    'saved' => false,
                    'messages' => [new Message('Entity id `' . $post['id'] . '` not found.', 'id', 'NotFound', 404)],
                ];
            }
            unset($post['id']);
        }
        
        $model ??= $this->loadModel();

        assert($model instanceof ModelInterface);
        
        // before assign event
        $this->eventsManager->fire('rest:beforeAssign', $this, [&$model, &$post, &$saveFields, &$mapFields], false);
        $model->assign($post, $saveFields, $mapFields);
        
        if ($this->eventsManager->fire('rest:beforeSave', $this, [&$model]) === false) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            return [
                'saved' => false,
                'messages' => $model->getMessages(),
            ];
        } 
        $saved = $model->save();
        $this->eventsManager->fire('rest:afterSave', $this, [&$model], false);
        
        $ret = [
            'saved' => $saved,
            'messages' => $model->getMessages()
        ];
        
        if ($saved) {
            // load relationship
            $with = $this->getWith()?->toArray();
            if (isset($with) && $model instanceof EagerLoadInterface) {
                $model = $model->load($with);
            }
            
            // expose the model data
            $ret['data'] = $this->expose($model);
        }
        
        return $ret;
    }
}


1			<?php
2
3			/**
4			* This file is part of the Zemit Framework.
5			*
6			* (c) Zemit Team <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE.txt
9			* file that was distributed with this source code.
10			*/
11
12			namespace Zemit\Mvc\Controller\Traits\Query;
13
14			use Phalcon\Messages\Message;
15			use Phalcon\Mvc\ModelInterface;
16			use Zemit\Mvc\Controller\Traits\Abstracts\AbstractExpose;
17			use Zemit\Mvc\Controller\Traits\Abstracts\AbstractInjectable;
18			use Zemit\Mvc\Controller\Traits\Abstracts\AbstractModel;
19			use Zemit\Mvc\Controller\Traits\Abstracts\AbstractParams;
20			use Zemit\Mvc\Controller\Traits\Abstracts\AbstractQuery;
21			use Zemit\Mvc\Controller\Traits\Abstracts\Query\AbstractSave;
22			use Zemit\Mvc\Controller\Traits\Abstracts\Query\AbstractWith;
23			use Zemit\Mvc\Controller\Traits\Abstracts\Query\Fields\AbstractMapFields;
24			use Zemit\Mvc\Controller\Traits\Abstracts\Query\Fields\AbstractSaveFields;
25			use Zemit\Mvc\Model\Interfaces\EagerLoadInterface;
26
27			trait Save
28			{
29			use AbstractSave;
30
31			use AbstractExpose;
32			use AbstractInjectable;
33			use AbstractModel;
34			use AbstractParams;
35			use AbstractQuery;
36			use AbstractWith;
37			use AbstractMapFields;
38			use AbstractSaveFields;
39
40			/**
41			* Saves the entity and returns the result as an array.
42			* @todo handle dynamic and/or composed primary keys
43			* @todo handle multiple entities
44			* @todo segregate create vs update vs save
45			*
46			* @return array The result of the save operation, including the saved status, messages,
47			* and optionally the saved entity data if the save was successful.
48			*/
49			public function save(): array
50			{
51			$post = $this->getParams();
52			$saveFields = $this->getSaveFields()?->toArray();
53			$mapFields = $this->getMapFields()?->toArray();
54
55			// @todo find what we should do here to handle: 1. dynamic and/or composed primary keys
56			if (isset($post['id'])) {
57			$model = $this->findFirst();
58			if (!isset($model)) {
59			return [
60			'saved' => false,
61			'messages' => [new Message('Entity id `' . $post['id'] . '` not found.', 'id', 'NotFound', 404)],
62			];
63			}
64			unset($post['id']);
65			}
66
67			$model ??= $this->loadModel();
			0 ignored issues – show Comprehensibility Best Practice introduced 2024-10-31 18:42 UTC by Report Bug Copy Issue Report The variable `$model` does not seem to be defined for all execution paths leading up to this point. Loading history...
68			assert($model instanceof ModelInterface);
69
70			// before assign event
71			$this->eventsManager->fire('rest:beforeAssign', $this, [&$model, &$post, &$saveFields, &$mapFields], false);
72			$model->assign($post, $saveFields, $mapFields);
73
74			if ($this->eventsManager->fire('rest:beforeSave', $this, [&$model]) === false) {
			0 ignored issues – show introduced 2024-10-31 18:42 UTC by Report Bug Copy Issue Report The condition `$this->eventsManager->fi...rray($model)) === false` is always `true`. Loading history... Bug introduced 2024-10-31 18:42 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->eventsManager->fi..., $this, array($model))` targeting `Phalcon\Events\Manager::fire()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
75			return [
76			'saved' => false,
77			'messages' => $model->getMessages(),
78			];
79			}
80			$saved = $model->save();
81			$this->eventsManager->fire('rest:afterSave', $this, [&$model], false);
82
83			$ret = [
84			'saved' => $saved,
85			'messages' => $model->getMessages()
86			];
87
88			if ($saved) {
89			// load relationship
90			$with = $this->getWith()?->toArray();
91			if (isset($with) && $model instanceof EagerLoadInterface) {
92			$model = $model->load($with);
93			}
94
95			// expose the model data
96			$ret['data'] = $this->expose($model);
97			}
98
99			return $ret;
100			}
101			}
102

zemit-cms / core

Push — master ( 507036...762659 )

Save::save() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like