Accessible\Annotation\AbstractCollectionBehavior

Complexity

Total Complexity

5

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	3
A	getItemName()	0	4	1
A	getMethods()	0	4	1

<?php

namespace Accessible\Annotation;

/**
 * This class is the base of the collection-based behavior annotations.
 */
abstract class AbstractCollectionBehavior
{
    /**
     * The property can be accessed through an addX method.
     *
     * @var string
     */
    const ADD = "add";

    /**
     * The property can be accessed through a removeX method.
     *
     * @var string
     */
    const REMOVE = "remove";

    /**
     * The name of an item in the collection. It is used to deduce the methods names.
     * If it is not defined, it will be the singularized version of the property name.
     *
     * @var string
     */
    protected $itemName;

    /**
     * The list of methods that can be used with the collection.
     *
     * @var array
     */
    protected $methods;

    /**
     * The default methods that can be used.
     *
     * @var array<string>
     */
    protected $defaultMethods;

    /**
     * Initializes the annotation.
     *
     * @param mixed $values The annotation's parameters.
     */
    public function __construct($values)
    {
        $this->defaultMethods = array(AbstractCollectionBehavior::ADD, AbstractCollectionBehavior::REMOVE);

        $defaults = array(
            'itemName' => null,
            'methods' => $this->defaultMethods
        );

        foreach ($defaults as $property => $defaultValue) {
            $this->$property = (empty($values[$property])) ? $defaultValue : $values[$property];
        }
    }

    /**
     * Get the item name.
     *
     * @return string
     */
    public function getItemName()
    {
        return $this->itemName;
    }

    /**
     * Get the list of methods that can be used.
     *
     * @return array<string>
     */
    public function getMethods()
    {
        return $this->methods;
    }
}