Vox\Metadata\AnnotationsTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Test Coverage

Coverage

72.72%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	hasAnnotation()	0	3	1
A	setAnnotations()	0	5	1
A	getAnnotation()	0	7	3
A	getAnnotations()	0	3	1

<?php

namespace Vox\Metadata;

/**
 * Trait to facilitate the annotations read from the metadata drivers
 * 
 * @author Jhonatan Teixeira <jhonatan.teixeira@gmail.com>
 */
trait AnnotationsTrait
{
    public $annotations;
    
    public function getAnnotations(): array
    {
        return $this->annotations;
    }

    public function setAnnotations(array $annotations)
    {
        $this->annotations = $annotations;
        
        return $this;
    }
    
    public function getAnnotation(string $annotationName, $throwException = false)
    {
        if (!isset($this->annotations[$annotationName]) && $throwException) {
            throw new \InvalidArgumentException("no annotation with name $annotationName");
        }
        
        return $this->annotations[$annotationName] ?? null;
    }
    
    public function hasAnnotation(string $annotationName)
    {
        return isset($this->annotations[$annotationName]);
    }
}