jkphl /
micrometa
| 1 | <?php |
||
| 49 | class PropertyList implements PropertyListInterface |
||
| 50 | { |
||
| 51 | /** |
||
| 52 | * Property values |
||
| 53 | * |
||
| 54 | * @var array[] |
||
| 55 | */ |
||
| 56 | protected $values = []; |
||
| 57 | /** |
||
| 58 | * Property names |
||
| 59 | * |
||
| 60 | * @var \stdClass[] |
||
| 61 | */ |
||
| 62 | protected $names = []; |
||
| 63 | /** |
||
| 64 | * Name cursor mapping |
||
| 65 | * |
||
| 66 | * @var int[] |
||
| 67 | */ |
||
| 68 | protected $nameToCursor = []; |
||
| 69 | /** |
||
| 70 | * Internal cursor |
||
| 71 | * |
||
| 72 | * @var int |
||
| 73 | */ |
||
| 74 | protected $cursor = 0; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Unset a property |
||
| 78 | * |
||
| 79 | * @param \stdClass|string $iri IRI |
||
| 80 | * @throws ErrorException |
||
| 81 | */ |
||
| 82 | 1 | public function offsetUnset($iri) |
|
| 83 | { |
||
| 84 | 1 | throw new ErrorException( |
|
| 85 | 1 | sprintf(ErrorException::CANNOT_UNSET_PROPERTY_STR, $iri), |
|
| 86 | 1 | ErrorException::CANNOT_UNSET_PROPERTY, |
|
| 87 | 1 | E_WARNING |
|
| 88 | ); |
||
| 89 | } |
||
| 90 | |||
| 91 | /** |
||
| 92 | * Return the number of properties |
||
| 93 | * |
||
| 94 | * @return int Number of properties |
||
| 95 | */ |
||
| 96 | 1 | public function count() |
|
| 97 | { |
||
| 98 | 1 | return count($this->values); |
|
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Return the current property values |
||
| 103 | * |
||
| 104 | * @return array Property values |
||
| 105 | */ |
||
| 106 | 7 | public function current() |
|
| 107 | { |
||
| 108 | 7 | return $this->values[$this->cursor]; |
|
| 109 | } |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Move forward to next element |
||
| 113 | */ |
||
| 114 | 7 | public function next() |
|
| 115 | { |
||
| 116 | 7 | ++$this->cursor; |
|
| 117 | 7 | } |
|
| 118 | |||
| 119 | /** |
||
| 120 | * Return the current IRI key |
||
| 121 | * |
||
| 122 | * @return \stdClass IRI key |
||
| 123 | */ |
||
| 124 | 7 | public function key() |
|
| 125 | { |
||
| 126 | 7 | return $this->names[$this->cursor]; |
|
|
1 ignored issue
–
show
|
|||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Checks if current position is valid |
||
| 131 | * |
||
| 132 | * @return boolean The current position is valid |
||
| 133 | */ |
||
| 134 | 15 | public function valid() |
|
| 135 | { |
||
| 136 | 15 | return isset($this->values[$this->cursor]); |
|
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Rewind the Iterator to the first element |
||
| 141 | */ |
||
| 142 | 15 | public function rewind() |
|
| 143 | { |
||
| 144 | 15 | $this->cursor = 0; |
|
| 145 | 15 | } |
|
| 146 | |||
| 147 | /** |
||
| 148 | * Add a property |
||
| 149 | * |
||
| 150 | * @param \stdClass $property Property |
||
| 151 | */ |
||
| 152 | 28 | public function add($property) |
|
| 166 | |||
| 167 | /** |
||
| 168 | * Return whether a property exists |
||
| 169 | * |
||
| 170 | * @param \stdClass|string $iri IRI |
||
| 171 | * @return boolean Property exists |
||
| 172 | */ |
||
| 173 | 28 | public function offsetExists($iri) |
|
| 184 | |||
| 185 | /** |
||
| 186 | * Get a particular property cursor by its profiled name |
||
| 187 | * |
||
| 188 | * @param \stdClass $iri IRI |
||
| 189 | * @return int Property cursor |
||
| 190 | * @throws OutOfBoundsException If the property name is unknown |
||
| 191 | */ |
||
| 192 | 23 | protected function getProfiledPropertyCursor($iri) |
|
| 193 | { |
||
| 194 | 23 | $iriStr = $iri->profile.$iri->name; |
|
| 195 | |||
| 196 | // If the property name is unknown |
||
| 197 | 23 | if (!isset($this->nameToCursor[$iriStr])) { |
|
| 198 | 23 | $this->handleUnknownName($iriStr); |
|
| 199 | } |
||
| 200 | |||
| 201 | 5 | return $this->nameToCursor[$iriStr]; |
|
| 202 | } |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Handle an unknown property name |
||
| 206 | * |
||
| 207 | * @param string $name Property name |
||
| 208 | * @throws OutOfBoundsException If the property name is unknown |
||
| 209 | */ |
||
| 210 | 31 | protected function handleUnknownName($name) |
|
| 217 | |||
| 218 | /** |
||
| 219 | * Get a particular property cursor by its name |
||
| 220 | * |
||
| 221 | * @param string $name Property name |
||
| 222 | * @return int Property cursor |
||
| 223 | */ |
||
| 224 | 9 | protected function getPropertyCursor($name) |
|
| 225 | { |
||
| 226 | // Run through all property names |
||
| 227 | 9 | foreach ($this->names as $cursor => $iri) { |
|
| 228 | 4 | if ($name === $iri->name) { |
|
| 229 | 4 | return $cursor; |
|
| 230 | } |
||
| 231 | } |
||
| 232 | |||
| 233 | 8 | return $this->handleUnknownName($name); |
|
| 234 | } |
||
| 235 | |||
| 236 | /** |
||
| 237 | * Set a particular property |
||
| 238 | * |
||
| 239 | * @param \stdClass|string $iri IRI |
||
| 240 | * @param array $value Property values |
||
| 241 | */ |
||
| 242 | 8 | public function offsetSet($iri, $value) |
|
| 251 | |||
| 252 | /** |
||
| 253 | * Get a particular property |
||
| 254 | * |
||
| 255 | * @param \stdClass|string $iri IRI |
||
| 256 | * @return array Property values |
||
| 257 | * @throws OutOfBoundsException If the property name is unknown |
||
| 258 | */ |
||
| 259 | 13 | public function &offsetGet($iri) |
|
| 266 | } |
||
| 267 |
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.