Smoren\ArrayView\Traits\ArrayViewAccessTrait

Complexity

Total Complexity

21

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
B	offsetGet()	0	21	7
A	offsetExists()	0	15	5
B	offsetSet()	0	30	8
A	offsetUnset()	0	3	1

<?php

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\SliceSelector;
use Smoren\ArrayView\Structs\Slice;

/**
 * @template T
 */
trait ArrayViewAccessTrait
{
    /**
     * @param numeric|string|ArraySelectorInterface $offset

The type Smoren\ArrayView\Traits\numeric was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return bool
     *
     * {@inheritDoc}
     */
    public function offsetExists($offset): bool
    {
        if (\is_numeric($offset)) {
            return $this->numericOffsetExists($offset);

It seems like numericOffsetExists() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if (\is_string($offset) && Slice::isSlice($offset)) {
            return true;
        }

        if ($offset instanceof ArraySelectorInterface) {
            return true;
        }

        return false;
    }

    /**
     * @param numeric|string|ArraySelectorInterface $offset
     *
     * @return T|array<T>
     *
     * {@inheritDoc}
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($offset)
    {
        /** @var mixed $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))];

It seems like convertIndex() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if (\is_string($offset) && Slice::isSlice($offset)) {
            return $this->subview(new SliceSelector($offset))->toArray();

It seems like subview() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($offset instanceof ArraySelectorInterface) {
            return $this->subview($offset)->toArray();
        }

        $strOffset = \is_scalar($offset) ? \strval($offset) : \gettype($offset);
        throw new KeyError("Invalid key: \"{$strOffset}\".");
    }

    /**
     * @param numeric|string|ArraySelectorInterface $offset
     * @param T|array<T>|ArrayViewInterface<T> $value

The type Smoren\ArrayView\Traits\T was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return void
     *
     * {@inheritDoc}
     */
    public function offsetSet($offset, $value): void
    {
        /** @var mixed $offset */
        if ($this->isReadonly()) {

It seems like isReadonly() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            throw new ReadonlyError("Cannot modify a readonly view.");
        }

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

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

The property source does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            return;
        }

        if (\is_string($offset) && Slice::isSlice($offset)) {
            /** @var array<T>|ArrayViewInterface<T> $value */
            $this->subview(new SliceSelector($offset))->set($value);
            return;
        }

        if ($offset instanceof ArraySelectorInterface) {
            $this->subview($offset)->set($value);
            return;
        }

        $strOffset = \is_scalar($offset) ? \strval($offset) : \gettype($offset);
        throw new KeyError("Invalid key: \"{$strOffset}\".");
    }

    /**
     * @param numeric|string|ArraySelectorInterface $offset
     *
     * @return void
     *
     * @throws NotSupportedError
     *
     * {@inheritDoc}
     */
    public function offsetUnset($offset): void

The parameter $offset is not used and could be removed.

    {
        throw new NotSupportedError();
    }
}