Charcoal\Object\RevisionableTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	192
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	setRevisionEnabled()	0	5	1
A	createRevisionObject()	0	6	1
A	setObjectRevisionClass()	0	11	2
A	getRevisionEnabled()	0	4	1
A	getObjectRevisionClass()	0	4	1
A	objectRevisionClass()	0	4	1
A	generateRevision()	0	11	2
A	latestRevision()	0	7	1
A	revisionNum()	0	7	1
A	allRevisions()	0	17	2
A	revertToRevision()	0	23	4
	modelFactory()	0	1	?
	metadata()	0	1	?

<?php

namespace Charcoal\Object;

use InvalidArgumentException;

// From 'charcoal-core'
use Charcoal\Loader\CollectionLoader;

// From 'charcoal-object'
use Charcoal\Object\ObjectRevision;
use Charcoal\Object\ObjectRevisionInterface;

/**
 *
 */
trait RevisionableTrait
{
    /**
     * @var boolean $revisionEnabled
     */
    protected $revisionEnabled = true;

    /**
     * The class name of the object revision model.
     *
     * Must be a fully-qualified PHP namespace and an implementation of
     * {@see \Charcoal\Object\ObjectRevisionInterface}. Used by the model factory.
     *
     * @var string
     */
    private $objectRevisionClass = ObjectRevision::class;

    /**
     * @param  boolean $enabled The (revision) enabled flag.
     * @return RevisionableInterface Chainable
     */
    public function setRevisionEnabled($enabled)
    {
        $this->revisionEnabled = !!$enabled;
        return $this;
    }

    /**
     * @return boolean
     */
    public function getRevisionEnabled()
    {
        return $this->revisionEnabled;
    }

    /**
     * Create a revision object.
     *
     * @return ObjectRevisionInterface
     */
    public function createRevisionObject()
    {
        $rev = $this->modelFactory()->create($this->getObjectRevisionClass());

        return $rev;
    }

    /**
     * Set the class name of the object revision model.
     *
     * @param  string $className The class name of the object revision model.
     * @throws InvalidArgumentException If the class name is not a string.
     * @return AbstractPropertyDisplay Chainable
     */
    protected function setObjectRevisionClass($className)
    {
        if (!is_string($className)) {
            throw new InvalidArgumentException(
                'Route class name must be a string.'
            );
        }

        $this->objectRevisionClass = $className;
        return $this;
    }

    /**
     * Retrieve the class name of the object revision model.
     *
     * @return string
     */
    public function getObjectRevisionClass()
    {
        return $this->objectRevisionClass;
    }

    /**
     * Alias of {@see self::getObjectRevisionClass()}.
     *
     * @return string
     */
    public function objectRevisionClass()
    {
        return $this->getObjectRevisionClass();
    }

    /**
     * @see \Charcoal\Object\ObjectRevision::create_fromObject()
     * @return ObjectRevision
     */
    public function generateRevision()
    {
        $rev = $this->createRevisionObject();

        $rev->createFromObject($this);
        if (!empty($rev->getDataDiff())) {
            $rev->save();
        }

        return $rev;
    }

    /**
     * @see \Charcoal\Object\ObejctRevision::lastObjectRevision
     * @return ObjectRevision
     */
    public function latestRevision()
    {
        $rev = $this->createRevisionObject();
        $rev = $rev->lastObjectRevision($this);

        return $rev;
    }

    /**
     * @see \Charcoal\Object\ObejctRevision::objectRevisionNum
     * @param  integer $revNum The revision number.
     * @return ObjectRevision
     */
    public function revisionNum($revNum)
    {
        $rev = $this->createRevisionObject();
        $rev = $rev->objectRevisionNum($this, intval($revNum));

        return $rev;
    }

    /**
     * Retrieves all revisions for the current objet
     *
     * @param  callable $callback Optional object callback.
     * @return array
     */
    public function allRevisions(callable $callback = null)
    {
        $loader = new CollectionLoader([
            'logger'  => $this->logger,

The property logger does not exist. Did you maybe forget to declare it?

            'factory' => $this->modelFactory(),
        ]);
        $loader->setModel($this->createRevisionObject());

$this->createRevisionObject() is of type object<Charcoal\Object\ObjectRevisionInterface>, but the function expects a string|object<Charcoal\Model\ModelInterface>.

        $loader->addFilter('targetType', $this->objType());

It seems like objType() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $loader->addFilter('targetId', $this->id());

It seems like id() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $loader->addOrder('revTs', 'desc');
        if ($callback !== null) {
            $loader->setCallback($callback);
        }
        $revisions = $loader->load();

        return $revisions->objects();
    }

    /**
     * @param  integer $revNum The revision number to revert to.
     * @throws InvalidArgumentException If revision number is invalid.
     * @return boolean Success / Failure.
     */
    public function revertToRevision($revNum)
    {
        if (!$revNum) {
            throw new InvalidArgumentException(
                'Invalid revision number'
            );
        }

        $rev = $this->revisionNum(intval($revNum));

        if (!$rev->id()) {
            return false;
        }

        if (isset($obj['lastModifiedBy'])) {

The variable $obj seems only to be defined at a later point. As such the call to isset() seems to always evaluate to false.

            $obj['lastModifiedBy'] = $rev->getRevUser();
        }

        $this->setData($rev->getDataObj());

It seems like setData() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->update();

It seems like update() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return true;
    }

    /**
     * Retrieve the object model factory.
     *
     * @return \Charcoal\Factory\FactoryInterface
     */
    abstract public function modelFactory();

    /**
     * @return \Charcoal\Model\MetadataInterface
     */
    abstract public function metadata();
}