StatesTrait::hasBeenMutated() - Code Metrics - Inspection of "Added object tests" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( abf23a...b0f4e6 )

by Joschi

created 2016-05-22 22:12 UTC

StatesTrait::hasBeenMutated() A

↳ Parent: StatesTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

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

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @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\Traits;

use Apparat\Object\Domain\Model\Properties\SystemProperties;

/**
 * Object states trait
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain\Model\Object\Traits
 * @property SystemProperties $systemProperties
 */
trait StatesTrait
{
    /**
     * Object state
     *
     * @var int
     */
    protected $state = self::STATE_CLEAN;
    /**
     * Property collection states
     *
     * @var array
     */
    protected $collectionStates = [];

    /**
     * Return whether the object is in mutated state
     *
     * @return boolean Mutated state
     */
    public function hasBeenMutated()
    {
        return !!($this->state & self::STATE_MUTATED);
    }

    /**
     * Return whether the object is in published state
     *
     * @return boolean Published state
     */
    public function isPublished()
    {
        return $this->systemProperties->isPublished();
    }

    /**
     * Return whether the object has been deleted
     *
     * @return boolean Object is deleted
     */
    public function isDeleted()
    {
        return $this->systemProperties->isDeleted();
    }

    /**
     * Return whether the object has just been deleted
     *
     * @return boolean Object has just been deleted
     */
    public function hasBeenDeleted()
    {
        return !!($this->state & self::STATE_DELETED);
    }

    /**
     * Return whether the object has just been undeleted
     *
     * @return boolean Object has just been undeleted
     */
    public function hasBeenUndeleted()
    {
        return !!($this->state & self::STATE_UNDELETED);
    }

    /**
     * Return whether the object is in modified state
     *
     * @return boolean Modified state
     */
    public function hasBeenModified()
    {
        return !!($this->state & self::STATE_MODIFIED);
    }

    /**
     * Set the object state to mutated
     */
    protected function setMutatedState()
    {
        // Make this object a draft if not already the case and not just
        if (!$this->isDraft() && !$this->hasBeenPublished()) {
            // TODO: Send signal
            $this->convertToDraft();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        // Enable the mutated state
        $this->state |= self::STATE_MUTATED;

        // Enable the modified state
        $this->setModifiedState();
    }

    /**
     * Return the object draft mode
     *
     * @return boolean Object draft mode
     */
    public function isDraft()
    {
        return $this->systemProperties->isDraft();
    }

    /**
     * Return whether the object has just been published
     *
     * @return boolean Object has just been published
     */
    public function hasBeenPublished()
    {
        return !!($this->state & self::STATE_PUBLISHED);
    }

    /**
     * Set the object state to modified
     */
    protected function setModifiedState()
    {
        // If this object is not in modified state yet
        if (!($this->state & self::STATE_MODIFIED)) {
            // TODO: Send signal
        }

        // Enable the modified state
        $this->state |= self::STATE_MODIFIED;

        // Update the modification timestamp
        $this->setSystemProperties($this->systemProperties->touch(), true);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Set the object state to deleted
     */
    protected function setDeletedState()
    {
        // If this object is not in deleted state yet
        if (!($this->state & self::STATE_DELETED)) {
            // TODO: Send signal
        }

        // Enable the deleted state
        $this->state |= self::STATE_DELETED;
        $this->state &= ~self::STATE_UNDELETED;

        // Update system properties
        $this->setSystemProperties($this->systemProperties->delete(), true);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->setModifiedState();
    }

    /**
     * Set the object state to undeleted
     */
    protected function setUndeletedState()
    {
        // If this object is in deleted state
        if ($this->state & self::STATE_DELETED) {
            // TODO: Send signal
        }

        // Disable the deleted state
        $this->state |= self::STATE_UNDELETED;
        $this->state &= ~self::STATE_DELETED;

        // Update system properties
        $this->setSystemProperties($this->systemProperties->undelete(), true);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->setModifiedState();
    }

    /**
     * Set the object state to published
     */
    protected function setPublishedState()
    {
        // If this object is not in published state yet
        if (!($this->state & self::STATE_PUBLISHED)) {
            // TODO: Send signal
        }

        // Set the published flag
        $this->state |= self::STATE_PUBLISHED;

        // Update system properties
        $this->setSystemProperties($this->systemProperties->publish(), true);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $this->setModifiedState();
    }

    /**
     * Reset the object state
     */
    protected function resetState()
    {
        // If this object is not clean
        if ($this->state != self::STATE_CLEAN) {
            // TODO: Send signal
        }

        $this->state = self::STATE_CLEAN;
    }
}


1		<?php
2
3		/**
4		* apparat-object
5		*
6		* @category Apparat
7		* @package Apparat\Object
8		* @subpackage Apparat\Object\Domain
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Apparat\Object\Domain\Model\Object\Traits;
38
39		use Apparat\Object\Domain\Model\Properties\SystemProperties;
40
41		/**
42		* Object states trait
43		*
44		* @package Apparat\Object
45		* @subpackage Apparat\Object\Domain\Model\Object\Traits
46		* @property SystemProperties $systemProperties
47		*/
48		trait StatesTrait
49		{
50		/**
51		* Object state
52		*
53		* @var int
54		*/
55		protected $state = self::STATE_CLEAN;
56		/**
57		* Property collection states
58		*
59		* @var array
60		*/
61		protected $collectionStates = [];
62
63		/**
64		* Return whether the object is in mutated state
65		*
66		* @return boolean Mutated state
67		*/
68	3	public function hasBeenMutated()
69		{
70	3	return !!($this->state & self::STATE_MUTATED);
71		}
72
73		/**
74		* Return whether the object is in published state
75		*
76		* @return boolean Published state
77		*/
78		public function isPublished()
79		{
80		return $this->systemProperties->isPublished();
81		}
82
83		/**
84		* Return whether the object has been deleted
85		*
86		* @return boolean Object is deleted
87		*/
88		public function isDeleted()
89		{
90		return $this->systemProperties->isDeleted();
91		}
92
93		/**
94		* Return whether the object has just been deleted
95		*
96		* @return boolean Object has just been deleted
97		*/
98	1	public function hasBeenDeleted()
99		{
100	1	return !!($this->state & self::STATE_DELETED);
101		}
102
103		/**
104		* Return whether the object has just been undeleted
105		*
106		* @return boolean Object has just been undeleted
107		*/
108	1	public function hasBeenUndeleted()
109		{
110	1	return !!($this->state & self::STATE_UNDELETED);
111		}
112
113		/**
114		* Return whether the object is in modified state
115		*
116		* @return boolean Modified state
117		*/
118	3	public function hasBeenModified()
119		{
120	3	return !!($this->state & self::STATE_MODIFIED);
121		}
122
123		/**
124		* Set the object state to mutated
125		*/
126	4	protected function setMutatedState()
127		{
128		// Make this object a draft if not already the case and not just
129	4	if (!$this->isDraft() && !$this->hasBeenPublished()) {
130		// TODO: Send signal
131	4	$this->convertToDraft();
		0 ignored issues – show Bug introduced 2016-05-22 22:17 UTC by Report Bug Copy Issue Report It seems like `convertToDraft()` 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...
132		}
133
134		// Enable the mutated state
135	4	$this->state \|= self::STATE_MUTATED;
136
137		// Enable the modified state
138	4	$this->setModifiedState();
139	4	}
140
141		/**
142		* Return the object draft mode
143		*
144		* @return boolean Object draft mode
145		*/
146	5	public function isDraft()
147		{
148	5	return $this->systemProperties->isDraft();
149		}
150
151		/**
152		* Return whether the object has just been published
153		*
154		* @return boolean Object has just been published
155		*/
156	4	public function hasBeenPublished()
157		{
158	4	return !!($this->state & self::STATE_PUBLISHED);
159		}
160
161		/**
162		* Set the object state to modified
163		*/
164	7	protected function setModifiedState()
165		{
166		// If this object is not in modified state yet
167	7	if (!($this->state & self::STATE_MODIFIED)) {
168		// TODO: Send signal
169		}
170
171		// Enable the modified state
172	7	$this->state \|= self::STATE_MODIFIED;
173
174		// Update the modification timestamp
175	7	$this->setSystemProperties($this->systemProperties->touch(), true);
		0 ignored issues – show Bug introduced 2016-05-22 22:17 UTC by Report Bug Copy Issue Report It seems like `setSystemProperties()` 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...
176	7	}
177
178		/**
179		* Set the object state to deleted
180		*/
181		protected function setDeletedState()
182		{
183		// If this object is not in deleted state yet
184		if (!($this->state & self::STATE_DELETED)) {
185		// TODO: Send signal
186		}
187
188		// Enable the deleted state
189		$this->state \|= self::STATE_DELETED;
190		$this->state &= ~self::STATE_UNDELETED;
191
192		// Update system properties
193		$this->setSystemProperties($this->systemProperties->delete(), true);
		0 ignored issues – show Bug introduced 2016-05-22 22:17 UTC by Report Bug Copy Issue Report It seems like `setSystemProperties()` 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		$this->setModifiedState();
195		}
196
197		/**
198		* Set the object state to undeleted
199		*/
200		protected function setUndeletedState()
201		{
202		// If this object is in deleted state
203		if ($this->state & self::STATE_DELETED) {
204		// TODO: Send signal
205		}
206
207		// Disable the deleted state
208		$this->state \|= self::STATE_UNDELETED;
209		$this->state &= ~self::STATE_DELETED;
210
211		// Update system properties
212		$this->setSystemProperties($this->systemProperties->undelete(), true);
		0 ignored issues – show Bug introduced 2016-05-22 22:17 UTC by Report Bug Copy Issue Report It seems like `setSystemProperties()` 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...
213		$this->setModifiedState();
214		}
215
216		/**
217		* Set the object state to published
218		*/
219	1	protected function setPublishedState()
220		{
221		// If this object is not in published state yet
222	1	if (!($this->state & self::STATE_PUBLISHED)) {
223		// TODO: Send signal
224		}
225
226		// Set the published flag
227	1	$this->state \|= self::STATE_PUBLISHED;
228
229		// Update system properties
230	1	$this->setSystemProperties($this->systemProperties->publish(), true);
		0 ignored issues – show Bug introduced 2016-05-22 22:17 UTC by Report Bug Copy Issue Report It seems like `setSystemProperties()` 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...
231	1	$this->setModifiedState();
232	1	}
233
234		/**
235		* Reset the object state
236		*/
237	24	protected function resetState()
238		{
239		// If this object is not clean
240	24	if ($this->state != self::STATE_CLEAN) {
241		// TODO: Send signal
242		}
243
244	24	$this->state = self::STATE_CLEAN;
245	24	}
246		}
247

apparat / object

Push — master ( abf23a...b0f4e6 )

StatesTrait::hasBeenMutated() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like