IndexListSelector::getValue() - Code Metrics - Smoren/array-view-php - Measure and Improve Code Quality continuously with Scrutinizer

IndexListSelector::getValue() A
last analyzed 2024-03-24 00:34 UTC

↳ Parent: IndexListSelector

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace Smoren\ArrayView\Selectors;

use Smoren\ArrayView\Exceptions\IndexError;
use Smoren\ArrayView\Interfaces\ArrayViewInterface;
use Smoren\ArrayView\Interfaces\IndexListSelectorInterface;
use Smoren\ArrayView\Views\ArrayIndexListView;

/**
 * Represents an index list selector that selects elements based on the provided array of indexes.
 *
 * ```php
 * $originalArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
 * $view = ArrayView::toView($originalArray);
 *
 * $selector = new IndexListSelector([0, 2, 4]);
 * print_r($view[$selector]); // [1, 3, 5]
 * print_r($view->subview($selector)->toArray()); // [1, 3, 5]
 * ```
 */
final class IndexListSelector implements IndexListSelectorInterface
{
    /**
     * @var array<int> The array of indexes to select elements from.
     */
    private array $value;

    /**
     * Creates a new IndexListSelector instance with the provided array of indexes.
     *
     * @param array<int>|ArrayViewInterface<int> $value The array of indexes or array view containing indexes.
     */
    public function __construct($value)
    {
        $this->value = \is_array($value) ? $value : $value->toArray();
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * Selects elements from the source array based on the index list.
     *
     * @template T The type of elements in the source array view.
     *
     * @param ArrayViewInterface<T> $source The source array view to select elements from.
     * @param bool|null $readonly Whether the selection should be read-only.
     *
     * @return ArrayIndexListView<T> The view containing the selected elements.
     *
     * {@inheritDoc}
     */
    public function select(ArrayViewInterface $source, ?bool $readonly = null): ArrayIndexListView
    {
        if (!$this->compatibleWith($source)) {
            throw new IndexError('Some indexes are out of range.');
        }

        return new ArrayIndexListView($source, $this->value, $readonly ?? $source->isReadonly());
    }

    /**
     * Checks if the selector is compatible with the given view.
     *
     * @template T View elements type.
     *
     * @param ArrayViewInterface<T> $view the view to check compatibility with.
     *
     * @return bool true if the element is compatible, false otherwise
     *
     * {@inheritDoc}
     */
    public function compatibleWith(ArrayViewInterface $view): bool
    {
        return \count($this->value) === 0 || \max($this->value) < \count($view) && \min($this->value) >= -\count($view);
    }

    /**
     * {@inheritDoc}
     */
    public function getValue(): array
    {
        return $this->value;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Smoren\ArrayView\Selectors;
6
7			use Smoren\ArrayView\Exceptions\IndexError;
8			use Smoren\ArrayView\Interfaces\ArrayViewInterface;
9			use Smoren\ArrayView\Interfaces\IndexListSelectorInterface;
10			use Smoren\ArrayView\Views\ArrayIndexListView;
11
12			/**
13			* Represents an index list selector that selects elements based on the provided array of indexes.
14			*
15			* ```php
16			* $originalArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
17			* $view = ArrayView::toView($originalArray);
18			*
19			* $selector = new IndexListSelector([0, 2, 4]);
20			* print_r($view[$selector]); // [1, 3, 5]
21			* print_r($view->subview($selector)->toArray()); // [1, 3, 5]
22			* ```
23			*/
24			final class IndexListSelector implements IndexListSelectorInterface
25			{
26			/**
27			* @var array<int> The array of indexes to select elements from.
28			*/
29			private array $value;
30
31			/**
32			* Creates a new IndexListSelector instance with the provided array of indexes.
33			*
34			* @param array<int>\|ArrayViewInterface<int> $value The array of indexes or array view containing indexes.
35			*/
36			public function __construct($value)
37			{
38			$this->value = \is_array($value) ? $value : $value->toArray();
			0 ignored issues – show Documentation Bug introduced 2024-03-10 18:29 UTC by Report Bug Copy Issue Report `is_array($value) ? $value : $value->toArray()` is of type `array<mixed,Smoren\ArrayView\Interfaces\T\|mixed>`, but the property `$value` was declared to be of type `integer[]`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
39			}
40
41			/**
42			* Selects elements from the source array based on the index list.
43			*
44			* @template T The type of elements in the source array view.
45			*
46			* @param ArrayViewInterface<T> $source The source array view to select elements from.
47			* @param bool\|null $readonly Whether the selection should be read-only.
48			*
49			* @return ArrayIndexListView<T> The view containing the selected elements.
50			*
51			* {@inheritDoc}
52			*/
53			public function select(ArrayViewInterface $source, ?bool $readonly = null): ArrayIndexListView
54			{
55			if (!$this->compatibleWith($source)) {
56			throw new IndexError('Some indexes are out of range.');
57			}
58
59			return new ArrayIndexListView($source, $this->value, $readonly ?? $source->isReadonly());
60			}
61
62			/**
63			* Checks if the selector is compatible with the given view.
64			*
65			* @template T View elements type.
66			*
67			* @param ArrayViewInterface<T> $view the view to check compatibility with.
68			*
69			* @return bool true if the element is compatible, false otherwise
70			*
71			* {@inheritDoc}
72			*/
73			public function compatibleWith(ArrayViewInterface $view): bool
74			{
75			return \count($this->value) === 0 \|\| \max($this->value) < \count($view) && \min($this->value) >= -\count($view);
76			}
77
78			/**
79			* {@inheritDoc}
80			*/
81			public function getValue(): array
82			{
83			return $this->value;
84			}
85			}
86

Smoren / array-view-php

IndexListSelector::getValue() A last analyzed 2024-03-24 00:34 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

IndexListSelector::getValue() A
last analyzed 2024-03-24 00:34 UTC