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

ArrayViewAccessTrait::toSelector() B
last analyzed 2024-03-24 00:34 UTC

↳ Parent: ArrayViewAccessTrait
Complexity

Conditions	10
Paths	10
Size

Total Lines	26
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	12
c	0
b	0
f	0
dl	0
loc	26
rs	7.6666
cc	10
nc	10
nop	1
How to fix Complexity

<?php

declare(strict_types=1);

namespace Smoren\ArrayView\Traits;

use Smoren\ArrayView\Exceptions\IndexError;
use Smoren\ArrayView\Exceptions\KeyError;
use Smoren\ArrayView\Exceptions\NotSupportedError;
use Smoren\ArrayView\Exceptions\ReadonlyError;
use Smoren\ArrayView\Interfaces\ArraySelectorInterface;
use Smoren\ArrayView\Interfaces\ArrayViewInterface;
use Smoren\ArrayView\Selectors\IndexListSelector;
use Smoren\ArrayView\Selectors\MaskSelector;
use Smoren\ArrayView\Selectors\SliceSelector;
use Smoren\ArrayView\Structs\Slice;
use Smoren\ArrayView\Util;

/**
 * Trait providing methods for accessing elements in ArrayView object.
 *
 * The trait implements methods for accessing, retrieving, setting,
 * and unsetting elements in the ArrayView object.
 *
 * @template T Type of ArrayView values.
 * @template S of string|array<int|bool>|ArrayViewInterface<int|bool>|ArraySelectorInterface Selector type.
 */
trait ArrayViewAccessTrait
{
    /**
     * Check if the specified offset exists in the ArrayView object.
     *
     * ```php
     * $source = [1, 2, 3, 4, 5];
     * $view = ArrayView::toView($source);
     *
     * isset($view[0]); // true
     * isset($view[-1]); // true
     * isset($view[10]); // false
     *
     * isset($view[new SliceSelector('::2')]); // true
     * isset($view[new IndexListSelector([0, 2, 4])]); // true
     * isset($view[new IndexListSelector([0, 2, 10])]); // false
     * isset($view[new MaskSelector([true, true, false, false, true])]); // true
     * isset($view[new MaskSelector([true, true, false, false, true, true])]); // false
     *
     * isset($view['::2']); // true
     * isset($view[[0, 2, 4]]); // true
     * isset($view[[0, 2, 10]]); // false
     * isset($view[[true, true, false, false, true]]); // true
     * isset($view[[true, true, false, false, true, true]]); // false
     * ```
     *
     * @param numeric|S $offset The offset to check.
filter:
    dependency_paths: ["lib/*"]
     *
     * @return bool
     *
     * {@inheritDoc}
     */
    public function offsetExists($offset): bool
    {
        if (\is_numeric($offset)) {

            return $this->numericOffsetExists($offset);
        }

        try {
            return $this->toSelector($offset)->compatibleWith($this);
            return $this->toSelector($offset)->compatibleWith(/** @scrutinizer ignore-type */ $this);
        } catch (KeyError $e) {
            return false;
        }
    }

    /**
     * Get the value at the specified offset in the ArrayView object.
     *
     * ```php
     * $source = [1, 2, 3, 4, 5];
     * $view = ArrayView::toView($source);
     *
     * $view[0]; // 1
     * $view[-1]; // 5
     *
     * $view[new SliceSelector('::2')]; // [1, 3, 5]
     * $view[new IndexListSelector([0, 2, 4])]; // [1, 3, 5]
     * $view[new MaskSelector([true, true, false, false, true])]; // [1, 2, 5]
     *
     * $view['::2']; // [1, 3, 5]
     * $view[[0, 2, 4]]; // [1, 3, 5]
     * $view[[true, true, false, false, true]]; // [1, 2, 5]
     * ```
     *
     * @param numeric|S $offset The offset to get the value at.
     *
     * @return T|array<T> The value at the specified offset.
     *
     * @throws IndexError if the offset is out of range.
     * @throws KeyError if the key is invalid.
     *
     * {@inheritDoc}
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($offset)
    {
        if (\is_numeric($offset)) {

            if (!$this->numericOffsetExists($offset)) {
                throw new IndexError("Index {$offset} is out of range.");
            }
            return $this->source[$this->convertIndex(\intval($offset))];
        }

        return $this->subview($this->toSelector($offset))->toArray();
        return $this->/** @scrutinizer ignore-call */ subview($this->toSelector($offset))->toArray();
    }

    /**
     * Set the value at the specified offset in the ArrayView object.
     *
     * ```php
     * $source = [1, 2, 3, 4, 5];
     * $view = ArrayView::toView($source);
     *
     * $view[0] = 11;
     * $view[-1] = 55;
     *
     * $source; // [11, 2, 3, 4, 55]
     *
     * $source = [1, 2, 3, 4, 5];
     * $view = ArrayView::toView($source);
     *
     * $view[new SliceSelector('::2')] = [11, 33, 55];
     * $source; // [11, 2, 33, 4, 55]
     *
     * $view[new IndexListSelector([1, 3])] = [22, 44];
     * $source; // [11, 22, 33, 44, 55]
     *
     * $view[new MaskSelector([true, false, false, false, true])] = [111, 555];
     * $source; // [111, 22, 33, 44, 555]
     *
     * $source = [1, 2, 3, 4, 5];
     * $view = ArrayView::toView($source);
     *
     * $view['::2'] = [11, 33, 55];
     * $source; // [11, 2, 33, 4, 55]
     *
     * $view[[1, 3]] = [22, 44];
     * $source; // [11, 22, 33, 44, 55]
     *
     * $view[[true, false, false, false, true]] = [111, 555];
     * $source; // [111, 22, 33, 44, 555]
     * ```
     *
     * @param numeric|S $offset The offset to set the value at.
     * @param T|array<T>|ArrayViewInterface<T> $value The value to set.
filter:
    dependency_paths: ["lib/*"]
     *
     * @return void
     *
     * @throws IndexError if the offset is out of range.
     * @throws KeyError if the key is invalid.
     * @throws ReadonlyError if the object is readonly.
     *
     * {@inheritDoc}
     */
    public function offsetSet($offset, $value): void
    {
        if ($this->isReadonly()) {
        if ($this->/** @scrutinizer ignore-call */ isReadonly()) {
            throw new ReadonlyError("Cannot modify a readonly view.");
        }

        if (!\is_numeric($offset)) {

            $this->subview($this->toSelector($offset))->set($value);
            return;
        }

        if (!$this->numericOffsetExists($offset)) {
            throw new IndexError("Index {$offset} is out of range.");
        }

        // @phpstan-ignore-next-line
        $this->source[$this->convertIndex(\intval($offset))] = $value;
    }

    /**
     * Unset the value at the specified offset in the array-like object.
     *
     * @param numeric|S $offset The offset to unset the value at.
     *
     * @return void
     *
     * @throws NotSupportedError always.
     *
     * {@inheritDoc}
     */
    public function offsetUnset($offset): void
    public function offsetUnset(/** @scrutinizer ignore-unused */ $offset): void
    {
        throw new NotSupportedError();
    }

    /**
     * Converts array to selector.
     *
     * @param S $input value to convert.
     *
     * @return ArraySelectorInterface
     */
    protected function toSelector($input): ArraySelectorInterface
    {
        if ($input instanceof ArraySelectorInterface) {
            return $input;
        }

        if (\is_string($input) && Slice::isSlice($input)) {
            return new SliceSelector($input);
        }

        if ($input instanceof ArrayViewInterface) {
            $input = $input->toArray();
        }

        if (!\is_array($input) || !Util::isArraySequential($input)) {
            $strOffset = \is_scalar($input) ? \strval($input) : \gettype($input);
            throw new KeyError("Invalid key: \"{$strOffset}\".");
        }

        if (\count($input) > 0 && \is_bool($input[0])) {
            /** @var array<bool> $input */
            return new MaskSelector($input);
        }

        /** @var array<int> $input */
        return new IndexListSelector($input);
    }
}

Smoren / array-view-php

ArrayViewAccessTrait::toSelector() B last analyzed 2024-03-24 00:34 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

ArrayViewAccessTrait::toSelector() B
last analyzed 2024-03-24 00:34 UTC
