RevisionableTrait::createRevisionObjectCollectionLoader() - Code Metrics - Inspection of "Improve RevisionableTrait" - locomotivemtl/charcoal-object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bd3d9d...695b4d )

by Chauncey

created 2020-06-09 21:13 UTC

createRevisionObjectCollectionLoader() A

↳ Parent: RevisionableTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	10
Ratio	100 %

Importance

Changes

Metric	Value
dl	10
loc	10
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?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 collection loader.
     *
     * @return CollectionLoader
     */
    public function createRevisionObjectCollectionLoader()

    {
        $loader = new CollectionLoader([
            'logger'  => $this->logger,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            'factory' => $this->modelFactory(),
            'model'   => $this->getRevisionObjectPrototype(),
        ]);

        return $loader;
    }

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

        return $rev;
    }

    /**
     * Retrieve the revision object prototype.
     *
     * @return ObjectRevisionInterface
     */
    public function getRevisionObjectPrototype()
    {
        $proto = $this->modelFactory()->get($this->getObjectRevisionClass());

        return $proto;
    }

    /**
     * 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()
     *
     * @todo Should return NULL if source does not exist.
     *
     * @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 = $this->createRevisionObjectCollectionLoader();
        $loader
            ->addOrder('revTs', 'desc')
            ->addFilters([
                [
                    'property' => 'targetType',
                    'value'    => $this->objType(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                ],
                [
                    'property' => 'targetId',
                    'value'    => $this->id(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                ],
            ]);

        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'])) {

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

        $this->setData($rev->getDataObj());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->update();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return true;
    }

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

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


1		<?php
2
3		namespace Charcoal\Object;
4
5		use InvalidArgumentException;
6
7		// From 'charcoal-core'
8		use Charcoal\Loader\CollectionLoader;
9
10		// From 'charcoal-object'
11		use Charcoal\Object\ObjectRevision;
12		use Charcoal\Object\ObjectRevisionInterface;
13
14		/**
15		*
16		*/
17		trait RevisionableTrait
18		{
19		/**
20		* @var boolean $revisionEnabled
21		*/
22		protected $revisionEnabled = true;
23
24		/**
25		* The class name of the object revision model.
26		*
27		* Must be a fully-qualified PHP namespace and an implementation of
28		* {@see \Charcoal\Object\ObjectRevisionInterface}. Used by the model factory.
29		*
30		* @var string
31		*/
32		private $objectRevisionClass = ObjectRevision::class;
33
34		/**
35		* @param boolean $enabled The (revision) enabled flag.
36		* @return RevisionableInterface Chainable
37		*/
38		public function setRevisionEnabled($enabled)
39		{
40		$this->revisionEnabled = !!$enabled;
41		return $this;
42		}
43
44		/**
45		* @return boolean
46		*/
47		public function getRevisionEnabled()
48		{
49		return $this->revisionEnabled;
50		}
51
52		/**
53		* Create a revision collection loader.
54		*
55		* @return CollectionLoader
56		*/
57	View Code Duplication	public function createRevisionObjectCollectionLoader()
		0 ignored issues – show Duplication introduced 2020-06-09 21:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
58		{
59		$loader = new CollectionLoader([
60		'logger' => $this->logger,
		0 ignored issues – show Bug introduced 2017-01-26 04:18 UTC by Report Bug Copy Issue Report The property `logger` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
61		'factory' => $this->modelFactory(),
62		'model' => $this->getRevisionObjectPrototype(),
63		]);
64
65		return $loader;
66		}
67
68		/**
69		* Create a revision object.
70		*
71		* @return ObjectRevisionInterface
72		*/
73		public function createRevisionObject()
74		{
75		$rev = $this->modelFactory()->create($this->getObjectRevisionClass());
76
77		return $rev;
78		}
79
80		/**
81		* Retrieve the revision object prototype.
82		*
83		* @return ObjectRevisionInterface
84		*/
85		public function getRevisionObjectPrototype()
86		{
87		$proto = $this->modelFactory()->get($this->getObjectRevisionClass());
88
89		return $proto;
90		}
91
92		/**
93		* Set the class name of the object revision model.
94		*
95		* @param string $className The class name of the object revision model.
96		* @throws InvalidArgumentException If the class name is not a string.
97		* @return AbstractPropertyDisplay Chainable
98		*/
99		protected function setObjectRevisionClass($className)
100		{
101		if (!is_string($className)) {
102		throw new InvalidArgumentException(
103		'Route class name must be a string.'
104		);
105		}
106
107		$this->objectRevisionClass = $className;
108		return $this;
109		}
110
111		/**
112		* Retrieve the class name of the object revision model.
113		*
114		* @return string
115		*/
116		public function getObjectRevisionClass()
117		{
118		return $this->objectRevisionClass;
119		}
120
121		/**
122		* Alias of {@see self::getObjectRevisionClass()}.
123		*
124		* @return string
125		*/
126		public function objectRevisionClass()
127		{
128		return $this->getObjectRevisionClass();
129		}
130
131		/**
132		* @see \Charcoal\Object\ObjectRevision::create_fromObject()
133		* @return ObjectRevision
134		*/
135		public function generateRevision()
136		{
137		$rev = $this->createRevisionObject();
138
139		$rev->createFromObject($this);
140		if (!empty($rev->getDataDiff())) {
141		$rev->save();
142		}
143
144		return $rev;
145		}
146
147		/**
148		* @see \Charcoal\Object\ObejctRevision::lastObjectRevision
149		* @return ObjectRevision
150		*/
151		public function latestRevision()
152		{
153		$rev = $this->createRevisionObject();
154		$rev = $rev->lastObjectRevision($this);
155
156		return $rev;
157		}
158
159		/**
160		* @see \Charcoal\Object\ObejctRevision::objectRevisionNum()
161		*
162		* @todo Should return NULL if source does not exist.
163		*
164		* @param integer $revNum The revision number.
165		* @return ObjectRevision
166		*/
167		public function revisionNum($revNum)
168		{
169		$rev = $this->createRevisionObject();
170		$rev = $rev->objectRevisionNum($this, intval($revNum));
171
172		return $rev;
173		}
174
175		/**
176		* Retrieves all revisions for the current objet
177		*
178		* @param callable $callback Optional object callback.
179		* @return array
180		*/
181		public function allRevisions(callable $callback = null)
182		{
183		$loader = $this->createRevisionObjectCollectionLoader();
184		$loader
185		->addOrder('revTs', 'desc')
186		->addFilters([
187		[
188		'property' => 'targetType',
189		'value' => $this->objType(),
		0 ignored issues – show Bug introduced 2020-06-09 21:17 UTC by Report Bug Copy Issue Report It seems like `objType()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
190		],
191		[
192		'property' => 'targetId',
193		'value' => $this->id(),
		0 ignored issues – show Bug introduced 2020-06-09 21:17 UTC by Report Bug Copy Issue Report It seems like `id()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
194		],
195		]);
196
197		if ($callback !== null) {
198		$loader->setCallback($callback);
199		}
200
201		$revisions = $loader->load();
202		return $revisions->objects();
203		}
204
205		/**
206		* @param integer $revNum The revision number to revert to.
207		* @throws InvalidArgumentException If revision number is invalid.
208		* @return boolean Success / Failure.
209		*/
210		public function revertToRevision($revNum)
211		{
212		if (!$revNum) {
213		throw new InvalidArgumentException(
214		'Invalid revision number'
215		);
216		}
217
218		$rev = $this->revisionNum(intval($revNum));
219
220		if (!$rev->id()) {
221		return false;
222		}
223
224		if (isset($obj['lastModifiedBy'])) {
		0 ignored issues – show Bug introduced 2019-11-07 21:29 UTC by Report Bug Copy Issue Report The variable `$obj` seems only to be defined at a later point. As such the call to `isset()` seems to always evaluate to `false`. This check marks calls to `isset(...)` or `empty(...)` that are found before the variable itself is defined. These will always have the same result. This is likely the result of code being shifted around. Consider removing these calls. Loading history...
225		$obj['lastModifiedBy'] = $rev->getRevUser();
226		}
227
228		$this->setData($rev->getDataObj());
		0 ignored issues – show Bug introduced 2017-01-26 04:18 UTC by Report Bug Copy Issue Report It seems like `setData()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
229		$this->update();
		0 ignored issues – show Bug introduced 2017-01-26 04:18 UTC by Report Bug Copy Issue Report It seems like `update()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
230
231		return true;
232		}
233
234		/**
235		* Retrieve the object model factory.
236		*
237		* @return \Charcoal\Factory\FactoryInterface
238		*/
239		abstract public function modelFactory();
240
241		/**
242		* @return \Charcoal\Model\MetadataInterface
243		*/
244		abstract public function metadata();
245		}
246

locomotivemtl / charcoal-object

Push — master ( bd3d9d...695b4d )

createRevisionObjectCollectionLoader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like