Apparat\Object\Domain\Repository\Selector

Complexity

Total Complexity

36

Size/Duplication

Total Lines	420
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	12
Bugs	0	Features	2

20 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	32	1
B	validateDateComponent()	0	38	5
A	validateIdComponent()	0	16	3
A	validateTypeComponent()	0	16	3
A	validateRevisionComponent()	0	16	3
A	validateVisibilityComponent()	0	16	2
A	isValidVisibility()	0	6	3
A	validateDraftComponent()	0	16	2
A	isValidDraftState()	0	6	3
A	getYear()	0	4	1
A	getMonth()	0	4	1
A	getDay()	0	4	1
A	getHour()	0	4	1
A	getMinute()	0	4	1
A	getSecond()	0	4	1
A	getId()	0	4	1
A	getType()	0	4	1
A	getRevision()	0	4	1
A	getVisibility()	0	4	1
A	getDraft()	0	4	1

<?php

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

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <joschi@kuphal.net> / @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\Contract\TypeServiceInterface;
use Apparat\Object\Domain\Model\Object\Revision;

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

    /**
     * Repository selector constructor
     *
     * @param TypeServiceInterface $typeService Type Service
     * @param string|int|NULL $year Year
     * @param string|int|NULL $month Month
     * @param string|int|NULL $day Day
     * @param string|int|NULL $hour Hour
     * @param string|int|NULL $minute Minute
     * @param string|int|NULL $second Second
     * @param string|int|NULL $uid Object ID
     * @param string|NULL $type Object type
     * @param int|NULL $revision Revision
     * @param int $visibility Visibility
     * @param int $draft Draft state
     */
    public function __construct(
        TypeServiceInterface $typeService,
        $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,
        $draft = SelectorInterface::PUBLISHED
    ) {
        // Validate the date component
        $this->validateDateComponent($year, $month, $day, $hour, $minute, $second);

        // Validate the ID component
        $this->validateIdComponent($uid);

        // Validate the type component
        $this->validateTypeComponent($typeService, $type);

        // Validate the revision component
        $this->validateRevisionComponent($revision);

        // Validate the visibility component
        $this->validateVisibilityComponent($visibility);

        // Validate the draft component
        $this->validateDraftComponent($draft);
    }

    /**
     * Validate the date component
     *
     * @param string|int|NULL $year Year
     * @param string|int|NULL $month Month
     * @param string|int|NULL $day Day
     * @param string|int|NULL $hour Hour
     * @param string|int|NULL $minute Minute
     * @param string|int|NULL $second Second
     * @throws InvalidArgumentException If any of the date components isn't valid
     */
    protected function validateDateComponent(
        $year = self::WILDCARD,
        $month = self::WILDCARD,
        $day = self::WILDCARD,
        $hour = self::WILDCARD,
        $minute = self::WILDCARD,
        $second = self::WILDCARD
    ) {
        $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);
        }
    }

    /**
     * Validate the ID component
     *
     * @param string|int|NULL $uid Object ID
     * @throws InvalidArgumentException If the ID component isn't valid
     */
    protected function validateIdComponent($uid)
    {
        // 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;
    }

    /**
     * Validate the type component
     *
     * @param TypeServiceInterface $typeService Type Service
     * @param string|NULL $type Object type
     * @throws InvalidArgumentException If the type component isn't valid
     */
    protected function validateTypeComponent(TypeServiceInterface $typeService, $type)
    {
        // If the type component isn't valid
        if (!$typeService->supportsType($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;
    }

    /**
     * Validate the revision component
     *
     * @param int|NULL $revision Revision
     * @throws InvalidArgumentException If the revision component isn't valid
     */
    protected function validateRevisionComponent($revision)
    {
        // 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;
    }

    /**
     * Validate the visibility component
     *
     * @param int $visibility Visibility
     * @throws InvalidArgumentException If the visibility component isn't valid
     */
    protected function validateVisibilityComponent($visibility)
    {
        // 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;
    }

    /**
     * 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);
    }

    /**
     * Validate the draft component
     *
     * @param int $draft Draft state
     * @throws InvalidArgumentException If the draft component isn't valid
     */
    protected function validateDraftComponent($draft)
    {
        // If the object draft state isn't valid
        if (!self::isValidDraftState($draft)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Invalid repository selector draft state "%s"',
                    $draft
                ),
                InvalidArgumentException::INVALID_REPOSITORY_SELECTOR_COMPONENT,
                null,
                'draft'
            );
        }
        $this->draft = $draft;
    }

    /**
     * Test if the given argument is a valid object draft state
     *
     * @param int $draft Object draft state
     * @return boolean Valid draft state
     */
    public static function isValidDraftState($draft)
    {
        return ($draft === SelectorInterface::PUBLISHED)
        || ($draft === SelectorInterface::DRAFT)
        || ($draft === SelectorInterface::ALL);
    }

    /**
     * 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;
    }

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