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 <?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\Helpers;
use Maslosoft\Addendum\Interfaces\AnnotationInterface;
/**
* Helper class for easier annotation params setting
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class ParamsExpander
{
/**
* Expand params to annotation values.
* When annotation is used with multi top values, this will help assign this values to annotation.
* Examples of multi valued params include:
*
* ```
* @Annotation(Class\Literal, 2)
* @Annotation(class = Class\Literal, items = 2)
* ```
*
* Example of use:
* ```
* $data = ParamsExpander::expand($annotation, ['class', 'items'])
* ```
* This will assign `$annotation->class` and `$annotation->items` with named or anonymous params (based on order of params).
* @param AnnotationInterface $annotation
* @param string[] $params List of parameters names in order.
* @param mixed[] $values Values used to expand params, if not set `$annotation->value` will be used if available.
* @return mixed[] Expanded params
*/
public static function expand(AnnotationInterface $annotation, $params, $values = [])
{
if (!empty($annotation->value))
{
$values = $values ?: (array) $annotation->value;
}
$data = [];
foreach ($params as $key => $name)
{
if (is_array($values) && array_key_exists($key, $values))
{
$data[$name] = $values[$key];
unset($values[$key]);
continue;
}
if (is_array($values) && array_key_exists($name, $values))
{
$data[$name] = $values[$name];
unset($values[$name]);
continue;
}
if (isset($annotation->$name))
{
$data[$name] = $annotation->$name;
}
}
return $data;
}
}
API documentation generated by ApiGen