Codeburner\Annotator\Annotation

Complexity

Total Complexity

11

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	7
Bugs	2	Features	1

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	getName()	0	4	1
A	getArguments()	0	4	1
A	getArgument()	0	4	2
A	getArgumentCount()	0	4	1
A	hasArgument()	0	4	1
A	filter()	0	4	1
A	__toString()	0	8	2

<?php

/**
 * Codeburner Framework.
 *
 * @author Alex Rohleder <contato@alexrohleder.com.br>
 * @copyright 2016 Alex Rohleder
 * @license http://opensource.org/licenses/MIT
 */

namespace Codeburner\Annotator;

/**
 * The annotation representation.
 *
 * @author Alex Rohleder <contato@alexrohleder.com.br>
 */

class Annotation
{

    /**
     * The annotation token.
     *
     * @var string
     */

    protected $name;

    /**
     * Formmated arguments, but not casted.
     *
     * @var string[]
     */

    protected $arguments;

    /**
     * @param string $name
     * @param string $arguments
     */

    public function __construct($name, $arguments)
    {
        $this->name = $name;

        if (strpos($arguments, "{") === 0) {
               $this->arguments = (array) json_decode($arguments, true);
        } else $this->arguments = (array) trim($arguments);

        $this->filter();
    }

    /**
     * @return string
     */

    public function getName()
    {
        return $this->name;
    }

    /**
     * @return array
     */

    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * @param string $name
     * @param string $default = null
     * @return string
     */

    public function getArgument($name, $default = null)
    {
        return isset($this->arguments[$name]) ? $this->arguments[$name] : $default;
    }

    /**
     * @return int
     */

    public function getArgumentCount()
    {
        return count($this->arguments);
    }

    /**
     * @param string $name
     * @return boolean
     */

    public function hasArgument($name)
    {
        return isset($this->arguments[$name]);
    }

    /**
     * Overwrite this method to parse and validate the arguments in a
     * new Annotation definition.
     *
     * @return void
     */

    protected function filter()
    {
        // void
    }

    /**
     * @return string
     */

    public function __toString()
    {
        if (count($this->arguments) === 1) {
            return (string) $this->arguments[0];
        }

        throw new Exceptions\AnnotationException("The annotation cannot be converted to string.");
    }

}