OutOffWorkTimeController::modifyAction() - Code Metrics - Inspection of "#458 Расширение функционала "Нерабочего времени"" - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( aa0db1...06f5e3 )

by Портнов

created 2023-02-16 11:27 UTC

OutOffWorkTimeController::modifyAction() F

↳ Parent: OutOffWorkTimeController

Complexity

Conditions	11
Paths	528

Size

Total Lines	87
Code Lines	63

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	63
c	0
b	0
f	0
dl	0
loc	87
rs	3.8517
cc	11
nc	528
nop	1

How to fix Long Method Complexity

<?php
/*
 * MikoPBX - free phone system for small business
 * Copyright (C) 2017-2020 Alexey Portnov and Nikolay Beketov
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 */

namespace MikoPBX\AdminCabinet\Controllers;

use MikoPBX\AdminCabinet\Forms\TimeFrameEditForm;
use MikoPBX\Common\Models\{Extensions,
    IncomingRoutingTable,
    OutWorkTimes,
    OutWorkTimesRouts,
    Sip,
    SoundFiles};

class OutOffWorkTimeController extends BaseController
{


    /**
     * Построение списка правила маршрутизации в нерабочее время
     */
    public function indexAction(): void
    {
        $paremeters      = [
            'order' => 'date_from, weekday_from, time_from',
        ];
        $timeframesTable = [];
        $timeFrames      = OutWorkTimes::find($paremeters);
        foreach ($timeFrames as $timeFrame) {
            if(mb_strlen($timeFrame->description) < 50){
                $shot_description = $timeFrame->description;
            }else{
                $shot_description = trim(mb_substr($timeFrame->description, 0 , 50)).'...';
            }
            $timeframesTable[] = [
                'id'               => $timeFrame->id,
                'date_from'        => ( ! empty($timeFrame->date_from))
                > 0 ? date(
                    "d.m.Y",
                    $timeFrame->date_from
                ) : '',
                'date_to'          => ( ! empty($timeFrame->date_to)) > 0
                    ? date("d.m.Y", $timeFrame->date_to) : '',
                'weekday_from'     => ( ! empty($timeFrame->weekday_from)) ? $this->translation->_(
                    date(
                        'D',
                        strtotime("Sunday +{$timeFrame->weekday_from} days")
                    )
                ) : '',
                'weekday_to'       => ( ! empty($timeFrame->weekday_to)) ? $this->translation->_(
                    date(
                        'D',
                        strtotime("Sunday +{$timeFrame->weekday_to} days")
                    )
                ) : '',
                'time_from'        => $timeFrame->time_from,
                'time_to'          => $timeFrame->time_to,
                'action'           => $timeFrame->action,
                'audio_message_id' => ($timeFrame->SoundFiles) ? $timeFrame->SoundFiles->name : '',
                'extension'        => ($timeFrame->Extensions) ? $timeFrame->Extensions->getRepresent() : '',
                'description'      => $timeFrame->description,
                'allowRestriction' => $timeFrame->allowRestriction,
                'shot_description' => $shot_description,
            ];
        }

        $this->view->indexTable = $timeframesTable;
    }

    /**
     * Карточка редактирования записи нерабочего времени
     *
     * @param string $id
     */
    public function modifyAction($id = ''): void
    {
        $timeFrame = OutWorkTimes::findFirstById($id);
        if ($timeFrame === null) {
            $timeFrame = new OutWorkTimes();
        }
        $forwardingExtensions = [];
        $forwardingExtensions[""] = $this->translation->_("ex_SelectNumber");
        $parameters               = [
            'conditions' => 'number = :extension:',
            'bind'       => [
                'extension' => $timeFrame->extension,
            ],
        ];
        $extensions               = Extensions::find($parameters);
        foreach ($extensions as $record) {
            $forwardingExtensions[$record->number] = $record->getRepresent();
        }
        $audioMessages = [];
        $audioMessages[""] = $this->translation->_("sf_SelectAudioFile");
        $soundFiles        = SoundFiles::find('category="custom"');
        foreach ($soundFiles as $record) {
            $audioMessages[$record->id] = $record->name;
        }

        $availableActions = [
            'playmessage' => $this->translation->_('tf_SelectActionPlayMessage'),
            'extension'   => $this->translation->_('tf_SelectActionRedirectToExtension'),
        ];

        $weekDays = ['-1' => '-'];
        for ($i = "1"; $i <= 7; $i++) {
            $weekDays[$i] = $this->translation->_(date('D', strtotime("Sunday +{$i} days")));
        }

        $form                  = new TimeFrameEditForm(
            $timeFrame, [
            'extensions'        => $forwardingExtensions,
            'audio-message'     => $audioMessages,
            'available-actions' => $availableActions,
            'week-days'         => $weekDays,
        ]
        );
        $this->view->form      = $form;
        $this->view->represent = $timeFrame->getRepresent();

        // Получим список ссылок на разрещенные правила маршутизации в этой группе
        $parameters      = [
            'columns'    => 'routId AS rule_id',
            'conditions' => 'timeConditionId=:timeConditionId:',
            'bind'       => [
                'timeConditionId' => $id,
            ],
        ];
        $allowedRules    = OutWorkTimesRouts::find($parameters)->toArray();
        $allowedRulesIds = array_column($allowedRules, 'rule_id');

        // Получим список правил маршрутизации
        $rules        = IncomingRoutingTable::find(['order' => 'priority', 'conditions' => 'id>1']);
        $routingTable = [];
        foreach ($rules as $rule) {
            $provider = $rule->Providers;
            if ($provider) {
                $modelType  = ucfirst($provider->type);
                $provByType = $provider->$modelType;
            } else {
                $provByType = new SIP();
            }
            $extension = $rule->Extensions;
            $values = [
                'id'        => $rule->id,
                'rulename'  => $rule->rulename,
                'priority'  => $rule->priority,
                'number'    => $rule->number,
                'timeout'   => $rule->timeout,
                'provider'  => $rule->Providers ? $rule->Providers->getRepresent() : '',
                'provider-uniqid'  => $rule->Providers ? $rule->Providers->uniqid : 'none',
                'disabled'  => $provByType->disabled,
                'extension' => $rule->extension,
                'callerid'  => $extension ? $extension->getRepresent() : '',
                'note'      => $rule->note,
                'status'    => in_array($rule->id, $allowedRulesIds, true) ? '' : 'disabled',
            ];

            $routingTable[] = $values;
        }
        $this->view->rules = $routingTable;
    }

    /**
     * Сохранение записи нерабочего времени
     */
    public function saveAction(): void
    {
        if ( ! $this->request->isPost()) {
            return;
        }
        $data = $this->request->getPost();

        $this->db->begin();
        $timeFrame = OutWorkTimes::findFirstByid($data['id']);
        if ($timeFrame === null) {
            $timeFrame = new OutWorkTimes();
        }

        // Заполним параметры пользователя
        foreach ($timeFrame as $name => $value) {
            switch ($name) {
                case 'weekday_from':
                case 'weekday_to':
                    if ( ! array_key_exists($name, $data)) {
                        $timeFrame->$name = '';
                    } else {
                        $timeFrame->$name = ($data[$name] < 1) ? null : $data[$name];
                    }

                    break;
                case 'allowRestriction':
                    if(isset($data[$name])){
                        $timeFrame->$name = ($data[$name] === 'on') ? "1" : "0";
                    }else{
                        $timeFrame->$name = '0';
                    }
                    break;
                case 'date_from':
                case 'date_to':
                case 'time_from':
                case 'time_to':
                    if ( ! array_key_exists($name, $data)) {
                        $timeFrame->$name = '';
                    } else {
                        $timeFrame->$name = $data[$name];
                    }
                    break;
                default:
                    if ( ! array_key_exists($name, $data)) {
                        continue 2;
                    }
                    $timeFrame->$name = $data[$name];
            }
        }

        if('playmessage' === $timeFrame->action){
            $timeFrame->extension = '';
        }
        $error = false;
        if ($timeFrame->save() === false) {
            $errors = $timeFrame->getMessages();
            $this->flash->warning(implode('<br>', $errors));
            $this->view->success = false;
            $this->db->rollback();
            return;
        }
        if ( ! $error) {

            $data['id'] = $timeFrame->id;
            $error = ! $this->saveAllowedOutboundRules($data);
        }

        if($error){
            $this->view->success = false;
            $this->db->rollback();
        }else{
            $this->flash->success($this->translation->_('ms_SuccessfulSaved'));
            $this->view->success = true;
            $this->db->commit();
        }


        // Если это было создание карточки то надо перегрузить страницу с указанием ID
        if (empty($data['id'])) {
            $this->view->reload = "out-off-work-time/modify/{$timeFrame->id}";
        }
    }

    /**
     * Сохраняет параметры маршрутов
     *
     * @param $data
     *
     * @return bool
     */
    private function saveAllowedOutboundRules($data): bool
    {
        // 1. Удалим все старые ссылки на правила относящиеся к этой группе
        $parameters = [
            'conditions' => 'timeConditionId=:timeConditionId:',
            'bind'       => [
                'timeConditionId' => $data['id'],
            ],
        ];
        $oldRules   = OutWorkTimesRouts::find($parameters);
        if ($oldRules->delete() === false) {
            $errors = $oldRules->getMessages();
            $this->flash->error(implode('<br>', $errors));

            return false;
        }

        // 2. Запишем разрешенные направления
        foreach ($data as $key => $value) {
            if (substr_count($key, 'rule-') > 0) {
                $rule_id = explode('rule-', $key)[1];
                if ($data[$key] === 'on') {
                    $newRule = new OutWorkTimesRouts();
                    $newRule->id = $rule_id;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
                    $newRule->timeConditionId = $data['id'];
                    $newRule->routId          = $rule_id;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
                    if ($newRule->save() === false) {
                        $errors = $newRule->getMessages();
                        $this->flash->error(implode('<br>', $errors));
                        return false;
                    }
                }
            }
        }

        return true;
    }

    /**
     * Удаление запси с данными о нерабочем времени
     *
     * @param string $id
     */
    public function deleteAction($id = '')
    {
        $timeFrame = OutWorkTimes::findFirstByid($id);
        if ($timeFrame !== null) {
            $timeFrame->delete();
        }

        $this->forward('OutOffWorkTime/index');
    }


}


1			<?php
2			/*
3			* MikoPBX - free phone system for small business
4			* Copyright (C) 2017-2020 Alexey Portnov and Nikolay Beketov
5			*
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License along with this program.
17			* If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			namespace MikoPBX\AdminCabinet\Controllers;
21
22			use MikoPBX\AdminCabinet\Forms\TimeFrameEditForm;
23			use MikoPBX\Common\Models\{Extensions,
24			IncomingRoutingTable,
25			OutWorkTimes,
26			OutWorkTimesRouts,
27			Sip,
28			SoundFiles};
29
30			class OutOffWorkTimeController extends BaseController
31			{
32
33
34			/**
35			* Построение списка правила маршрутизации в нерабочее время
36			*/
37			public function indexAction(): void
38			{
39			$paremeters = [
40			'order' => 'date_from, weekday_from, time_from',
41			];
42			$timeframesTable = [];
43			$timeFrames = OutWorkTimes::find($paremeters);
44			foreach ($timeFrames as $timeFrame) {
45			if(mb_strlen($timeFrame->description) < 50){
46			$shot_description = $timeFrame->description;
47			}else{
48			$shot_description = trim(mb_substr($timeFrame->description, 0 , 50)).'...';
49			}
50			$timeframesTable[] = [
51			'id' => $timeFrame->id,
52			'date_from' => ( ! empty($timeFrame->date_from))
53			> 0 ? date(
54			"d.m.Y",
55			$timeFrame->date_from
56			) : '',
57			'date_to' => ( ! empty($timeFrame->date_to)) > 0
58			? date("d.m.Y", $timeFrame->date_to) : '',
59			'weekday_from' => ( ! empty($timeFrame->weekday_from)) ? $this->translation->_(
60			date(
61			'D',
62			strtotime("Sunday +{$timeFrame->weekday_from} days")
63			)
64			) : '',
65			'weekday_to' => ( ! empty($timeFrame->weekday_to)) ? $this->translation->_(
66			date(
67			'D',
68			strtotime("Sunday +{$timeFrame->weekday_to} days")
69			)
70			) : '',
71			'time_from' => $timeFrame->time_from,
72			'time_to' => $timeFrame->time_to,
73			'action' => $timeFrame->action,
74			'audio_message_id' => ($timeFrame->SoundFiles) ? $timeFrame->SoundFiles->name : '',
75			'extension' => ($timeFrame->Extensions) ? $timeFrame->Extensions->getRepresent() : '',
76			'description' => $timeFrame->description,
77			'allowRestriction' => $timeFrame->allowRestriction,
78			'shot_description' => $shot_description,
79			];
80			}
81
82			$this->view->indexTable = $timeframesTable;
83			}
84
85			/**
86			* Карточка редактирования записи нерабочего времени
87			*
88			* @param string $id
89			*/
90			public function modifyAction($id = ''): void
91			{
92			$timeFrame = OutWorkTimes::findFirstById($id);
93			if ($timeFrame === null) {
94			$timeFrame = new OutWorkTimes();
95			}
96			$forwardingExtensions = [];
97			$forwardingExtensions[""] = $this->translation->_("ex_SelectNumber");
98			$parameters = [
99			'conditions' => 'number = :extension:',
100			'bind' => [
101			'extension' => $timeFrame->extension,
102			],
103			];
104			$extensions = Extensions::find($parameters);
105			foreach ($extensions as $record) {
106			$forwardingExtensions[$record->number] = $record->getRepresent();
107			}
108			$audioMessages = [];
109			$audioMessages[""] = $this->translation->_("sf_SelectAudioFile");
110			$soundFiles = SoundFiles::find('category="custom"');
111			foreach ($soundFiles as $record) {
112			$audioMessages[$record->id] = $record->name;
113			}
114
115			$availableActions = [
116			'playmessage' => $this->translation->_('tf_SelectActionPlayMessage'),
117			'extension' => $this->translation->_('tf_SelectActionRedirectToExtension'),
118			];
119
120			$weekDays = ['-1' => '-'];
121			for ($i = "1"; $i <= 7; $i++) {
122			$weekDays[$i] = $this->translation->_(date('D', strtotime("Sunday +{$i} days")));
123			}
124
125			$form = new TimeFrameEditForm(
126			$timeFrame, [
127			'extensions' => $forwardingExtensions,
128			'audio-message' => $audioMessages,
129			'available-actions' => $availableActions,
130			'week-days' => $weekDays,
131			]
132			);
133			$this->view->form = $form;
134			$this->view->represent = $timeFrame->getRepresent();
135
136			// Получим список ссылок на разрещенные правила маршутизации в этой группе
137			$parameters = [
138			'columns' => 'routId AS rule_id',
139			'conditions' => 'timeConditionId=:timeConditionId:',
140			'bind' => [
141			'timeConditionId' => $id,
142			],
143			];
144			$allowedRules = OutWorkTimesRouts::find($parameters)->toArray();
145			$allowedRulesIds = array_column($allowedRules, 'rule_id');
146
147			// Получим список правил маршрутизации
148			$rules = IncomingRoutingTable::find(['order' => 'priority', 'conditions' => 'id>1']);
149			$routingTable = [];
150			foreach ($rules as $rule) {
151			$provider = $rule->Providers;
152			if ($provider) {
153			$modelType = ucfirst($provider->type);
154			$provByType = $provider->$modelType;
155			} else {
156			$provByType = new SIP();
157			}
158			$extension = $rule->Extensions;
159			$values = [
160			'id' => $rule->id,
161			'rulename' => $rule->rulename,
162			'priority' => $rule->priority,
163			'number' => $rule->number,
164			'timeout' => $rule->timeout,
165			'provider' => $rule->Providers ? $rule->Providers->getRepresent() : '',
166			'provider-uniqid' => $rule->Providers ? $rule->Providers->uniqid : 'none',
167			'disabled' => $provByType->disabled,
168			'extension' => $rule->extension,
169			'callerid' => $extension ? $extension->getRepresent() : '',
170			'note' => $rule->note,
171			'status' => in_array($rule->id, $allowedRulesIds, true) ? '' : 'disabled',
172			];
173
174			$routingTable[] = $values;
175			}
176			$this->view->rules = $routingTable;
177			}
178
179			/**
180			* Сохранение записи нерабочего времени
181			*/
182			public function saveAction(): void
183			{
184			if ( ! $this->request->isPost()) {
185			return;
186			}
187			$data = $this->request->getPost();
188
189			$this->db->begin();
190			$timeFrame = OutWorkTimes::findFirstByid($data['id']);
191			if ($timeFrame === null) {
192			$timeFrame = new OutWorkTimes();
193			}
194
195			// Заполним параметры пользователя
196			foreach ($timeFrame as $name => $value) {
197			switch ($name) {
198			case 'weekday_from':
199			case 'weekday_to':
200			if ( ! array_key_exists($name, $data)) {
201			$timeFrame->$name = '';
202			} else {
203			$timeFrame->$name = ($data[$name] < 1) ? null : $data[$name];
204			}
205
206			break;
207			case 'allowRestriction':
208			if(isset($data[$name])){
209			$timeFrame->$name = ($data[$name] === 'on') ? "1" : "0";
210			}else{
211			$timeFrame->$name = '0';
212			}
213			break;
214			case 'date_from':
215			case 'date_to':
216			case 'time_from':
217			case 'time_to':
218			if ( ! array_key_exists($name, $data)) {
219			$timeFrame->$name = '';
220			} else {
221			$timeFrame->$name = $data[$name];
222			}
223			break;
224			default:
225			if ( ! array_key_exists($name, $data)) {
226			continue 2;
227			}
228			$timeFrame->$name = $data[$name];
229			}
230			}
231
232			if('playmessage' === $timeFrame->action){
233			$timeFrame->extension = '';
234			}
235			$error = false;
236			if ($timeFrame->save() === false) {
237			$errors = $timeFrame->getMessages();
238			$this->flash->warning(implode('<br>', $errors));
239			$this->view->success = false;
240			$this->db->rollback();
241			return;
242			}
243			if ( ! $error) {
			0 ignored issues – show introduced 2023-02-16 11:38 UTC by Report Bug Copy Issue Report The condition `$error` is always `false`. Loading history...
244			$data['id'] = $timeFrame->id;
245			$error = ! $this->saveAllowedOutboundRules($data);
246			}
247
248			if($error){
249			$this->view->success = false;
250			$this->db->rollback();
251			}else{
252			$this->flash->success($this->translation->_('ms_SuccessfulSaved'));
253			$this->view->success = true;
254			$this->db->commit();
255			}
256
257
258			// Если это было создание карточки то надо перегрузить страницу с указанием ID
259			if (empty($data['id'])) {
260			$this->view->reload = "out-off-work-time/modify/{$timeFrame->id}";
261			}
262			}
263
264			/**
265			* Сохраняет параметры маршрутов
266			*
267			* @param $data
268			*
269			* @return bool
270			*/
271			private function saveAllowedOutboundRules($data): bool
272			{
273			// 1. Удалим все старые ссылки на правила относящиеся к этой группе
274			$parameters = [
275			'conditions' => 'timeConditionId=:timeConditionId:',
276			'bind' => [
277			'timeConditionId' => $data['id'],
278			],
279			];
280			$oldRules = OutWorkTimesRouts::find($parameters);
281			if ($oldRules->delete() === false) {
282			$errors = $oldRules->getMessages();
283			$this->flash->error(implode('<br>', $errors));
284
285			return false;
286			}
287
288			// 2. Запишем разрешенные направления
289			foreach ($data as $key => $value) {
290			if (substr_count($key, 'rule-') > 0) {
291			$rule_id = explode('rule-', $key)[1];
292			if ($data[$key] === 'on') {
293			$newRule = new OutWorkTimesRouts();
294			$newRule->id = $rule_id;
			0 ignored issues – show Documentation Bug introduced 2023-02-16 11:38 UTC by Report Bug Copy Issue Report The property `$id` was declared of type `integer`, but `$rule_id` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
295			$newRule->timeConditionId = $data['id'];
296			$newRule->routId = $rule_id;
			0 ignored issues – show Documentation Bug introduced 2023-02-16 11:38 UTC by Report Bug Copy Issue Report The property `$routId` was declared of type `integer`, but `$rule_id` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
297			if ($newRule->save() === false) {
298			$errors = $newRule->getMessages();
299			$this->flash->error(implode('<br>', $errors));
300			return false;
301			}
302			}
303			}
304			}
305
306			return true;
307			}
308
309			/**
310			* Удаление запси с данными о нерабочем времени
311			*
312			* @param string $id
313			*/
314			public function deleteAction($id = '')
315			{
316			$timeFrame = OutWorkTimes::findFirstByid($id);
317			if ($timeFrame !== null) {
318			$timeFrame->delete();
319			}
320
321			$this->forward('OutOffWorkTime/index');
322			}
323
324
325			}
326

mikopbx / Core

Push — develop ( aa0db1...06f5e3 )

OutOffWorkTimeController::modifyAction() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like