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 18.0, at vendor_prefixed/symfony/dependency-injection/ParameterBag/ParameterBagInterface.php

104 lines 2.7 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.
17	*
18	* @author Fabien Potencier <[email protected]>
19	*/
20	interface ParameterBagInterface
21	{
22	/**
23	* Clears all parameters.
24	*
25	* @throws LogicException if the ParameterBagInterface can not be cleared
26	*/
27	public function clear();
28	/**
29	* Adds parameters to the service container parameters.
30	*
31	* @param array $parameters An array of parameters
32	*
33	* @throws LogicException if the parameter can not be added
34	*/
35	public function add(array $parameters);
36	/**
37	* Gets the service container parameters.
38	*
39	* @return array An array of parameters
40	*/
41	public function all();
42	/**
43	* Gets a service container parameter.
44	*
45	* @param string $name The parameter name
46	*
47	* @return mixed The parameter value
48	*
49	* @throws ParameterNotFoundException if the parameter is not defined
50	*/
51	public function get($name);
52	/**
53	* Removes a parameter.
54	*
55	* @param string $name The parameter name
56	*/
57	public function remove($name);
58	/**
59	* Sets a service container parameter.
60	*
61	* @param string $name The parameter name
62	* @param mixed $value The parameter value
63	*
64	* @throws LogicException if the parameter can not be set
65	*/
66	public function set($name, $value);
67	/**
68	* Returns true if a parameter name is defined.
69	*
70	* @param string $name The parameter name
71	*
72	* @return bool true if the parameter name is defined, false otherwise
73	*/
74	public function has($name);
75	/**
76	* Replaces parameter placeholders (%name%) by their values for all parameters.
77	*/
78	public function resolve();
79	/**
80	* Replaces parameter placeholders (%name%) by their values.
81	*
82	* @param mixed $value A value
83	*
84	* @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
85	*/
86	public function resolveValue($value);
87	/**
88	* Escape parameter placeholders %.
89	*
90	* @param mixed $value
91	*
92	* @return mixed
93	*/
94	public function escapeValue($value);
95	/**
96	* Unescape parameter placeholders %.
97	*
98	* @param mixed $value
99	*
100	* @return mixed
101	*/
102	public function unescapeValue($value);
103	}
104