Selector::getVisibility() - Code Metrics - Inspection of "Added support for object visibility" - apparat/object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1629d3...30b37e )

by Joschi

created 2016-05-25 20:44 UTC

Selector::getVisibility() A

↳ Parent: Selector

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	1

Metric	Value
cc	1
eloc	2
c	1
b	0
f	1
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\Repository;

use Apparat\Object\Domain\Model\Object\Revision;
use Apparat\Object\Domain\Model\Object\Type;

/**
 * Repository selector
 *
 * @package Apparat\Object
 * @subpackage Apparat\Object\Domain
 */
class Selector implements SelectorInterface
{
    /**
     * Year component
     *
     * @var int
     */
    private $year = null;
    /**
     * Month component
     *
     * @var int
     */
    private $month = null;
    /**
     * Day component
     *
     * @var int
     */
    private $day = null;
    /**
     * Hour component
     *
     * @var int
     */
    private $hour = null;
    /**
     * Minute component
     *
     * @var int
     */
    private $minute = null;
    /**
     * Second component
     *
     * @var int
     */
    private $second = null;
    /**
     * Object ID
     *
     * @var int|string
     */
    private $uid = null;
    /**
     * Object type
     *
     * @var string
     */
    private $type = null;
    /**
     * Revision component
     *
     * @var int
     */
    private $revision = null;
    /**
     * Object visibility
     *
     * @var int
     */
    private $visibility = SelectorInterface::VISIBLE;

    /**
     * Repository selector constructor
     *
     * @param string|int|NULL $year
     * @param string|int|NULL $month
     * @param string|int|NULL $day
     * @param string|int|NULL $hour
     * @param string|int|NULL $minute
     * @param string|int|NULL $second
     * @param string|int|NULL $uid Object ID
     * @param string|NULL $type Object type
     * @param int|NULL $revision
     * @param int $visibility
     * @throws InvalidArgumentException If any of the components isn't valid
     */
    public function __construct(
        $year = self::WILDCARD,
        $month = self::WILDCARD,
        $day = self::WILDCARD,
        $hour = self::WILDCARD,
        $minute = self::WILDCARD,
        $second = self::WILDCARD,
        $uid = self::WILDCARD,
        $type = self::WILDCARD,
        $revision = Revision::CURRENT,
        $visibility = SelectorInterface::VISIBLE
    ) {
        $datePrecision = intval(getenv('OBJECT_DATE_PRECISION'));

        // Validate the creation date and ID components
        $dateComponents = [
            'year' => $year,
            'month' => $month,
            'day' => $day,
            'hour' => $hour,
            'minute' => $minute,
            'second' => $second
        ];
        foreach (array_slice($dateComponents, 0, $datePrecision) as $label => $component) {
            // If the component isn't valid
            if (!is_int($component) && ($component !== self::WILDCARD)) {
                throw new InvalidArgumentException(
                    sprintf(
                        'Invalid repository selector '.$label.' component "%s"',
                        $component
                    ),
                    InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
                    null,
                    $label
                );
            }

            // Set the component value
            $this->$label =
                ($component === self::WILDCARD) ? self::WILDCARD : str_pad($component, 2, '0', STR_PAD_LEFT);
        }

        // If the ID component isn't valid
        if (!is_int($uid) && ($uid !== self::WILDCARD)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Invalid repository selector ID component "%s"',
                    $uid
                ),
                InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
                null,
                'id'
            );
        }
        $this->uid = $uid;

        // If the type component isn't valid
        if (!Type::isValidType($type) && ($type !== self::WILDCARD)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Invalid repository selector type component "%s"',
                    $type
                ),
                InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
                null,
                'type'
            );
        }
        $this->type = $type;

        // If the revision component isn't valid
        if (!Revision::isValidRevision($revision) && ($revision !== self::WILDCARD)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Invalid repository selector revision component "%s"',
                    $revision
                ),
                InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
                null,
                'revision'
            );
        }
        $this->revision = $revision;

        // If the object visibility isn't valid
        if (!self::isValidVisibility($visibility)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Invalid repository selector visibility "%s"',
                    $visibility
                ),
                InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
                null,
                'visibility'
            );
        }
        $this->visibility = $visibility;
    }

    /**
     * Return the year component
     *
     * @return int Year component
     */
    public function getYear()
    {
        return $this->year;
    }

    /**
     * Return the month component
     *
     * @return int Month component
     */
    public function getMonth()
    {
        return $this->month;
    }

    /**
     * Return the day component
     *
     * @return int Day component
     */
    public function getDay()
    {
        return $this->day;
    }

    /**
     * Return the hour component
     *
     * @return int Hour component
     */
    public function getHour()
    {
        return $this->hour;
    }

    /**
     * Return the minute component
     *
     * @return int
     */
    public function getMinute()
    {
        return $this->minute;
    }

    /**
     * Return the second component
     *
     * @return int
     */
    public function getSecond()
    {
        return $this->second;
    }

    /**
     * Return the ID component
     *
     * @return int ID component
     */
    public function getId()
    {
        return $this->uid;
    }

    /**
     * Return the Type component
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Return the revision component
     *
     * @return int Revision component
     */
    public function getRevision()
    {
        return $this->revision;
    }

    /**
     * Return the object visibility
     *
     * @return int Object visibility
     */
    public function getVisibility()
    {
        return $this->visibility;
    }

    /**
     * Test if the given argument is a valid object visibility
     *
     * @param int $visibility Object visibility
     * @return boolean Valid visibility
     */
    public static function isValidVisibility($visibility)
    {
        return ($visibility === SelectorInterface::VISIBLE)
        || ($visibility === SelectorInterface::HIDDEN)
        || ($visibility === SelectorInterface::ALL);
    }
}


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\Repository;
38
39		use Apparat\Object\Domain\Model\Object\Revision;
40		use Apparat\Object\Domain\Model\Object\Type;
41
42		/**
43		* Repository selector
44		*
45		* @package Apparat\Object
46		* @subpackage Apparat\Object\Domain
47		*/
48		class Selector implements SelectorInterface
49		{
50		/**
51		* Year component
52		*
53		* @var int
54		*/
55		private $year = null;
56		/**
57		* Month component
58		*
59		* @var int
60		*/
61		private $month = null;
62		/**
63		* Day component
64		*
65		* @var int
66		*/
67		private $day = null;
68		/**
69		* Hour component
70		*
71		* @var int
72		*/
73		private $hour = null;
74		/**
75		* Minute component
76		*
77		* @var int
78		*/
79		private $minute = null;
80		/**
81		* Second component
82		*
83		* @var int
84		*/
85		private $second = null;
86		/**
87		* Object ID
88		*
89		* @var int\|string
90		*/
91		private $uid = null;
92		/**
93		* Object type
94		*
95		* @var string
96		*/
97		private $type = null;
98		/**
99		* Revision component
100		*
101		* @var int
102		*/
103		private $revision = null;
104		/**
105		* Object visibility
106		*
107		* @var int
108		*/
109		private $visibility = SelectorInterface::VISIBLE;
110
111		/**
112		* Repository selector constructor
113		*
114		* @param string\|int\|NULL $year
115		* @param string\|int\|NULL $month
116		* @param string\|int\|NULL $day
117		* @param string\|int\|NULL $hour
118		* @param string\|int\|NULL $minute
119		* @param string\|int\|NULL $second
120		* @param string\|int\|NULL $uid Object ID
121		* @param string\|NULL $type Object type
122		* @param int\|NULL $revision
123		* @param int $visibility
124		* @throws InvalidArgumentException If any of the components isn't valid
125		*/
126	16	public function __construct(
127		$year = self::WILDCARD,
128		$month = self::WILDCARD,
129		$day = self::WILDCARD,
130		$hour = self::WILDCARD,
131		$minute = self::WILDCARD,
132		$second = self::WILDCARD,
133		$uid = self::WILDCARD,
134		$type = self::WILDCARD,
135		$revision = Revision::CURRENT,
136		$visibility = SelectorInterface::VISIBLE
137		) {
138	16	$datePrecision = intval(getenv('OBJECT_DATE_PRECISION'));
139
140		// Validate the creation date and ID components
141		$dateComponents = [
142	16	'year' => $year,
143	16	'month' => $month,
144	16	'day' => $day,
145	16	'hour' => $hour,
146	16	'minute' => $minute,
147		'second' => $second
148	16	];
149	16	foreach (array_slice($dateComponents, 0, $datePrecision) as $label => $component) {
150		// If the component isn't valid
151	16	if (!is_int($component) && ($component !== self::WILDCARD)) {
152	1	throw new InvalidArgumentException(
153	1	sprintf(
154	1	'Invalid repository selector '.$label.' component "%s"',
155		$component
156	1	),
157	1	InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
158	1	null,
159		$label
160	1	);
161		}
162
163		// Set the component value
164	15	$this->$label =
165	15	($component === self::WILDCARD) ? self::WILDCARD : str_pad($component, 2, '0', STR_PAD_LEFT);
166	15	}
167
168		// If the ID component isn't valid
169	15	if (!is_int($uid) && ($uid !== self::WILDCARD)) {
170	1	throw new InvalidArgumentException(
171	1	sprintf(
172	1	'Invalid repository selector ID component "%s"',
173		$uid
174	1	),
175	1	InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
176	1	null,
177		'id'
178	1	);
179		}
180	14	$this->uid = $uid;
181
182		// If the type component isn't valid
183	14	if (!Type::isValidType($type) && ($type !== self::WILDCARD)) {
184	1	throw new InvalidArgumentException(
185	1	sprintf(
186	1	'Invalid repository selector type component "%s"',
187		$type
188	1	),
189	1	InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
190	1	null,
191		'type'
192	1	);
193		}
194	13	$this->type = $type;
195
196		// If the revision component isn't valid
197	13	if (!Revision::isValidRevision($revision) && ($revision !== self::WILDCARD)) {
198	1	throw new InvalidArgumentException(
199	1	sprintf(
200	1	'Invalid repository selector revision component "%s"',
201		$revision
202	1	),
203	1	InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
204	1	null,
205		'revision'
206	1	);
207		}
208	12	$this->revision = $revision;
209
210		// If the object visibility isn't valid
211	12	if (!self::isValidVisibility($visibility)) {
212		throw new InvalidArgumentException(
213		sprintf(
214		'Invalid repository selector visibility "%s"',
215		$visibility
216		),
217		InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
218		null,
219		'visibility'
220		);
221		}
222	12	$this->visibility = $visibility;
223	12	}
224
225		/**
226		* Return the year component
227		*
228		* @return int Year component
229		*/
230	10	public function getYear()
231		{
232	10	return $this->year;
233		}
234
235		/**
236		* Return the month component
237		*
238		* @return int Month component
239		*/
240	10	public function getMonth()
241		{
242	10	return $this->month;
243		}
244
245		/**
246		* Return the day component
247		*
248		* @return int Day component
249		*/
250	10	public function getDay()
251		{
252	10	return $this->day;
253		}
254
255		/**
256		* Return the hour component
257		*
258		* @return int Hour component
259		*/
260	10	public function getHour()
261		{
262	10	return $this->hour;
263		}
264
265		/**
266		* Return the minute component
267		*
268		* @return int
269		*/
270	10	public function getMinute()
271		{
272	10	return $this->minute;
273		}
274
275		/**
276		* Return the second component
277		*
278		* @return int
279		*/
280	10	public function getSecond()
281		{
282	10	return $this->second;
283		}
284
285		/**
286		* Return the ID component
287		*
288		* @return int ID component
289		*/
290	10	public function getId()
291		{
292	10	return $this->uid;
293		}
294
295		/**
296		* Return the Type component
297		*
298		* @return string
299		*/
300	10	public function getType()
301		{
302	10	return $this->type;
303		}
304
305		/**
306		* Return the revision component
307		*
308		* @return int Revision component
309		*/
310	10	public function getRevision()
311		{
312	10	return $this->revision;
313		}
314
315		/**
316		* Return the object visibility
317		*
318		* @return int Object visibility
319		*/
320	10	public function getVisibility()
321		{
322	10	return $this->visibility;
323		}
324
325		/**
326		* Test if the given argument is a valid object visibility
327		*
328		* @param int $visibility Object visibility
329		* @return boolean Valid visibility
330		*/
331	12	public static function isValidVisibility($visibility)
332		{
333	12	return ($visibility === SelectorInterface::VISIBLE)
334	2	\|\| ($visibility === SelectorInterface::HIDDEN)
335	12	\|\| ($visibility === SelectorInterface::ALL);
336		}
337		}
338

apparat / object

Push — master ( 1629d3...30b37e )

Selector::getVisibility() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like