Smoren /
array-view-php
| Total Complexity | 64 |
| Total Lines | 325 |
| Duplicated Lines | 0 % |
| Changes | 4 | ||
| Bugs | 2 | Features | 0 |
Complex classes like ArrayView often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ArrayView, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 26 | class ArrayView implements ArrayViewInterface |
||
| 27 | { |
||
| 28 | /** |
||
| 29 | * @var array<T>|ArrayViewInterface<T> |
||
| 30 | */ |
||
| 31 | protected $source; |
||
| 32 | /** |
||
| 33 | * @var bool |
||
| 34 | */ |
||
| 35 | protected bool $readonly; |
||
| 36 | /** |
||
| 37 | * @var ArrayViewInterface<T>|null |
||
| 38 | */ |
||
| 39 | protected ?ArrayViewInterface $parentView; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * {@inheritDoc} |
||
| 43 | */ |
||
| 44 | public static function toView(&$source, ?bool $readonly = null): ArrayViewInterface |
||
| 45 | { |
||
| 46 | if (!($source instanceof ArrayViewInterface)) { |
||
| 47 | return new ArrayView($source, $readonly); |
||
| 48 | } |
||
| 49 | |||
| 50 | if (!$source->isReadonly() && $readonly) { |
||
| 51 | return new ArrayView($source, $readonly); |
||
| 52 | } |
||
| 53 | |||
| 54 | return $source; |
||
| 55 | } |
||
| 56 | |||
| 57 | /** |
||
| 58 | * {@inheritDoc} |
||
| 59 | */ |
||
| 60 | public static function toUnlinkedView($source, ?bool $readonly = null): ArrayViewInterface |
||
| 61 | { |
||
| 62 | return static::toView($source, $readonly); |
||
| 63 | } |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @param array<T>|ArrayViewInterface<T> $source |
||
| 67 | * @param bool|null $readonly |
||
| 68 | * @throws ReadonlyError |
||
| 69 | */ |
||
| 70 | public function __construct(&$source, ?bool $readonly = null) |
||
| 71 | { |
||
| 72 | if (is_array($source) && !Util::isArraySequential($source)) { |
||
| 73 | throw new ValueError('Cannot create view for non-sequential array.'); |
||
| 74 | } |
||
| 75 | |||
| 76 | $this->source = &$source; |
||
| 77 | $this->readonly = $readonly ?? (($source instanceof ArrayViewInterface) ? $source->isReadonly() : false); |
||
|
introduced
by
|
|||
| 78 | $this->parentView = ($source instanceof ArrayViewInterface) ? $source : null; |
||
| 79 | |||
| 80 | if (($source instanceof ArrayViewInterface) && $source->isReadonly() && !$this->isReadonly()) { |
||
| 81 | throw new ReadonlyError("Cannot create non-readonly view for readonly source."); |
||
| 82 | } |
||
| 83 | } |
||
| 84 | |||
| 85 | /** |
||
| 86 | * {@inheritDoc} |
||
| 87 | */ |
||
| 88 | public function toArray(): array |
||
| 89 | { |
||
| 90 | return [...$this]; |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * {@inheritDoc} |
||
| 95 | */ |
||
| 96 | public function filter(callable $predicate): ArrayViewInterface |
||
| 97 | { |
||
| 98 | return $this->is($predicate)->select($this); |
||
| 99 | } |
||
| 100 | |||
| 101 | /** |
||
| 102 | * {@inheritDoc} |
||
| 103 | */ |
||
| 104 | public function is(callable $predicate): MaskSelectorInterface |
||
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * {@inheritDoc} |
||
| 112 | */ |
||
| 113 | public function subview($selector, bool $readonly = null): ArrayViewInterface |
||
| 114 | { |
||
| 115 | return is_string($selector) |
||
| 116 | ? (new SliceSelector($selector))->select($this, $readonly) |
||
| 117 | : $selector->select($this, $readonly); |
||
| 118 | } |
||
| 119 | |||
| 120 | /** |
||
| 121 | * @return ArrayView<T> |
||
| 122 | * |
||
| 123 | * {@inheritDoc} |
||
| 124 | */ |
||
| 125 | public function apply(callable $mapper): self |
||
| 126 | { |
||
| 127 | for ($i = 0; $i < \count($this); $i++) { |
||
| 128 | /** @var T $item */ |
||
| 129 | $item = $this[$i]; |
||
| 130 | $this[$i] = $mapper($item, $i); |
||
| 131 | } |
||
| 132 | return $this; |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * @template U |
||
| 137 | * |
||
| 138 | * @param array<U>|ArrayViewInterface<U> $data |
||
| 139 | * @param callable(T, U, int): T $mapper |
||
| 140 | * |
||
| 141 | * @return ArrayView<T> |
||
| 142 | * |
||
| 143 | * {@inheritDoc} |
||
| 144 | */ |
||
| 145 | public function applyWith($data, callable $mapper): self |
||
| 146 | { |
||
| 147 | [$dataSize, $thisSize] = [\count($data), \count($this)]; |
||
| 148 | if ($dataSize !== $thisSize) { |
||
| 149 | throw new LengthError("Length of values array not equal to view length ({$dataSize} != {$thisSize})."); |
||
| 150 | } |
||
| 151 | |||
| 152 | $dataView = ArrayView::toView($data); |
||
| 153 | |||
| 154 | for ($i = 0; $i < \count($this); $i++) { |
||
| 155 | /** @var T $lhs */ |
||
| 156 | $lhs = $this[$i]; |
||
| 157 | /** @var U $rhs */ |
||
| 158 | $rhs = $dataView[$i]; |
||
| 159 | $this[$i] = $mapper($lhs, $rhs, $i); |
||
| 160 | } |
||
| 161 | |||
| 162 | return $this; |
||
| 163 | } |
||
| 164 | |||
| 165 | /** |
||
| 166 | * {@inheritDoc} |
||
| 167 | * |
||
| 168 | * @return ArrayView<T> |
||
| 169 | */ |
||
| 170 | public function set($newValues): self |
||
| 171 | { |
||
| 172 | if (!\is_array($newValues) && !($newValues instanceof ArrayViewInterface)) { |
||
| 173 | for ($i = 0; $i < \count($this); $i++) { |
||
| 174 | $this[$i] = $newValues; |
||
| 175 | } |
||
| 176 | return $this; |
||
| 177 | } |
||
| 178 | |||
| 179 | [$dataSize, $thisSize] = [\count($newValues), \count($this)]; |
||
| 180 | if ($dataSize !== $thisSize) { |
||
| 181 | throw new LengthError("Length of values array not equal to view length ({$dataSize} != {$thisSize})."); |
||
| 182 | } |
||
| 183 | |||
| 184 | $newValuesView = ArrayView::toView($newValues); |
||
| 185 | |||
| 186 | for ($i = 0; $i < \count($this); $i++) { |
||
| 187 | // @phpstan-ignore-next-line |
||
| 188 | $this[$i] = $newValuesView[$i]; |
||
| 189 | } |
||
| 190 | |||
| 191 | return $this; |
||
| 192 | } |
||
| 193 | |||
| 194 | /** |
||
| 195 | * @return \Generator<int, T> |
||
| 196 | */ |
||
| 197 | public function getIterator(): \Generator |
||
| 198 | { |
||
| 199 | for ($i = 0; $i < \count($this); $i++) { |
||
| 200 | /** @var T $item */ |
||
| 201 | $item = $this[$i]; |
||
| 202 | yield $item; |
||
| 203 | } |
||
| 204 | } |
||
| 205 | |||
| 206 | /** |
||
| 207 | * @return bool |
||
| 208 | */ |
||
| 209 | public function isReadonly(): bool |
||
| 212 | } |
||
| 213 | |||
| 214 | /** |
||
| 215 | * @param numeric|string|ArraySelectorInterface $offset |
||
| 216 | * @return bool |
||
| 217 | */ |
||
| 218 | public function offsetExists($offset): bool |
||
| 233 | } |
||
| 234 | |||
| 235 | /** |
||
| 236 | * @param numeric|string|ArraySelectorInterface $offset |
||
| 237 | * @return T|array<T> |
||
| 238 | */ |
||
| 239 | #[\ReturnTypeWillChange] |
||
| 240 | public function offsetGet($offset) |
||
| 241 | { |
||
| 242 | /** @var mixed $offset */ |
||
| 243 | if (\is_numeric($offset)) { |
||
| 244 | if (!$this->numericOffsetExists($offset)) { |
||
| 245 | throw new IndexError("Index {$offset} is out of range."); |
||
| 246 | } |
||
| 247 | return $this->source[$this->convertIndex(\intval($offset))]; |
||
| 248 | } |
||
| 249 | |||
| 250 | if (\is_string($offset) && Slice::isSlice($offset)) { |
||
| 251 | return $this->subview(new SliceSelector($offset))->toArray(); |
||
| 252 | } |
||
| 253 | |||
| 254 | if ($offset instanceof ArraySelectorInterface) { |
||
| 255 | return $this->subview($offset)->toArray(); |
||
| 256 | } |
||
| 257 | |||
| 258 | $strOffset = \is_scalar($offset) ? \strval($offset) : \gettype($offset); |
||
| 259 | throw new KeyError("Invalid key: \"{$strOffset}\"."); |
||
| 260 | } |
||
| 261 | |||
| 262 | /** |
||
| 263 | * @param numeric|string|ArraySelectorInterface $offset |
||
| 264 | * @param T|array<T>|ArrayViewInterface<T> $value |
||
| 265 | * @return void |
||
| 266 | */ |
||
| 267 | public function offsetSet($offset, $value): void |
||
| 268 | { |
||
| 269 | /** @var mixed $offset */ |
||
| 270 | if ($this->isReadonly()) { |
||
| 271 | throw new ReadonlyError("Cannot modify a readonly view."); |
||
| 272 | } |
||
| 273 | |||
| 274 | if (\is_numeric($offset)) { |
||
| 275 | if (!$this->numericOffsetExists($offset)) { |
||
| 276 | throw new IndexError("Index {$offset} is out of range."); |
||
| 277 | } |
||
| 278 | |||
| 279 | // @phpstan-ignore-next-line |
||
| 280 | $this->source[$this->convertIndex(\intval($offset))] = $value; |
||
| 281 | return; |
||
| 282 | } |
||
| 283 | |||
| 284 | if (\is_string($offset) && Slice::isSlice($offset)) { |
||
| 285 | /** @var array<T>|ArrayViewInterface<T> $value */ |
||
| 286 | $this->subview(new SliceSelector($offset))->set($value); |
||
| 287 | return; |
||
| 288 | } |
||
| 289 | |||
| 290 | if ($offset instanceof ArraySelectorInterface) { |
||
| 291 | $this->subview($offset)->set($value); |
||
| 292 | return; |
||
| 293 | } |
||
| 294 | |||
| 295 | $strOffset = \is_scalar($offset) ? \strval($offset) : \gettype($offset); |
||
| 296 | throw new KeyError("Invalid key: \"{$strOffset}\"."); |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * @param numeric|string|ArraySelectorInterface $offset |
||
| 301 | * @return void |
||
| 302 | * @throws NotSupportedError |
||
| 303 | */ |
||
| 304 | public function offsetUnset($offset): void |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * @return int |
||
| 311 | */ |
||
| 312 | public function count(): int |
||
| 315 | } |
||
| 316 | |||
| 317 | protected function getParentSize(): int |
||
| 322 | } |
||
| 323 | |||
| 324 | /** |
||
| 325 | * @param int $i |
||
| 326 | * @return int |
||
| 327 | */ |
||
| 328 | protected function convertIndex(int $i): int |
||
| 329 | { |
||
| 330 | return Util::normalizeIndex($i, \count($this->source)); |
||
| 331 | } |
||
| 332 | |||
| 333 | /** |
||
| 334 | * @param numeric $offset |
||
| 335 | * @return bool |
||
| 336 | */ |
||
| 337 | private function numericOffsetExists($offset): bool |
||
| 351 | } |
||
| 352 | } |
||
| 353 |
Loading history...