Issues in BillManagementAction.php - All Issues - Inspection of "Hid update button if `your_tariff` is true in Tari..." - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4bde9c...94e19b )

by Andrii

created 2019-07-24 11:17 UTC

src/actions/BillManagementAction.php (1 issue)

Labels

Documentation 1

Severity

Informational 1

Andrey Klochok 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\actions;

use hipanel\modules\finance\forms\BillForm;
use hipanel\modules\finance\models\Bill;
use hipanel\modules\finance\providers\BillTypesProvider;
use hiqdev\hiart\Collection;
use hiqdev\hiart\ResponseErrorException;
use Yii;
use yii\base\Action;
use yii\web\Controller;
use yii\web\Response;

class BillManagementAction extends Action
{
    /**
     * @var \yii\web\Request
     */
    protected $request;

    /**
     * @var Collection
     */
    protected $collection;
    /**
     * @var BillTypesProvider
     */
    private $billTypesProvider;

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

    /**
     * @var string The view that represents current update action
     */
    public $_view;

    /**
     * @var bool
     */
    public $forceNewRecord = false;

    public function __construct($id, Controller $controller, BillTypesProvider $billTypesProvider, array $config = [])
    {
        parent::__construct($id, $controller, $config);

        $this->request = Yii::$app->request;
        $this->billTypesProvider = $billTypesProvider;
    }

    public function init()
    {
        parent::init();

        if (!isset($this->scenario) || !in_array($this->scenario, [BillForm::SCENARIO_CREATE, BillForm::SCENARIO_UPDATE, BillForm::SCENARIO_COPY], true)) {
            $this->scenario = $this->id;
        }
    }

    public function run()
    {
        $this->createCollection();
        $this->findBills();

        $result = $this->saveBills();
        if ($result instanceof Response) {
            return $result;
        }

        list($billTypes, $billGroupLabels) = $this->billTypesProvider->getGroupedList();

        return $this->controller->render($this->view, [
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'models' => $this->collection->getModels(),
            'billTypes' => $billTypes,
            'billGroupLabels' => $billGroupLabels,
        ]);
    }

    private function findBills()
    {
        $ids = $this->getRequestedIds();

        if ($ids === false) {
            return;
        }

        $bills = Bill::find()->joinWith('charges')->where(['ids' => $ids, 'with_charges' => true])->all();
        $billForms = BillForm::createMultipleFromBills($bills, $this->scenario);
        if ($this->forceNewRecord === true) {
            foreach ($billForms as $model) {
                $model->forceNewRecord();
            }
        }
        $this->collection->set($billForms);
    }

    private function getRequestedIds()
    {
        $request = $this->request;

        if ($request->isPost && ($ids = $request->post('selection')) !== null) {
            return $ids;
        }

        if ($request->isGet && ($id = $request->get('id')) !== null) {
            return [$id];
        }

        if ($request->isPost && $request->post('BillForm') !== null) {
            return false;
        }

        if ($this->scenario === BillForm::SCENARIO_CREATE) {
            $this->collection->set([new BillForm(['scenario' => $this->scenario])]);

            return true;
        }

        throw new \yii\web\UnprocessableEntityHttpException('Id is missing');
    }

    private function createCollection()
    {
        $this->collection = new Collection([
            'model' => new BillForm(['scenario' => $this->scenario]),
            'scenario' => $this->scenario,
            'loadFormatter' => function ($baseModel, $key, $value) {
                /** @var BillForm $baseModel */
                $charges = $this->request->post($baseModel->newCharge()->formName());
                $value['charges'] = isset($charges[$key]) ? $charges[$key] : [];

                return [$key, $value];
            },
            'dataCollector' => function ($model) {
                /** @var BillForm $model */
                return [$model->getPrimaryKey(), $model->toArray()];
            },
        ]);
    }

    private function saveBills()
    {
        $request = $this->request;
        $collection = $this->collection;

        if (
            $request->isPost
            && ($payload = $request->post($this->collection->formName)) !== null
            && $collection->load($payload)
            && $collection->validate()
        ) {
            try {
                $collection->save();
                $this->addSuccessFlash();

                return $this->controller->redirect(['@bill', 'id_in' => $collection->getIds()]);
            } catch (ResponseErrorException $e) {
                Yii::$app->session->addFlash('error', $e->getMessage());

                return false;
            }
        }

        return null;
    }

    private function addSuccessFlash()
    {
        if ($this->scenario === BillForm::SCENARIO_CREATE) {
            return Yii::$app->session->addFlash('success', Yii::t('hipanel:finance', 'Bill was created successfully'));
        }

        if ($this->scenario === BillForm::SCENARIO_UPDATE) {
            return Yii::$app->session->addFlash('success', Yii::t('hipanel:finance', 'Bill was updated successfully'));
        }
    }

    /**
     * @return string
     */
    public function getView()
    {
        return $this->_view ?: $this->scenario;
    }

    /**
     * @param string $view
     */
    public function setView($view)
    {
        $this->_view = $view;
    }
}


1		<?php
2		/**
3		* Finance module for HiPanel
4		*
5		* @link https://github.com/hiqdev/hipanel-module-finance
6		* @package hipanel-module-finance
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hipanel\modules\finance\actions;
12
13		use hipanel\modules\finance\forms\BillForm;
14		use hipanel\modules\finance\models\Bill;
15		use hipanel\modules\finance\providers\BillTypesProvider;
16		use hiqdev\hiart\Collection;
17		use hiqdev\hiart\ResponseErrorException;
18		use Yii;
19		use yii\base\Action;
20		use yii\web\Controller;
21		use yii\web\Response;
22
23		class BillManagementAction extends Action
24		{
25		/**
26		* @var \yii\web\Request
27		*/
28		protected $request;
29
30		/**
31		* @var Collection
32		*/
33		protected $collection;
34		/**
35		* @var BillTypesProvider
36		*/
37		private $billTypesProvider;
38
39		/**
40		* @var string
41		*/
42		public $scenario;
43
44		/**
45		* @var string The view that represents current update action
46		*/
47		public $_view;
48
49		/**
50		* @var bool
51		*/
52		public $forceNewRecord = false;
53
54		public function __construct($id, Controller $controller, BillTypesProvider $billTypesProvider, array $config = [])
55		{
56		parent::__construct($id, $controller, $config);
57
58		$this->request = Yii::$app->request;
59		$this->billTypesProvider = $billTypesProvider;
60		}
61
62		public function init()
63		{
64		parent::init();
65
66		if (!isset($this->scenario) \|\| !in_array($this->scenario, [BillForm::SCENARIO_CREATE, BillForm::SCENARIO_UPDATE, BillForm::SCENARIO_COPY], true)) {
67		$this->scenario = $this->id;
68		}
69		}
70
71		public function run()
72		{
73		$this->createCollection();
74		$this->findBills();
75
76		$result = $this->saveBills();
77		if ($result instanceof Response) {
78		return $result;
79		}
80
81		list($billTypes, $billGroupLabels) = $this->billTypesProvider->getGroupedList();
82
83		return $this->controller->render($this->view, [
		0 ignored issues – show Documentation introduced 2019-03-15 15:18 UTC by Report Bug Copy Issue Report Show Similar Issues like this The property `view` does not exist on `object<hipanel\modules\f...s\BillManagementAction>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
84		'models' => $this->collection->getModels(),
85		'billTypes' => $billTypes,
86		'billGroupLabels' => $billGroupLabels,
87		]);
88		}
89
90		private function findBills()
91		{
92		$ids = $this->getRequestedIds();
93
94		if ($ids === false) {
95		return;
96		}
97
98		$bills = Bill::find()->joinWith('charges')->where(['ids' => $ids, 'with_charges' => true])->all();
99		$billForms = BillForm::createMultipleFromBills($bills, $this->scenario);
100		if ($this->forceNewRecord === true) {
101		foreach ($billForms as $model) {
102		$model->forceNewRecord();
103		}
104		}
105		$this->collection->set($billForms);
106		}
107
108		private function getRequestedIds()
109		{
110		$request = $this->request;
111
112		if ($request->isPost && ($ids = $request->post('selection')) !== null) {
113		return $ids;
114		}
115
116		if ($request->isGet && ($id = $request->get('id')) !== null) {
117		return [$id];
118		}
119
120		if ($request->isPost && $request->post('BillForm') !== null) {
121		return false;
122		}
123
124		if ($this->scenario === BillForm::SCENARIO_CREATE) {
125		$this->collection->set([new BillForm(['scenario' => $this->scenario])]);
126
127		return true;
128		}
129
130		throw new \yii\web\UnprocessableEntityHttpException('Id is missing');
131		}
132
133		private function createCollection()
134		{
135		$this->collection = new Collection([
136		'model' => new BillForm(['scenario' => $this->scenario]),
137		'scenario' => $this->scenario,
138		'loadFormatter' => function ($baseModel, $key, $value) {
139		/** @var BillForm $baseModel */
140		$charges = $this->request->post($baseModel->newCharge()->formName());
141		$value['charges'] = isset($charges[$key]) ? $charges[$key] : [];
142
143		return [$key, $value];
144		},
145		'dataCollector' => function ($model) {
146		/** @var BillForm $model */
147		return [$model->getPrimaryKey(), $model->toArray()];
148		},
149		]);
150		}
151
152		private function saveBills()
153		{
154		$request = $this->request;
155		$collection = $this->collection;
156
157		if (
158		$request->isPost
159		&& ($payload = $request->post($this->collection->formName)) !== null
160		&& $collection->load($payload)
161		&& $collection->validate()
162		) {
163		try {
164		$collection->save();
165		$this->addSuccessFlash();
166
167		return $this->controller->redirect(['@bill', 'id_in' => $collection->getIds()]);
168		} catch (ResponseErrorException $e) {
169		Yii::$app->session->addFlash('error', $e->getMessage());
170
171		return false;
172		}
173		}
174
175		return null;
176		}
177
178		private function addSuccessFlash()
179		{
180	View Code Duplication	if ($this->scenario === BillForm::SCENARIO_CREATE) {
181		return Yii::$app->session->addFlash('success', Yii::t('hipanel:finance', 'Bill was created successfully'));
182		}
183
184	View Code Duplication	if ($this->scenario === BillForm::SCENARIO_UPDATE) {
185		return Yii::$app->session->addFlash('success', Yii::t('hipanel:finance', 'Bill was updated successfully'));
186		}
187		}
188
189		/**
190		* @return string
191		*/
192		public function getView()
193		{
194		return $this->_view ?: $this->scenario;
195		}
196
197		/**
198		* @param string $view
199		*/
200		public function setView($view)
201		{
202		$this->_view = $view;
203		}
204		}
205

hiqdev / hipanel-module-finance

Push — master ( 4bde9c...94e19b )

src/actions/BillManagementAction.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like