BaseController::beforeExecuteRoute() - Code Metrics - Inspection of "Мелкие правки описания" - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 90372d...e80252 )

by Nikolay
created 2020-10-01 16:17 UTC
BaseController::beforeExecuteRoute() A

↳ Parent: BaseController
Complexity

Conditions	3
Paths	3
Size

Total Lines	5
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	4
dl	0
loc	5
c	0
b	0
f	0
rs	10
cc	3
nc	3
nop	0
<?php
/**
 * Copyright (C) MIKO LLC - All Rights Reserved
 * Unauthorized copying of this file, via any medium is strictly prohibited
 * Proprietary and confidential
 * Written by Nikolay Beketov, 6 2018
 *
 */

use Models\PbxExtensionModules;
use Phalcon\Mvc\Controller;
use Phalcon\Mvc\Dispatcher;
use Phalcon\Mvc\View;
use Phalcon\Text;

class BaseController extends Controller {

    protected $di;
    protected $actionName;
    protected $controllerName;
    protected $controllerNameUnCamelized;


    /**
     * Инициализация базововго класса
     */
    public function initialize(){
        $this->di                    = $this->getDi();
        $this->actionName            = $this->dispatcher->getActionName();
        $this->controllerName        = Text::camelize($this->dispatcher->getControllerName(),'_');
        $this->controllerNameUnCamelized = Text::uncamelize( $this->controllerName  ,'-');

        $this->moduleName            = $this->dispatcher->getModuleName();


        if ( $this->request->isAjax() === FALSE ) {
            $this->prepareView( );
        }
    }


    /**
     * Инициализирует шаблонизатор View и устанавливает переменные системы для отображения
     */
    protected function prepareView() :void{
        date_default_timezone_set( $this->getSessionData('PBXTimezone') );
        $roSession  = $this->sessionRO;

        $this->view->PBXVersion = $this->getSessionData('PBXVersion');
        if ( $roSession !== null && array_key_exists('auth', $roSession)) {
            $this->view->SSHPort    = $this->getSessionData('SSHPort');
            $this->view->PBXLicense = $this->getSessionData('PBXLicense');
            $this->view->PBXLanguage= $this->getSessionData('PBXLanguage');
        } else {
            $this->view->SSHPort    = '';
            $this->view->PBXLicense = '';
            $this->view->PBXLanguage= '';
        }

        // Кеш версий модулей и атс, для правильной работы АТС при установке модулей
        $versionHash = $this->getVersionsHash();
        $this->session->set( 'versionHash', $versionHash);

        if ( $roSession !== null && array_key_exists('SubmitMode', $roSession)) {
            $this->view->submitMode = $roSession[ 'SubmitMode' ];
        } else {
            $this->view->submitMode = 'SaveSettings';
        }

        // Добавим версию модуля, если это модуль
        if ( $this->moduleName === 'PBXExtension' ) {
            $module = PbxExtensionModules::findFirstByUniqid( $this->controllerName );
            $module = PbxExtensionModules::findFirstByUniqid( $this->controllerName );
            if ( !$module ) {
                $module = new PbxExtensionModules();
                $module->disabled = '1';

                $module->name = 'Unknown module';
            }
            $this->view->module = $module;
        }

        // Разрешим отправку анонимной информации об ошибках
        if ($this->getSessionData('SendMetrics') === '1'){
            touch('/tmp/sendmetrics');
            $this->view->lastSentryEventId = Sentry\State\Hub::getCurrent()->getLastEventId();
        } else {
            if (file_exists('/tmp/sendmetrics')){
                unlink('/tmp/sendmetrics');
            }
            $this->view->lastSentryEventId = Null;
        }
        switch ( $this->actionName ) {
            case'index':
            case'delete':
            case'save':
            case'modify':
            case'*** WITHOUT ACTION ***':
                $this->tag->setTitle( $this->config->application->kind . ' | '

                    . $this->translation->_( 'Breadcrumb'
                    . $this->translation->/** @scrutinizer ignore-call */ _( 'Breadcrumb'
                        . $this->controllerName ) );
                break;
            default:
                $this->tag->setTitle( $this->config->application->kind . ' | '
                    . $this->translation->_( 'Breadcrumb'
                        . $this->controllerName
                        . $this->actionName ) );
        }

        $this->view->t = $this->translation;
        $this->view->debugMode = $this->config->application->debugMode;
        $this->view->urlToLogo = $this->url->get( 'public/img/logo-mikopbx.svg' );
        if ($this->language === 'ru'){

            $this->view->urlToWiki
                = "https://wiki.mikopbx.com/{$this->controllerNameUnCamelized}";
        } else {
            $this->view->urlToWiki
                = "https://wiki.mikopbx.com/{$this->language}:{$this->controllerNameUnCamelized}";
        }

        $this->view->urlToController = $this->url->get( $this->controllerNameUnCamelized );
        $this->view->represent       = '';
        $this->view->cacheName       = "{$this->controllerName}{$this->actionName}{$this->language}{$versionHash}";

        // Подключим нужный View
        if ( $this->moduleName  === 'PBXExtension' ) {
            $this->view->setTemplateAfter( 'modules' );
        } else {
            $this->view->setTemplateAfter( 'main' );
        }

        // Для модулей кинем в кеш все статические картинки
        if ( $this->moduleName  === 'PBXExtension' ) {
            $modulesDir = $this->getDI()->getModulesDir();
            $moduleImageDir = $modulesDir . $this->controllerName.'/public/img';
            $moduleImageCacheDir = $this->config->application->imgCacheDir.$this->controllerName;
            if (file_exists($moduleImageDir)
                && !file_exists($moduleImageCacheDir)){
                symlink ( $moduleImageDir, $moduleImageCacheDir );
            }
        }
    }

    /**
     * Постобработка запроса
     *
     * @param \Phalcon\Mvc\Dispatcher $dispatcher
     *
     * @return \Phalcon\Http\Response|\Phalcon\Http\ResponseInterface
     */
    public function afterExecuteRoute( Dispatcher $dispatcher ) {
    public function afterExecuteRoute( /** @scrutinizer ignore-unused */ Dispatcher $dispatcher ) {
        if ( $this->request->isAjax() === TRUE ) {
            $this->view->disableLevel( [
                         disableLevel( [
                View::LEVEL_ACTION_VIEW     => TRUE,
                View::LEVEL_LAYOUT          => TRUE,
                View::LEVEL_MAIN_LAYOUT     => TRUE,
                View::LEVEL_AFTER_TEMPLATE  => TRUE,
                View::LEVEL_BEFORE_TEMPLATE => TRUE,
            ] );
            $this->response->setContentType( 'application/json', 'UTF-8' );
            $data = $this->view->getParamsToView();

            /* Set global params if is not set in controller/action */
            if (is_array($data) && isset($data['raw_response'])){
                $result = $data['raw_response'];
            } elseif ( is_array( $data ) ) {
                $data['success'] = array_key_exists( 'success', $data ) ? $data['success'] : TRUE;
                $data['reload']  = array_key_exists( 'reload', $data ) ? $data['reload'] : FALSE;
                $data['message'] = $data['message'] ?? $this->flash->getMessages();
                $data['message'] = $data['message'] ?? $this->flash->/** @scrutinizer ignore-call */ getMessages();

                // Добавим информацию о последней ошибке для отображения диалогового окна для пользователя
                if (file_exists('/tmp/sendmetrics')) {
                    $data['lastSentryEventId'] = Sentry\State\Hub::getCurrent()->getLastEventId();
                }
                $result            = json_encode( $data );
            }

            $this->response->setContent( $result );

        }
        return $this->response->send();
    }

    /**
     * Перехват события перед обработкой в контроллере
     */
    public function beforeExecuteRoute() :void{
        if ($this->request->isPost()){
            $data = $this->request->getPost('submitMode');
            if (!empty($data)){
                $this->session->set('SubmitMode', $data);
            }
        }
    }

    /**
     * Перевод страниц без перезагрузки страниц
     *
     * @param string $uri
     */
    protected function forward( $uri ) {
        $uriParts = explode( '/', $uri );
        $params   = array_slice( $uriParts, 2 );

        return $this->dispatcher->forward(
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
            [
                'controller' => $uriParts[0],
                'action'     => $uriParts[1],
                'params'     => $params,
            ]

        );
    }

    /**
     * Транслитерация переданной строки
     *
     * @param $string
     *
     * @return string
     */
    protected function transliterate( $string ) :string{

        $converter = [
            'а' => 'a',
            'б' => 'b',
            'в' => 'v',
            'г' => 'g',
            'д' => 'd',
            'е' => 'e',
            'ё' => 'e',
            'ж' => 'zh',
            'з' => 'z',
            'и' => 'i',
            'й' => 'y',
            'к' => 'k',
            'л' => 'l',
            'м' => 'm',
            'н' => 'n',
            'о' => 'o',
            'п' => 'p',
            'р' => 'r',
            'с' => 's',
            'т' => 't',
            'у' => 'u',
            'ф' => 'f',
            'х' => 'h',
            'ц' => 'c',
            'ч' => 'ch',
            'ш' => 'sh',
            'щ' => 'sch',
            'ь' => 'i',
            'ы' => 'y',
            'ъ' => '',
            'э' => 'e',
            'ю' => 'yu',
            'я' => 'ya',

            'А' => 'A',
            'Б' => 'B',
            'В' => 'V',
            'Г' => 'G',
            'Д' => 'D',
            'Е' => 'E',
            'Ё' => 'E',
            'Ж' => 'Zh',
            'З' => 'Z',
            'И' => 'I',
            'Й' => 'Y',
            'К' => 'K',
            'Л' => 'L',
            'М' => 'M',
            'Н' => 'N',
            'О' => 'O',
            'П' => 'P',
            'Р' => 'R',
            'С' => 'S',
            'Т' => 'T',
            'У' => 'U',
            'Ф' => 'F',
            'Х' => 'H',
            'Ц' => 'C',
            'Ч' => 'Ch',
            'Ш' => 'Sh',
            'Щ' => 'Sch',
            'Ь' => 'I',
            'Ы' => 'Y',
            'Ъ' => ' ',
            'Э' => 'E',
            'Ю' => 'Yu',
            'Я' => 'Ya',
        ];

        return strtr( $string, $converter );

    }

    /**
     * Генерирует хеш из версий установленных модулей и АТС, для корректного склеивания JS, CSS и локализаций.
     *
     */
    private function getVersionsHash() :string{
        $result = Models\PbxSettings::getValueByKey( 'PBXVersion' );
        $modulesVersions = Models\PbxExtensionModules::find(['columns'=>'id,version']);
        foreach ($modulesVersions as $module) {
            $result.="{$module->version}{$module->version}";
        }
        return md5($result);
    }

    /**
     * Берет данные из сессии или из базы данных и записывает в кеш
     *
     * @param $key string параметры сессии
     *
     * @return string
     */
    protected function getSessionData($key) :string{
        $roSession  = $this->sessionRO;

        if ( $roSession !== null && array_key_exists($key, $roSession) && !empty($roSession[ $key ])) {
            $value = $roSession[ $key ];
        } else {
            $value = Models\PbxSettings::getValueByKey( $key ) ;
            $this->session->set( $key, $value);
        }
        return $value;
    }
}

mikopbx / Core

Push — master ( 90372d...e80252 )

BaseController::beforeExecuteRoute() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
