simondeeley\Helpers\ImmutableArrayHelperMethods

Complexity

Total Complexity

2

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	offsetUnset()	0	3	1
A	offsetSet()	0	3	1

<?php
declare(strict_types=1);
/**
 * This file is part of the Type package.
 * For the full copyright information please view the LICENCE file that was
 * distributed with this package.
 *
 * @copyright Simon Deeley 2017
 */

namespace simondeeley\Helpers;

use simondeeley\Exceptions\ImmutableMethodCallException;

/**
 * Helper trait to implement immutable arrays
 *
 * Implements two basic methods to prevent accidental or implicit modification
 * of an arrays properties.
 *
 * @author Simon Deeley <s.deeley@icloud.com>
 */
trait ImmutableArrayHelperMethods
{
    /**
     * Prevent implicit setting of properties
     *
     * @see http://php.net/manual/en/arrayaccess.offsetset.php
     *
     * @param string $property - Property name to set
     * @param mixed $value - Mixed value to set property to
     * @return void
     * @throws ImmutableMethodCallException - Always throws an exception
     */
    final public function offsetSet($property, $value)

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

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

    {
        throw new ImmutableMethodCallException;
    }

    /**
     * Prevent implicit unsetting of properties
     *
     * @see http://php.net/manual/en/arrayaccess.offsetunset.php
     *
     * @param string $property - Property name to unset
     * @return void
     * @throws ImmutableMethodCallException - Always throws an exception
     */
    final public function offsetUnset($property)

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

    {
        throw new ImmutableMethodCallException;
    }
}