Apparat\Server\Ports\Types\ObjectRoute

Complexity

Total Complexity

3

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	nameToBit()	0	4	3

<?php

/**
 * apparat-server
 *
 * @category    Apparat
 * @package     Apparat\Server
 * @subpackage  Apparat\Server\Ports
 * @author      Joschi Kuphal <joschi@tollwerk.de> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <joschi@tollwerk.de> / @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\Server\Ports\Types;

/**
 * Default route types
 *
 * @package Apparat\Server
 * @subpackage Apparat\Server\Ports
 */
class ObjectRoute
{
    /**
     * Year default route
     *
     * @var int
     */
    const YEAR = 1;
    /**
     * Month default route
     *
     * @var int
     */
    const MONTH = 2;
    /**
     * Day default route
     *
     * @var int
     */
    const DAY = 4;
    /**
     * Hour default route
     *
     * @var int
     */
    const HOUR = 8;
    /**
     * Minute default route
     *
     * @var int
     */
    const MINUTE = 16;
    /**
     * Second default route
     *
     * @var int
     */
    const SECOND = 32;
    /**
     * Type default route
     *
     * @var int
     */
    const TYPE = 64;
    /**
     * Object default route
     *
     * @var int
     */
    const OBJECT = 128;
    /**
     * Objects default route
     *
     * @var int
     */
    const OBJECTS = 256;
    /**
     * All default routes
     *
     * @var int
     */
    const ALL = 511;
    /**
     * Month route / selector
     *
     * @var string
     */
    const YEAR_STR = 'year';
    /**
     * Month route / selector
     *
     * @var string
     */
    const MONTH_STR = 'month';
    /**
     * Day route / selector
     *
     * @var string
     */
    const DAY_STR = 'day';
    /**
     * Hour route / selector
     *
     * @var string
     */
    const HOUR_STR = 'hour';
    /**
     * Minute route / selector
     *
     * @var string
     */
    const MINUTE_STR = 'minute';
    /**
     * Second route / selector
     *
     * @var string
     */
    const SECOND_STR = 'second';
    /**
     * ID selector
     *
     * @var string
     */
    const ID_STR = 'id';
    /**
     * Revvision selector
     *
     * @var string
     */
    const REVISION_STR = 'revision';
    /**
     * Object
     *
     * @var string
     */
    const OBJECT_STR = 'object';
    /**
     * Objects
     *
     * @var string
     */
    const OBJECTS_STR = 'objects';
    /**
     * Type route / selector
     *
     * @var string
     */
    const TYPE_STR = 'type';
    /**
     * Slug
     *
     * @var string
     */
    const SLUG_STR = 'slug';
    /**
     * Wildcard
     *
     * @var string
     */
    const WILDCARD = '*';
    /**
     * Plain text accept header
     *
     * @var string
     */
    const ACCEPT_TEXT = 'text/plain';
    /**
     * Markdown accept header
     *
     * @var string
     */
    const ACCEPT_MARKDOWN = 'text/markdown';
    /**
     * HTML accept header
     *
     * @var string
     */
    const ACCEPT_HTML = 'text/html';
    /**
     * JSON accept header
     *
     * @var string
     */
    const ACCEPT_JSON = 'application/json';
    /**
     * Accepted response types
     *
     * @var array
     */
    public static $accept = [
        self::ACCEPT_HTML,
        self::ACCEPT_TEXT,
        self::ACCEPT_MARKDOWN,
        self::ACCEPT_JSON,
    ];
    /**
     * Default route name / bit mapping
     *
     * @var array
     */
    protected static $nameBits = [
        self::YEAR_STR => self::YEAR,
        self::MONTH_STR => self::MONTH,
        self::DAY_STR => self::DAY,
        self::HOUR_STR => self::HOUR,
        self::MINUTE_STR => self::MINUTE,
        self::SECOND_STR => self::SECOND,
        self::TYPE_STR => self::TYPE,
        self::OBJECT_STR => self::OBJECT,
        self::OBJECTS_STR => self::OBJECTS,
    ];

    /**
     * Return a bit value for a particular default route name
     *
     * @param string $name Default route name
     * @return int Default route bit
     */
    public static function nameToBit($name)
    {
        return (empty($name) || empty(self::$nameBits[$name])) ? 0 : self::$nameBits[$name];
    }
}