Expression.php
1 month ago
Template.php
1 month ago
VarSpecifier.php
1 month ago
VariableBag.php
1 month ago
VariableBag.php
101 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * League.Uri (https://uri.thephpleague.com) |
| 5 | * |
| 6 | * (c) Ignace Nyamagana Butera <nyamsprod@gmail.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | declare (strict_types=1); |
| 12 | namespace IAWPSCOPED\League\Uri\UriTemplate; |
| 13 | |
| 14 | use IAWPSCOPED\League\Uri\Exceptions\TemplateCanNotBeExpanded; |
| 15 | use TypeError; |
| 16 | use function gettype; |
| 17 | use function is_array; |
| 18 | use function is_bool; |
| 19 | use function is_object; |
| 20 | use function is_scalar; |
| 21 | use function method_exists; |
| 22 | use function sprintf; |
| 23 | /** @internal */ |
| 24 | final class VariableBag |
| 25 | { |
| 26 | /** |
| 27 | * @var array<string,string|array<string>> |
| 28 | */ |
| 29 | private array $variables = []; |
| 30 | /** |
| 31 | * @param iterable<string,string|bool|int|float|array<string|bool|int|float>> $variables |
| 32 | */ |
| 33 | public function __construct(iterable $variables = []) |
| 34 | { |
| 35 | foreach ($variables as $name => $value) { |
| 36 | $this->assign($name, $value); |
| 37 | } |
| 38 | } |
| 39 | public static function __set_state(array $properties) : self |
| 40 | { |
| 41 | return new self($properties['variables']); |
| 42 | } |
| 43 | /** |
| 44 | * @return array<string,string|array<string>> |
| 45 | */ |
| 46 | public function all() : array |
| 47 | { |
| 48 | return $this->variables; |
| 49 | } |
| 50 | /** |
| 51 | * Fetches the variable value if none found returns null. |
| 52 | * |
| 53 | * @return null|string|array<string> |
| 54 | */ |
| 55 | public function fetch(string $name) |
| 56 | { |
| 57 | return $this->variables[$name] ?? null; |
| 58 | } |
| 59 | /** |
| 60 | * @param string|bool|int|float|array<string|bool|int|float> $value |
| 61 | */ |
| 62 | public function assign(string $name, $value) : void |
| 63 | { |
| 64 | $this->variables[$name] = $this->normalizeValue($value, $name, \true); |
| 65 | } |
| 66 | /** |
| 67 | * @param mixed $value the value to be expanded |
| 68 | * |
| 69 | * @throws TemplateCanNotBeExpanded if the value contains nested list |
| 70 | * |
| 71 | * @return string|array<string> |
| 72 | */ |
| 73 | private function normalizeValue($value, string $name, bool $isNestedListAllowed) |
| 74 | { |
| 75 | if (is_bool($value)) { |
| 76 | return \true === $value ? '1' : '0'; |
| 77 | } |
| 78 | if (null === $value || is_scalar($value) || is_object($value) && method_exists($value, '__toString')) { |
| 79 | return (string) $value; |
| 80 | } |
| 81 | if (!is_array($value)) { |
| 82 | throw new TypeError(sprintf('The variable ' . $name . ' must be NULL, a scalar or a stringable object `%s` given', gettype($value))); |
| 83 | } |
| 84 | if (!$isNestedListAllowed) { |
| 85 | throw TemplateCanNotBeExpanded::dueToNestedListOfValue($name); |
| 86 | } |
| 87 | foreach ($value as &$var) { |
| 88 | $var = self::normalizeValue($var, $name, \false); |
| 89 | } |
| 90 | unset($var); |
| 91 | return $value; |
| 92 | } |
| 93 | /** |
| 94 | * Replaces elements from passed variables into the current instance. |
| 95 | */ |
| 96 | public function replace(VariableBag $variables) : self |
| 97 | { |
| 98 | return new self($this->variables + $variables->variables); |
| 99 | } |
| 100 | } |
| 101 |