TemplateOutput::setUpSmarty() - Code Metrics - Inspection of "revert dependency upgrades; purely php8" - mdaniels5757/waca - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — php8 (#218)

by Michael

created 2024-08-19 21:15 UTC

TemplateOutput::setUpSmarty() A

↳ Parent: TemplateOutput

Complexity

Conditions	1
Paths	1

Size

Total Lines	51
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	38
c	3
b	0
f	0
dl	0
loc	51
rs	9.312
cc	1
nc	1
nop	0

How to fix Long Method

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 * ACC Development Team. Please see team.json for a list of contributors.     *
 *                                                                            *
 * This is free and unencumbered software released into the public domain.    *
 * Please see LICENSE.md for the full licencing statement.                    *
 ******************************************************************************/

namespace Waca\Fragments;

use Smarty;
use Waca\DataObjects\User;
use Waca\Environment;
use Waca\SiteConfiguration;

trait TemplateOutput
{
    /** @var Smarty */
    private $smarty;

    /**
     * @return SiteConfiguration
     */
    protected abstract function getSiteConfiguration();

    /**
     * Assigns a Smarty variable
     *
     * @param  array|string $name  the template variable name(s)
     * @param  mixed        $value the value to assign
     */
    final protected function assign($name, $value)
    {
        $this->smarty->assign($name, $value);
    }

    /**
     * Sets up the variables used by the main Smarty base template.
     *
     * This list is getting kinda long.
     */
    final protected function setUpSmarty()
    {
        $this->smarty = new Smarty\Smarty();
filter:
    dependency_paths: ["lib/*"]
        $this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
        $this->smarty->registerPlugin('modifier', 'implode', 'implode');

        $this->assign('currentUser', User::getCommunity());
        $this->assign('skin', 'auto');
        $this->assign('currentDomain', null);
        $this->assign('loggedIn', false);
        $this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
        $this->assign('resourceCacheEpoch', $this->getSiteConfiguration()->getResourceCacheEpoch());

        $this->assign('siteNoticeText', '');
        $this->assign('siteNoticeVersion', 0);
        $this->assign('siteNoticeState', 'd-none');
        $this->assign('toolversion', Environment::getToolVersion());

        // default these
        $this->assign('onlineusers', array());
        $this->assign('typeAheadBlock', '');
        $this->assign('extraJs', array());

        // nav menu access control
        $this->assign('nav__canRequests', false);
        $this->assign('nav__canLogs', false);
        $this->assign('nav__canUsers', false);
        $this->assign('nav__canSearch', false);
        $this->assign('nav__canStats', false);
        $this->assign('nav__canBan', false);
        $this->assign('nav__canEmailMgmt', false);
        $this->assign('nav__canWelcomeMgmt', false);
        $this->assign('nav__canSiteNoticeMgmt', false);
        $this->assign('nav__canUserMgmt', false);
        $this->assign('nav__canViewRequest', false);
        $this->assign('nav__canJobQueue', false);
        $this->assign('nav__canFlaggedComments', false);
        $this->assign('nav__canDomainMgmt', false);
        $this->assign('nav__canQueueMgmt', false);
        $this->assign('nav__canFormMgmt', false);
        $this->assign('nav__canErrorLog', false);

        // Navigation badges for concern areas.
        $this->assign("nav__numAdmin", 0);
        $this->assign("nav__numFlaggedComments", 0);
        $this->assign("nav__numJobQueueFailed", 0);

        // debug helpers
        $this->assign('showDebugCssBreakpoints', $this->getSiteConfiguration()->getDebuggingCssBreakpointsEnabled());

        $this->assign('page', $this);
    }

    /**
     * Fetches a rendered Smarty template
     *
     * @param $template string Template file path, relative to /templates/
     *
     * @return string Templated HTML
     */
    final protected function fetchTemplate($template)
    {
        return $this->smarty->fetch($template);
    }
}


1			<?php
2			/******************************************************************************
3			* Wikipedia Account Creation Assistance tool *
4			* ACC Development Team. Please see team.json for a list of contributors. *
5			* *
6			* This is free and unencumbered software released into the public domain. *
7			* Please see LICENSE.md for the full licencing statement. *
8			******************************************************************************/
9
10			namespace Waca\Fragments;
11
12			use Smarty;
13			use Waca\DataObjects\User;
14			use Waca\Environment;
15			use Waca\SiteConfiguration;
16
17			trait TemplateOutput
18			{
19			/** @var Smarty */
20			private $smarty;
21
22			/**
23			* @return SiteConfiguration
24			*/
25			protected abstract function getSiteConfiguration();
26
27			/**
28			* Assigns a Smarty variable
29			*
30			* @param array\|string $name the template variable name(s)
31			* @param mixed $value the value to assign
32			*/
33			final protected function assign($name, $value)
34			{
35			$this->smarty->assign($name, $value);
36			}
37
38			/**
39			* Sets up the variables used by the main Smarty base template.
40			*
41			* This list is getting kinda long.
42			*/
43			final protected function setUpSmarty()
44			{
45			$this->smarty = new Smarty\Smarty();
			0 ignored issues – show Bug introduced 2024-08-19 21:18 UTC by Report Bug Copy Issue Report The type `Smarty\Smarty` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
46			$this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
47			$this->smarty->registerPlugin('modifier', 'implode', 'implode');
48
49			$this->assign('currentUser', User::getCommunity());
50			$this->assign('skin', 'auto');
51			$this->assign('currentDomain', null);
52			$this->assign('loggedIn', false);
53			$this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
54			$this->assign('resourceCacheEpoch', $this->getSiteConfiguration()->getResourceCacheEpoch());
55
56			$this->assign('siteNoticeText', '');
57			$this->assign('siteNoticeVersion', 0);
58			$this->assign('siteNoticeState', 'd-none');
59			$this->assign('toolversion', Environment::getToolVersion());
60
61			// default these
62			$this->assign('onlineusers', array());
63			$this->assign('typeAheadBlock', '');
64			$this->assign('extraJs', array());
65
66			// nav menu access control
67			$this->assign('nav__canRequests', false);
68			$this->assign('nav__canLogs', false);
69			$this->assign('nav__canUsers', false);
70			$this->assign('nav__canSearch', false);
71			$this->assign('nav__canStats', false);
72			$this->assign('nav__canBan', false);
73			$this->assign('nav__canEmailMgmt', false);
74			$this->assign('nav__canWelcomeMgmt', false);
75			$this->assign('nav__canSiteNoticeMgmt', false);
76			$this->assign('nav__canUserMgmt', false);
77			$this->assign('nav__canViewRequest', false);
78			$this->assign('nav__canJobQueue', false);
79			$this->assign('nav__canFlaggedComments', false);
80			$this->assign('nav__canDomainMgmt', false);
81			$this->assign('nav__canQueueMgmt', false);
82			$this->assign('nav__canFormMgmt', false);
83			$this->assign('nav__canErrorLog', false);
84
85			// Navigation badges for concern areas.
86			$this->assign("nav__numAdmin", 0);
87			$this->assign("nav__numFlaggedComments", 0);
88			$this->assign("nav__numJobQueueFailed", 0);
89
90			// debug helpers
91			$this->assign('showDebugCssBreakpoints', $this->getSiteConfiguration()->getDebuggingCssBreakpointsEnabled());
92
93			$this->assign('page', $this);
94			}
95
96			/**
97			* Fetches a rendered Smarty template
98			*
99			* @param $template string Template file path, relative to /templates/
100			*
101			* @return string Templated HTML
102			*/
103			final protected function fetchTemplate($template)
104			{
105			return $this->smarty->fetch($template);
106			}
107			}
108

mdaniels5757 / waca

Pull Request — php8 (#218)

TemplateOutput::setUpSmarty() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like