Maslosoft Addendum API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 <?php
/**
* This software package is licensed under AGPL, Commercial license.
*
* @package maslosoft/addendum
* @licence AGPL, Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com> (Meta container, further improvements, bugfixes)
* @copyright Copyright (c) Maslosoft (Meta container, further improvements, bugfixes)
* @copyright Copyright (c) Jan Suchal (Original version, builder, parser)
* @link https://maslosoft.com/addendum/ - maslosoft addendum
* @link https://code.google.com/p/addendum/ - original addendum project
*/
namespace Maslosoft\Addendum\Collections;
use Maslosoft\Addendum\Addendum;
use Maslosoft\Addendum\Interfaces\AnnotationInterface;
class AnnotationsCollection
{
/**
* Annotations holder
* @var AnnotationInterface[]
*/
private $annotations;
public function __construct($annotations)
{
$this->annotations = $annotations;
}
/**
* Check if has annotation.
* This method should be used with annotation name, not class name, ie:
*
* ```
* $this->hasAnnotation('Label');
* ```
*
* @param string $name
* @return bool
*/
public function hasAnnotation($name)
{
$class = Addendum::resolveClassName($name);
return isset($this->annotations[$class]);
}
/**
* Get annotation.
* This method should be used with annotation name, not class name, ie:
*
* ```
* $this->getAnnotation('Label');
* ```
*
* @param string $name
* @return AnnotationInterface
*/
public function getAnnotation($name)
{
$class = Addendum::resolveClassName($name);
return isset($this->annotations[$class]) ? end($this->annotations[$class]) : false;
}
public function getAnnotations()
{
$result = [];
foreach ($this->annotations as $instances)
{
$result[] = end($instances);
}
return $result;
}
/**
* Get all annotations with optional restriction to $restriction annotation name
* @param string $restriction
* @return AnnotationInterface[]
*/
public function getAllAnnotations($restriction = false)
{
$restriction = Addendum::resolveClassName($restriction);
$result = [];
foreach ($this->annotations as $class => $instances)
{
if (!$restriction || $restriction == $class)
{
$result = array_merge($result, $instances);
}
}
return $result;
}
}
API documentation generated by ApiGen