JsDataHelper::getAppJs() - Code Metrics - Inspection of "Finish 5.2.0" - Schlaefer/Saito - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5b5792...2b84bd )

by Schlaefer

created 2019-07-11 13:13 UTC

JsDataHelper::getAppJs() A

↳ Parent: JsDataHelper

Complexity

Conditions	4
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	8
nop	2
dl	0
loc	53
rs	9.0254
c	0
b	0
f	0

How to fix Long Method

<?php
/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers 2015
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace App\View\Helper;

use App\Controller\Component\CurrentUserComponent;
use Cake\Core\Configure;
use Cake\Event\Event;
use Cake\View\Helper;
use Cake\View\View;
use Saito\JsData\JsData;
use Saito\User\ForumsUserInterface;

/**
 * Javascript Data Helper
 */
class JsDataHelper extends AppHelper
{

    public $helpers = ['Url'];

    /**
     * JsData
     *
     * @var JsData
     */
    protected $_JsData;

    /**
     * CakePHP beforeRender event-handler
     *
     * @param Event $event event
     * @param mixed $viewFile view file
     * @return void
     */
    public function beforeRender(Event $event, $viewFile): void

    {
        $View = $event->getSubject();
        $this->_JsData = $View->get('jsData');
    }

    /**
     * get app js
     *
     * @param View $View view
     * @param ForumsUserInterface $CurrentUser user
     * @return string
     */
    public function getAppJs(View $View, ForumsUserInterface $CurrentUser)
    {
        $settings = Configure::read('Saito.Settings');
        $request = $View->getRequest();

        $js = $this->_JsData->getJs();
        $js += [
            'app' => [
                'version' => Configure::read('Saito.v'),
                'settings' => [
                    'autoPageReload' => (isset($View->viewVars['autoPageReload']) ? $View->viewVars['autoPageReload'] : 0),

                    'editPeriod' => (int)Configure::read(
                        'Saito.Settings.edit_period'
                    ),
                    'language' => Configure::read('Saito.language'),
                    'notificationIcon' => $this->Url->assetUrl(
                        'html5-notification-icon.png',
                        [
                            'pathPrefix' => Configure::read('App.imageBaseUrl'),
                            'fullBase' => true
                        ]
                    ),
                    'quote_symbol' => $settings['quote_symbol'],
                    'subject_maxlength' => $settings['subject_maxlength'],
                    'theme' => $View->getTheme(),
                    'apiroot' => $request->getAttribute('webroot') . 'api/v2/',
                    'webroot' => $request->getAttribute('webroot')
                ]
            ],
            'request' => [
                'action' => $request->getParam('action'),
                'controller' => $request->getParam('controller'),
                'isMobile' => $request->isMobile(),
                'isPreview' => $request->isPreview(),
                'csrf' => $this->_getCsrf($View)
            ],
            'currentUser' => [
                'id' => (int)$CurrentUser->get('id'),
                'username' => $CurrentUser->get('username'),
                'user_show_inline' => $CurrentUser->get('inline_view_on_click') || false,
                'user_show_thread_collapsed' => $CurrentUser->get('user_show_thread_collapsed') || false
            ],
            'callbacks' => [
                'beforeAppInit' => [],
                'afterAppInit' => [],
                'afterViewInit' => []
            ]
        ];
        $out = 'var SaitoApp = ' . json_encode($js);
        $out .= '; SaitoApp.timeAppStart = new Date().getTime();';

        return $out;
    }

    /**
     * Get CSRF-config
     *
     * @param View $View View
     * @return array
     * - 'header' HTTP header for CSRF-token
     * - 'token' CSRF-token
     */
    protected function _getCsrf(View $View)
    {
        $key = 'csrfToken';
        $token = $View->getRequest()->getCookie($key);
        if (empty($token)) {
            $token = $View->getResponse()->getCookie($key)['value'];
        }
        $header = 'X-CSRF-Token';

        return compact('header', 'token');
    }

    /**
     * Passes method calls on to JsData
     *
     * {@inheritDoc}
     */
    public function __call($method, $params)

    {
        $proxy = [$this->_JsData, $method];
        if (is_callable($proxy)) {
            return call_user_func_array($proxy, $params);
        }

        parent::__call($method, $params);
    }
}


1		<?php
2		/**
3		* Saito - The Threaded Web Forum
4		*
5		* @copyright Copyright (c) the Saito Project Developers 2015
6		* @link https://github.com/Schlaefer/Saito
7		* @license http://opensource.org/licenses/MIT
8		*/
9
10		namespace App\View\Helper;
11
12		use App\Controller\Component\CurrentUserComponent;
13		use Cake\Core\Configure;
14		use Cake\Event\Event;
15		use Cake\View\Helper;
16		use Cake\View\View;
17		use Saito\JsData\JsData;
18		use Saito\User\ForumsUserInterface;
19
20		/**
21		* Javascript Data Helper
22		*/
23		class JsDataHelper extends AppHelper
24		{
25
26		public $helpers = ['Url'];
27
28		/**
29		* JsData
30		*
31		* @var JsData
32		*/
33		protected $_JsData;
34
35		/**
36		* CakePHP beforeRender event-handler
37		*
38		* @param Event $event event
39		* @param mixed $viewFile view file
40		* @return void
41		*/
42		public function beforeRender(Event $event, $viewFile): void
		0 ignored issues – show Unused Code introduced 2019-05-16 13:57 UTC by Report Bug Copy Issue Report The parameter `$viewFile` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
43		{
44		$View = $event->getSubject();
45		$this->_JsData = $View->get('jsData');
46		}
47
48		/**
49		* get app js
50		*
51		* @param View $View view
52		* @param ForumsUserInterface $CurrentUser user
53		* @return string
54		*/
55		public function getAppJs(View $View, ForumsUserInterface $CurrentUser)
56		{
57		$settings = Configure::read('Saito.Settings');
58		$request = $View->getRequest();
59
60		$js = $this->_JsData->getJs();
61		$js += [
62		'app' => [
63		'version' => Configure::read('Saito.v'),
64		'settings' => [
65		'autoPageReload' => (isset($View->viewVars['autoPageReload']) ? $View->viewVars['autoPageReload'] : 0),
		0 ignored issues – show Deprecated Code introduced 2019-06-02 09:43 UTC by Report Bug Copy Issue Report The property `Cake\View\ViewVarsTrait::$viewVars` has been deprecated with message: 3.7.0 Use `$this->set()` instead, also see `$this->viewBuilder()->getVar()`. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
66		'editPeriod' => (int)Configure::read(
67		'Saito.Settings.edit_period'
68		),
69		'language' => Configure::read('Saito.language'),
70		'notificationIcon' => $this->Url->assetUrl(
71		'html5-notification-icon.png',
72		[
73		'pathPrefix' => Configure::read('App.imageBaseUrl'),
74		'fullBase' => true
75		]
76		),
77		'quote_symbol' => $settings['quote_symbol'],
78		'subject_maxlength' => $settings['subject_maxlength'],
79		'theme' => $View->getTheme(),
80		'apiroot' => $request->getAttribute('webroot') . 'api/v2/',
81		'webroot' => $request->getAttribute('webroot')
82		]
83		],
84		'request' => [
85		'action' => $request->getParam('action'),
86		'controller' => $request->getParam('controller'),
87		'isMobile' => $request->isMobile(),
88		'isPreview' => $request->isPreview(),
89		'csrf' => $this->_getCsrf($View)
90		],
91		'currentUser' => [
92		'id' => (int)$CurrentUser->get('id'),
93		'username' => $CurrentUser->get('username'),
94		'user_show_inline' => $CurrentUser->get('inline_view_on_click') \|\| false,
95		'user_show_thread_collapsed' => $CurrentUser->get('user_show_thread_collapsed') \|\| false
96		],
97		'callbacks' => [
98		'beforeAppInit' => [],
99		'afterAppInit' => [],
100		'afterViewInit' => []
101		]
102		];
103		$out = 'var SaitoApp = ' . json_encode($js);
104		$out .= '; SaitoApp.timeAppStart = new Date().getTime();';
105
106		return $out;
107		}
108
109		/**
110		* Get CSRF-config
111		*
112		* @param View $View View
113		* @return array
114		* - 'header' HTTP header for CSRF-token
115		* - 'token' CSRF-token
116		*/
117		protected function _getCsrf(View $View)
118		{
119		$key = 'csrfToken';
120		$token = $View->getRequest()->getCookie($key);
121		if (empty($token)) {
122		$token = $View->getResponse()->getCookie($key)['value'];
123		}
124		$header = 'X-CSRF-Token';
125
126		return compact('header', 'token');
127		}
128
129		/**
130		* Passes method calls on to JsData
131		*
132		* {@inheritDoc}
133		*/
134	View Code Duplication	public function __call($method, $params)
		0 ignored issues – show Duplication introduced 2019-06-15 08:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
135		{
136		$proxy = [$this->_JsData, $method];
137		if (is_callable($proxy)) {
138		return call_user_func_array($proxy, $params);
139		}
140
141		parent::__call($method, $params);
142		}
143		}
144

Schlaefer / Saito

Push — master ( 5b5792...2b84bd )

JsDataHelper::getAppJs() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like