|
1
|
|
|
<?php |
|
2
|
|
|
namespace Fwlib\Html\Generator\Element; |
|
3
|
|
|
|
|
4
|
|
|
use Fwlib\Html\Generator\AbstractElement; |
|
5
|
|
|
use Fwlib\Html\Generator\ElementMode; |
|
6
|
|
|
|
|
7
|
|
|
/** |
|
8
|
|
|
* Radio input |
|
9
|
|
|
* |
|
10
|
|
|
* @copyright Copyright 2014-2015 Fwolf |
|
11
|
|
|
* @license http://www.gnu.org/licenses/lgpl.html LGPL-3.0+ |
|
12
|
|
|
*/ |
|
13
|
|
|
class Radio extends AbstractElement |
|
14
|
|
|
{ |
|
15
|
|
|
/** |
|
16
|
|
|
* @var string |
|
17
|
|
|
*/ |
|
18
|
|
|
protected $unknownValueTitle = 'Invalid Data'; |
|
19
|
|
|
|
|
20
|
|
|
|
|
21
|
|
|
/** |
|
22
|
|
|
* {@inheritdoc} |
|
23
|
|
|
* |
|
24
|
|
|
* Configs |
|
25
|
|
|
* - items: Value => title pair, value should not include whitespace. |
|
26
|
|
|
*/ |
|
27
|
|
|
protected function getDefaultConfigs() |
|
28
|
|
|
{ |
|
29
|
|
|
$configs = parent::getDefaultConfigs(); |
|
30
|
|
|
|
|
31
|
|
|
return array_merge($configs, [ |
|
|
|
|
|
|
32
|
|
|
'items' => [], |
|
33
|
|
|
]); |
|
34
|
|
|
} |
|
35
|
|
|
|
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* @return array |
|
39
|
|
|
*/ |
|
40
|
|
|
protected function getItems() |
|
41
|
|
|
{ |
|
42
|
|
|
return $this->getConfig('items'); |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* {@inheritdoc} |
|
48
|
|
|
* |
|
49
|
|
|
* @see http://html.cita.illinois.edu/nav/form/radio/ |
|
50
|
|
|
*/ |
|
51
|
|
|
protected function getOutputForEditMode() |
|
52
|
|
|
{ |
|
53
|
|
|
$items = $this->getItems(); |
|
54
|
|
|
|
|
55
|
|
|
$radioValue = $this->getValue(); |
|
56
|
|
|
|
|
57
|
|
|
$output = ''; |
|
58
|
|
|
$rawAttributes = $this->getRawAttributes(); |
|
59
|
|
|
|
|
60
|
|
|
foreach ($items as $value => $title) { |
|
61
|
|
|
$checked = ($radioValue == $value) ? " checked='checked'" : ''; |
|
62
|
|
|
$valueId = $this->getId("--$value"); |
|
63
|
|
|
$titleClass = $this->getTitleClass(); |
|
64
|
|
|
$titleId = $this->getTitleId($value); |
|
65
|
|
|
|
|
66
|
|
|
$nameHtml = trim($this->getNameHtml()); |
|
67
|
|
|
|
|
68
|
|
|
$output .= <<<TAG |
|
69
|
|
|
<input type='radio'{$this->getClassHtml()}{$this->getIdHtml($valueId)} |
|
70
|
|
|
{$nameHtml} value='{$value}'{$checked}{$rawAttributes} /> |
|
71
|
|
|
<label{$this->getClassHtml($titleClass)}{$this->getIdHtml($titleId)} |
|
72
|
|
|
for='{$valueId}'>{$title}</label> |
|
73
|
|
|
|
|
74
|
|
|
TAG; |
|
75
|
|
|
} |
|
76
|
|
|
|
|
77
|
|
|
$containerClass = $this->getClass('__container'); |
|
78
|
|
|
$containerId = $this->getId('__container'); |
|
79
|
|
|
$output = trim($output); |
|
80
|
|
|
$output = <<<TAG |
|
81
|
|
|
<fieldset{$this->getClassHtml($containerClass)}{$this->getIdHtml($containerId)}> |
|
82
|
|
|
$output |
|
83
|
|
|
</fieldset> |
|
84
|
|
|
TAG; |
|
85
|
|
|
|
|
86
|
|
|
return $output; |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* {@inheritdoc} |
|
92
|
|
|
*/ |
|
93
|
|
|
protected function getOutputForShowMode() |
|
94
|
|
|
{ |
|
95
|
|
|
$items = $this->getItems(); |
|
96
|
|
|
$radioValue = $this->getValue(); |
|
97
|
|
|
|
|
98
|
|
|
$title = array_key_exists($radioValue, $items) |
|
99
|
|
|
? $items[$radioValue] |
|
100
|
|
|
: $this->unknownValueTitle; |
|
101
|
|
|
|
|
102
|
|
|
$output = "<input type='hidden'" . |
|
103
|
|
|
$this->getIdHtml() . |
|
104
|
|
|
$this->getNameHtml() . |
|
105
|
|
|
$this->getValueHtml(ElementMode::EDIT) . |
|
106
|
|
|
$this->getRawAttributes() . |
|
107
|
|
|
" />\n" . |
|
108
|
|
|
"<span" . |
|
109
|
|
|
$this->getClassHtml($this->getTitleClass()) . |
|
110
|
|
|
$this->getIdHtml($this->getTitleId($radioValue)) . |
|
111
|
|
|
">" . |
|
112
|
|
|
$title . |
|
113
|
|
|
"</span>"; |
|
114
|
|
|
|
|
115
|
|
|
return $output; |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
|
|
119
|
|
|
/** |
|
120
|
|
|
* @return string |
|
121
|
|
|
*/ |
|
122
|
|
|
protected function getTitleClass() |
|
123
|
|
|
{ |
|
124
|
|
|
$class = $this->getClass(); |
|
125
|
|
|
|
|
126
|
|
|
$class = empty($class) ? '' : $class . '__title'; |
|
127
|
|
|
|
|
128
|
|
|
return $class; |
|
129
|
|
|
} |
|
130
|
|
|
|
|
131
|
|
|
|
|
132
|
|
|
/** |
|
133
|
|
|
* @param string $value |
|
134
|
|
|
* @return string |
|
135
|
|
|
*/ |
|
136
|
|
|
protected function getTitleId($value) |
|
137
|
|
|
{ |
|
138
|
|
|
$idStr = $this->getId(); |
|
139
|
|
|
|
|
140
|
|
|
$idStr = empty($idStr) ? '' : $idStr . "__title--$value"; |
|
141
|
|
|
|
|
142
|
|
|
return $idStr; |
|
143
|
|
|
} |
|
144
|
|
|
} |
|
145
|
|
|
|
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_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.