Content::setLastModified() - Code Metrics - Inspection of "Split Content into Authorable and Timestampable." - locomotivemtl/charcoal-object - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 67ee52...70965b )

by Mathieu

created 2017-07-11 20:10 UTC

Content::setLastModified() A

↳ Parent: Project

Complexity

Conditions	4
Paths	5

Size

Total Lines	17
Code Lines	11

Duplication

Lines	17
Ratio	100 %

Importance

Changes

Metric	Value
dl	17
loc	17
c	0
b	0
f	0
rs	9.2
cc	4
eloc	11
nc	5
nop	1

<?php

namespace Charcoal\Object;

use InvalidArgumentException;

// From Pimple
use Pimple\Container;

// From 'charcoal-factory'
use Charcoal\Factory\FactoryInterface;

// From 'charcoal-core'
use Charcoal\Model\AbstractModel;

// From `charcoal-translation`
use Charcoal\Translator\TranslatorAwareTrait;

// From `charcoal-object`
use Charcoal\Object\ContentInterface;
use Charcoal\Object\AuthorableInterface;
use Charcoal\Object\AuthorableTrait;
use Charcoal\Object\RevisionableInterface;
use Charcoal\Object\RevisionableTrait;
use Charcoal\Object\TimestampableInterface;
use Charcoal\Object\TimestampableTrait;

/**
 *
 */
class Content extends AbstractModel implements
    AuthorableInterface,
    ContentInterface,
    RevisionableInterface,
    TimestampableInterface
{
    use AuthorableTrait;
    use RevisionableTrait;
    use TranslatorAwareTrait;
    use TimestampableTrait;

    /**
     * Objects are active by default
     * @var boolean
     */
    private $active = true;

    /**
     * The position is used for ordering lists
     * @var integer
     */
    private $position = 0;


    /**
     * @var FactoryInterface
     */
    private $modelFactory;

    /**
     * @var string[]
     */
    private $requiredAclPermissions = [];

    /**
     * Dependencies
     * @param Container $container DI Container.
     * @return void
     */
    public function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        $this->setTranslator($container['translator']);
        $this->setModelFactory($container['model/factory']);
    }

    /**
     * @param FactoryInterface $factory The factory used to create models.
     * @return Content Chainable
     */
    protected function setModelFactory(FactoryInterface $factory)
    {
        $this->modelFactory = $factory;
        return $this;
    }

    /**
     * @return FactoryInterface The model factory.
     */
    protected function modelFactory()
    {
        return $this->modelFactory;
    }

    /**
     * @param boolean $active The active flag.
     * @return Content Chainable
     */
    public function setActive($active)
    {
        $this->active = !!$active;
        return $this;
    }

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

    /**
     * @param integer $position The position (for ordering purpose).
     * @throws InvalidArgumentException If the position is not an integer (or numeric integer string).
     * @return Content Chainable
     */
    public function setPosition($position)
    {
        if ($position === null) {
            $this->position = null;
            return $this;
        }

        if (!is_numeric($position)) {
            throw new InvalidArgumentException(sprintf(
                'Position must be an integer, received %s',
                is_object($position) ? get_class($position) : gettype($position)
            ));
        }

        $this->position = (int)$position;
        return $this;
    }

    /**
     * @return integer
     */
    public function position()
    {
        return $this->position;
    }


    /**
     * @throws InvalidArgumentException If the ACL permissions are invalid.
     * @param  string|string[] $permissions The required ACL permissions.
     * @return Content Chainable
     */
    public function setRequiredAclPermissions($permissions)
    {
        if ($permissions === null || !$permissions) {
            $this->permissions = [];

            return $this;
        }
        if (is_string($permissions)) {
            $permissions = explode(',', $permissions);
            $permissions = array_map('trim', $permissions);
        }
        if (!is_array($permissions)) {
            throw new InvalidArgumentException(
                sprintf('Invalid ACL permissions. Permissions need to be an array (%s given)', gettype($permissions))
            );
        }
        $this->requiredAclPermissions = $permissions;
        return $this;
    }

    /**
     * @return string[]
     */
    public function requiredAclPermissions()
    {
        return $this->requiredAclPermissions;
    }

    /**
     * StorableTrait > preSave(): Called automatically before saving the object to source.
     * For content object, set the `created` and `lastModified` properties automatically
     * @return boolean
     */
    public function preSave()
    {
        parent::preSave();

        // Timestampable properties
        $this->setCreated('now');
        $this->setLastModified('now');

        return true;
    }

    /**
     * StorableTrait > preUpdate(): Called automatically before updating the object to source.
     * For content object, set the `lastModified` property automatically.
     *
     * @param array $properties The properties (ident) set for update.
     * @return boolean
     */
    public function preUpdate(array $properties = null)
    {
        parent::preUpdate($properties);


        // Content is revisionable
        if ($this->revisionEnabled()) {
            $this->generateRevision();
        }

        // Timestampable propertiees
        $this->setLastModified('now');

        return true;
    }
}


1			<?php
2
3			namespace Charcoal\Object;
4
5			use InvalidArgumentException;
6
7			// From Pimple
8			use Pimple\Container;
9
10			// From 'charcoal-factory'
11			use Charcoal\Factory\FactoryInterface;
12
13			// From 'charcoal-core'
14			use Charcoal\Model\AbstractModel;
15
16			// From `charcoal-translation`
17			use Charcoal\Translator\TranslatorAwareTrait;
18
19			// From `charcoal-object`
20			use Charcoal\Object\ContentInterface;
21			use Charcoal\Object\AuthorableInterface;
22			use Charcoal\Object\AuthorableTrait;
23			use Charcoal\Object\RevisionableInterface;
24			use Charcoal\Object\RevisionableTrait;
25			use Charcoal\Object\TimestampableInterface;
26			use Charcoal\Object\TimestampableTrait;
27
28			/**
29			*
30			*/
31			class Content extends AbstractModel implements
32			AuthorableInterface,
33			ContentInterface,
34			RevisionableInterface,
35			TimestampableInterface
36			{
37			use AuthorableTrait;
38			use RevisionableTrait;
39			use TranslatorAwareTrait;
40			use TimestampableTrait;
41
42			/**
43			* Objects are active by default
44			* @var boolean
45			*/
46			private $active = true;
47
48			/**
49			* The position is used for ordering lists
50			* @var integer
51			*/
52			private $position = 0;
53
54
55			/**
56			* @var FactoryInterface
57			*/
58			private $modelFactory;
59
60			/**
61			* @var string[]
62			*/
63			private $requiredAclPermissions = [];
64
65			/**
66			* Dependencies
67			* @param Container $container DI Container.
68			* @return void
69			*/
70			public function setDependencies(Container $container)
71			{
72			parent::setDependencies($container);
73
74			$this->setTranslator($container['translator']);
75			$this->setModelFactory($container['model/factory']);
76			}
77
78			/**
79			* @param FactoryInterface $factory The factory used to create models.
80			* @return Content Chainable
81			*/
82			protected function setModelFactory(FactoryInterface $factory)
83			{
84			$this->modelFactory = $factory;
85			return $this;
86			}
87
88			/**
89			* @return FactoryInterface The model factory.
90			*/
91			protected function modelFactory()
92			{
93			return $this->modelFactory;
94			}
95
96			/**
97			* @param boolean $active The active flag.
98			* @return Content Chainable
99			*/
100			public function setActive($active)
101			{
102			$this->active = !!$active;
103			return $this;
104			}
105
106			/**
107			* @return boolean
108			*/
109			public function active()
110			{
111			return $this->active;
112			}
113
114			/**
115			* @param integer $position The position (for ordering purpose).
116			* @throws InvalidArgumentException If the position is not an integer (or numeric integer string).
117			* @return Content Chainable
118			*/
119			public function setPosition($position)
120			{
121			if ($position === null) {
122			$this->position = null;
123			return $this;
124			}
125
126			if (!is_numeric($position)) {
127			throw new InvalidArgumentException(sprintf(
128			'Position must be an integer, received %s',
129			is_object($position) ? get_class($position) : gettype($position)
130			));
131			}
132
133			$this->position = (int)$position;
134			return $this;
135			}
136
137			/**
138			* @return integer
139			*/
140			public function position()
141			{
142			return $this->position;
143			}
144
145
146			/**
147			* @throws InvalidArgumentException If the ACL permissions are invalid.
148			* @param string\|string[] $permissions The required ACL permissions.
149			* @return Content Chainable
150			*/
151			public function setRequiredAclPermissions($permissions)
152			{
153			if ($permissions === null \|\| !$permissions) {
154			$this->permissions = [];
			0 ignored issues – show Bug introduced 2017-02-09 13:12 UTC by Report Bug Copy Issue Report The property `permissions` does not seem to exist. Did you mean `requiredAclPermissions`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
155			return $this;
156			}
157			if (is_string($permissions)) {
158			$permissions = explode(',', $permissions);
159			$permissions = array_map('trim', $permissions);
160			}
161			if (!is_array($permissions)) {
162			throw new InvalidArgumentException(
163			sprintf('Invalid ACL permissions. Permissions need to be an array (%s given)', gettype($permissions))
164			);
165			}
166			$this->requiredAclPermissions = $permissions;
167			return $this;
168			}
169
170			/**
171			* @return string[]
172			*/
173			public function requiredAclPermissions()
174			{
175			return $this->requiredAclPermissions;
176			}
177
178			/**
179			* StorableTrait > preSave(): Called automatically before saving the object to source.
180			* For content object, set the `created` and `lastModified` properties automatically
181			* @return boolean
182			*/
183			public function preSave()
184			{
185			parent::preSave();
186
187			// Timestampable properties
188			$this->setCreated('now');
189			$this->setLastModified('now');
190
191			return true;
192			}
193
194			/**
195			* StorableTrait > preUpdate(): Called automatically before updating the object to source.
196			* For content object, set the `lastModified` property automatically.
197			*
198			* @param array $properties The properties (ident) set for update.
199			* @return boolean
200			*/
201			public function preUpdate(array $properties = null)
202			{
203			parent::preUpdate($properties);
			0 ignored issues – show Bug introduced 2017-01-26 04:18 UTC by Report Bug Copy Issue Report It seems like `$properties` defined by parameter `$properties` on line 201 can also be of type `array`; however, `Charcoal\Model\AbstractModel::preUpdate()` does only seem to accept `null\|array<integer,string>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
204
205			// Content is revisionable
206			if ($this->revisionEnabled()) {
207			$this->generateRevision();
208			}
209
210			// Timestampable propertiees
211			$this->setLastModified('now');
212
213			return true;
214			}
215			}
216

locomotivemtl / charcoal-object

Push — master ( 67ee52...70965b )

Content::setLastModified() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like