Linna\DataMapper\DomainObjectAbstract

Complexity

Total Complexity

7

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	1	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__isset()	0	7	2
A	__get()	0	4	2
A	getId()	0	3	1
A	setId()	0	9	2

<?php

/**
 * Linna Framework.
 *
 * @author Sebastian Rapetti <sebastian.rapetti@alice.it>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\DataMapper;

use UnexpectedValueException;

/**
 * Abstract Class for Domain Object.
 */
abstract class DomainObjectAbstract implements DomainObjectInterface
{
    use DomainObjectTimeTrait;

    /**
     * @var int Read only object id on persistent storage.
     *
     * -1 means that the id is not set!
     */
    protected int $id = -1;

    /**
     * Get the id of the object (unique to the object type).
     *
     * <pre><code class="php">$object = new DomainObject($dependencies);
     *
     * $object->getId();
     * </code></pre>
     *
     * @return int Current object id.
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * Set the id for the object.
     *
     * <pre><code class="php">$object = new DomainObject($dependencies);
     *
     * $object->setId(5);
     * </code></pre>
     *
     * @param int $id New object id.
     *
     * @throws UnexpectedValueException If the id on the object is already set.
     *
     * @return int New object id.
     */
    public function setId(int $id): int
    {
        if ($this->id !== -1) {
            throw new UnexpectedValueException('ObjectId property is immutable.');
        }

        $this->id = $id;

        return $id;
    }

    /**
     * Return the value of a private or protected property.
     *
     * @param string $name
     *
     * @return mixed
     */
    public function __get(string $name)
    {
        if ($name === 'id') {
            return $this->id;
        }
    }

    /**
     * Return if a private or protected property exists.
     *
     * @param string $name
     *
     * @return bool
     */
    public function __isset(string $name)
    {
        if ($name === 'id') {
            return true;
        }

        return false;
    }
}