Zicht\Bundle\FrameworkExtraBundle\Helper\AnnotationRegistry

Complexity

Total Complexity

13

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setAnnotation()	0	4	2
A	addAnnotations()	0	8	3
A	getAnnotations()	0	3	1
A	getAnnotation()	0	10	3
A	addAnnotation()	0	10	3
A	__construct()	0	3	1

<?php
/**
 * @author Gerard van Helden <gerard@zicht.nl>
 * @copyright Zicht Online <http://zicht.nl>
 */
namespace Zicht\Bundle\FrameworkExtraBundle\Helper;

/**
 * Provides a global registry for page "annotations", which can be used for meta data such as meta tags, title or
 * OpenGraph data. This can be utilized using the Twig {% annotate %} and {% annotations %} {% endannotations %}
 * constructs.
 */
class AnnotationRegistry
{
    /**
     * The annotations
     *
     * @var array
     */
    private $annotations = array();


    /**
     * Constructor.
     */
    public function __construct()
    {
        $this->annotations = array();
    }


    /**
     * Add an annotation.
     *
     * @param string $name
     * @param mixed $value
     * @param int $priority
     * @return void
     */
    public function addAnnotation($name, $value, $priority = 0)
    {
        $annotation = $this->getAnnotation($name);
        $new_annotation = array('name' => $name, 'value' => $value, 'priority' => $priority);
        if (!empty($annotation)) {
            if ($priority > $annotation['value']['priority']) {
                $this->setAnnotation($annotation['key'], $new_annotation);

$new_annotation of type array<string,integer|mixed|string> is incompatible with the type string expected by parameter $annotation of Zicht\Bundle\FrameworkExtraBundle\Helper\AnnotationRegistry::setAnnotation().

            }
        } else {
            $this->annotations[]= $new_annotation;
        }
    }

    /**
     * Get annotation
     *
     * @param string $name
     * @return array
     */
    public function getAnnotation($name)
    {
        $match = array();
        foreach ($this->getAnnotations() as $key => $annotation) {
            if ($annotation['name'] == $name) {
                $match['key'] = $key;
                $match['value'] = $annotation;
            }
        }
        return $match;
    }

    /**
     * Set annotation
     *
     * @param string $key
     * @param string $annotation
     */
    public function setAnnotation($key, $annotation)
    {
        if (array_key_exists($key, $this->annotations)) {
            $this->annotations[$key] = $annotation;
        }
    }

    /**
     * Get the annotations.
     *
     * @return array
     */
    public function getAnnotations()
    {
        return $this->annotations;
    }


    /**
     * Add multiple annotations, or an annotated object that implements the getPublicAnnotations() method.
     *
     * @param mixed $values
     * @return void
     */
    public function addAnnotations($values)
    {
        // TODO interface
        if (method_exists($values, 'getPublicAnnotations')) {
            $this->addAnnotations($values->getPublicAnnotations());
        } else {
            foreach ($values as $name => $value) {
                $this->addAnnotation($name, $value);
            }
        }
    }
}