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 99 100 101 102 103 104 105 <?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\Utilities;
use Maslosoft\Addendum\Annotations\TargetAnnotation;
use Maslosoft\Addendum\Exceptions\TargetException;
use Maslosoft\Addendum\Interfaces\AnnotationInterface;
use Maslosoft\Addendum\Reflection\ReflectionAnnotatedClass;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;
/**
* Check target constraits
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class TargetChecker
{
/**
* Check target constraints
* @param AnnotationInterface $annotation Annotation
* @param ReflectionClass|ReflectionMethod|ReflectionProperty|bool $target
* @return type
* @throws TargetException
*/
public static function check($annotation, $target)
{
$reflection = new ReflectionAnnotatedClass($annotation);
if (!$reflection->hasAnnotation('Target'))
{
return;
}
$value = $reflection->getAnnotation('Target')->value;
$values = is_array($value) ? $value : [$value];
foreach ($values as $value)
{
if ($value == TargetAnnotation::TargetClass && $target instanceof ReflectionClass)
{
return;
}
if ($value == TargetAnnotation::TargetMethod && $target instanceof ReflectionMethod)
{
return;
}
if ($value == TargetAnnotation::TargetProperty && $target instanceof ReflectionProperty)
{
return;
}
if ($value == TargetAnnotation::TargetNested && $target === false)
{
return;
}
}
if ($target !== false && $value && !in_array($value, [
TargetAnnotation::TargetClass,
TargetAnnotation::TargetMethod,
TargetAnnotation::TargetProperty,
TargetAnnotation::TargetNested
]))
{
if ($target instanceof ReflectionClass)
{
$interfaceTarget = $target;
}
else
{
/* @var $target ReflectionProperty */
$interfaceTarget = new ReflectionClass($target->class);
}
if(!ClassChecker::exists($value))
{
throw new TargetException(sprintf('Annotation "%s" used in "%s" is only allowed on instances of "%s", but this class does not exists (see @Target)', basename($reflection->name), $interfaceTarget->name, $value));
}
if (!$interfaceTarget->implementsInterface($value))
{
throw new TargetException(sprintf('Annotation "%s" used in "%s" is only allowed on instances of "%s" (see @Target)', basename($reflection->name), $interfaceTarget->name, $value));
}
}
if ($target === false && $value == TargetAnnotation::TargetNested)
{
throw new TargetException("Annotation '" . get_class($annotation) . "' nesting not allowed");
}
elseif (in_array($value, TargetAnnotation::getTargets()))
{
throw new TargetException(sprintf("Annotation '%s' not allowed on %s, it's target is %s (see @Target)", get_class($annotation), ReflectionName::createName($target), $value));
}
}
}
API documentation generated by ApiGen