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']; |
|
|
|
|
85
|
|
|
} |
86
|
|
|
|
87
|
|
|
public function defaultOptions(): iterable |
88
|
|
|
{ |
89
|
|
|
return [ |
|
|
|
|
90
|
|
|
'escapeHtmlAttribute' => true, |
91
|
|
|
'escapeText' => true, |
92
|
|
|
]; |
93
|
|
|
} |
94
|
|
|
} |
95
|
|
|
|
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:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.