Header::getFirstPossibleSessionTimeout() - Code Metrics - Inspection of "Merge pull request #2914 from wouterverstuyf/maste..." - forkcms/forkcms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( caa24b...5f12a0 )

by jelmer

created 2019-10-03 13:48 UTC

Header::getFirstPossibleSessionTimeout() A

↳ Parent: Header

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	2
nop	0
dl	0
loc	10
ccs	0
cts	8
cp	0
crap	12
rs	10
c	0
b	0
f	0

<?php

namespace Backend\Core\Engine;

use Common\Core\Header\Asset;
use Common\Core\Header\AssetCollection;
use Common\Core\Header\JsData;
use Common\Core\Header\Minifier;
use Common\Core\Header\Priority;
use ForkCMS\App\KernelLoader;
use Symfony\Component\HttpKernel\KernelInterface;
use Backend\Core\Language\Language as BL;

/**
 * This class will be used to alter the head-part of the HTML-document that will be created by he Backend
 * Therefore it will handle meta-stuff (title, including JS, including CSS, ...)
 */
final class Header extends KernelLoader
{
    /**
     * The added css-files
     *
     * @var AssetCollection
     */
    private $cssFiles;

    /**
     * Data that will be passed to js
     *
     * @var JsData
     */
    private $jsData;

    /**
     * The added js-files
     *
     * @var AssetCollection
     */
    private $jsFiles;

    /**
     * Template instance
     *
     * @var TwigTemplate
     */
    private $template;

    /**
     * URL-instance
     *
     * @var Url
     */
    private $url;

    public function __construct(KernelInterface $kernel)
    {
        parent::__construct($kernel);

        $container = $this->getContainer();
        $container->set('header', $this);

        $this->url = $container->get('url');
        $this->template = $container->get('template');

        $this->cssFiles = new AssetCollection(
            Minifier::css(
                $container->getParameter('site.path_www'),
                BACKEND_CACHE_URL . '/MinifiedCss/',
                BACKEND_CACHE_PATH . '/MinifiedCss/'
            )
        );
        $this->jsFiles = new AssetCollection(
            Minifier::js(
                $container->getParameter('site.path_www'),
                BACKEND_CACHE_URL . '/MinifiedJs/',
                BACKEND_CACHE_PATH . '/MinifiedJs/'
            )
        );
        $this->jsData = new JsData(
            [
                'interface_language' => $this->getInterfaceLanguage(),
                'debug' => $this->getContainer()->getParameter('kernel.debug'),
            ]
        );

        $this->addCoreJs();
        $this->addCoreCss();
    }

    private function addCoreJs(): void
    {
        $this->addJS('/js/vendors/jquery.min.js', 'Core', false, true, true, Priority::core());
        $this->addJS('/js/vendors/jquery-migrate.min.js', 'Core', false, true, true, Priority::core());
        $this->addJS('/js/vendors/jquery-ui.min.js', 'Core', false, true, true, Priority::core());
        $this->addJS('/js/vendors/bootstrap.min.js', 'Core', false, true, true, Priority::core());
        $this->addJS('/js/vendors/typeahead.bundle.min.js', 'Core', false, true, true, Priority::core());
        $this->addJS('/js/vendors/bootstrap-tagsinput.min.js', 'Core', false, true, true, Priority::core());
        $this->addJS('jquery/jquery.backend.js', 'Core', true, false, true, Priority::core());
        $this->addJS('utils.js', 'Core', true, false, true, Priority::core());
        $this->addJS('backend.js', 'Core', true, false, true, Priority::core());
    }

    private function addCoreCss(): void
    {
        $this->addCSS('/css/vendors/bootstrap-tagsinput.css', 'Core', true, true, true, Priority::core());
        $this->addCSS('/css/vendors/bootstrap-tagsinput-typeahead.css', 'Core', true, true, true, Priority::core());
        $this->addCSS('/css/vendors/bootstrap-accessibility.css', 'Core', true, true, true, Priority::core());
        $this->addCSS('screen.css', 'Core', false, true, true, Priority::core());
        $this->addCSS('debug.css', 'Core', false, true, true, Priority::debug());
    }

    private function buildPathForModule(string $fileName, string $module, string $subDirectory): string
    {
        if ($module === 'Core') {
            return '/src/Backend/Core/' . $subDirectory . '/' . $fileName;
        }

        return '/src/Backend/Modules/' . $module . '/' . $subDirectory . '/' . $fileName;
    }

    /**
     * Add a CSS-file.
     *
     * If you don't specify a module, the current one will be used to automatically create the path to the file.
     * Automatic creation of the filename will result in
     *   src/Backend/Modules/MODULE/Layout/Css/FILE (for modules)
     *   src/Backend/Core/Layout/Css/FILE (for core)
     *
     * If you set overwritePath to true, the above-described automatic path creation will not happen, instead the
     * file-parameter will be used as path; which we then expect to be a full path (It has to start with a slash '/')
     *
     * @param string $file The name of the file to load.
     * @param string $module The module wherein the file is located.
     * @param bool $overwritePath Should we overwrite the full path?
     *                            An external url will always be handled with $overwritePath as true.
     * @param bool $minify Should the CSS be minified?
     * @param bool $addTimestamp May we add a timestamp for caching purposes?
     * @param Priority $priority the files are added based on the priority
     *                           defaults to standard for full links or core or module for core or module css
     */
    public function addCSS(
        string $file,
        string $module = null,
        bool $overwritePath = false,
        bool $minify = true,
        bool $addTimestamp = false,
        Priority $priority = null
    ): void {
        $module = $module ?? $this->url->getModule();
        $isExternalUrl = $this->get('fork.validator.url')->isExternalUrl($file);
        $overwritePath = $overwritePath || $isExternalUrl; // external urls always overwrite the path
        $minify = $minify && !$isExternalUrl;

        $this->cssFiles->add(
            new Asset(
                $overwritePath ? $file : $this->buildPathForModule($file, $module, 'Layout/Css'),
                $addTimestamp,
                $priority ?? ($overwritePath ? Priority::standard() : Priority::forModule($module))
            ),
            $minify
        );
    }

    /**
     * Add a JS-file.
     * If you don't specify a module, the current one will be used
     * If you set overwritePath to true we expect a full path (It has to start with a /)
     *
     * @param string $file The file to load.
     * @param string $module The module wherein the file is located.
     * @param bool $minify Should the javascript be minified?
     * @param bool $overwritePath Should we overwrite the full path?
     *                            An external url will always be handled with $overwritePath as true.
     * @param bool $addTimestamp May we add a timestamp for caching purposes?
     * @param Priority $priority the files are added based on the priority
     *                           defaults to standard for full links or core or module for core or module css
     */
    public function addJS(
        string $file,
        string $module = null,
        bool $minify = true,
        bool $overwritePath = false,
        bool $addTimestamp = false,
        Priority $priority = null
    ): void {
        $module = $module ?? $this->url->getModule();
        $isExternalUrl = $this->get('fork.validator.url')->isExternalUrl($file);
        $overwritePath = $overwritePath || $isExternalUrl; // external urls always overwrite the path
        $minify = $minify && !$isExternalUrl;

        $this->jsFiles->add(
            new Asset(
                $overwritePath ? $file : $this->buildPathForModule($file, $module ?? $this->url->getModule(), 'Js'),
                $addTimestamp,
                $priority ?? ($overwritePath ? Priority::standard() : Priority::forModule($module))
            ),
            $minify
        );
    }

    /**
     * Add data into the jsData
     *
     * @param string $module The name of the module.
     * @param string $key The key under which the value will be stored.
     * @param mixed $value The value
     */
    public function addJsData(string $module, string $key, $value): void
    {
        $this->jsData->add($module, $key, $value);
    }

    /**
     * Parse the header into the template
     */
    public function parse(): void
    {
        $this->template->assign('page_title', BL::getLabel($this->url->getModule()));
        $this->cssFiles->parse($this->template, 'cssFiles');
        $this->jsFiles->parse($this->template, 'jsFiles');

        $this->jsData->add('site', 'domain', SITE_DOMAIN);
        $this->jsData->add('editor', 'language', $this->getCKEditorLanguage());
        $this->jsData->add('Core', 'session_timeout', $this->getFirstPossibleSessionTimeout());

        if (!empty($this->get('fork.settings')->get('Core', 'theme'))) {
            $this->jsData->add('theme', 'theme', $this->get('fork.settings')->get('Core', 'theme'));
            $themePath = FRONTEND_PATH . '/Themes/' . $this->get('fork.settings')->get('Core', 'theme');
            $this->jsData->add('theme', 'path', $themePath);
            $this->jsData->add('theme', 'has_css', is_file($themePath . '/Core/Layout/Css/screen.css'));
            $this->jsData->add('theme', 'has_editor_css', is_file($themePath . '/Core/Layout/Css/editor_content.css'));
        }
        $this->template->assign('jsData', $this->jsData);
    }

    private function getFirstPossibleSessionTimeout(): int
    {
        $garbageCollectionMaxLifeTime = (int) ini_get('session.gc_maxlifetime');
        $cookieLifetime = (int) ini_get('session.cookie_lifetime');

        if ($cookieLifetime === 0 || $cookieLifetime < $garbageCollectionMaxLifeTime) {
            return $garbageCollectionMaxLifeTime;
        }

        return $cookieLifetime;
    }

    /**
     * @return string
     */
    private function getInterfaceLanguage(): string
    {
        if (Authentication::getUser()->isAuthenticated()) {
            return (string) Authentication::getUser()->getSetting('interface_language');
        }

        return BL::getInterfaceLanguage();
    }

    /**
     * @return string
     */
    private function getCKEditorLanguage(): string
    {
        $language = $this->getInterfaceLanguage();

        // CKeditor has support for simplified Chinese, but the language is called zh-cn instead of zn
        if ($language === 'zh') {
            return 'zh-cn';
        }

        return $language;
    }

    public function appendDetailToBreadcrumbs(string $stringToAppend): void
    {
        $this->template->assignGlobal('breadcrumbDetail', $stringToAppend);
    }
}


1			<?php
2
3			namespace Backend\Core\Engine;
4
5			use Common\Core\Header\Asset;
6			use Common\Core\Header\AssetCollection;
7			use Common\Core\Header\JsData;
8			use Common\Core\Header\Minifier;
9			use Common\Core\Header\Priority;
10			use ForkCMS\App\KernelLoader;
11			use Symfony\Component\HttpKernel\KernelInterface;
12			use Backend\Core\Language\Language as BL;
13
14			/**
15			* This class will be used to alter the head-part of the HTML-document that will be created by he Backend
16			* Therefore it will handle meta-stuff (title, including JS, including CSS, ...)
17			*/
18			final class Header extends KernelLoader
19			{
20			/**
21			* The added css-files
22			*
23			* @var AssetCollection
24			*/
25			private $cssFiles;
26
27			/**
28			* Data that will be passed to js
29			*
30			* @var JsData
31			*/
32			private $jsData;
33
34			/**
35			* The added js-files
36			*
37			* @var AssetCollection
38			*/
39			private $jsFiles;
40
41			/**
42			* Template instance
43			*
44			* @var TwigTemplate
45			*/
46			private $template;
47
48			/**
49			* URL-instance
50			*
51			* @var Url
52			*/
53			private $url;
54
55			public function __construct(KernelInterface $kernel)
56			{
57			parent::__construct($kernel);
58
59			$container = $this->getContainer();
60			$container->set('header', $this);
61
62			$this->url = $container->get('url');
63			$this->template = $container->get('template');
64
65			$this->cssFiles = new AssetCollection(
66			Minifier::css(
67			$container->getParameter('site.path_www'),
68			BACKEND_CACHE_URL . '/MinifiedCss/',
69			BACKEND_CACHE_PATH . '/MinifiedCss/'
70			)
71			);
72			$this->jsFiles = new AssetCollection(
73			Minifier::js(
74			$container->getParameter('site.path_www'),
75			BACKEND_CACHE_URL . '/MinifiedJs/',
76			BACKEND_CACHE_PATH . '/MinifiedJs/'
77			)
78			);
79			$this->jsData = new JsData(
80			[
81			'interface_language' => $this->getInterfaceLanguage(),
82			'debug' => $this->getContainer()->getParameter('kernel.debug'),
83			]
84			);
85
86			$this->addCoreJs();
87			$this->addCoreCss();
88			}
89
90			private function addCoreJs(): void
91			{
92			$this->addJS('/js/vendors/jquery.min.js', 'Core', false, true, true, Priority::core());
93			$this->addJS('/js/vendors/jquery-migrate.min.js', 'Core', false, true, true, Priority::core());
94			$this->addJS('/js/vendors/jquery-ui.min.js', 'Core', false, true, true, Priority::core());
95			$this->addJS('/js/vendors/bootstrap.min.js', 'Core', false, true, true, Priority::core());
96			$this->addJS('/js/vendors/typeahead.bundle.min.js', 'Core', false, true, true, Priority::core());
97			$this->addJS('/js/vendors/bootstrap-tagsinput.min.js', 'Core', false, true, true, Priority::core());
98			$this->addJS('jquery/jquery.backend.js', 'Core', true, false, true, Priority::core());
99			$this->addJS('utils.js', 'Core', true, false, true, Priority::core());
100			$this->addJS('backend.js', 'Core', true, false, true, Priority::core());
101			}
102
103			private function addCoreCss(): void
104			{
105			$this->addCSS('/css/vendors/bootstrap-tagsinput.css', 'Core', true, true, true, Priority::core());
106			$this->addCSS('/css/vendors/bootstrap-tagsinput-typeahead.css', 'Core', true, true, true, Priority::core());
107			$this->addCSS('/css/vendors/bootstrap-accessibility.css', 'Core', true, true, true, Priority::core());
108			$this->addCSS('screen.css', 'Core', false, true, true, Priority::core());
109			$this->addCSS('debug.css', 'Core', false, true, true, Priority::debug());
110			}
111
112			private function buildPathForModule(string $fileName, string $module, string $subDirectory): string
113			{
114			if ($module === 'Core') {
115			return '/src/Backend/Core/' . $subDirectory . '/' . $fileName;
116			}
117
118			return '/src/Backend/Modules/' . $module . '/' . $subDirectory . '/' . $fileName;
119			}
120
121			/**
122			* Add a CSS-file.
123			*
124			* If you don't specify a module, the current one will be used to automatically create the path to the file.
125			* Automatic creation of the filename will result in
126			* src/Backend/Modules/MODULE/Layout/Css/FILE (for modules)
127			* src/Backend/Core/Layout/Css/FILE (for core)
128			*
129			* If you set overwritePath to true, the above-described automatic path creation will not happen, instead the
130			* file-parameter will be used as path; which we then expect to be a full path (It has to start with a slash '/')
131			*
132			* @param string $file The name of the file to load.
133			* @param string $module The module wherein the file is located.
134			* @param bool $overwritePath Should we overwrite the full path?
135			* An external url will always be handled with $overwritePath as true.
136			* @param bool $minify Should the CSS be minified?
137			* @param bool $addTimestamp May we add a timestamp for caching purposes?
138			* @param Priority $priority the files are added based on the priority
139			* defaults to standard for full links or core or module for core or module css
140			*/
141			public function addCSS(
142			string $file,
143			string $module = null,
144			bool $overwritePath = false,
145			bool $minify = true,
146			bool $addTimestamp = false,
147			Priority $priority = null
148			): void {
149			$module = $module ?? $this->url->getModule();
150			$isExternalUrl = $this->get('fork.validator.url')->isExternalUrl($file);
151			$overwritePath = $overwritePath \|\| $isExternalUrl; // external urls always overwrite the path
152			$minify = $minify && !$isExternalUrl;
153
154			$this->cssFiles->add(
155			new Asset(
156			$overwritePath ? $file : $this->buildPathForModule($file, $module, 'Layout/Css'),
157			$addTimestamp,
158			$priority ?? ($overwritePath ? Priority::standard() : Priority::forModule($module))
159			),
160			$minify
161			);
162			}
163
164			/**
165			* Add a JS-file.
166			* If you don't specify a module, the current one will be used
167			* If you set overwritePath to true we expect a full path (It has to start with a /)
168			*
169			* @param string $file The file to load.
170			* @param string $module The module wherein the file is located.
171			* @param bool $minify Should the javascript be minified?
172			* @param bool $overwritePath Should we overwrite the full path?
173			* An external url will always be handled with $overwritePath as true.
174			* @param bool $addTimestamp May we add a timestamp for caching purposes?
175			* @param Priority $priority the files are added based on the priority
176			* defaults to standard for full links or core or module for core or module css
177			*/
178			public function addJS(
179			string $file,
180			string $module = null,
181			bool $minify = true,
182			bool $overwritePath = false,
183			bool $addTimestamp = false,
184			Priority $priority = null
185			): void {
186			$module = $module ?? $this->url->getModule();
187			$isExternalUrl = $this->get('fork.validator.url')->isExternalUrl($file);
188			$overwritePath = $overwritePath \|\| $isExternalUrl; // external urls always overwrite the path
189			$minify = $minify && !$isExternalUrl;
190
191			$this->jsFiles->add(
192			new Asset(
193			$overwritePath ? $file : $this->buildPathForModule($file, $module ?? $this->url->getModule(), 'Js'),
194			$addTimestamp,
195			$priority ?? ($overwritePath ? Priority::standard() : Priority::forModule($module))
196			),
197			$minify
198			);
199			}
200
201			/**
202			* Add data into the jsData
203			*
204			* @param string $module The name of the module.
205			* @param string $key The key under which the value will be stored.
206			* @param mixed $value The value
207			*/
208			public function addJsData(string $module, string $key, $value): void
209			{
210			$this->jsData->add($module, $key, $value);
211			}
212
213			/**
214			* Parse the header into the template
215			*/
216			public function parse(): void
217			{
218			$this->template->assign('page_title', BL::getLabel($this->url->getModule()));
219			$this->cssFiles->parse($this->template, 'cssFiles');
220			$this->jsFiles->parse($this->template, 'jsFiles');
221
222			$this->jsData->add('site', 'domain', SITE_DOMAIN);
223			$this->jsData->add('editor', 'language', $this->getCKEditorLanguage());
224			$this->jsData->add('Core', 'session_timeout', $this->getFirstPossibleSessionTimeout());
225
226			if (!empty($this->get('fork.settings')->get('Core', 'theme'))) {
227			$this->jsData->add('theme', 'theme', $this->get('fork.settings')->get('Core', 'theme'));
228			$themePath = FRONTEND_PATH . '/Themes/' . $this->get('fork.settings')->get('Core', 'theme');
229			$this->jsData->add('theme', 'path', $themePath);
230			$this->jsData->add('theme', 'has_css', is_file($themePath . '/Core/Layout/Css/screen.css'));
231			$this->jsData->add('theme', 'has_editor_css', is_file($themePath . '/Core/Layout/Css/editor_content.css'));
232			}
233			$this->template->assign('jsData', $this->jsData);
234			}
235
236			private function getFirstPossibleSessionTimeout(): int
237			{
238			$garbageCollectionMaxLifeTime = (int) ini_get('session.gc_maxlifetime');
239			$cookieLifetime = (int) ini_get('session.cookie_lifetime');
240
241			if ($cookieLifetime === 0 \|\| $cookieLifetime < $garbageCollectionMaxLifeTime) {
242			return $garbageCollectionMaxLifeTime;
243			}
244
245			return $cookieLifetime;
246			}
247
248			/**
249			* @return string
250			*/
251			private function getInterfaceLanguage(): string
252			{
253			if (Authentication::getUser()->isAuthenticated()) {
254			return (string) Authentication::getUser()->getSetting('interface_language');
255			}
256
257			return BL::getInterfaceLanguage();
258			}
259
260			/**
261			* @return string
262			*/
263			private function getCKEditorLanguage(): string
264			{
265			$language = $this->getInterfaceLanguage();
266
267			// CKeditor has support for simplified Chinese, but the language is called zh-cn instead of zn
268			if ($language === 'zh') {
269			return 'zh-cn';
270			}
271
272			return $language;
273			}
274
275			public function appendDetailToBreadcrumbs(string $stringToAppend): void
276			{
277			$this->template->assignGlobal('breadcrumbDetail', $stringToAppend);
278			}
279			}
280

forkcms / forkcms

Push — master ( caa24b...5f12a0 )

Header::getFirstPossibleSessionTimeout() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like