TwigExtensions::extendForWidget() - Code Metrics - Inspection of "translation function removed to favor define trans..." - selamiphp/views - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a66c1...7a18b6 )

by Mehmet

created 2017-07-02 09:48 UTC

TwigExtensions::extendForWidget() B

↳ Parent: TwigExtensions

Complexity

Conditions	4
Paths	1

Size

Total Lines	39
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	39
ccs	0
cts	37
cp	0
rs	8.5806
cc	4
eloc	30
nc	1
nop	0
crap	20

<?php
declare(strict_types = 1);

namespace Selami\View\Twig;

use Selami\View\ExtensionsAbstract;
use Twig_Environment;
use Camel\CaseTransformer;
use Camel\Format;
use InvalidArgumentException;
use BadMethodCallException;

/**
 * Class TwigExtensions extends ViewExtensionsAbstracts
 *
 * @package Selami\View\Twig
 */
class TwigExtensions extends ExtensionsAbstract
{
    private $twig;
    private $config;
    private $toCamelCase;
    private $toSnakeCase;

    public function __construct(Twig_Environment $twig, array $config)
    {
        $this->twig = $twig;
        $this->config = $config;
        $this->toCamelCase = new CaseTransformer(new Format\SnakeCase, new Format\StudlyCaps);
        $this->toSnakeCase = new CaseTransformer(new Format\CamelCase, new Format\SnakeCase);
        $this->loadExtensions();
        $this->loadFunctions();
    }

    protected function loadExtensions() : void
    {
        $this->twig->addExtension(new \Twig_Extensions_Extension_Date());
        $this->twig->addExtension(new \Twig_Extensions_Extension_Intl());
        $this->twig->addExtension(new \Twig_Extensions_Extension_Text());
        $this->twig->addExtension(new \Twig_Extensions_Extension_I18n());
    }

    /**
     * Build translate array.
     *
     * @param  $translateArray
     * @return array
     */
    private function buildTranslateArray(array $translateArray) : array

    {
        $tmpArray = [];
        foreach ($translateArray as $key => $value) {
            $tmpArray['@'.$key] = $value;
        }
        return $tmpArray;
    }

    protected function extendForGetUrl() : void
    {
        $filter = new \Twig_SimpleFunction(
            'getUrl',
            function (
                $alias,
                $params = []
            ) {
                if (array_key_exists($alias, $this->config['aliases'])) {
                    $data = $this->config['aliases'][$alias];
                    $relative_path = $data;
                    foreach ($params as $param => $value) {
                        if (strpos($param, ':') === strlen($param)-1) {
                            $relative_path = preg_replace('/{'.$param.'(.*?)}/msi', $value, $relative_path);
                        } else {
                            $relative_path = str_replace('{'.$param.'}', $value, $relative_path);
                        }
                    }
                    return $this->config['base_url'] . '/' . $relative_path;
                }
                return '';
            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
    }

    protected function extendForWidget() : void
    {
        $filter = new \Twig_SimpleFunction(
            'Widget_*_*',
            function ($widgetNameStr, $widgetActionStr, $args = []) {
                $widgetAction = $this->toCamelCase->transform($widgetActionStr);
                $widgetName = $this->toCamelCase->transform($widgetNameStr);
                $widget = '\\' . $this->config['app_namespace'] . '\\Widget\\' . $widgetName;
                if (!class_exists($widget)) {
                    $message = 'Widget ' . $widgetName . '_' . $widgetAction . ' has not class name as ' . $widget;
                    throw new BadMethodCallException($message);
                }
                $widgetInstance = new $widget($args);
                if (!method_exists($widgetInstance, $widgetAction)) {
                    $message = 'Widget ' . $widget . ' has not method name as ' . $widgetAction;
                    throw new BadMethodCallException($message);
                }
                $templateFileBasename = $args['template'] ?? $this->toSnakeCase->transform($widgetActionStr) . '.twig';
                $templateFullPath = $this->config['templates_dir'] . '/_widgets/'
                    . $this->toSnakeCase->transform($widgetNameStr) . '/' . $templateFileBasename;

                if (!file_exists($templateFullPath)) {
                    $message = sprintf(
                        '%s  template file not found! %s needs a main template file at: %s',
                        $templateFileBasename,
                        $widgetNameStr . '_' . $widgetActionStr,
                        $templateFullPath
                    );
                    throw new InvalidArgumentException($message);
                }
                $templateFile =  '_widgets/'
                    . $this->toSnakeCase->transform($widgetNameStr) . '/' . $templateFileBasename;
                $widgetData = $widgetInstance->{$widgetAction}();
                return $this->twig->render($templateFile, $widgetData);
            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
    }

    protected function extendForQueryParams() : void

    {
        $filter = new \Twig_SimpleFunction(
            'queryParams',
            function ($queryParams, $prefix = '?') {
                return $prefix . http_build_query($queryParams);
            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
    }

    protected function extendForSiteUrl() : void

    {
        $filter = new \Twig_SimpleFunction(
            'siteUrl',
            function ($path = '') {
                return $this->config['base_url'] . $path;
            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
    }

    protected function extendForVarDump() : void
    {
        $filter = new \Twig_SimpleFunction(
            'varDump',
            function ($args) {
                /**
            * @noinspection ForgottenDebugOutputInspection 
            */
                var_dump($args);

            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
    }

    protected function extendForPagination() : void
    {
        /**
 * @noinspection MoreThanThreeArgumentsInspection 
*/
        $filter = new \Twig_SimpleFunction(
            'Pagination',
            function (
                int $total,
                int $current,
                string $linkTemplate,
                string $parentTemplate = '<ul class="pagination">(items)</ul>',
                string $itemTemplate = '<li class="(item_class)">(link)</li>',
                string $linkItemTemplate = '<a href="(href)" class="(link_class)">(text)</a>',
                string $ellipsesTemplate = '<li><a>...</a></li>'
            ) {
                $items =  '';
                $pageGroupLimit = 3;
                $useEllipses = ($total >10) ? 1 : 0;
                $renderedEllipses = 0;
                $values = [
                    '(item_class)'  => '',
                    '(href)'        => '',
                    '(link_class)'  => '',
                    '(text)'  => ''
                ];
                for ($i=1; $i <= $total; $i++) {
                    $values['(link_class)'] = '';
                    $values['(item_class)'] = '';
                    if ($i === $current) {
                        $values['(link_class)'] = 'active';
                        $values['(item_class)'] = 'active';
                    }
                    $values['(text)'] = $i;
                    $values['(href)'] = str_replace('(page_num)', $i, $linkTemplate);
                    $link = strtr($linkItemTemplate, $values);
                    $useLink = 1;
                    if ($useEllipses === 1) {
                        $useLink = 0;
                        if (($i <= $pageGroupLimit)
                            ||  ($i >= ($current-1) && $i <= ($current+1))
                            || ($i >= ($total-2))
                        ) {
                            $useLink = 1;
                            $renderedEllipses = 0;
                        } else {
                            if ($renderedEllipses === 0) {
                                $items .= $ellipsesTemplate;
                            }
                            $renderedEllipses = 1;
                        }
                    }
                    if ($useLink === 1) {
                        $thisItemTemplate = str_replace(
                            array('(link)'),
                            array($link),
                            $itemTemplate
                        );
                        $items .= strtr($thisItemTemplate, $values);
                    }
                }
                return str_replace('(items)', $items, $parentTemplate);
            },
            array('is_safe' => array('html'))
        );
        $this->twig->addFunction($filter);
    }
}


1		<?php
2		declare(strict_types = 1);
3
4		namespace Selami\View\Twig;
5
6		use Selami\View\ExtensionsAbstract;
7		use Twig_Environment;
8		use Camel\CaseTransformer;
9		use Camel\Format;
10		use InvalidArgumentException;
11		use BadMethodCallException;
12
13		/**
14		* Class TwigExtensions extends ViewExtensionsAbstracts
15		*
16		* @package Selami\View\Twig
17		*/
18		class TwigExtensions extends ExtensionsAbstract
19		{
20		private $twig;
21		private $config;
22		private $toCamelCase;
23		private $toSnakeCase;
24
25		public function __construct(Twig_Environment $twig, array $config)
26		{
27		$this->twig = $twig;
28		$this->config = $config;
29		$this->toCamelCase = new CaseTransformer(new Format\SnakeCase, new Format\StudlyCaps);
30		$this->toSnakeCase = new CaseTransformer(new Format\CamelCase, new Format\SnakeCase);
31		$this->loadExtensions();
32		$this->loadFunctions();
33		}
34
35		protected function loadExtensions() : void
36		{
37		$this->twig->addExtension(new \Twig_Extensions_Extension_Date());
38		$this->twig->addExtension(new \Twig_Extensions_Extension_Intl());
39		$this->twig->addExtension(new \Twig_Extensions_Extension_Text());
40		$this->twig->addExtension(new \Twig_Extensions_Extension_I18n());
41		}
42
43		/**
44		* Build translate array.
45		*
46		* @param $translateArray
47		* @return array
48		*/
49		private function buildTranslateArray(array $translateArray) : array
		0 ignored issues – show Unused Code introduced 2017-07-02 09:52 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
50		{
51		$tmpArray = [];
52		foreach ($translateArray as $key => $value) {
53		$tmpArray['@'.$key] = $value;
54		}
55		return $tmpArray;
56		}
57
58		protected function extendForGetUrl() : void
59		{
60		$filter = new \Twig_SimpleFunction(
61		'getUrl',
62		function (
63		$alias,
64		$params = []
65		) {
66		if (array_key_exists($alias, $this->config['aliases'])) {
67		$data = $this->config['aliases'][$alias];
68		$relative_path = $data;
69		foreach ($params as $param => $value) {
70		if (strpos($param, ':') === strlen($param)-1) {
71		$relative_path = preg_replace('/{'.$param.'(.*?)}/msi', $value, $relative_path);
72		} else {
73		$relative_path = str_replace('{'.$param.'}', $value, $relative_path);
74		}
75		}
76		return $this->config['base_url'] . '/' . $relative_path;
77		}
78		return '';
79		},
80		array('is_safe' => array('html'))
81		);
82		$this->twig->addFunction($filter);
83		}
84
85		protected function extendForWidget() : void
86		{
87		$filter = new \Twig_SimpleFunction(
88		'Widget__',
89		function ($widgetNameStr, $widgetActionStr, $args = []) {
90		$widgetAction = $this->toCamelCase->transform($widgetActionStr);
91		$widgetName = $this->toCamelCase->transform($widgetNameStr);
92		$widget = '\\' . $this->config['app_namespace'] . '\\Widget\\' . $widgetName;
93		if (!class_exists($widget)) {
94		$message = 'Widget ' . $widgetName . '_' . $widgetAction . ' has not class name as ' . $widget;
95		throw new BadMethodCallException($message);
96		}
97		$widgetInstance = new $widget($args);
98		if (!method_exists($widgetInstance, $widgetAction)) {
99		$message = 'Widget ' . $widget . ' has not method name as ' . $widgetAction;
100		throw new BadMethodCallException($message);
101		}
102		$templateFileBasename = $args['template'] ?? $this->toSnakeCase->transform($widgetActionStr) . '.twig';
103		$templateFullPath = $this->config['templates_dir'] . '/_widgets/'
104		. $this->toSnakeCase->transform($widgetNameStr) . '/' . $templateFileBasename;
105
106		if (!file_exists($templateFullPath)) {
107		$message = sprintf(
108		'%s template file not found! %s needs a main template file at: %s',
109		$templateFileBasename,
110		$widgetNameStr . '_' . $widgetActionStr,
111		$templateFullPath
112		);
113		throw new InvalidArgumentException($message);
114		}
115		$templateFile = '_widgets/'
116		. $this->toSnakeCase->transform($widgetNameStr) . '/' . $templateFileBasename;
117		$widgetData = $widgetInstance->{$widgetAction}();
118		return $this->twig->render($templateFile, $widgetData);
119		},
120		array('is_safe' => array('html'))
121		);
122		$this->twig->addFunction($filter);
123		}
124
125	View Code Duplication	protected function extendForQueryParams() : void
		1 ignored issue – show Duplication introduced 2017-06-21 11:14 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...
126		{
127		$filter = new \Twig_SimpleFunction(
128		'queryParams',
129		function ($queryParams, $prefix = '?') {
130		return $prefix . http_build_query($queryParams);
131		},
132		array('is_safe' => array('html'))
133		);
134		$this->twig->addFunction($filter);
135		}
136
137	View Code Duplication	protected function extendForSiteUrl() : void
		1 ignored issue – show Duplication introduced 2017-06-21 11:14 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...
138		{
139		$filter = new \Twig_SimpleFunction(
140		'siteUrl',
141		function ($path = '') {
142		return $this->config['base_url'] . $path;
143		},
144		array('is_safe' => array('html'))
145		);
146		$this->twig->addFunction($filter);
147		}
148
149		protected function extendForVarDump() : void
150		{
151		$filter = new \Twig_SimpleFunction(
152		'varDump',
153		function ($args) {
154		/**
155		* @noinspection ForgottenDebugOutputInspection
156		*/
157		var_dump($args);
		1 ignored issue – show Security Debugging Code introduced 2017-06-21 11:14 UTC by Report Bug Copy Issue Report `var_dump($args);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
158		},
159		array('is_safe' => array('html'))
160		);
161		$this->twig->addFunction($filter);
162		}
163
164		protected function extendForPagination() : void
165		{
166		/**
167		* @noinspection MoreThanThreeArgumentsInspection
168		*/
169		$filter = new \Twig_SimpleFunction(
170		'Pagination',
171		function (
172		int $total,
173		int $current,
174		string $linkTemplate,
175		string $parentTemplate = '<ul class="pagination">(items)</ul>',
176		string $itemTemplate = '<li class="(item_class)">(link)</li>',
177		string $linkItemTemplate = '<a href="(href)" class="(link_class)">(text)</a>',
178		string $ellipsesTemplate = '<li><a>...</a></li>'
179		) {
180		$items = '';
181		$pageGroupLimit = 3;
182		$useEllipses = ($total >10) ? 1 : 0;
183		$renderedEllipses = 0;
184		$values = [
185		'(item_class)' => '',
186		'(href)' => '',
187		'(link_class)' => '',
188		'(text)' => ''
189		];
190		for ($i=1; $i <= $total; $i++) {
191		$values['(link_class)'] = '';
192		$values['(item_class)'] = '';
193		if ($i === $current) {
194		$values['(link_class)'] = 'active';
195		$values['(item_class)'] = 'active';
196		}
197		$values['(text)'] = $i;
198		$values['(href)'] = str_replace('(page_num)', $i, $linkTemplate);
199		$link = strtr($linkItemTemplate, $values);
200		$useLink = 1;
201		if ($useEllipses === 1) {
202		$useLink = 0;
203		if (($i <= $pageGroupLimit)
204		\|\| ($i >= ($current-1) && $i <= ($current+1))
205		\|\| ($i >= ($total-2))
206		) {
207		$useLink = 1;
208		$renderedEllipses = 0;
209		} else {
210		if ($renderedEllipses === 0) {
211		$items .= $ellipsesTemplate;
212		}
213		$renderedEllipses = 1;
214		}
215		}
216		if ($useLink === 1) {
217		$thisItemTemplate = str_replace(
218		array('(link)'),
219		array($link),
220		$itemTemplate
221		);
222		$items .= strtr($thisItemTemplate, $values);
223		}
224		}
225		return str_replace('(items)', $items, $parentTemplate);
226		},
227		array('is_safe' => array('html'))
228		);
229		$this->twig->addFunction($filter);
230		}
231		}
232

selamiphp / views

Push — master ( 4a66c1...7a18b6 )

TwigExtensions::extendForWidget() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like