Brickoo\Component\Annotation\Definition\AnnotationParameterDefinition

Complexity

Total Complexity

4

Size/Duplication

Total Lines	52
Duplicated Lines	15.38 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	8	8	1
A	getName()	0	3	1
A	getType()	0	3	1
A	isRequired()	0	3	1

<?php

/*
 * Copyright (c) 2011-2015, Celestino Diaz <celestino.diaz@gmx.de>
 *
 * 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 Brickoo\Component\Annotation\Definition;

use Brickoo\Component\Common\Assert;

/**
 * AnnotationParameterDefinition
 *
 * Implements an annotation parameter definition.
 * @author Celestino Diaz <celestino.diaz@gmx.de>
 */
class AnnotationParameterDefinition {

    /** @var string */
    private $name;

    /** @var string */
    private $type;

    /** @var boolean */
    private $required;

    /**
     * Class constructor.
     * @param string $name
     * @param string $type
     * @param boolean $required
     * @throws \InvalidArgumentException
     */
    public function __construct($name, $type, $required = true) {
        Assert::isString($name);
        Assert::isString($type);
        Assert::isBoolean($required);
        $this->name = $name;
        $this->type = $type;
        $this->required = $required;
    }

    /**
     * Returns the parameter name.
     * @return string the parameter name
     */
    public function getName() {
        return $this->name;
    }

    /**
     * Returns the parameter type.
     * @return string the parameter type
     */
    public function getType() {
        return $this->type;
    }

    /**
     * Checks if the parameter is required.
     * @return boolean check result
     */
    public function isRequired() {
        return $this->required;
    }

}