TemplateProperty::addChoices() - Code Metrics - Inspection of "TemplateProperty: Revised use of available templat..." - locomotivemtl/charcoal-cms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#3)

by Chauncey

created 2017-05-25 21:12 UTC

TemplateProperty::addChoices() A

↳ Parent: TemplateProperty

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	1
eloc	5
nc	1
nop	1

<?php

namespace Charcoal\Property;

use PDO;

use RuntimeException;
use InvalidArgumentException;

// From Pimple
use Pimple\Container;

// From 'charcoal-translator'
use Charcoal\Translator\Translation;

// From 'charcoal-property'
use Charcoal\Property\AbstractProperty;
use Charcoal\Property\SelectablePropertyInterface;
use Charcoal\Property\SelectablePropertyTrait;

/**
 * Template Selector Property
 */
class TemplateProperty extends AbstractProperty implements SelectablePropertyInterface

{
    use SelectablePropertyTrait;

    /**
     * The available selectable templates.
     *
     * @var array|null
     */
    private $availableTemplates;

    /**
     * @return string
     */
    public function type()
    {
        return 'template';
    }

    /**
     * Inject dependencies from a DI Container.
     *
     * @param  Container $container A dependencies container instance.
     * @return void
     */
    public function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        if (isset($container['config']['templates'])) {
            $this->availableTemplates = $this->parseChoices($container['config']['templates']);
            $this->choices = $this->availableTemplates;
        }
    }

    /**
     * Set the available choices.
     *
     * @param  array $choices One or more choice structures.
     * @return TemplateProperty Chainable.
     */
    public function setChoices(array $choices)
    {
        unset($choices);

        $this->logger->debug(
            'Choices can not be set for template properties. They are auto-generated from available languages.'
        );

        return $this;
    }

    /**
     * Merge the available choices.
     *
     * @param  array $choices One or more choice structures.
     * @return TemplateProperty Chainable.
     */
    public function addChoices(array $choices)
    {
        unset($choices);

        $this->logger->debug(
            'Choices can not be added for template properties. They are auto-generated from available languages.'
        );

        return $this;
    }

    /**
     * Add a choice to the available choices.
     *
     * @param string       $choiceIdent The choice identifier (will be key / default ident).
     * @param string|array $choice      A string representing the choice label or a structure.
     * @return TemplateProperty Chainable.
     */
    public function addChoice($choiceIdent, $choice)
    {
        unset($choiceIdent, $choice);

        $this->logger->debug(
            'Choices can not be added for template properties. They are auto-generated from available languages.'
        );

        return $this;
    }

    /**
     * Format the given value for display.
     *
     * @param  mixed $val     The value to to convert for display.
     * @param  array $options Optional display options.
     * @return string
     */
    public function displayVal($val, array $options = [])
    {
        if ($val === null || $val === '') {
            return '';
        }

        /** Parse multilingual values */
        if ($this->l10n()) {
            $propertyValue = $this->l10nVal($val, $options);
            if ($propertyValue === null) {
                return '';
            }
        } elseif ($val instanceof Translation) {
            $propertyValue = (string)$val;
        } else {
            $propertyValue = $val;
        }

        $separator = $this->multipleSeparator();

        /** Parse multiple values / ensure they are of array type. */
        if ($this->multiple()) {
            if (!is_array($propertyValue)) {
                $propertyValue = explode($separator, $propertyValue);
            }
        }

        if ($separator === ',') {
            $separator = ', ';
        }

        if (is_array($propertyValue)) {
            foreach ($propertyValue as &$value) {
                if (is_string($value)) {

                    $value = $this->choiceLabel($value);
                    if (!is_string($value)) {
                        $value = $this->l10nVal($value, $options);
                    }
                }
            }
            $propertyValue = implode($separator, $propertyValue);
        } elseif (is_string($propertyValue)) {

            $propertyValue = $this->choiceLabel($propertyValue);
            if (!is_string($propertyValue)) {
                $propertyValue = $this->l10nVal($propertyValue, $options);
            }
        }

        return $propertyValue;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Retrieve the selected template's FQCN.
     *
     * @return string
     */
    public function __toString()
    {
        $val = $this->val();
        if ($this->hasChoice($val)) {
            $choice = $this->choice($val);
            $keys   = [ 'controller', 'template', 'class' ];
            foreach ($keys as $key) {
                if (isset($choice[$key])) {
                    return $choice[$key];
                }
            }
        }

        return '';
    }

    /**
     * @return string
     */
    public function sqlExtra()
    {
        return '';
    }

    /**
     * Get the SQL type (Storage format)
     *
     * @return string The SQL type
     */
    public function sqlType()
    {
        if ($this->multiple()) {
            return 'TEXT';
        }

        return 'VARCHAR(255)';
    }

    /**
     * @return integer
     */
    public function sqlPdoType()
    {
        return PDO::PARAM_STR;
    }
}


1		<?php
2
3		namespace Charcoal\Property;
4
5		use PDO;
6
7		use RuntimeException;
8		use InvalidArgumentException;
9
10		// From Pimple
11		use Pimple\Container;
12
13		// From 'charcoal-translator'
14		use Charcoal\Translator\Translation;
15
16		// From 'charcoal-property'
17		use Charcoal\Property\AbstractProperty;
18		use Charcoal\Property\SelectablePropertyInterface;
19		use Charcoal\Property\SelectablePropertyTrait;
20
21		/**
22		* Template Selector Property
23		*/
24		class TemplateProperty extends AbstractProperty implements SelectablePropertyInterface
		0 ignored issues – show Bug introduced 2016-10-05 23:08 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: loadMetadata, metadata, metadataIdent, setMetadata, setMetadataIdent, setMetadataLoader, setValidator, validate, validator Loading history...
25		{
26		use SelectablePropertyTrait;
27
28		/**
29		* The available selectable templates.
30		*
31		* @var array\|null
32		*/
33		private $availableTemplates;
34
35		/**
36		* @return string
37		*/
38		public function type()
39		{
40		return 'template';
41		}
42
43		/**
44		* Inject dependencies from a DI Container.
45		*
46		* @param Container $container A dependencies container instance.
47		* @return void
48		*/
49		public function setDependencies(Container $container)
50		{
51		parent::setDependencies($container);
52
53		if (isset($container['config']['templates'])) {
54		$this->availableTemplates = $this->parseChoices($container['config']['templates']);
55		$this->choices = $this->availableTemplates;
56		}
57		}
58
59		/**
60		* Set the available choices.
61		*
62		* @param array $choices One or more choice structures.
63		* @return TemplateProperty Chainable.
64		*/
65		public function setChoices(array $choices)
66		{
67		unset($choices);
68
69		$this->logger->debug(
70		'Choices can not be set for template properties. They are auto-generated from available languages.'
71		);
72
73		return $this;
74		}
75
76		/**
77		* Merge the available choices.
78		*
79		* @param array $choices One or more choice structures.
80		* @return TemplateProperty Chainable.
81		*/
82		public function addChoices(array $choices)
83		{
84		unset($choices);
85
86		$this->logger->debug(
87		'Choices can not be added for template properties. They are auto-generated from available languages.'
88		);
89
90		return $this;
91		}
92
93		/**
94		* Add a choice to the available choices.
95		*
96		* @param string $choiceIdent The choice identifier (will be key / default ident).
97		* @param string\|array $choice A string representing the choice label or a structure.
98		* @return TemplateProperty Chainable.
99		*/
100		public function addChoice($choiceIdent, $choice)
101		{
102		unset($choiceIdent, $choice);
103
104		$this->logger->debug(
105		'Choices can not be added for template properties. They are auto-generated from available languages.'
106		);
107
108		return $this;
109		}
110
111		/**
112		* Format the given value for display.
113		*
114		* @param mixed $val The value to to convert for display.
115		* @param array $options Optional display options.
116		* @return string
117		*/
118		public function displayVal($val, array $options = [])
119		{
120		if ($val === null \|\| $val === '') {
121		return '';
122		}
123
124		/** Parse multilingual values */
125		if ($this->l10n()) {
126		$propertyValue = $this->l10nVal($val, $options);
127		if ($propertyValue === null) {
128		return '';
129		}
130		} elseif ($val instanceof Translation) {
131		$propertyValue = (string)$val;
132		} else {
133		$propertyValue = $val;
134		}
135
136		$separator = $this->multipleSeparator();
137
138		/** Parse multiple values / ensure they are of array type. */
139		if ($this->multiple()) {
140		if (!is_array($propertyValue)) {
141		$propertyValue = explode($separator, $propertyValue);
142		}
143		}
144
145		if ($separator === ',') {
146		$separator = ', ';
147		}
148
149		if (is_array($propertyValue)) {
150		foreach ($propertyValue as &$value) {
151	View Code Duplication	if (is_string($value)) {
		0 ignored issues – show Duplication introduced 2017-05-25 16:41 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
152		$value = $this->choiceLabel($value);
153		if (!is_string($value)) {
154		$value = $this->l10nVal($value, $options);
155		}
156		}
157		}
158		$propertyValue = implode($separator, $propertyValue);
159	View Code Duplication	} elseif (is_string($propertyValue)) {
		0 ignored issues – show Duplication introduced 2017-05-25 16:41 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
160		$propertyValue = $this->choiceLabel($propertyValue);
161		if (!is_string($propertyValue)) {
162		$propertyValue = $this->l10nVal($propertyValue, $options);
163		}
164		}
165
166		return $propertyValue;
		0 ignored issues – show Bug Best Practice introduced 2017-05-25 16:41 UTC by Report Bug Copy Issue Report The return type of `return $propertyValue;` (`string\|null\|object\|integer\|double\|boolean`) is incompatible with the return type declared by the interface `Charcoal\Property\PropertyInterface::displayVal` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
167		}
168
169		/**
170		* Retrieve the selected template's FQCN.
171		*
172		* @return string
173		*/
174		public function __toString()
175		{
176		$val = $this->val();
177		if ($this->hasChoice($val)) {
178		$choice = $this->choice($val);
179		$keys = [ 'controller', 'template', 'class' ];
180		foreach ($keys as $key) {
181		if (isset($choice[$key])) {
182		return $choice[$key];
183		}
184		}
185		}
186
187		return '';
188		}
189
190		/**
191		* @return string
192		*/
193		public function sqlExtra()
194		{
195		return '';
196		}
197
198		/**
199		* Get the SQL type (Storage format)
200		*
201		* @return string The SQL type
202		*/
203		public function sqlType()
204		{
205		if ($this->multiple()) {
206		return 'TEXT';
207		}
208
209		return 'VARCHAR(255)';
210		}
211
212		/**
213		* @return integer
214		*/
215		public function sqlPdoType()
216		{
217		return PDO::PARAM_STR;
218		}
219		}
220

locomotivemtl / charcoal-cms

Pull Request — master (#3)

TemplateProperty::addChoices() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like