HtmlElementFactory::defaultOptions() - Code Metrics - sandrokeil/HtmlElement - Measure and Improve Code Quality continuously with Scrutinizer

HtmlElementFactory::defaultOptions() A
last analyzed 2017-08-04 19:17 UTC

↳ Parent: HtmlElementFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0

<?php
/**
 * Sake
 *
 * @link      http://github.com/sandrokeil/HtmlElement for the canonical source repository
 * @copyright Copyright (c) 2014-2017 Sandro Keil
 * @license   http://github.com/sandrokeil/HtmlElement/blob/master/LICENSE.txt New BSD License
 */

namespace Sake\HtmlElement\Service;

use Sake\HtmlElement\View\Helper\HtmlElement;
use Interop\Config\ConfigurationTrait;
use Interop\Config\ProvidesDefaultOptions;
use Interop\Config\RequiresConfigId;
use Interop\Container\ContainerInterface;

/**
 * HtmlElement view helper factory
 *
 * Creates html view helper and injects escaper
 */
class HtmlElementFactory implements ProvidesDefaultOptions, RequiresConfigId
{

    use ConfigurationTrait;

    /**
     * @var string
     */
    private $configId;

    /**
     * Creates a new instance from a specified config, specifically meant to be used as static factory.
     *
     * In case you want to use another config key than provided by the factories, you can add the following factory to
     * your config:
     *
     * <code>
     * <?php
     * return [
     *     HtmlElement::class => [HtmlElementFactory::class, 'service_name'],
     * ];
     * </code>
     *
     * @throws \InvalidArgumentException
     */
    public static function __callStatic(string $name, array $arguments): HtmlElement
    {
        if (! isset($arguments[0]) || ! $arguments[0] instanceof ContainerInterface) {
            throw new \InvalidArgumentException(
                sprintf('The first argument must be of type %s', ContainerInterface::class)
            );
        }

        return (new static($name))->__invoke($arguments[0]);
    }

    public function __invoke(ContainerInterface $container): HtmlElement
    {
        $config = $container->get('config');
        $config = $this->options($config, $this->configId);

        $htmlElement = new HtmlElement();

        if (isset($config['escapeHtmlAttribute'])) {
            $htmlElement->setEscapeHtmlAttribute($config['escapeHtmlAttribute']);
        }

        if (isset($config['escapeText'])) {
            $htmlElement->setEscapeText($config['escapeText']);
        }

        return $htmlElement;
    }

    public function __construct(string $configId = 'default')
    {
        $this->configId = $configId;
    }

    public function dimensions(): iterable
    {
        return ['sake_htmlelement', 'view_helper'];
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());
}
    }

    public function defaultOptions(): iterable
    {
        return [
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());
}
            'escapeHtmlAttribute' => true,
            'escapeText' => true,
        ];
    }
}


1			<?php
2			/**
3			* Sake
4			*
5			* @link http://github.com/sandrokeil/HtmlElement for the canonical source repository
6			* @copyright Copyright (c) 2014-2017 Sandro Keil
7			* @license http://github.com/sandrokeil/HtmlElement/blob/master/LICENSE.txt New BSD License
8			*/
9
10			namespace Sake\HtmlElement\Service;
11
12			use Sake\HtmlElement\View\Helper\HtmlElement;
13			use Interop\Config\ConfigurationTrait;
14			use Interop\Config\ProvidesDefaultOptions;
15			use Interop\Config\RequiresConfigId;
16			use Interop\Container\ContainerInterface;
17
18			/**
19			* HtmlElement view helper factory
20			*
21			* Creates html view helper and injects escaper
22			*/
23			class HtmlElementFactory implements ProvidesDefaultOptions, RequiresConfigId
24			{
25
26			use ConfigurationTrait;
27
28			/**
29			* @var string
30			*/
31			private $configId;
32
33			/**
34			* Creates a new instance from a specified config, specifically meant to be used as static factory.
35			*
36			* In case you want to use another config key than provided by the factories, you can add the following factory to
37			* your config:
38			*
39			* <code>
40			* <?php
41			* return [
42			* HtmlElement::class => [HtmlElementFactory::class, 'service_name'],
43			* ];
44			* </code>
45			*
46			* @throws \InvalidArgumentException
47			*/
48			public static function __callStatic(string $name, array $arguments): HtmlElement
49			{
50			if (! isset($arguments[0]) \|\| ! $arguments[0] instanceof ContainerInterface) {
51			throw new \InvalidArgumentException(
52			sprintf('The first argument must be of type %s', ContainerInterface::class)
53			);
54			}
55
56			return (new static($name))->__invoke($arguments[0]);
57			}
58
59			public function __invoke(ContainerInterface $container): HtmlElement
60			{
61			$config = $container->get('config');
62			$config = $this->options($config, $this->configId);
63
64			$htmlElement = new HtmlElement();
65
66			if (isset($config['escapeHtmlAttribute'])) {
67			$htmlElement->setEscapeHtmlAttribute($config['escapeHtmlAttribute']);
68			}
69
70			if (isset($config['escapeText'])) {
71			$htmlElement->setEscapeText($config['escapeText']);
72			}
73
74			return $htmlElement;
75			}
76
77			public function __construct(string $configId = 'default')
78			{
79			$this->configId = $configId;
80			}
81
82			public function dimensions(): iterable
83			{
84			return ['sake_htmlelement', 'view_helper'];
			0 ignored issues – show Bug Best Practice introduced 2017-08-03 20:06 UTC by Report Bug Copy Issue Report The return type of `return array('sake_htmlelement', 'view_helper');` (`string[]`) is incompatible with the return type declared by the interface `Interop\Config\RequiresConfig::dimensions` of type `Interop\Config\iterable`. 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...
85			}
86
87			public function defaultOptions(): iterable
88			{
89			return [
			0 ignored issues – show Bug Best Practice introduced 2017-08-03 20:06 UTC by Report Bug Copy Issue Report The return type of `return array('escapeHtml... 'escapeText' => true);` (`array<string,boolean>`) is incompatible with the return type declared by the interface `Interop\Config\ProvidesD...Options::defaultOptions` of type `Interop\Config\iterable`. 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...
90			'escapeHtmlAttribute' => true,
91			'escapeText' => true,
92			];
93			}
94			}
95

sandrokeil / HtmlElement

HtmlElementFactory::defaultOptions() A last analyzed 2017-08-04 19:17 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HtmlElementFactory::defaultOptions() A
last analyzed 2017-08-04 19:17 UTC