Apparat\Object\Domain\Model\Object\Revision

Complexity

Total Complexity

17

Size/Duplication

Total Lines	150
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	unserialize()	0	4	1
A	getRevision()	0	4	1
A	__construct()	0	13	2
A	isValidRevision()	0	4	3
A	current()	0	4	1
A	isCurrent()	0	4	1
A	serialize()	0	4	1
A	increment()	0	4	2
A	equals()	0	4	2
A	isDraft()	0	4	1
A	setDraft()	0	8	2

<?php

/**
 * apparat-object
 *
 * @category    Apparat
 * @package     Apparat\Object
 * @subpackage  Apparat\Object\Domain
 * @author      Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Object\Domain\Model\Object;

use Apparat\Object\Domain\Contract\SerializablePropertyInterface;

/**
 * Object revision
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain
 */
class Revision implements SerializablePropertyInterface
{
    /**
     * Current revision
     *
     * @var null
     */
    const CURRENT = null;
    /**
     * Object revision number
     *
     * @var int|null
     */
    protected $revision = null;
    /**
     * Draft revision
     *
     * @var bool
     */
    protected $draft = false;

    /**
     * Revision constructor
     *
     * @param int $revision Object revision number
     * @param bool $draft Draft revision
     */
    public function __construct($revision, $draft = false)
    {
        // If the revision number is invalid
        if (!self::isValidRevision($revision)) {
            throw new InvalidArgumentException(
                sprintf('Invalid object revision number "%s"', $revision),
                InvalidArgumentException::INVALID_OBJECT_REVISION
            );
        }

        $this->revision = $revision;
        $this->draft = boolval($draft);
    }

    /**
     * Test whether a revision number is valid
     *
     * @param int|NULL $revision Revision number
     * @return bool Is valid revision
     */
    public static function isValidRevision($revision)
    {
        return ($revision === self::CURRENT) || (is_int($revision) && ($revision >= 1));
    }

    /**
     * Return a current revision instance
     *
     * @param boolean $draft Draft mode
     * @return Revision Current revision instance
     */
    public static function current($draft = false)
    {
        return new static(self::CURRENT, $draft);
    }

    /**
     * Unserialize the string representation of this property
     *
     * @param string $str Serialized property
     * @return Revision Revision property
     */
    public static function unserialize($str)
    {
        return new static(intval($str));
    }

    /**
     * Test whether this is the current revision
     *
     * @return bool Is current revision
     */
    public function isCurrent()
    {
        return $this->revision === self::CURRENT;
    }

    /**
     * Serialize the property
     *
     * @return mixed Property serialization
     */
    public function serialize()
    {
        return $this->getRevision();
    }

    /**
     * Return the object revision number
     *
     * @return int|null Object revision number
     */
    public function getRevision()
    {
        return $this->revision;
    }

    /**
     * Return an incremented revision
     *
     * @return Revision Incremented revision
     */
    public function increment()
    {
        return ($this->revision === self::CURRENT) ? $this : new static($this->revision + 1);
    }

    /**
     * Compare this revision to a given one
     *
     * @param Revision $revision Comparison revision
     * @return bool This revision equals the given one
     */
    public function equals(Revision $revision)
    {
        return ($this->revision == $revision->getRevision()) && ($this->draft == $revision->isDraft());
    }

    /**
     * Return whether this is a draft revision
     *
     * @return bool Draft revision
     */
    public function isDraft()
    {
        return $this->draft;
    }

    /**
     * Enable / disable the draft flag
     *
     * @param boolean $draft Enable / disable the draft flag
     * @return Revision Self reference
     */
    public function setDraft($draft)
    {
        $draft = boolval($draft);
        if ($draft !== $this->draft) {
            return new static($this->revision, $draft);
        }
        return $this;
    }
}