Equip\Data\Traits\ProtectedValueObjectTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__isset()	0	4	1
A	__get()	0	4	1
A	__set()	0	7	1
A	__unset()	0	7	1

<?php

namespace Equip\Data\Traits;

use RuntimeException;

trait ProtectedValueObjectTrait
{
    /**
     * Checks if a property is defined in the object
     *
     * This will return `false` if the value is `null`! To check if a value
     * exists in the object, use `has()`.
     *
     * @param string $key
     *
     * @return boolean
     */
    public function __isset($key)
    {
        return isset($this->$key);
    }

    /**
     * Allow read access to immutable object properties
     *
     * @param string $key
     *
     * @return mixed
     */
    public function __get($key)
    {
        return $this->$key;
    }

    /**
     * Protects against the object being modified
     *
     * @param string $key
     * @param mixed  $value
     *
     * @return void
     *
     * @throws \RuntimeException
     */
    public function __set($key, $value)

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

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

    {
        throw new RuntimeException(sprintf(
            'Modification of immutable object `%s` is not allowed',
            get_class($this)
        ));
    }

    /**
     * Protects against the object being modified
     *
     * @param string $key
     *
     * @return void
     *
     * @throws \RuntimeException
     */
    public function __unset($key)

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

    {
        throw new RuntimeException(sprintf(
            'Modification of immutable object `%s` is not allowed',
            get_class($this)
        ));
    }
}