Svg::run() - Code Metrics - Inspection of "Updated svg widget to enable svg > use implementat..." - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1852)

by Marc

created 2018-09-13 14:13 UTC

Svg::run() B

↳ Parent: Svg

Complexity

Conditions	7
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	8.4746
c	0
b	0
f	0
cc	7
nc	1
nop	0

<?php

namespace luya\web;

use luya\base\Widget;
use luya\Exception;
use luya\helpers\FileHelper;
use luya\helpers\StringHelper;
use luya\traits\CacheableTrait;
use Yii;

/**
 * Svg "inserter"
 *
 * This Widget will insert the contents of a given SVG file at the widgets position
 * or create an svg>use element for a given file + symbol.
 *
 * Inline the SVG contents:
 *
 * ```php
 *  <?= Svg::widget([
 *     'folder' => "@webroot/images/svg",
 *     'file' => 'logos/logo.svg',
 *     'cssClass' => 'additional-class-for-css'
 * ]); ?>
 * ```
 *
 * SVG > Use implementation:
 *
 * ```php
 * <?= Svg::widget([
 *     'symbolMode' => true,
 *     'symbolName' => 'example'
 *     'file' => 'images/svg-sprite.svg',
 *     'cssClass' => 'additional-class-for-css'
 * ]); ?>
 * ```
 *
 * @property string $folder The base folder path. Default is "@webroot/svg"
 *
 * @author Marc Stampfli <[email protected]>
 * @since 1.0.0
 */
class Svg extends Widget
{
    use CacheableTrait;

    /**
     * @var bool If symbolMode is true the widget will create a svg > use
     */
    public $symbolMode;

    /**
     * @var string The name of the symbol that will be referenced
     */
    public $symbolName;

    /**
     * @var string Relative path to the SVG file based on $folder
     */
    public $file;

    /**
     * @var string Additional css class to add to the SVG element, use only if the SVG itself has no class
     */
    public $cssClass;

    /**
     * @var string The base folder path. Default is "@webroot/svg"
     */
    private $_folder;

    /**
     * Setter method for $folder.
     *
     * @param string $folder Set folder for the given string (parsed trough Yii::getAlias())
     */
    public function setFolder($folder)
    {
        $this->_folder = Yii::getAlias($folder);
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Getter method for $folder.
     *
     * @return string Returns the folder string, if none is set it will return the default value "@webroot/svg"
     */
    public function getFolder()
    {
        if ($this->_folder === null) {
            $this->_folder = Yii::getAlias("@webroot/svg");
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        }

        return rtrim($this->_folder, DIRECTORY_SEPARATOR);
    }

    /**
     * @inheritdoc
     */
    public function run()
    {
        // Cache generated code
        return $this->getOrSetHasCache(['svg', $this->folder, $this->file, $this->cssClass], function () {

            // Check if file ends with .svg, if not add the extension
            $svgFile = StringHelper::endsWith($this->file, '.svg') ? $this->file : $this->file . '.svg';

            if ($this->symbolMode) {
                $svgPath = Yii::$app->view->publicHtml . '/' . $svgFile;

                return '<svg class="symbol symbol--' . $this->symbolName . '' . ($this->cssClass ? ' ' . $this->cssClass : '') . '"><use class="symbol__use" xlink:href="' . $svgPath . '#' . $this->symbolName . '" /></svg>';
            } else {
                // Build the full svg file path
                $svgPath = $this->folder . DIRECTORY_SEPARATOR . $svgFile;

                // Get the svg contents
                $content = FileHelper::getFileContent($svgPath);

                // If a cssClass string is given, add it to the <svg> tag
                if ($this->cssClass && is_string($this->cssClass)) {
                    $content = preg_replace('/<svg/', '<svg class="' . $this->cssClass . '"', $content);
                }

                if ($content) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    return $content;
                }
            }

            throw new Exception('Unable to access SVG File: ' . $svgPath);
        });
    }
}


1			<?php
2
3			namespace luya\web;
4
5			use luya\base\Widget;
6			use luya\Exception;
7			use luya\helpers\FileHelper;
8			use luya\helpers\StringHelper;
9			use luya\traits\CacheableTrait;
10			use Yii;
11
12			/**
13			* Svg "inserter"
14			*
15			* This Widget will insert the contents of a given SVG file at the widgets position
16			* or create an svg>use element for a given file + symbol.
17			*
18			* Inline the SVG contents:
19			*
20			* ```php
21			* <?= Svg::widget([
22			* 'folder' => "@webroot/images/svg",
23			* 'file' => 'logos/logo.svg',
24			* 'cssClass' => 'additional-class-for-css'
25			* ]); ?>
26			* ```
27			*
28			* SVG > Use implementation:
29			*
30			* ```php
31			* <?= Svg::widget([
32			* 'symbolMode' => true,
33			* 'symbolName' => 'example'
34			* 'file' => 'images/svg-sprite.svg',
35			* 'cssClass' => 'additional-class-for-css'
36			* ]); ?>
37			* ```
38			*
39			* @property string $folder The base folder path. Default is "@webroot/svg"
40			*
41			* @author Marc Stampfli <[email protected]>
42			* @since 1.0.0
43			*/
44			class Svg extends Widget
45			{
46			use CacheableTrait;
47
48			/**
49			* @var bool If symbolMode is true the widget will create a svg > use
50			*/
51			public $symbolMode;
52
53			/**
54			* @var string The name of the symbol that will be referenced
55			*/
56			public $symbolName;
57
58			/**
59			* @var string Relative path to the SVG file based on $folder
60			*/
61			public $file;
62
63			/**
64			* @var string Additional css class to add to the SVG element, use only if the SVG itself has no class
65			*/
66			public $cssClass;
67
68			/**
69			* @var string The base folder path. Default is "@webroot/svg"
70			*/
71			private $_folder;
72
73			/**
74			* Setter method for $folder.
75			*
76			* @param string $folder Set folder for the given string (parsed trough Yii::getAlias())
77			*/
78			public function setFolder($folder)
79			{
80			$this->_folder = Yii::getAlias($folder);
			0 ignored issues – show Documentation Bug introduced 2017-12-06 10:26 UTC by Report Bug Copy Issue Report It seems like `\Yii::getAlias($folder)` can also be of type `boolean`. However, the property `$_folder` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
81			}
82
83			/**
84			* Getter method for $folder.
85			*
86			* @return string Returns the folder string, if none is set it will return the default value "@webroot/svg"
87			*/
88			public function getFolder()
89			{
90			if ($this->_folder === null) {
91			$this->_folder = Yii::getAlias("@webroot/svg");
			0 ignored issues – show Documentation Bug introduced 2017-12-06 10:26 UTC by Report Bug Copy Issue Report It seems like `\Yii::getAlias('@webroot/svg')` can also be of type `boolean`. However, the property `$_folder` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
92			}
93
94			return rtrim($this->_folder, DIRECTORY_SEPARATOR);
95			}
96
97			/**
98			* @inheritdoc
99			*/
100			public function run()
101			{
102			// Cache generated code
103			return $this->getOrSetHasCache(['svg', $this->folder, $this->file, $this->cssClass], function () {
104
105			// Check if file ends with .svg, if not add the extension
106			$svgFile = StringHelper::endsWith($this->file, '.svg') ? $this->file : $this->file . '.svg';
107
108			if ($this->symbolMode) {
109			$svgPath = Yii::$app->view->publicHtml . '/' . $svgFile;
110
111			return '<svg class="symbol symbol--' . $this->symbolName . '' . ($this->cssClass ? ' ' . $this->cssClass : '') . '"><use class="symbol__use" xlink:href="' . $svgPath . '#' . $this->symbolName . '" /></svg>';
112			} else {
113			// Build the full svg file path
114			$svgPath = $this->folder . DIRECTORY_SEPARATOR . $svgFile;
115
116			// Get the svg contents
117			$content = FileHelper::getFileContent($svgPath);
118
119			// If a cssClass string is given, add it to the <svg> tag
120			if ($this->cssClass && is_string($this->cssClass)) {
121			$content = preg_replace('/<svg/', '<svg class="' . $this->cssClass . '"', $content);
122			}
123
124			if ($content) {
			0 ignored issues – show Bug Best Practice introduced 2017-12-06 10:26 UTC by Report Bug Copy Issue Report The expression `$content` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
125			return $content;
126			}
127			}
128
129			throw new Exception('Unable to access SVG File: ' . $svgPath);
130			});
131			}
132			}
133

luyadev / luya

Pull Request — master (#1852)

Svg::run() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like