1
|
|
|
<?php namespace nyx\console\input\parameter; |
2
|
|
|
|
3
|
|
|
// External dependencies |
4
|
|
|
use nyx\core; |
5
|
|
|
|
6
|
|
|
// Internal dependencies |
7
|
|
|
use nyx\console\input; |
8
|
|
|
|
9
|
|
|
/** |
10
|
|
|
* Input Values |
11
|
|
|
* |
12
|
|
|
* Base class for Input Argument and Option value collections. |
13
|
|
|
* |
14
|
|
|
* Those collections are bound by their definitions and as such parameters that are not defined cannot be set. |
15
|
|
|
* They can also not escape their definition, eg. a definition may only be set during construction to avoid |
16
|
|
|
* mismatches between the master and the bag definitions referenced in Values collections. |
17
|
|
|
* |
18
|
|
|
* @version 0.1.0 |
19
|
|
|
* @author Michal Chojnacki <[email protected]> |
20
|
|
|
* @copyright 2012-2017 Nyx Dev Team |
21
|
|
|
* @link https://github.com/unyx/nyx |
22
|
|
|
*/ |
23
|
|
|
abstract class Values extends core\collections\Map |
24
|
|
|
{ |
25
|
|
|
/** |
26
|
|
|
* @var Definitions The Definitions of the Parameters that can be present in this collection. |
27
|
|
|
*/ |
28
|
|
|
protected $definitions; |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* {@inheritdoc} |
32
|
|
|
* |
33
|
|
|
* @param Definitions $definition The Definitions of the Parameters that can be present in this collection. |
34
|
|
|
*/ |
35
|
|
|
public function __construct(Definitions $definition, $items = null) |
36
|
|
|
{ |
37
|
|
|
$this->definitions = $definition; |
38
|
|
|
|
39
|
|
|
parent::__construct($items); |
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* Returns the Definitions of the Parameters that can be present in this collection. |
44
|
|
|
* |
45
|
|
|
* @return Definitions |
46
|
|
|
*/ |
47
|
|
|
public function definitions() : Definitions |
48
|
|
|
{ |
49
|
|
|
return $this->definitions; |
50
|
|
|
} |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* {@inheritdoc} |
54
|
|
|
*/ |
55
|
|
|
public function set($name, $value) : core\collections\interfaces\Map |
56
|
|
|
{ |
57
|
|
|
if (!isset($name, $value)) { |
58
|
|
|
throw new \InvalidArgumentException('Input Values must be named and have a value that is not null.'); |
59
|
|
|
} |
60
|
|
|
|
61
|
|
|
$parameter = $this->assertIsDefined($name); |
62
|
|
|
|
63
|
|
|
// When dealing with a multi-value parameter, push the value into an array instead of just setting it, |
64
|
|
|
// unless it's an array itself (in which case it will override the currently set array). |
65
|
|
|
if ($parameter->getValue() instanceof input\values\Multiple && !is_array($value)) { |
66
|
|
|
$this->items[$name][] = $value; |
67
|
|
|
} else { |
68
|
|
|
$this->items[$name] = $value; |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
return $this; |
|
|
|
|
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* Finalizes the Collection, populating it with Parameters that have not been explicitly set, but |
76
|
|
|
* have defined default values. |
77
|
|
|
* |
78
|
|
|
* @return $this |
79
|
|
|
*/ |
80
|
|
|
public function finalize() : Values |
81
|
|
|
{ |
82
|
|
|
/* @var input\Parameter $parameter */ |
83
|
|
|
foreach ($this->definitions as $name => $parameter) { |
84
|
|
|
if (isset($this->items[$name])) { |
85
|
|
|
continue; |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
// In the case of Parameters which do not accept values (ie. optional flags), we explicitly default them |
89
|
|
|
// to a boolean false, opposed to a boolean true when they are actually set in input. |
90
|
|
|
$this->items[$name] = ($value = $parameter->getValue()) ? $value->getDefault() : false; |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
return $this; |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* Asserts a Parameter with the given name is defined for this collection and returns it. |
98
|
|
|
* |
99
|
|
|
* @param string $name The name of the Parameter. |
100
|
|
|
* @throws \OutOfBoundsException When no Parameter with the given name has been defined. |
101
|
|
|
* @return input\Parameter |
102
|
|
|
*/ |
103
|
|
|
protected function assertIsDefined(string $name) : input\Parameter |
104
|
|
|
{ |
105
|
|
|
/* @var input\Parameter $parameter */ |
106
|
|
|
if (!$parameter = $this->definitions->get($name)) { |
107
|
|
|
throw new \OutOfBoundsException("The parameter [$name] is not defined."); |
108
|
|
|
} |
109
|
|
|
|
110
|
|
|
return $parameter; |
111
|
|
|
} |
112
|
|
|
|
113
|
|
|
/** |
114
|
|
|
* {@inheritdoc} |
115
|
|
|
*/ |
116
|
|
|
protected function derive($items) : core\collections\interfaces\Collection |
117
|
|
|
{ |
118
|
|
|
return new static($this->definitions, $items); |
|
|
|
|
119
|
|
|
} |
120
|
|
|
} |
121
|
|
|
|
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.