EccubeExtension::getPhpFunctions() - Code Metrics - Inspection of "Merge pull request #3376 from KenTanaka/experiment..." - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — experimental/sf ( 2c9648...be7f7d )

by chihiro

created 2018-08-05 00:16 UTC

EccubeExtension::getPhpFunctions() A

↳ Parent: EccubeExtension

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	13
ccs	0
cts	7
cp	0
crap	6
rs	9.8333
c	0
b	0
f	0

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Eccube\Twig\Extension;

use Eccube\Common\EccubeConfig;
use Eccube\Entity\Product;
use Eccube\Util\StringUtil;
use Symfony\Component\Form\FormView;
use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;
use Twig\TwigFunction;

class EccubeExtension extends AbstractExtension
{
    /**
     * @var EccubeConfig
     */
    protected $eccubeConfig;

    public function __construct(EccubeConfig $eccubeConfig)
    {
        $this->eccubeConfig = $eccubeConfig;
    }

    /**
     * Returns a list of functions to add to the existing list.
     *
     * @return TwigFunction[] An array of functions
     */
    public function getFunctions()
    {
        return [
            new TwigFunction('has_errors', [$this, 'hasErrors']),
            new TwigFunction('active_menus', [$this, 'getActiveMenus']),
            new TwigFunction('class_categories_as_json', [$this, 'getClassCategoriesAsJson']),
            new TwigFunction('php_*', function () {
                $arg_list = func_get_args();
                $function = array_shift($arg_list);
                if (is_callable($function)) {
                    return call_user_func_array($function, $arg_list);
                }
                trigger_error('Called to an undefined function : php_'.$function, E_USER_WARNING);
            }, ['pre_escape' => 'html', 'is_safe' => ['html']]),
        ];
    }

    /**
     * Returns a list of filters.
     *
     * @return TwigFilter[]
     */
    public function getFilters()
    {
        return [
            new TwigFilter('no_image_product', [$this, 'getNoImageProduct']),
            new TwigFilter('date_format', [$this, 'getDateFormatFilter']),
            new TwigFilter('price', [$this, 'getPriceFilter']),
            new TwigFilter('ellipsis', [$this, 'getEllipsis']),
            new TwigFilter('time_ago', [$this, 'getTimeAgo']),
            new TwigFilter('file_ext_icon', [$this, 'getExtensionIcon'], ['is_safe' => ['html']]),
        ];
    }

    /**
     * Name of this extension
     *
     * @return string
     */
    public function getName()
    {
        return 'eccube';
    }

    /**
     * Name of this extension
     *
     * @param array $menus
     *
     * @return array
     */
    public function getActiveMenus($menus = [])
    {
        $count = count($menus);
        for ($i = $count; $i <= 2; $i++) {
            $menus[] = '';
        }

        return $menus;
    }

    /**
     * return No Image filename
     *
     * @return string
     */
    public function getNoImageProduct($image)
    {
        return empty($image) ? 'no_image_product.jpg' : $image;
    }

    /**
     * Name of this extension
     *
     * @return string
     */
    public function getDateFormatFilter($date, $value = '', $format = 'Y/m/d')
    {
        if (is_null($date)) {
            return $value;
        } else {
            return $date->format($format);
        }
    }

    /**
     * Name of this extension
     *
     * @return string
     */
    public function getPriceFilter($number, $decimals = 0, $decPoint = '.', $thousandsSep = ',')

    {
        $locale = $this->eccubeConfig['locale'];
        $currency = $this->eccubeConfig['currency'];
        $formatter = new \NumberFormatter($locale, \NumberFormatter::CURRENCY);

        return $formatter->formatCurrency($number, $currency);
    }

    /**
     * Name of this extension
     *
     * @return string
     */
    public function getEllipsis($value, $length = 100, $end = '...')
    {
        return StringUtil::ellipsis($value, $length, $end);
    }

    /**
     * Name of this extension
     *
     * @return string
     */
    public function getTimeAgo($date)
    {
        return StringUtil::timeAgo($date);
    }

    /**
     * FormView にエラーが含まれるかを返す.
     *
     * @return bool
     */
    public function hasErrors()
    {
        $hasErrors = false;

        $views = func_get_args();
        foreach ($views as $view) {
            if (!$view instanceof FormView) {
                throw new \InvalidArgumentException();
            }
            if (count($view->vars['errors'])) {
                $hasErrors = true;
                break;
            }
        }

        return $hasErrors;
    }

    /**
     * product_idで指定したProductを取得
     * Productが取得できない場合、または非公開の場合、商品情報は表示させない。
     * デバッグ環境以外ではProductが取得できなくでもエラー画面は表示させず無視される。
     *
     * @param $id
     *
     * @return Product|null
     */
    public function getProduct($id)
    {
        try {
            $Product = $this->app['eccube.repository.product']->get($id);

            if ($Product->getStatus()->getId() == Disp::DISPLAY_SHOW) {
                return $Product;
            }
        } catch (\Exception $e) {
            return null;
        }

        return null;
    }

    /**
     * Twigでphp関数を使用できるようにする。
     *
     * @return mixed|null
     */
    public function getPhpFunctions()
    {
        $arg_list = func_get_args();
        $function = array_shift($arg_list);

        if (is_callable($function)) {
            return call_user_func_array($function, $arg_list);
        }

        trigger_error('Called to an undefined function : php_'.$function, E_USER_WARNING);

        return null;
    }

    /**
     * Get the ClassCategories as JSON.
     *
     * @param Product $Product
     *
     * @return string
     */
    public function getClassCategoriesAsJson(Product $Product)
    {
        $Product->_calc();
        $class_categories = [
            '__unselected' => [
                '__unselected' => [
                    'name' => trans('product.text.please_select'),
                    'product_class_id' => '',
                ],
            ],
        ];
        foreach ($Product->getProductClasses() as $ProductClass) {
            /* @var $ProductClass \Eccube\Entity\ProductClass */
            $ClassCategory1 = $ProductClass->getClassCategory1();
            $ClassCategory2 = $ProductClass->getClassCategory2();
            if ($ClassCategory2 && !$ClassCategory2->isVisible()) {
                continue;
            }
            $class_category_id1 = $ClassCategory1 ? (string) $ClassCategory1->getId() : '__unselected2';
            $class_category_id2 = $ClassCategory2 ? (string) $ClassCategory2->getId() : '';
            $class_category_name2 = $ClassCategory2 ? $ClassCategory2->getName().($ProductClass->getStockFind() ? '' : trans('product.text.out_of_stock')) : '';

            $class_categories[$class_category_id1]['#'] = [
                'classcategory_id2' => '',
                'name' => trans('product.text.please_select'),
                'product_class_id' => '',
            ];
            $class_categories[$class_category_id1]['#'.$class_category_id2] = [
                'classcategory_id2' => $class_category_id2,
                'name' => $class_category_name2,
                'stock_find' => $ProductClass->getStockFind(),
                'price01' => $ProductClass->getPrice01() === null ? '' : number_format($ProductClass->getPrice01()),
                'price02' => number_format($ProductClass->getPrice02()),
                'price01_inc_tax' => $ProductClass->getPrice01() === null ? '' : number_format($ProductClass->getPrice01IncTax()),
                'price02_inc_tax' => number_format($ProductClass->getPrice02IncTax()),
                'product_class_id' => (string) $ProductClass->getId(),
                'product_code' => $ProductClass->getCode() === null ? '' : $ProductClass->getCode(),
                'sale_type' => (string) $ProductClass->getSaleType()->getId(),
            ];
        }

        return json_encode($class_categories);
    }

    /**
     * Display file extension icon
     *
     * @param $ext
     * @param $attr
     *
     * @return string
     */
    public function getExtensionIcon($ext, $attr = [])
    {
        $classes = [
            'txt' => 'fa-file-text-o',
            'rtf' => 'fa-file-text-o',
            'pdf' => 'fa-file-pdf-o',
            'doc' => 'fa-file-word-o',
            'docx' => 'fa-file-word-o',
            'csv' => 'fa-file-excel-o',
            'xls' => 'fa-file-excel-o',
            'xlsx' => 'fa-file-excel-o',
            'ppt' => 'fa-file-powerpoint-o',
            'pptx' => 'fa-file-powerpoint-o',
            'png' => 'fa-file-image-o',
            'jpg' => 'fa-file-image-o',
            'jpeg' => 'fa-file-image-o',
            'bmp' => 'fa-file-image-o',
            'gif' => 'fa-file-image-o',
            'zip' => 'fa-file-archive-o',
            'tar' => 'fa-file-archive-o',
            'gz' => 'fa-file-archive-o',
            'rar' => 'fa-file-archive-o',
            '7zip' => 'fa-file-archive-o',
            'mp3' => 'fa-file-audio-o',
            'm4a' => 'fa-file-audio-o',
            'wav' => 'fa-file-audio-o',
            'mp4' => 'fa-file-video-o',
            'wmv' => 'fa-file-video-o',
            'mov' => 'fa-file-video-o',
            'mkv' => 'fa-file-video-o',
        ];
        $class = isset($classes[$ext]) ? $classes[$ext] : 'fa-file-o';
        $attr['class'] = isset($attr['class'])
            ? $attr['class']." fa {$class}"
            : "fa {$class}";

        $html = '<i ';
        foreach ($attr as $name => $value) {
            $html .= "{$name}=\"$value\" ";
        }
        $html .= '></i>';

        return $html;
    }

    /**
     * URLに対する権限有無チェック
     *
     * @param $target
     * @param $AuthorityRoles
     *
     * @return boolean
     */
    public function isAuthorizedUrl($target, $AuthorityRoles)
    {
        foreach ($AuthorityRoles as $authorityRole) {
            $denyUrl = str_replace('/', '\/', $authorityRole);
            if (preg_match("/^({$denyUrl})/i", $target)) {
                return false;
            }
        }

        return true;
    }
}


1		<?php
2
3		/*
4		* This file is part of EC-CUBE
5		*
6		* Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
7		*
8		* http://www.lockon.co.jp/
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Eccube\Twig\Extension;
15
16		use Eccube\Common\EccubeConfig;
17		use Eccube\Entity\Product;
18		use Eccube\Util\StringUtil;
19		use Symfony\Component\Form\FormView;
20		use Twig\Extension\AbstractExtension;
21		use Twig\TwigFilter;
22		use Twig\TwigFunction;
23
24		class EccubeExtension extends AbstractExtension
25		{
26		/**
27		* @var EccubeConfig
28		*/
29		protected $eccubeConfig;
30
31	470	public function __construct(EccubeConfig $eccubeConfig)
32		{
33	470	$this->eccubeConfig = $eccubeConfig;
34		}
35
36		/**
37		* Returns a list of functions to add to the existing list.
38		*
39		* @return TwigFunction[] An array of functions
40		*/
41	241	public function getFunctions()
42		{
43		return [
44	241	new TwigFunction('has_errors', [$this, 'hasErrors']),
45	241	new TwigFunction('active_menus', [$this, 'getActiveMenus']),
46	241	new TwigFunction('class_categories_as_json', [$this, 'getClassCategoriesAsJson']),
47	241	new TwigFunction('php_*', function () {
48	10	$arg_list = func_get_args();
49	10	$function = array_shift($arg_list);
50	10	if (is_callable($function)) {
51	10	return call_user_func_array($function, $arg_list);
52		}
53		trigger_error('Called to an undefined function : php_'.$function, E_USER_WARNING);
54	241	}, ['pre_escape' => 'html', 'is_safe' => ['html']]),
55		];
56		}
57
58		/**
59		* Returns a list of filters.
60		*
61		* @return TwigFilter[]
62		*/
63	241	public function getFilters()
64		{
65		return [
66	241	new TwigFilter('no_image_product', [$this, 'getNoImageProduct']),
67	241	new TwigFilter('date_format', [$this, 'getDateFormatFilter']),
68	241	new TwigFilter('price', [$this, 'getPriceFilter']),
69	241	new TwigFilter('ellipsis', [$this, 'getEllipsis']),
70	241	new TwigFilter('time_ago', [$this, 'getTimeAgo']),
71	241	new TwigFilter('file_ext_icon', [$this, 'getExtensionIcon'], ['is_safe' => ['html']]),
72		];
73		}
74
75		/**
76		* Name of this extension
77		*
78		* @return string
79		*/
80		public function getName()
81		{
82		return 'eccube';
83		}
84
85		/**
86		* Name of this extension
87		*
88		* @param array $menus
89		*
90		* @return array
91		*/
92	152	public function getActiveMenus($menus = [])
93		{
94	152	$count = count($menus);
95	152	for ($i = $count; $i <= 2; $i++) {
96	112	$menus[] = '';
97		}
98
99	152	return $menus;
100		}
101
102		/**
103		* return No Image filename
104		*
105		* @return string
106		*/
107	63	public function getNoImageProduct($image)
108		{
109	63	return empty($image) ? 'no_image_product.jpg' : $image;
110		}
111
112		/**
113		* Name of this extension
114		*
115		* @return string
116		*/
117	1	public function getDateFormatFilter($date, $value = '', $format = 'Y/m/d')
118		{
119	1	if (is_null($date)) {
120	1	return $value;
121		} else {
122		return $date->format($format);
123		}
124		}
125
126		/**
127		* Name of this extension
128		*
129		* @return string
130		*/
131	141	public function getPriceFilter($number, $decimals = 0, $decPoint = '.', $thousandsSep = ',')
		0 ignored issues – show Unused Code introduced 2017-08-29 02:45 UTC by Report Bug Copy Issue Report The parameter `$decimals` 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... Unused Code introduced 2017-08-29 02:45 UTC by Report Bug Copy Issue Report The parameter `$decPoint` 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... Unused Code introduced 2017-08-29 02:45 UTC by Report Bug Copy Issue Report The parameter `$thousandsSep` 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...
132		{
133	141	$locale = $this->eccubeConfig['locale'];
134	141	$currency = $this->eccubeConfig['currency'];
135	141	$formatter = new \NumberFormatter($locale, \NumberFormatter::CURRENCY);
136
137	141	return $formatter->formatCurrency($number, $currency);
138		}
139
140		/**
141		* Name of this extension
142		*
143		* @return string
144		*/
145		public function getEllipsis($value, $length = 100, $end = '...')
146		{
147		return StringUtil::ellipsis($value, $length, $end);
148		}
149
150		/**
151		* Name of this extension
152		*
153		* @return string
154		*/
155		public function getTimeAgo($date)
156		{
157		return StringUtil::timeAgo($date);
158		}
159
160		/**
161		* FormView にエラーが含まれるかを返す.
162		*
163		* @return bool
164		*/
165	13	public function hasErrors()
166		{
167	13	$hasErrors = false;
168
169	13	$views = func_get_args();
170	13	foreach ($views as $view) {
171	13	if (!$view instanceof FormView) {
172		throw new \InvalidArgumentException();
173		}
174	13	if (count($view->vars['errors'])) {
175	1	$hasErrors = true;
176	13	break;
177		}
178		}
179
180	13	return $hasErrors;
181		}
182
183		/**
184		* product_idで指定したProductを取得
185		* Productが取得できない場合、または非公開の場合、商品情報は表示させない。
186		* デバッグ環境以外ではProductが取得できなくでもエラー画面は表示させず無視される。
187		*
188		* @param $id
189		*
190		* @return Product\|null
191		*/
192		public function getProduct($id)
193		{
194		try {
195		$Product = $this->app['eccube.repository.product']->get($id);
196
197		if ($Product->getStatus()->getId() == Disp::DISPLAY_SHOW) {
198		return $Product;
199		}
200		} catch (\Exception $e) {
201		return null;
202		}
203
204		return null;
205		}
206
207		/**
208		* Twigでphp関数を使用できるようにする。
209		*
210		* @return mixed\|null
211		*/
212		public function getPhpFunctions()
213		{
214		$arg_list = func_get_args();
215		$function = array_shift($arg_list);
216
217		if (is_callable($function)) {
218		return call_user_func_array($function, $arg_list);
219		}
220
221		trigger_error('Called to an undefined function : php_'.$function, E_USER_WARNING);
222
223		return null;
224		}
225
226		/**
227		* Get the ClassCategories as JSON.
228		*
229		* @param Product $Product
230		*
231		* @return string
232		*/
233	16	public function getClassCategoriesAsJson(Product $Product)
234		{
235	16	$Product->_calc();
236		$class_categories = [
237		'__unselected' => [
238		'__unselected' => [
239	16	'name' => trans('product.text.please_select'),
240	16	'product_class_id' => '',
241		],
242		],
243		];
244	16	foreach ($Product->getProductClasses() as $ProductClass) {
245		/* @var $ProductClass \Eccube\Entity\ProductClass */
246	16	$ClassCategory1 = $ProductClass->getClassCategory1();
247	16	$ClassCategory2 = $ProductClass->getClassCategory2();
248	16	if ($ClassCategory2 && !$ClassCategory2->isVisible()) {
249		continue;
250		}
251	16	$class_category_id1 = $ClassCategory1 ? (string) $ClassCategory1->getId() : '__unselected2';
252	16	$class_category_id2 = $ClassCategory2 ? (string) $ClassCategory2->getId() : '';
253	16	$class_category_name2 = $ClassCategory2 ? $ClassCategory2->getName().($ProductClass->getStockFind() ? '' : trans('product.text.out_of_stock')) : '';
254
255	16	$class_categories[$class_category_id1]['#'] = [
256	16	'classcategory_id2' => '',
257	16	'name' => trans('product.text.please_select'),
258	16	'product_class_id' => '',
259		];
260	16	$class_categories[$class_category_id1]['#'.$class_category_id2] = [
261	16	'classcategory_id2' => $class_category_id2,
262	16	'name' => $class_category_name2,
263	16	'stock_find' => $ProductClass->getStockFind(),
264	16	'price01' => $ProductClass->getPrice01() === null ? '' : number_format($ProductClass->getPrice01()),
265	16	'price02' => number_format($ProductClass->getPrice02()),
266	16	'price01_inc_tax' => $ProductClass->getPrice01() === null ? '' : number_format($ProductClass->getPrice01IncTax()),
267	16	'price02_inc_tax' => number_format($ProductClass->getPrice02IncTax()),
268	16	'product_class_id' => (string) $ProductClass->getId(),
269	16	'product_code' => $ProductClass->getCode() === null ? '' : $ProductClass->getCode(),
270	16	'sale_type' => (string) $ProductClass->getSaleType()->getId(),
271		];
272		}
273
274	16	return json_encode($class_categories);
275		}
276
277		/**
278		* Display file extension icon
279		*
280		* @param $ext
281		* @param $attr
282		*
283		* @return string
284		*/
285	3	public function getExtensionIcon($ext, $attr = [])
286		{
287		$classes = [
288	3	'txt' => 'fa-file-text-o',
289		'rtf' => 'fa-file-text-o',
290		'pdf' => 'fa-file-pdf-o',
291		'doc' => 'fa-file-word-o',
292		'docx' => 'fa-file-word-o',
293		'csv' => 'fa-file-excel-o',
294		'xls' => 'fa-file-excel-o',
295		'xlsx' => 'fa-file-excel-o',
296		'ppt' => 'fa-file-powerpoint-o',
297		'pptx' => 'fa-file-powerpoint-o',
298		'png' => 'fa-file-image-o',
299		'jpg' => 'fa-file-image-o',
300		'jpeg' => 'fa-file-image-o',
301		'bmp' => 'fa-file-image-o',
302		'gif' => 'fa-file-image-o',
303		'zip' => 'fa-file-archive-o',
304		'tar' => 'fa-file-archive-o',
305		'gz' => 'fa-file-archive-o',
306		'rar' => 'fa-file-archive-o',
307		'7zip' => 'fa-file-archive-o',
308		'mp3' => 'fa-file-audio-o',
309		'm4a' => 'fa-file-audio-o',
310		'wav' => 'fa-file-audio-o',
311		'mp4' => 'fa-file-video-o',
312		'wmv' => 'fa-file-video-o',
313		'mov' => 'fa-file-video-o',
314		'mkv' => 'fa-file-video-o',
315		];
316	3	$class = isset($classes[$ext]) ? $classes[$ext] : 'fa-file-o';
317	3	$attr['class'] = isset($attr['class'])
318	3	? $attr['class']." fa {$class}"
319		: "fa {$class}";
320
321	3	$html = '<i ';
322	3	foreach ($attr as $name => $value) {
323	3	$html .= "{$name}=\"$value\" ";
324		}
325	3	$html .= '></i>';
326
327	3	return $html;
328		}
329
330		/**
331		* URLに対する権限有無チェック
332		*
333		* @param $target
334		* @param $AuthorityRoles
335		*
336		* @return boolean
337		*/
338		public function isAuthorizedUrl($target, $AuthorityRoles)
339		{
340		foreach ($AuthorityRoles as $authorityRole) {
341		$denyUrl = str_replace('/', '\/', $authorityRole);
342		if (preg_match("/^({$denyUrl})/i", $target)) {
343		return false;
344		}
345		}
346
347		return true;
348		}
349		}
350

EC-CUBE / ec-cube

Push — experimental/sf ( 2c9648...be7f7d )

EccubeExtension::getPhpFunctions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like