FigTree\Config\Concerns\ArrayAccessData

Complexity

Total Complexity

6

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetGet()	0	3	1
A	getIterator()	0	3	1
A	offsetExists()	0	3	1
A	offsetUnset()	0	3	1
A	toArray()	0	3	1
A	offsetSet()	0	3	1

<?php

namespace FigTree\Config\Concerns;

use ArrayIterator;
use Traversable;
use FigTree\Config\Exceptions\{
	ReadOnlyException,
};

trait ArrayAccessData
{
	protected array $data = [];

	/**
	 * Magic method to handle key_exists/isset checks of an array value on the object.
	 *
	 * @param string|int $offset
	 *
	 * @return boolean
	 */
	public function offsetExists($offset): bool
	{
		return key_exists($offset, $this->data);
	}

	/**
	 * Magic method to handle retrieval of an array value on the object.
	 *
	 * @param string|int $offset
	 *
	 * @return mixed
	 */
	public function offsetGet($offset)
	{
		return $this->data[$offset] ?? null;
	}

	/**
	 * Magic method to handle modification of an array value on the object.
	 *
	 * @param string|int $offset
	 * @param mixed $value
	 *
	 * @return void
	 *
	 * @throws \FigTree\Config\Exceptions\ReadOnlyException
	 */
	public function offsetSet($offset, $value): void

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

	{
		throw new ReadOnlyException($offset);
	}

	/**
	 * Magic method to handle removal of an array value on the object.
	 *
	 * @param string|int $offset
	 *
	 * @return void
	 *
	 * @throws \FigTree\Config\Exceptions\ReadOnlyException
	 */
	public function offsetUnset($offset): void
	{
		throw new ReadOnlyException($offset);
	}

	/**
	 * Convert the object into an array.
	 *
	 * @return array
	 */
	public function toArray(): array
	{
		return $this->data;
	}

	/**
	 * Retrieve an external iterator.
	 *
	 * @return \Traversable
	 */
	public function getIterator(): Traversable
	{
		return new ArrayIterator($this->data);
	}
}