wordpress-seo / vendor_prefixed / symfony / dependency-injection / ParameterBag / ParameterBagInterface.php

ParameterBagInterface.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 28.4, at vendor_prefixed/symfony/dependency-injection/ParameterBag/ParameterBagInterface.php

95 lines 2.6 KB

Raw Download Zip

1	<?php
2
3	/*
4	* This file is part of the Symfony package.
5	*
6	* (c) Fabien Potencier <[email protected]>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11	namespace YoastSEO_Vendor\Symfony\Component\DependencyInjection\ParameterBag;
12
13	use YoastSEO_Vendor\Symfony\Component\DependencyInjection\Exception\LogicException;
14	use YoastSEO_Vendor\Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
15	/**
16	* ParameterBagInterface is the interface implemented by objects that manage service container parameters.
17	*
18	* @author Fabien Potencier <[email protected]>
19	*/
20	interface ParameterBagInterface
21	{
22	/**
23	* Clears all parameters.
24	*
25	* @throws LogicException if the ParameterBagInterface cannot be cleared
26	*/
27	public function clear();
28	/**
29	* Adds parameters to the service container parameters.
30	*
31	* @throws LogicException if the parameter cannot be added
32	*/
33	public function add(array $parameters);
34	/**
35	* Gets the service container parameters.
36	*
37	* @return array
38	*/
39	public function all();
40	/**
41	* Gets a service container parameter.
42	*
43	* @return array\|bool\|string\|int\|float\|\UnitEnum\|null
44	*
45	* @throws ParameterNotFoundException if the parameter is not defined
46	*/
47	public function get(string $name);
48	/**
49	* Removes a parameter.
50	*/
51	public function remove(string $name);
52	/**
53	* Sets a service container parameter.
54	*
55	* @param array\|bool\|string\|int\|float\|\UnitEnum\|null $value The parameter value
56	*
57	* @throws LogicException if the parameter cannot be set
58	*/
59	public function set(string $name, $value);
60	/**
61	* Returns true if a parameter name is defined.
62	*
63	* @return bool
64	*/
65	public function has(string $name);
66	/**
67	* Replaces parameter placeholders (%name%) by their values for all parameters.
68	*/
69	public function resolve();
70	/**
71	* Replaces parameter placeholders (%name%) by their values.
72	*
73	* @param mixed $value A value
74	*
75	* @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
76	*/
77	public function resolveValue($value);
78	/**
79	* Escape parameter placeholders %.
80	*
81	* @param mixed $value
82	*
83	* @return mixed
84	*/
85	public function escapeValue($value);
86	/**
87	* Unescape parameter placeholders %.
88	*
89	* @param mixed $value
90	*
91	* @return mixed
92	*/
93	public function unescapeValue($value);
94	}
95