boxzilla / src / di / class-container.php

class-container.php in Boxzilla – WordPress Popup Builder 3.2.21, at src/di/class-container.php

271 lines 8.0 KB

Raw Download Zip

1	<?php
2	// phpcs:ignoreFile
3	/*
4	* This file is part of Pimple.
5	*
6	* Copyright (c) 2009 Fabien Potencier
7	*
8	* Permission is hereby granted, free of charge, to any person obtaining a copy
9	* of this software and associated documentation files (the "Software"), to deal
10	* in the Software without restriction, including without limitation the rights
11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12	* copies of the Software, and to permit persons to whom the Software is furnished
13	* to do so, subject to the following conditions:
14	*
15	* The above copyright notice and this permission notice shall be included in all
16	* copies or substantial portions of the Software.
17	*
18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24	* THE SOFTWARE.
25	*/
26
27	namespace Boxzilla\DI;
28
29	/**
30	* Container main class.
31	*
32	* @author Fabien Potencier
33	*/
34	class Container implements \ArrayAccess {
35
36	private $values = array();
37	private $factories;
38	private $protected;
39	private $frozen = array();
40	private $raw = array();
41	private $keys = array();
42
43	/**
44	* Instantiate the container.
45	*
46	* Objects and parameters can be passed as argument to the constructor.
47	*
48	* @param array $values The parameters or objects.
49	*/
50	public function __construct( array $values = array() ) {
51	$this->factories = new \SplObjectStorage();
52	$this->protected = new \SplObjectStorage();
53
54	foreach ( $values as $key => $value ) {
55	$this->offsetSet( $key, $value );
56	}
57	}
58
59	/**
60	* Sets a parameter or an object.
61	*
62	* Objects must be defined as Closures.
63	*
64	* Allowing any PHP callable leads to difficult to debug problems
65	* as function names (strings) are callable (creating a function with
66	* the same name as an existing parameter would break your container).
67	*
68	* @param string $id The unique identifier for the parameter or object
69	* @param mixed $value The value of the parameter or a closure to define an object
70	* @throws \RuntimeException Prevent override of a frozen service
71	*/
72	public function offsetSet( $id, $value ) {
73	if ( isset( $this->frozen[ $id ] ) ) {
74	throw new \RuntimeException( sprintf( 'Cannot override frozen service "%s".', $id ) );
75	}
76
77	$this->values[ $id ] = $value;
78	$this->keys[ $id ] = true;
79	}
80
81	/**
82	* Gets a parameter or an object.
83	*
84	* @param string $id The unique identifier for the parameter or object
85	*
86	* @return mixed The value of the parameter or an object
87	*
88	* @throws \InvalidArgumentException if the identifier is not defined
89	*/
90	public function offsetGet( $id ) {
91	if ( ! isset( $this->keys[ $id ] ) ) {
92	throw new \InvalidArgumentException( sprintf( 'Identifier "%s" is not defined.', $id ) );
93	}
94
95	if (
96	isset( $this->raw[ $id ] )
97	\|\| ! is_object( $this->values[ $id ] )
98	\|\| isset( $this->protected[ $this->values[ $id ] ] )
99	\|\| ! method_exists( $this->values[ $id ], '__invoke' )
100	) {
101	return $this->values[ $id ];
102	}
103
104	if ( isset( $this->factories[ $this->values[ $id ] ] ) ) {
105	return $this->values[ $id ]($this);
106	}
107
108	$raw = $this->values[ $id ];
109	$val = $this->values[ $id ] = $raw( $this );
110	$this->raw[ $id ] = $raw;
111
112	$this->frozen[ $id ] = true;
113
114	return $val;
115	}
116
117	/**
118	* Checks if a parameter or an object is set.
119	*
120	* @param string $id The unique identifier for the parameter or object
121	*
122	* @return bool
123	*/
124	public function offsetExists( $id ) {
125	return isset( $this->keys[ $id ] );
126	}
127
128	/**
129	* Unsets a parameter or an object.
130	*
131	* @param string $id The unique identifier for the parameter or object
132	*/
133	public function offsetUnset( $id ) {
134	if ( isset( $this->keys[ $id ] ) ) {
135	if ( is_object( $this->values[ $id ] ) ) {
136	unset( $this->factories[ $this->values[ $id ] ], $this->protected[ $this->values[ $id ] ] );
137	}
138
139	unset( $this->values[ $id ], $this->frozen[ $id ], $this->raw[ $id ], $this->keys[ $id ] );
140	}
141	}
142
143	/**
144	* Marks a callable as being a factory service.
145	*
146	* @param callable $callable A service definition to be used as a factory
147	*
148	* @return callable The passed callable
149	*
150	* @throws \InvalidArgumentException Service definition has to be a closure of an invokable object
151	*/
152	public function factory( $callable ) {
153	if ( ! is_object( $callable ) \|\| ! method_exists( $callable, '__invoke' ) ) {
154	throw new \InvalidArgumentException( 'Service definition is not a Closure or invokable object.' );
155	}
156
157	$this->factories->attach( $callable );
158
159	return $callable;
160	}
161
162	/**
163	* Protects a callable from being interpreted as a service.
164	*
165	* This is useful when you want to store a callable as a parameter.
166	*
167	* @param callable $callable A callable to protect from being evaluated
168	*
169	* @return callable The passed callable
170	*
171	* @throws \InvalidArgumentException Service definition has to be a closure of an invokable object
172	*/
173	public function protect( $callable ) {
174	if ( ! is_object( $callable ) \|\| ! method_exists( $callable, '__invoke' ) ) {
175	throw new \InvalidArgumentException( 'Callable is not a Closure or invokable object.' );
176	}
177
178	$this->protected->attach( $callable );
179
180	return $callable;
181	}
182
183	/**
184	* Gets a parameter or the closure defining an object.
185	*
186	* @param string $id The unique identifier for the parameter or object
187	*
188	* @return mixed The value of the parameter or the closure defining an object
189	*
190	* @throws \InvalidArgumentException if the identifier is not defined
191	*/
192	public function raw( $id ) {
193	if ( ! isset( $this->keys[ $id ] ) ) {
194	throw new \InvalidArgumentException( sprintf( 'Identifier "%s" is not defined.', $id ) );
195	}
196
197	if ( isset( $this->raw[ $id ] ) ) {
198	return $this->raw[ $id ];
199	}
200
201	return $this->values[ $id ];
202	}
203
204	/**
205	* Extends an object definition.
206	*
207	* Useful when you want to extend an existing object definition,
208	* without necessarily loading that object.
209	*
210	* @param string $id The unique identifier for the object
211	* @param callable $callable A service definition to extend the original
212	*
213	* @return callable The wrapped callable
214	*
215	* @throws \InvalidArgumentException if the identifier is not defined or not a service definition
216	*/
217	public function extend( $id, $callable ) {
218	if ( ! isset( $this->keys[ $id ] ) ) {
219	throw new \InvalidArgumentException( sprintf( 'Identifier "%s" is not defined.', $id ) );
220	}
221
222	if ( ! is_object( $this->values[ $id ] ) \|\| ! method_exists( $this->values[ $id ], '__invoke' ) ) {
223	throw new \InvalidArgumentException( sprintf( 'Identifier "%s" does not contain an object definition.', $id ) );
224	}
225
226	if ( ! is_object( $callable ) \|\| ! method_exists( $callable, '__invoke' ) ) {
227	throw new \InvalidArgumentException( 'Extension service definition is not a Closure or invokable object.' );
228	}
229
230	$factory = $this->values[ $id ];
231
232	$extended = function ( $c ) use ( $callable, $factory ) {
233	return $callable( $factory( $c ), $c );
234	};
235
236	if ( isset( $this->factories[ $factory ] ) ) {
237	$this->factories->detach( $factory );
238	$this->factories->attach( $extended );
239	}
240
241	return $this[ $id ] = $extended;
242	}
243
244	/**
245	* Returns all defined value names.
246	*
247	* @return array An array of value names
248	*/
249	public function keys() {
250	return array_keys( $this->values );
251	}
252
253	/**
254	* Registers a service provider.
255	*
256	* @param ServiceProviderInterface $provider A ServiceProviderInterface instance
257	* @param array $values An array of values that customizes the provider
258	*
259	* @return static
260	*/
261	public function register( ServiceProviderInterface $provider, array $values = array() ) {
262	$provider->register( $this );
263
264	foreach ( $values as $key => $value ) {
265	$this[ $key ] = $value;
266	}
267
268	return $this;
269	}
270	}
271