AppserverIo\Psr\Servlet\Annotations\Route

Complexity

Total Complexity

9

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

78.95%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__getClass()	0	4	1
A	getName()	0	4	1
A	getDisplayName()	0	4	1
A	getDescription()	0	4	1
A	getUrlPattern()	0	4	1
A	getInitParams()	0	4	1
A	__construct()	0	16	3

<?php

/**
 * \AppserverIo\Psr\Servlet\Annotations\Route
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/servlet
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Psr\Servlet\Annotations;

use AppserverIo\Lang\Reflection\ReflectionAnnotation;

/**
 * Annotation to define a servlets routing.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/servlet
 * @link      http://www.appserver.io
 */
class Route extends ReflectionAnnotation
{

    /**
     * The annotation to define a servlets routing.
     *
     * @var string
     */
    const ANNOTATION = 'Route';

    /**
     * The constructor the initializes the instance with the
     * data passed with the token.
     *
     * @param string $annotationName The annotation name
     * @param array  $values         The annotation values
     */
    public function __construct($annotationName, array $values = array())
    {

        // pass values to parent constructor
        parent::__construct($annotationName, $values);

        // initialize the URL pattern values
        if (!isset($this->values[AnnotationKeys::URL_PATTERN])) {
            $this->values[AnnotationKeys::URL_PATTERN] = array();
        }

        // initialize the initialization parameter values
        if (!isset($this->values[AnnotationKeys::INIT_PARAMS])) {
            $this->values[AnnotationKeys::INIT_PARAMS] = array();
        }
    }

    /**
     * This method returns the class name as
     * a string.
     *
     * @return string
     */
    public static function __getClass()
    {
        return __CLASS__;
    }

    /**
     * Returns the value of the name attribute.
     *
     * @return string The annotations name attribute
     */
    public function getName()
    {
        return $this->values[AnnotationKeys::NAME];
    }

    /**
     * Returns the value of the displayName attribute.
     *
     * @return string The annotations displayName attribute
     */
    public function getDisplayName()
    {
        return $this->values[AnnotationKeys::DISPLAY_NAME];
    }

    /**
     * Returns the value of the description attribute.
     *
     * @return string The annotations description attribute
     */
    public function getDescription()
    {
        return $this->values[AnnotationKeys::DESCRIPTION];
    }

    /**
     * Returns the URL patterns the servlet is mapped to.
     *
     * @return array The URL patterns
     */
    public function getUrlPattern()
    {
        return $this->values[AnnotationKeys::URL_PATTERN];
    }

    /**
     * Returns the URL initialization parameters the servlet is mapped to.
     *
     * @return array The initialization parameters
     */
    public function getInitParams()
    {
        return $this->values[AnnotationKeys::INIT_PARAMS];
    }
}