@@ -13,322 +13,322 @@ |
||
| 13 | 13 | * @subpackage Core |
| 14 | 14 | */ |
| 15 | 15 | class Container implements ContainerContract { |
| 16 | - /** |
|
| 17 | - * ServiceProvider names to register with the container. |
|
| 18 | - * |
|
| 19 | - * Can be overwritten to include predefined providers. |
|
| 20 | - * |
|
| 21 | - * @var string[] |
|
| 22 | - */ |
|
| 23 | - protected $providers = array(); |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * Registered definitions. |
|
| 27 | - * |
|
| 28 | - * @var mixed[] |
|
| 29 | - */ |
|
| 30 | - private $definitions = array(); |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Aliases to share between fetches. |
|
| 34 | - * |
|
| 35 | - * @var <string, true>[] |
|
| 36 | - */ |
|
| 37 | - private $shared = array(); |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * Aliases of all the registered services. |
|
| 41 | - * |
|
| 42 | - * @var <string, true>[] |
|
| 43 | - */ |
|
| 44 | - private $aliases = array(); |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * Array of classes registered on the container. |
|
| 48 | - * |
|
| 49 | - * @var <string, true>[] |
|
| 50 | - */ |
|
| 51 | - private $classes = array(); |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * Current position in the loop. |
|
| 55 | - * |
|
| 56 | - * @var int |
|
| 57 | - */ |
|
| 58 | - private $position; |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * 0-indexed array of aliases for looping. |
|
| 62 | - * |
|
| 63 | - * @var string[] |
|
| 64 | - */ |
|
| 65 | - private $keys = array(); |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * Create a new container with the given providers. |
|
| 69 | - * |
|
| 70 | - * Providers can be instances or the class of the provider as a string. |
|
| 71 | - * |
|
| 72 | - * @param ServiceProvider[]|string[] $providers |
|
| 73 | - */ |
|
| 74 | - public function __construct( array $providers = array() ) { |
|
| 75 | - // array_unique ensures we only register each provider once. |
|
| 76 | - $providers = array_unique( array_merge( $this->providers, $providers ) ); |
|
| 77 | - |
|
| 78 | - foreach ( $providers as $provider ) { |
|
| 79 | - if ( is_string( $provider ) && class_exists( $provider ) ) { |
|
| 80 | - $provider = new $provider; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - if ( $provider instanceof ServiceProvider ) { |
|
| 84 | - $this->register( $provider ); |
|
| 85 | - } |
|
| 86 | - } |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * {@inheritdoc} |
|
| 92 | - * |
|
| 93 | - * @param string|array $alias |
|
| 94 | - * @param mixed $definition |
|
| 95 | - * |
|
| 96 | - * @throws DefinedAliasException |
|
| 97 | - * |
|
| 98 | - * @return $this |
|
| 99 | - */ |
|
| 100 | - public function define( $alias, $definition ) { |
|
| 101 | - if ( is_array( $alias ) ) { |
|
| 102 | - $class = current( $alias ); |
|
| 103 | - $alias = key( $alias ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - if ( isset( $this->aliases[ $alias ] ) ) { |
|
| 107 | - throw new DefinedAliasException( $alias ); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - $this->aliases[ $alias ] = true; |
|
| 111 | - $this->definitions[ $alias ] = $definition; |
|
| 112 | - |
|
| 113 | - // Closures are treated as factories unless |
|
| 114 | - // defined via Container::share. |
|
| 115 | - if ( ! $definition instanceof \Closure ) { |
|
| 116 | - $this->shared[ $alias ] = true; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - if ( isset( $class ) ) { |
|
| 120 | - $this->classes[ $class ] = $alias; |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - return $this; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * {@inheritdoc} |
|
| 128 | - * |
|
| 129 | - * @param string|array $alias |
|
| 130 | - * @param mixed $definition |
|
| 131 | - * |
|
| 132 | - * @throws DefinedAliasException |
|
| 133 | - * |
|
| 134 | - * @return $this |
|
| 135 | - */ |
|
| 136 | - public function share( $alias, $definition ) { |
|
| 137 | - $this->define( $alias, $definition ); |
|
| 138 | - |
|
| 139 | - if ( is_array( $alias ) ) { |
|
| 140 | - $alias = key( $alias ); |
|
| 141 | - } |
|
| 142 | - |
|
| 143 | - $this->shared[ $alias ] = true; |
|
| 144 | - |
|
| 145 | - return $this; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * {@inheritdoc} |
|
| 150 | - * |
|
| 151 | - * @param string $alias |
|
| 152 | - * |
|
| 153 | - * @throws UndefinedAliasException |
|
| 154 | - * |
|
| 155 | - * @return mixed |
|
| 156 | - */ |
|
| 157 | - public function fetch( $alias ) { |
|
| 158 | - if ( isset( $this->classes[ $alias ] ) ) { |
|
| 159 | - // If the alias is a class name, |
|
| 160 | - // then retrieve its linked alias. |
|
| 161 | - // This is only registered when |
|
| 162 | - // registering using an array. |
|
| 163 | - $alias = $this->classes[ $alias ]; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - if ( ! isset( $this->aliases[ $alias ] ) ) { |
|
| 167 | - throw new UndefinedAliasException( $alias ); |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - $value = $this->definitions[ $alias ]; |
|
| 171 | - |
|
| 172 | - // If the shared value is a closure, |
|
| 173 | - // execute it and assign the result |
|
| 174 | - // in place of the closure. |
|
| 175 | - if ( $value instanceof \Closure ) { |
|
| 176 | - $factory = $value; |
|
| 177 | - $value = $factory( $this ); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - // If the value is shared, save the shared value. |
|
| 181 | - if ( isset( $this->shared[ $alias ] ) ) { |
|
| 182 | - $this->definitions[ $alias ] = $value; |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - // Return the fetched value. |
|
| 186 | - return $value; |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * {@inheritdoc} |
|
| 191 | - * |
|
| 192 | - * @param string $alias |
|
| 193 | - * |
|
| 194 | - * @return bool |
|
| 195 | - */ |
|
| 196 | - public function has( $alias ) { |
|
| 197 | - return isset( $this->aliases[ $alias ] ); |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - /** |
|
| 201 | - * {@inheritDoc} |
|
| 202 | - * |
|
| 203 | - * @param string $alias |
|
| 204 | - * |
|
| 205 | - * @return $this |
|
| 206 | - */ |
|
| 207 | - public function remove( $alias ) { |
|
| 208 | - if ( isset( $this->aliases[ $alias ] ) ) { |
|
| 209 | - /** |
|
| 210 | - * If there's no reference in the aliases array, |
|
| 211 | - * the service won't be found on fetching and |
|
| 212 | - * can be overwritten on setting. |
|
| 213 | - * |
|
| 214 | - * Pros: Quick setting/unsetting, faster |
|
| 215 | - * performance on those operations when doing |
|
| 216 | - * a lot of these. |
|
| 217 | - * |
|
| 218 | - * Cons: Objects and values set in the container |
|
| 219 | - * can't get garbage collected. |
|
| 220 | - * |
|
| 221 | - * If this is a problem, this may need to be revisited. |
|
| 222 | - */ |
|
| 223 | - unset( $this->aliases[ $alias ] ); |
|
| 224 | - } |
|
| 225 | - |
|
| 226 | - return $this; |
|
| 227 | - } |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * {@inheritDoc} |
|
| 231 | - * |
|
| 232 | - * @param ServiceProvider $provider |
|
| 233 | - * |
|
| 234 | - * @return $this |
|
| 235 | - */ |
|
| 236 | - public function register( ServiceProvider $provider ) { |
|
| 237 | - // @todo make sure provider is only registered once |
|
| 238 | - $provider->register( $this ); |
|
| 239 | - |
|
| 240 | - return $this; |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Set a value into the container. |
|
| 245 | - * |
|
| 246 | - * @param string $id |
|
| 247 | - * @param mixed $value |
|
| 248 | - * |
|
| 249 | - * @see define |
|
| 250 | - */ |
|
| 251 | - public function offsetSet( $id, $value ) { |
|
| 252 | - $this->define( $id, $value ); |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - /** |
|
| 256 | - * Get an value from the container. |
|
| 257 | - * |
|
| 258 | - * @param string $id |
|
| 259 | - * |
|
| 260 | - * @return object |
|
| 261 | - * @throws UndefinedAliasException |
|
| 262 | - * |
|
| 263 | - * @see fetch |
|
| 264 | - */ |
|
| 265 | - public function offsetGet( $id ) { |
|
| 266 | - return $this->fetch( $id ); |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * Checks if a key is set on the container. |
|
| 271 | - * |
|
| 272 | - * @param string $id |
|
| 273 | - * |
|
| 274 | - * @return bool |
|
| 275 | - * |
|
| 276 | - * @see has |
|
| 277 | - */ |
|
| 278 | - public function offsetExists( $id ) { |
|
| 279 | - return $this->has( $id ); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /** |
|
| 283 | - * Remove a key from the container. |
|
| 284 | - * |
|
| 285 | - * @param string $id |
|
| 286 | - * |
|
| 287 | - * @see remove |
|
| 288 | - */ |
|
| 289 | - public function offsetUnset( $id ) { |
|
| 290 | - $this->remove( $id ); |
|
| 291 | - } |
|
| 292 | - |
|
| 293 | - /** |
|
| 294 | - * Sets the object properties to prepare for the loop. |
|
| 295 | - */ |
|
| 296 | - public function rewind() { |
|
| 297 | - $this->position = 0; |
|
| 298 | - $this->keys = array_keys( $this->aliases ); |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * Retrieves the service object for the current step in the loop. |
|
| 303 | - * |
|
| 304 | - * @return object |
|
| 305 | - */ |
|
| 306 | - public function current() { |
|
| 307 | - return $this->fetch( $this->keys[ $this->position ] ); |
|
| 308 | - } |
|
| 309 | - |
|
| 310 | - /** |
|
| 311 | - * Retrieves the key for the current step in the loop. |
|
| 312 | - * |
|
| 313 | - * @return string |
|
| 314 | - */ |
|
| 315 | - public function key() { |
|
| 316 | - return $this->keys[ $this->position ]; |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - /** |
|
| 320 | - * Increments to the next step in the loop. |
|
| 321 | - */ |
|
| 322 | - public function next() { |
|
| 323 | - $this->position ++; |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - /** |
|
| 327 | - * Checks if the next step in the loop in valid. |
|
| 328 | - * |
|
| 329 | - * @return bool |
|
| 330 | - */ |
|
| 331 | - public function valid() { |
|
| 332 | - return isset( $this->keys[ $this->position ] ); |
|
| 333 | - } |
|
| 16 | + /** |
|
| 17 | + * ServiceProvider names to register with the container. |
|
| 18 | + * |
|
| 19 | + * Can be overwritten to include predefined providers. |
|
| 20 | + * |
|
| 21 | + * @var string[] |
|
| 22 | + */ |
|
| 23 | + protected $providers = array(); |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * Registered definitions. |
|
| 27 | + * |
|
| 28 | + * @var mixed[] |
|
| 29 | + */ |
|
| 30 | + private $definitions = array(); |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Aliases to share between fetches. |
|
| 34 | + * |
|
| 35 | + * @var <string, true>[] |
|
| 36 | + */ |
|
| 37 | + private $shared = array(); |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * Aliases of all the registered services. |
|
| 41 | + * |
|
| 42 | + * @var <string, true>[] |
|
| 43 | + */ |
|
| 44 | + private $aliases = array(); |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * Array of classes registered on the container. |
|
| 48 | + * |
|
| 49 | + * @var <string, true>[] |
|
| 50 | + */ |
|
| 51 | + private $classes = array(); |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * Current position in the loop. |
|
| 55 | + * |
|
| 56 | + * @var int |
|
| 57 | + */ |
|
| 58 | + private $position; |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * 0-indexed array of aliases for looping. |
|
| 62 | + * |
|
| 63 | + * @var string[] |
|
| 64 | + */ |
|
| 65 | + private $keys = array(); |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * Create a new container with the given providers. |
|
| 69 | + * |
|
| 70 | + * Providers can be instances or the class of the provider as a string. |
|
| 71 | + * |
|
| 72 | + * @param ServiceProvider[]|string[] $providers |
|
| 73 | + */ |
|
| 74 | + public function __construct( array $providers = array() ) { |
|
| 75 | + // array_unique ensures we only register each provider once. |
|
| 76 | + $providers = array_unique( array_merge( $this->providers, $providers ) ); |
|
| 77 | + |
|
| 78 | + foreach ( $providers as $provider ) { |
|
| 79 | + if ( is_string( $provider ) && class_exists( $provider ) ) { |
|
| 80 | + $provider = new $provider; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + if ( $provider instanceof ServiceProvider ) { |
|
| 84 | + $this->register( $provider ); |
|
| 85 | + } |
|
| 86 | + } |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * {@inheritdoc} |
|
| 92 | + * |
|
| 93 | + * @param string|array $alias |
|
| 94 | + * @param mixed $definition |
|
| 95 | + * |
|
| 96 | + * @throws DefinedAliasException |
|
| 97 | + * |
|
| 98 | + * @return $this |
|
| 99 | + */ |
|
| 100 | + public function define( $alias, $definition ) { |
|
| 101 | + if ( is_array( $alias ) ) { |
|
| 102 | + $class = current( $alias ); |
|
| 103 | + $alias = key( $alias ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + if ( isset( $this->aliases[ $alias ] ) ) { |
|
| 107 | + throw new DefinedAliasException( $alias ); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + $this->aliases[ $alias ] = true; |
|
| 111 | + $this->definitions[ $alias ] = $definition; |
|
| 112 | + |
|
| 113 | + // Closures are treated as factories unless |
|
| 114 | + // defined via Container::share. |
|
| 115 | + if ( ! $definition instanceof \Closure ) { |
|
| 116 | + $this->shared[ $alias ] = true; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + if ( isset( $class ) ) { |
|
| 120 | + $this->classes[ $class ] = $alias; |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + return $this; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * {@inheritdoc} |
|
| 128 | + * |
|
| 129 | + * @param string|array $alias |
|
| 130 | + * @param mixed $definition |
|
| 131 | + * |
|
| 132 | + * @throws DefinedAliasException |
|
| 133 | + * |
|
| 134 | + * @return $this |
|
| 135 | + */ |
|
| 136 | + public function share( $alias, $definition ) { |
|
| 137 | + $this->define( $alias, $definition ); |
|
| 138 | + |
|
| 139 | + if ( is_array( $alias ) ) { |
|
| 140 | + $alias = key( $alias ); |
|
| 141 | + } |
|
| 142 | + |
|
| 143 | + $this->shared[ $alias ] = true; |
|
| 144 | + |
|
| 145 | + return $this; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * {@inheritdoc} |
|
| 150 | + * |
|
| 151 | + * @param string $alias |
|
| 152 | + * |
|
| 153 | + * @throws UndefinedAliasException |
|
| 154 | + * |
|
| 155 | + * @return mixed |
|
| 156 | + */ |
|
| 157 | + public function fetch( $alias ) { |
|
| 158 | + if ( isset( $this->classes[ $alias ] ) ) { |
|
| 159 | + // If the alias is a class name, |
|
| 160 | + // then retrieve its linked alias. |
|
| 161 | + // This is only registered when |
|
| 162 | + // registering using an array. |
|
| 163 | + $alias = $this->classes[ $alias ]; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + if ( ! isset( $this->aliases[ $alias ] ) ) { |
|
| 167 | + throw new UndefinedAliasException( $alias ); |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + $value = $this->definitions[ $alias ]; |
|
| 171 | + |
|
| 172 | + // If the shared value is a closure, |
|
| 173 | + // execute it and assign the result |
|
| 174 | + // in place of the closure. |
|
| 175 | + if ( $value instanceof \Closure ) { |
|
| 176 | + $factory = $value; |
|
| 177 | + $value = $factory( $this ); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + // If the value is shared, save the shared value. |
|
| 181 | + if ( isset( $this->shared[ $alias ] ) ) { |
|
| 182 | + $this->definitions[ $alias ] = $value; |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + // Return the fetched value. |
|
| 186 | + return $value; |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * {@inheritdoc} |
|
| 191 | + * |
|
| 192 | + * @param string $alias |
|
| 193 | + * |
|
| 194 | + * @return bool |
|
| 195 | + */ |
|
| 196 | + public function has( $alias ) { |
|
| 197 | + return isset( $this->aliases[ $alias ] ); |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + /** |
|
| 201 | + * {@inheritDoc} |
|
| 202 | + * |
|
| 203 | + * @param string $alias |
|
| 204 | + * |
|
| 205 | + * @return $this |
|
| 206 | + */ |
|
| 207 | + public function remove( $alias ) { |
|
| 208 | + if ( isset( $this->aliases[ $alias ] ) ) { |
|
| 209 | + /** |
|
| 210 | + * If there's no reference in the aliases array, |
|
| 211 | + * the service won't be found on fetching and |
|
| 212 | + * can be overwritten on setting. |
|
| 213 | + * |
|
| 214 | + * Pros: Quick setting/unsetting, faster |
|
| 215 | + * performance on those operations when doing |
|
| 216 | + * a lot of these. |
|
| 217 | + * |
|
| 218 | + * Cons: Objects and values set in the container |
|
| 219 | + * can't get garbage collected. |
|
| 220 | + * |
|
| 221 | + * If this is a problem, this may need to be revisited. |
|
| 222 | + */ |
|
| 223 | + unset( $this->aliases[ $alias ] ); |
|
| 224 | + } |
|
| 225 | + |
|
| 226 | + return $this; |
|
| 227 | + } |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * {@inheritDoc} |
|
| 231 | + * |
|
| 232 | + * @param ServiceProvider $provider |
|
| 233 | + * |
|
| 234 | + * @return $this |
|
| 235 | + */ |
|
| 236 | + public function register( ServiceProvider $provider ) { |
|
| 237 | + // @todo make sure provider is only registered once |
|
| 238 | + $provider->register( $this ); |
|
| 239 | + |
|
| 240 | + return $this; |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Set a value into the container. |
|
| 245 | + * |
|
| 246 | + * @param string $id |
|
| 247 | + * @param mixed $value |
|
| 248 | + * |
|
| 249 | + * @see define |
|
| 250 | + */ |
|
| 251 | + public function offsetSet( $id, $value ) { |
|
| 252 | + $this->define( $id, $value ); |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + /** |
|
| 256 | + * Get an value from the container. |
|
| 257 | + * |
|
| 258 | + * @param string $id |
|
| 259 | + * |
|
| 260 | + * @return object |
|
| 261 | + * @throws UndefinedAliasException |
|
| 262 | + * |
|
| 263 | + * @see fetch |
|
| 264 | + */ |
|
| 265 | + public function offsetGet( $id ) { |
|
| 266 | + return $this->fetch( $id ); |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * Checks if a key is set on the container. |
|
| 271 | + * |
|
| 272 | + * @param string $id |
|
| 273 | + * |
|
| 274 | + * @return bool |
|
| 275 | + * |
|
| 276 | + * @see has |
|
| 277 | + */ |
|
| 278 | + public function offsetExists( $id ) { |
|
| 279 | + return $this->has( $id ); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /** |
|
| 283 | + * Remove a key from the container. |
|
| 284 | + * |
|
| 285 | + * @param string $id |
|
| 286 | + * |
|
| 287 | + * @see remove |
|
| 288 | + */ |
|
| 289 | + public function offsetUnset( $id ) { |
|
| 290 | + $this->remove( $id ); |
|
| 291 | + } |
|
| 292 | + |
|
| 293 | + /** |
|
| 294 | + * Sets the object properties to prepare for the loop. |
|
| 295 | + */ |
|
| 296 | + public function rewind() { |
|
| 297 | + $this->position = 0; |
|
| 298 | + $this->keys = array_keys( $this->aliases ); |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * Retrieves the service object for the current step in the loop. |
|
| 303 | + * |
|
| 304 | + * @return object |
|
| 305 | + */ |
|
| 306 | + public function current() { |
|
| 307 | + return $this->fetch( $this->keys[ $this->position ] ); |
|
| 308 | + } |
|
| 309 | + |
|
| 310 | + /** |
|
| 311 | + * Retrieves the key for the current step in the loop. |
|
| 312 | + * |
|
| 313 | + * @return string |
|
| 314 | + */ |
|
| 315 | + public function key() { |
|
| 316 | + return $this->keys[ $this->position ]; |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + /** |
|
| 320 | + * Increments to the next step in the loop. |
|
| 321 | + */ |
|
| 322 | + public function next() { |
|
| 323 | + $this->position ++; |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + /** |
|
| 327 | + * Checks if the next step in the loop in valid. |
|
| 328 | + * |
|
| 329 | + * @return bool |
|
| 330 | + */ |
|
| 331 | + public function valid() { |
|
| 332 | + return isset( $this->keys[ $this->position ] ); |
|
| 333 | + } |
|
| 334 | 334 | } |
@@ -11,39 +11,39 @@ |
||
| 11 | 11 | * @subpackage Utility |
| 12 | 12 | */ |
| 13 | 13 | class Str { |
| 14 | - /** |
|
| 15 | - * Determine if a given string starts with a given substring. |
|
| 16 | - * |
|
| 17 | - * @param string $haystack |
|
| 18 | - * @param string|array $needles |
|
| 19 | - * |
|
| 20 | - * @return bool |
|
| 21 | - */ |
|
| 22 | - public static function starts_with( $haystack, $needles ) { |
|
| 23 | - foreach ( (array) $needles as $needle ) { |
|
| 24 | - if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) { |
|
| 25 | - return true; |
|
| 26 | - } |
|
| 27 | - } |
|
| 14 | + /** |
|
| 15 | + * Determine if a given string starts with a given substring. |
|
| 16 | + * |
|
| 17 | + * @param string $haystack |
|
| 18 | + * @param string|array $needles |
|
| 19 | + * |
|
| 20 | + * @return bool |
|
| 21 | + */ |
|
| 22 | + public static function starts_with( $haystack, $needles ) { |
|
| 23 | + foreach ( (array) $needles as $needle ) { |
|
| 24 | + if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) { |
|
| 25 | + return true; |
|
| 26 | + } |
|
| 27 | + } |
|
| 28 | 28 | |
| 29 | - return false; |
|
| 30 | - } |
|
| 29 | + return false; |
|
| 30 | + } |
|
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * Determine if a given string ends with a given substring. |
|
| 34 | - * |
|
| 35 | - * @param string $haystack |
|
| 36 | - * @param string|array $needles |
|
| 37 | - * |
|
| 38 | - * @return bool |
|
| 39 | - */ |
|
| 40 | - public static function ends_with( $haystack, $needles ) { |
|
| 41 | - foreach ( (array) $needles as $needle ) { |
|
| 42 | - if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) { |
|
| 43 | - return true; |
|
| 44 | - } |
|
| 45 | - } |
|
| 32 | + /** |
|
| 33 | + * Determine if a given string ends with a given substring. |
|
| 34 | + * |
|
| 35 | + * @param string $haystack |
|
| 36 | + * @param string|array $needles |
|
| 37 | + * |
|
| 38 | + * @return bool |
|
| 39 | + */ |
|
| 40 | + public static function ends_with( $haystack, $needles ) { |
|
| 41 | + foreach ( (array) $needles as $needle ) { |
|
| 42 | + if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) { |
|
| 43 | + return true; |
|
| 44 | + } |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - return false; |
|
| 48 | - } |
|
| 47 | + return false; |
|
| 48 | + } |
|
| 49 | 49 | } |
@@ -2,10 +2,10 @@ |
||
| 2 | 2 | namespace Intraxia\Jaxion\Contract\Core; |
| 3 | 3 | |
| 4 | 4 | interface I18n { |
| 5 | - /** |
|
| 6 | - * Loads the plugin's textdomain. |
|
| 7 | - * |
|
| 8 | - * @return void |
|
| 9 | - */ |
|
| 10 | - public function load_plugin_textdomain(); |
|
| 5 | + /** |
|
| 6 | + * Loads the plugin's textdomain. |
|
| 7 | + * |
|
| 8 | + * @return void |
|
| 9 | + */ |
|
| 10 | + public function load_plugin_textdomain(); |
|
| 11 | 11 | } |
@@ -11,53 +11,53 @@ |
||
| 11 | 11 | * @subpackage Core |
| 12 | 12 | */ |
| 13 | 13 | class I18n implements I18nContract, HasActions { |
| 14 | - /** |
|
| 15 | - * Plugin basename |
|
| 16 | - * |
|
| 17 | - * @var string |
|
| 18 | - */ |
|
| 19 | - private $basename; |
|
| 14 | + /** |
|
| 15 | + * Plugin basename |
|
| 16 | + * |
|
| 17 | + * @var string |
|
| 18 | + */ |
|
| 19 | + private $basename; |
|
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Plugin path. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - private $path; |
|
| 21 | + /** |
|
| 22 | + * Plugin path. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + private $path; |
|
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * I18n constructor. |
|
| 30 | - * |
|
| 31 | - * @param string $basename Plugin basename. |
|
| 32 | - * @param string $path Plugin path. |
|
| 33 | - */ |
|
| 34 | - public function __construct( $basename, $path ) { |
|
| 35 | - $this->basename = $basename; |
|
| 36 | - $this->path = $path; |
|
| 37 | - } |
|
| 28 | + /** |
|
| 29 | + * I18n constructor. |
|
| 30 | + * |
|
| 31 | + * @param string $basename Plugin basename. |
|
| 32 | + * @param string $path Plugin path. |
|
| 33 | + */ |
|
| 34 | + public function __construct( $basename, $path ) { |
|
| 35 | + $this->basename = $basename; |
|
| 36 | + $this->path = $path; |
|
| 37 | + } |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * {@inheritdoc} |
|
| 41 | - */ |
|
| 42 | - public function load_plugin_textdomain() { |
|
| 43 | - load_plugin_textdomain( |
|
| 44 | - $this->basename, |
|
| 45 | - false, |
|
| 46 | - basename( $this->path ) . '/languages/' |
|
| 47 | - ); |
|
| 48 | - } |
|
| 39 | + /** |
|
| 40 | + * {@inheritdoc} |
|
| 41 | + */ |
|
| 42 | + public function load_plugin_textdomain() { |
|
| 43 | + load_plugin_textdomain( |
|
| 44 | + $this->basename, |
|
| 45 | + false, |
|
| 46 | + basename( $this->path ) . '/languages/' |
|
| 47 | + ); |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * {@inheritDoc} |
|
| 52 | - * |
|
| 53 | - * @return array |
|
| 54 | - */ |
|
| 55 | - public function action_hooks() { |
|
| 56 | - return array( |
|
| 57 | - array( |
|
| 58 | - 'hook' => 'init', |
|
| 59 | - 'method' => 'load_plugin_textdomain', |
|
| 60 | - ), |
|
| 61 | - ); |
|
| 62 | - } |
|
| 50 | + /** |
|
| 51 | + * {@inheritDoc} |
|
| 52 | + * |
|
| 53 | + * @return array |
|
| 54 | + */ |
|
| 55 | + public function action_hooks() { |
|
| 56 | + return array( |
|
| 57 | + array( |
|
| 58 | + 'hook' => 'init', |
|
| 59 | + 'method' => 'load_plugin_textdomain', |
|
| 60 | + ), |
|
| 61 | + ); |
|
| 62 | + } |
|
| 63 | 63 | } |
@@ -6,54 +6,54 @@ |
||
| 6 | 6 | use WP_Error; |
| 7 | 7 | |
| 8 | 8 | interface EntityManager { |
| 9 | - /** |
|
| 10 | - * Get a single model of the provided class with the given ID. |
|
| 11 | - * |
|
| 12 | - * @param string $class Fully qualified class name of model. |
|
| 13 | - * @param int $id ID of the model. |
|
| 14 | - * |
|
| 15 | - * @return Model|WP_Error |
|
| 16 | - */ |
|
| 17 | - public function find( $class, $id ); |
|
| 9 | + /** |
|
| 10 | + * Get a single model of the provided class with the given ID. |
|
| 11 | + * |
|
| 12 | + * @param string $class Fully qualified class name of model. |
|
| 13 | + * @param int $id ID of the model. |
|
| 14 | + * |
|
| 15 | + * @return Model|WP_Error |
|
| 16 | + */ |
|
| 17 | + public function find( $class, $id ); |
|
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Finds all the models of the provided class for the given params. |
|
| 21 | - * |
|
| 22 | - * This method will return an empty Collection if the query returns no models. |
|
| 23 | - * |
|
| 24 | - * @param string $class Fully qualified class name of models to find. |
|
| 25 | - * @param array $params Params to constrain the find. |
|
| 26 | - * |
|
| 27 | - * @return Collection|WP_Error |
|
| 28 | - */ |
|
| 29 | - public function find_by( $class, array $params = array() ); |
|
| 19 | + /** |
|
| 20 | + * Finds all the models of the provided class for the given params. |
|
| 21 | + * |
|
| 22 | + * This method will return an empty Collection if the query returns no models. |
|
| 23 | + * |
|
| 24 | + * @param string $class Fully qualified class name of models to find. |
|
| 25 | + * @param array $params Params to constrain the find. |
|
| 26 | + * |
|
| 27 | + * @return Collection|WP_Error |
|
| 28 | + */ |
|
| 29 | + public function find_by( $class, array $params = array() ); |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * Saves a new model of the provided class with the given data. |
|
| 33 | - * |
|
| 34 | - * @param string $class |
|
| 35 | - * @param array $data |
|
| 36 | - * |
|
| 37 | - * @return Model|WP_Error |
|
| 38 | - */ |
|
| 39 | - public function create( $class, array $data = array() ); |
|
| 31 | + /** |
|
| 32 | + * Saves a new model of the provided class with the given data. |
|
| 33 | + * |
|
| 34 | + * @param string $class |
|
| 35 | + * @param array $data |
|
| 36 | + * |
|
| 37 | + * @return Model|WP_Error |
|
| 38 | + */ |
|
| 39 | + public function create( $class, array $data = array() ); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Updates a model with its latest dataE. |
|
| 43 | - * |
|
| 44 | - * @param Model $model |
|
| 45 | - * |
|
| 46 | - * @return Model|WP_Error |
|
| 47 | - */ |
|
| 48 | - public function persist( Model $model ); |
|
| 41 | + /** |
|
| 42 | + * Updates a model with its latest dataE. |
|
| 43 | + * |
|
| 44 | + * @param Model $model |
|
| 45 | + * |
|
| 46 | + * @return Model|WP_Error |
|
| 47 | + */ |
|
| 48 | + public function persist( Model $model ); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Delete the provide |
|
| 52 | - * |
|
| 53 | - * @param Model $model |
|
| 54 | - * @param bool $force |
|
| 55 | - * |
|
| 56 | - * @return mixed |
|
| 57 | - */ |
|
| 58 | - public function delete( Model $model, $force = false ); |
|
| 50 | + /** |
|
| 51 | + * Delete the provide |
|
| 52 | + * |
|
| 53 | + * @param Model $model |
|
| 54 | + * @param bool $force |
|
| 55 | + * |
|
| 56 | + * @return mixed |
|
| 57 | + */ |
|
| 58 | + public function delete( Model $model, $force = false ); |
|
| 59 | 59 | } |
@@ -13,137 +13,137 @@ |
||
| 13 | 13 | * @package Intraxia\Jaxion |
| 14 | 14 | */ |
| 15 | 15 | class Application extends Container implements ApplicationContract { |
| 16 | - /** |
|
| 17 | - * Define plugin version on Application. |
|
| 18 | - */ |
|
| 19 | - const VERSION = ''; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * Singleton instance of the Application object |
|
| 23 | - * |
|
| 24 | - * @var Application[] |
|
| 25 | - */ |
|
| 26 | - protected static $instances = array(); |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Instantiates a new Application container. |
|
| 30 | - * |
|
| 31 | - * The Application constructor enforces the presence of of a single instance |
|
| 32 | - * of the Application. If an instance already exists, an Exception will be thrown. |
|
| 33 | - * |
|
| 34 | - * @param string $file |
|
| 35 | - * @param array $providers |
|
| 36 | - * |
|
| 37 | - * @throws ApplicationAlreadyBootedException |
|
| 38 | - */ |
|
| 39 | - public function __construct( $file, array $providers = array() ) { |
|
| 40 | - if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
| 41 | - throw new ApplicationAlreadyBootedException; |
|
| 42 | - } |
|
| 43 | - |
|
| 44 | - static::$instances[ get_called_class() ] = $this; |
|
| 45 | - |
|
| 46 | - $this->register_constants( $file ); |
|
| 47 | - $this->register_core_services(); |
|
| 48 | - |
|
| 49 | - register_activation_hook( $file, array( $this, 'activate' ) ); |
|
| 50 | - register_deactivation_hook( $file, array( $this, 'deactivate' ) ); |
|
| 51 | - |
|
| 52 | - parent::__construct( $providers ); |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - /** |
|
| 56 | - * {@inheritDoc} |
|
| 57 | - * |
|
| 58 | - * @throws UnexpectedValueException |
|
| 59 | - */ |
|
| 60 | - public function boot() { |
|
| 61 | - $loader = $this->fetch( 'loader' ); |
|
| 62 | - |
|
| 63 | - if ( ! $loader instanceof LoaderContract ) { |
|
| 64 | - throw new UnexpectedValueException; |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - foreach ( $this as $alias => $value ) { |
|
| 68 | - if ( $value instanceof HasActions ) { |
|
| 69 | - $loader->register_actions( $value ); |
|
| 70 | - } |
|
| 71 | - |
|
| 72 | - if ( $value instanceof HasFilters ) { |
|
| 73 | - $loader->register_filters( $value ); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - if ( $value instanceof HasShortcode ) { |
|
| 77 | - $loader->register_shortcode( $value ); |
|
| 78 | - } |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - add_action( 'plugins_loaded', array( $loader, 'run' ) ); |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * {@inheritdoc} |
|
| 86 | - * |
|
| 87 | - * @codeCoverageIgnore |
|
| 88 | - */ |
|
| 89 | - public function activate() { |
|
| 90 | - // no-op |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * {@inheritdoc} |
|
| 95 | - * |
|
| 96 | - * @codeCoverageIgnore |
|
| 97 | - */ |
|
| 98 | - public function deactivate() { |
|
| 99 | - // no-op |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * {@inheritDoc} |
|
| 104 | - * |
|
| 105 | - * @return Application |
|
| 106 | - * @throws ApplicationNotBootedException |
|
| 107 | - */ |
|
| 108 | - public static function instance() { |
|
| 109 | - if ( ! isset( static::$instances[ get_called_class() ] ) ) { |
|
| 110 | - throw new ApplicationNotBootedException; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - return static::$instances[ get_called_class() ]; |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * {@inheritDoc} |
|
| 118 | - */ |
|
| 119 | - public static function shutdown() { |
|
| 120 | - if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
| 121 | - unset( static::$instances[ get_called_class() ] ); |
|
| 122 | - } |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Sets the plugin's url, path, and basename. |
|
| 127 | - * |
|
| 128 | - * @param string $file |
|
| 129 | - */ |
|
| 130 | - private function register_constants( $file ) { |
|
| 131 | - $this->share( 'url', plugin_dir_url( $file ) ); |
|
| 132 | - $this->share( 'path', plugin_dir_path( $file ) ); |
|
| 133 | - $this->share( 'basename', $basename = plugin_basename( $file ) ); |
|
| 134 | - $this->share( 'slug', dirname( $basename ) ); |
|
| 135 | - $this->share( 'version', static::VERSION ); |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - /** |
|
| 139 | - * Registers the built-in services with the Application container. |
|
| 140 | - */ |
|
| 141 | - private function register_core_services() { |
|
| 142 | - $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) { |
|
| 143 | - return new Loader( $app ); |
|
| 144 | - } ); |
|
| 145 | - $this->share( array( 'i18n' => 'Intaxia\Jaxion\Contract\Core\I18n' ), function ( $app ) { |
|
| 146 | - return new I18n( $app->fetch( 'basename' ), $app->fetch( 'path' ) ); |
|
| 147 | - } ); |
|
| 148 | - } |
|
| 16 | + /** |
|
| 17 | + * Define plugin version on Application. |
|
| 18 | + */ |
|
| 19 | + const VERSION = ''; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * Singleton instance of the Application object |
|
| 23 | + * |
|
| 24 | + * @var Application[] |
|
| 25 | + */ |
|
| 26 | + protected static $instances = array(); |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Instantiates a new Application container. |
|
| 30 | + * |
|
| 31 | + * The Application constructor enforces the presence of of a single instance |
|
| 32 | + * of the Application. If an instance already exists, an Exception will be thrown. |
|
| 33 | + * |
|
| 34 | + * @param string $file |
|
| 35 | + * @param array $providers |
|
| 36 | + * |
|
| 37 | + * @throws ApplicationAlreadyBootedException |
|
| 38 | + */ |
|
| 39 | + public function __construct( $file, array $providers = array() ) { |
|
| 40 | + if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
| 41 | + throw new ApplicationAlreadyBootedException; |
|
| 42 | + } |
|
| 43 | + |
|
| 44 | + static::$instances[ get_called_class() ] = $this; |
|
| 45 | + |
|
| 46 | + $this->register_constants( $file ); |
|
| 47 | + $this->register_core_services(); |
|
| 48 | + |
|
| 49 | + register_activation_hook( $file, array( $this, 'activate' ) ); |
|
| 50 | + register_deactivation_hook( $file, array( $this, 'deactivate' ) ); |
|
| 51 | + |
|
| 52 | + parent::__construct( $providers ); |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + /** |
|
| 56 | + * {@inheritDoc} |
|
| 57 | + * |
|
| 58 | + * @throws UnexpectedValueException |
|
| 59 | + */ |
|
| 60 | + public function boot() { |
|
| 61 | + $loader = $this->fetch( 'loader' ); |
|
| 62 | + |
|
| 63 | + if ( ! $loader instanceof LoaderContract ) { |
|
| 64 | + throw new UnexpectedValueException; |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + foreach ( $this as $alias => $value ) { |
|
| 68 | + if ( $value instanceof HasActions ) { |
|
| 69 | + $loader->register_actions( $value ); |
|
| 70 | + } |
|
| 71 | + |
|
| 72 | + if ( $value instanceof HasFilters ) { |
|
| 73 | + $loader->register_filters( $value ); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + if ( $value instanceof HasShortcode ) { |
|
| 77 | + $loader->register_shortcode( $value ); |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + add_action( 'plugins_loaded', array( $loader, 'run' ) ); |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * {@inheritdoc} |
|
| 86 | + * |
|
| 87 | + * @codeCoverageIgnore |
|
| 88 | + */ |
|
| 89 | + public function activate() { |
|
| 90 | + // no-op |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * {@inheritdoc} |
|
| 95 | + * |
|
| 96 | + * @codeCoverageIgnore |
|
| 97 | + */ |
|
| 98 | + public function deactivate() { |
|
| 99 | + // no-op |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * {@inheritDoc} |
|
| 104 | + * |
|
| 105 | + * @return Application |
|
| 106 | + * @throws ApplicationNotBootedException |
|
| 107 | + */ |
|
| 108 | + public static function instance() { |
|
| 109 | + if ( ! isset( static::$instances[ get_called_class() ] ) ) { |
|
| 110 | + throw new ApplicationNotBootedException; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + return static::$instances[ get_called_class() ]; |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * {@inheritDoc} |
|
| 118 | + */ |
|
| 119 | + public static function shutdown() { |
|
| 120 | + if ( isset( static::$instances[ get_called_class() ] ) ) { |
|
| 121 | + unset( static::$instances[ get_called_class() ] ); |
|
| 122 | + } |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Sets the plugin's url, path, and basename. |
|
| 127 | + * |
|
| 128 | + * @param string $file |
|
| 129 | + */ |
|
| 130 | + private function register_constants( $file ) { |
|
| 131 | + $this->share( 'url', plugin_dir_url( $file ) ); |
|
| 132 | + $this->share( 'path', plugin_dir_path( $file ) ); |
|
| 133 | + $this->share( 'basename', $basename = plugin_basename( $file ) ); |
|
| 134 | + $this->share( 'slug', dirname( $basename ) ); |
|
| 135 | + $this->share( 'version', static::VERSION ); |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + /** |
|
| 139 | + * Registers the built-in services with the Application container. |
|
| 140 | + */ |
|
| 141 | + private function register_core_services() { |
|
| 142 | + $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) { |
|
| 143 | + return new Loader( $app ); |
|
| 144 | + } ); |
|
| 145 | + $this->share( array( 'i18n' => 'Intaxia\Jaxion\Contract\Core\I18n' ), function ( $app ) { |
|
| 146 | + return new I18n( $app->fetch( 'basename' ), $app->fetch( 'path' ) ); |
|
| 147 | + } ); |
|
| 148 | + } |
|
| 149 | 149 | } |
@@ -12,208 +12,208 @@ |
||
| 12 | 12 | * @subpackage Register |
| 13 | 13 | */ |
| 14 | 14 | class Register implements RegisterContract { |
| 15 | - /** |
|
| 16 | - * Minification string for enqueued assets. |
|
| 17 | - * |
|
| 18 | - * @var string |
|
| 19 | - */ |
|
| 20 | - private $min = ''; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Url to the plugin directory. |
|
| 24 | - * |
|
| 25 | - * @var string |
|
| 26 | - */ |
|
| 27 | - protected $url; |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * Script/plugin version. |
|
| 31 | - * |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 34 | - protected $version; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * Array of script definition arrays. |
|
| 38 | - * |
|
| 39 | - * @var array |
|
| 40 | - */ |
|
| 41 | - private $scripts = array(); |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Array of style definition arrays. |
|
| 45 | - * |
|
| 46 | - * @var array |
|
| 47 | - */ |
|
| 48 | - private $styles = array(); |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * Instantiates a new instance of the Register class. |
|
| 52 | - * |
|
| 53 | - * The URL param should be relative to the plugin directory. The URL |
|
| 54 | - * form should always end with a '/'. All asset location definitions |
|
| 55 | - * should not begin with a slash and should be relative to the plugin's |
|
| 56 | - * root directory. The URL provided by default from the Application |
|
| 57 | - * class is compatible. |
|
| 58 | - * |
|
| 59 | - * @param string $url |
|
| 60 | - * @param string $version |
|
| 61 | - */ |
|
| 62 | - public function __construct( $url, $version = null ) { |
|
| 63 | - $this->url = $url; |
|
| 64 | - $this->version = $version ?: null; // Empty string should remain null. |
|
| 65 | - } |
|
| 66 | - |
|
| 67 | - /** |
|
| 68 | - * {@inheritdoc} |
|
| 69 | - * |
|
| 70 | - * @param bool $debug |
|
| 71 | - */ |
|
| 72 | - public function set_debug( $debug ) { |
|
| 73 | - if ( $debug ) { |
|
| 74 | - $this->min = '.min'; |
|
| 75 | - } else { |
|
| 76 | - $this->min = ''; |
|
| 77 | - } |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * {@inheritdoc} |
|
| 82 | - * |
|
| 83 | - * @param array $script |
|
| 84 | - */ |
|
| 85 | - public function register_script( $script ) { |
|
| 86 | - $this->scripts[] = $script; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * {@inheritdoc} |
|
| 91 | - * |
|
| 92 | - * @param array $style |
|
| 93 | - */ |
|
| 94 | - public function register_style( $style ) { |
|
| 95 | - $this->styles[] = $style; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * {@inheritDoc} |
|
| 100 | - */ |
|
| 101 | - public function enqueue_web_scripts() { |
|
| 102 | - foreach ( $this->scripts as $script ) { |
|
| 103 | - if ( in_array( $script['type'], array( 'web', 'shared' ) ) ) { |
|
| 104 | - $this->enqueue_script( $script ); |
|
| 105 | - } |
|
| 106 | - } |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * {@inheritDoc} |
|
| 111 | - */ |
|
| 112 | - public function enqueue_web_styles() { |
|
| 113 | - foreach ( $this->styles as $style ) { |
|
| 114 | - if ( in_array( $style['type'], array( 'web', 'shared' ) ) ) { |
|
| 115 | - $this->enqueue_style( $style ); |
|
| 116 | - } |
|
| 117 | - } |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * {@inheritDoc} |
|
| 122 | - * |
|
| 123 | - * @param string $hook Passes a string representing the current page. |
|
| 124 | - */ |
|
| 125 | - public function enqueue_admin_scripts( $hook ) { |
|
| 126 | - foreach ( $this->scripts as $script ) { |
|
| 127 | - if ( in_array( $script['type'], array( 'admin', 'shared' ) ) ) { |
|
| 128 | - $this->enqueue_script( $script, $hook ); |
|
| 129 | - } |
|
| 130 | - } |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * {@inheritDoc} |
|
| 135 | - * |
|
| 136 | - * @param string $hook Passes a string representing the current page. |
|
| 137 | - */ |
|
| 138 | - public function enqueue_admin_styles( $hook ) { |
|
| 139 | - foreach ( $this->styles as $style ) { |
|
| 140 | - if ( in_array( $style['type'], array( 'admin', 'shared' ) ) ) { |
|
| 141 | - $this->enqueue_style( $style, $hook ); |
|
| 142 | - } |
|
| 143 | - } |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * {@inheritDoc} |
|
| 148 | - * |
|
| 149 | - * @return array[] |
|
| 150 | - */ |
|
| 151 | - public function action_hooks() { |
|
| 152 | - return array( |
|
| 153 | - array( |
|
| 154 | - 'hook' => 'wp_enqueue_scripts', |
|
| 155 | - 'method' => 'enqueue_web_scripts', |
|
| 156 | - ), |
|
| 157 | - array( |
|
| 158 | - 'hook' => 'wp_enqueue_scripts', |
|
| 159 | - 'method' => 'enqueue_web_styles', |
|
| 160 | - ), |
|
| 161 | - array( |
|
| 162 | - 'hook' => 'admin_enqueue_scripts', |
|
| 163 | - 'method' => 'enqueue_admin_scripts', |
|
| 164 | - ), |
|
| 165 | - array( |
|
| 166 | - 'hook' => 'admin_enqueue_scripts', |
|
| 167 | - 'method' => 'enqueue_admin_styles', |
|
| 168 | - ), |
|
| 169 | - ); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * Enqueues an individual script if the style's condition is met. |
|
| 174 | - * |
|
| 175 | - * @param array $script The script attachment callback. |
|
| 176 | - * @param string $hook The location hook. Only passed on admin side. |
|
| 177 | - */ |
|
| 178 | - protected function enqueue_script( $script, $hook = null ) { |
|
| 179 | - if ( $script['condition']( $hook ) ) { |
|
| 180 | - wp_enqueue_script( |
|
| 181 | - $script['handle'], |
|
| 182 | - $this->url . $script['src'] . '.js', |
|
| 183 | - isset( $script['deps'] ) ? $script['deps'] : array(), |
|
| 184 | - $this->version, |
|
| 185 | - isset( $script['footer'] ) ? $script['footer'] : false |
|
| 186 | - ); |
|
| 187 | - |
|
| 188 | - if ( isset( $script['localize'] ) ) { |
|
| 189 | - if ( is_callable( $script['localize'] ) ) { // @todo make all properties callables |
|
| 190 | - $script['localize'] = call_user_func( $script['localize'] ); |
|
| 191 | - } |
|
| 192 | - |
|
| 193 | - wp_localize_script( |
|
| 194 | - $script['handle'], |
|
| 195 | - $script['localize']['name'], |
|
| 196 | - $script['localize']['data'] |
|
| 197 | - ); |
|
| 198 | - } |
|
| 199 | - } |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Enqueues an individual stylesheet if the style's condition is met. |
|
| 204 | - * |
|
| 205 | - * @param array $style The style attachment callback. |
|
| 206 | - * @param string $hook The location hook. |
|
| 207 | - */ |
|
| 208 | - protected function enqueue_style( $style, $hook = null ) { |
|
| 209 | - if ( $style['condition']( $hook ) ) { |
|
| 210 | - wp_enqueue_style( |
|
| 211 | - $style['handle'], |
|
| 212 | - $this->url . $style['src'] . '.css', |
|
| 213 | - isset( $style['deps'] ) ? $style['deps'] : array(), |
|
| 214 | - $this->version, |
|
| 215 | - isset( $style['media'] ) ? $style['media'] : 'all' |
|
| 216 | - ); |
|
| 217 | - } |
|
| 218 | - } |
|
| 15 | + /** |
|
| 16 | + * Minification string for enqueued assets. |
|
| 17 | + * |
|
| 18 | + * @var string |
|
| 19 | + */ |
|
| 20 | + private $min = ''; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Url to the plugin directory. |
|
| 24 | + * |
|
| 25 | + * @var string |
|
| 26 | + */ |
|
| 27 | + protected $url; |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * Script/plugin version. |
|
| 31 | + * |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | + protected $version; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * Array of script definition arrays. |
|
| 38 | + * |
|
| 39 | + * @var array |
|
| 40 | + */ |
|
| 41 | + private $scripts = array(); |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Array of style definition arrays. |
|
| 45 | + * |
|
| 46 | + * @var array |
|
| 47 | + */ |
|
| 48 | + private $styles = array(); |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * Instantiates a new instance of the Register class. |
|
| 52 | + * |
|
| 53 | + * The URL param should be relative to the plugin directory. The URL |
|
| 54 | + * form should always end with a '/'. All asset location definitions |
|
| 55 | + * should not begin with a slash and should be relative to the plugin's |
|
| 56 | + * root directory. The URL provided by default from the Application |
|
| 57 | + * class is compatible. |
|
| 58 | + * |
|
| 59 | + * @param string $url |
|
| 60 | + * @param string $version |
|
| 61 | + */ |
|
| 62 | + public function __construct( $url, $version = null ) { |
|
| 63 | + $this->url = $url; |
|
| 64 | + $this->version = $version ?: null; // Empty string should remain null. |
|
| 65 | + } |
|
| 66 | + |
|
| 67 | + /** |
|
| 68 | + * {@inheritdoc} |
|
| 69 | + * |
|
| 70 | + * @param bool $debug |
|
| 71 | + */ |
|
| 72 | + public function set_debug( $debug ) { |
|
| 73 | + if ( $debug ) { |
|
| 74 | + $this->min = '.min'; |
|
| 75 | + } else { |
|
| 76 | + $this->min = ''; |
|
| 77 | + } |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * {@inheritdoc} |
|
| 82 | + * |
|
| 83 | + * @param array $script |
|
| 84 | + */ |
|
| 85 | + public function register_script( $script ) { |
|
| 86 | + $this->scripts[] = $script; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * {@inheritdoc} |
|
| 91 | + * |
|
| 92 | + * @param array $style |
|
| 93 | + */ |
|
| 94 | + public function register_style( $style ) { |
|
| 95 | + $this->styles[] = $style; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * {@inheritDoc} |
|
| 100 | + */ |
|
| 101 | + public function enqueue_web_scripts() { |
|
| 102 | + foreach ( $this->scripts as $script ) { |
|
| 103 | + if ( in_array( $script['type'], array( 'web', 'shared' ) ) ) { |
|
| 104 | + $this->enqueue_script( $script ); |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * {@inheritDoc} |
|
| 111 | + */ |
|
| 112 | + public function enqueue_web_styles() { |
|
| 113 | + foreach ( $this->styles as $style ) { |
|
| 114 | + if ( in_array( $style['type'], array( 'web', 'shared' ) ) ) { |
|
| 115 | + $this->enqueue_style( $style ); |
|
| 116 | + } |
|
| 117 | + } |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * {@inheritDoc} |
|
| 122 | + * |
|
| 123 | + * @param string $hook Passes a string representing the current page. |
|
| 124 | + */ |
|
| 125 | + public function enqueue_admin_scripts( $hook ) { |
|
| 126 | + foreach ( $this->scripts as $script ) { |
|
| 127 | + if ( in_array( $script['type'], array( 'admin', 'shared' ) ) ) { |
|
| 128 | + $this->enqueue_script( $script, $hook ); |
|
| 129 | + } |
|
| 130 | + } |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * {@inheritDoc} |
|
| 135 | + * |
|
| 136 | + * @param string $hook Passes a string representing the current page. |
|
| 137 | + */ |
|
| 138 | + public function enqueue_admin_styles( $hook ) { |
|
| 139 | + foreach ( $this->styles as $style ) { |
|
| 140 | + if ( in_array( $style['type'], array( 'admin', 'shared' ) ) ) { |
|
| 141 | + $this->enqueue_style( $style, $hook ); |
|
| 142 | + } |
|
| 143 | + } |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * {@inheritDoc} |
|
| 148 | + * |
|
| 149 | + * @return array[] |
|
| 150 | + */ |
|
| 151 | + public function action_hooks() { |
|
| 152 | + return array( |
|
| 153 | + array( |
|
| 154 | + 'hook' => 'wp_enqueue_scripts', |
|
| 155 | + 'method' => 'enqueue_web_scripts', |
|
| 156 | + ), |
|
| 157 | + array( |
|
| 158 | + 'hook' => 'wp_enqueue_scripts', |
|
| 159 | + 'method' => 'enqueue_web_styles', |
|
| 160 | + ), |
|
| 161 | + array( |
|
| 162 | + 'hook' => 'admin_enqueue_scripts', |
|
| 163 | + 'method' => 'enqueue_admin_scripts', |
|
| 164 | + ), |
|
| 165 | + array( |
|
| 166 | + 'hook' => 'admin_enqueue_scripts', |
|
| 167 | + 'method' => 'enqueue_admin_styles', |
|
| 168 | + ), |
|
| 169 | + ); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Enqueues an individual script if the style's condition is met. |
|
| 174 | + * |
|
| 175 | + * @param array $script The script attachment callback. |
|
| 176 | + * @param string $hook The location hook. Only passed on admin side. |
|
| 177 | + */ |
|
| 178 | + protected function enqueue_script( $script, $hook = null ) { |
|
| 179 | + if ( $script['condition']( $hook ) ) { |
|
| 180 | + wp_enqueue_script( |
|
| 181 | + $script['handle'], |
|
| 182 | + $this->url . $script['src'] . '.js', |
|
| 183 | + isset( $script['deps'] ) ? $script['deps'] : array(), |
|
| 184 | + $this->version, |
|
| 185 | + isset( $script['footer'] ) ? $script['footer'] : false |
|
| 186 | + ); |
|
| 187 | + |
|
| 188 | + if ( isset( $script['localize'] ) ) { |
|
| 189 | + if ( is_callable( $script['localize'] ) ) { // @todo make all properties callables |
|
| 190 | + $script['localize'] = call_user_func( $script['localize'] ); |
|
| 191 | + } |
|
| 192 | + |
|
| 193 | + wp_localize_script( |
|
| 194 | + $script['handle'], |
|
| 195 | + $script['localize']['name'], |
|
| 196 | + $script['localize']['data'] |
|
| 197 | + ); |
|
| 198 | + } |
|
| 199 | + } |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Enqueues an individual stylesheet if the style's condition is met. |
|
| 204 | + * |
|
| 205 | + * @param array $style The style attachment callback. |
|
| 206 | + * @param string $hook The location hook. |
|
| 207 | + */ |
|
| 208 | + protected function enqueue_style( $style, $hook = null ) { |
|
| 209 | + if ( $style['condition']( $hook ) ) { |
|
| 210 | + wp_enqueue_style( |
|
| 211 | + $style['handle'], |
|
| 212 | + $this->url . $style['src'] . '.css', |
|
| 213 | + isset( $style['deps'] ) ? $style['deps'] : array(), |
|
| 214 | + $this->version, |
|
| 215 | + isset( $style['media'] ) ? $style['media'] : 'all' |
|
| 216 | + ); |
|
| 217 | + } |
|
| 218 | + } |
|
| 219 | 219 | } |
@@ -4,52 +4,52 @@ |
||
| 4 | 4 | use Intraxia\Jaxion\Contract\Core\HasActions; |
| 5 | 5 | |
| 6 | 6 | interface Register extends HasActions { |
| 7 | - /** |
|
| 8 | - * Enable debug mode for the enqueued assets. |
|
| 9 | - * |
|
| 10 | - * Debug mode will enqueue unminified versions of the registered assets. |
|
| 11 | - * Primarily, this is intended to be used along with WordPress's `SCRIPT_DEBUG` |
|
| 12 | - * constant, which enables unminified core assets to be enqueued. |
|
| 13 | - * |
|
| 14 | - * @param bool $debug |
|
| 15 | - */ |
|
| 16 | - public function set_debug( $debug ); |
|
| 17 | - |
|
| 18 | - /** |
|
| 19 | - * Provides a method to register new scripts outside of the constructor. |
|
| 20 | - * |
|
| 21 | - * @param array $script |
|
| 22 | - */ |
|
| 23 | - public function register_script( $script ); |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * Provides a method to register new styles outside of the constructor. |
|
| 27 | - * |
|
| 28 | - * @param array $style |
|
| 29 | - */ |
|
| 30 | - public function register_style( $style ); |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Enqueues the web & shared scripts on the Register. |
|
| 34 | - */ |
|
| 35 | - public function enqueue_web_scripts(); |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Enqueues the web & shared styles on the Register. |
|
| 39 | - */ |
|
| 40 | - public function enqueue_web_styles(); |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Enqueues the admin & shared scripts on the Register. |
|
| 44 | - * |
|
| 45 | - * @param string $hook Passes a string representing the current page. |
|
| 46 | - */ |
|
| 47 | - public function enqueue_admin_scripts( $hook ); |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Enqueues the admin & shared styles on the Register. |
|
| 51 | - * |
|
| 52 | - * @param string $hook Passes a string representing the current page. |
|
| 53 | - */ |
|
| 54 | - public function enqueue_admin_styles( $hook ); |
|
| 7 | + /** |
|
| 8 | + * Enable debug mode for the enqueued assets. |
|
| 9 | + * |
|
| 10 | + * Debug mode will enqueue unminified versions of the registered assets. |
|
| 11 | + * Primarily, this is intended to be used along with WordPress's `SCRIPT_DEBUG` |
|
| 12 | + * constant, which enables unminified core assets to be enqueued. |
|
| 13 | + * |
|
| 14 | + * @param bool $debug |
|
| 15 | + */ |
|
| 16 | + public function set_debug( $debug ); |
|
| 17 | + |
|
| 18 | + /** |
|
| 19 | + * Provides a method to register new scripts outside of the constructor. |
|
| 20 | + * |
|
| 21 | + * @param array $script |
|
| 22 | + */ |
|
| 23 | + public function register_script( $script ); |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * Provides a method to register new styles outside of the constructor. |
|
| 27 | + * |
|
| 28 | + * @param array $style |
|
| 29 | + */ |
|
| 30 | + public function register_style( $style ); |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Enqueues the web & shared scripts on the Register. |
|
| 34 | + */ |
|
| 35 | + public function enqueue_web_scripts(); |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Enqueues the web & shared styles on the Register. |
|
| 39 | + */ |
|
| 40 | + public function enqueue_web_styles(); |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Enqueues the admin & shared scripts on the Register. |
|
| 44 | + * |
|
| 45 | + * @param string $hook Passes a string representing the current page. |
|
| 46 | + */ |
|
| 47 | + public function enqueue_admin_scripts( $hook ); |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Enqueues the admin & shared styles on the Register. |
|
| 51 | + * |
|
| 52 | + * @param string $hook Passes a string representing the current page. |
|
| 53 | + */ |
|
| 54 | + public function enqueue_admin_styles( $hook ); |
|
| 55 | 55 | } |
@@ -14,227 +14,227 @@ |
||
| 14 | 14 | * @subpackage Axolotl |
| 15 | 15 | */ |
| 16 | 16 | class Collection implements Countable, Iterator, Serializes { |
| 17 | - /** |
|
| 18 | - * Collection elements. |
|
| 19 | - * |
|
| 20 | - * @var array |
|
| 21 | - */ |
|
| 22 | - protected $elements = array(); |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * Collection configuration. |
|
| 26 | - * |
|
| 27 | - * @var array |
|
| 28 | - */ |
|
| 29 | - protected $config = array(); |
|
| 30 | - |
|
| 31 | - /** |
|
| 32 | - * Models registered to the collection. |
|
| 33 | - * |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 36 | - protected $model; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * Where Collection is in loop. |
|
| 40 | - * |
|
| 41 | - * @var int |
|
| 42 | - */ |
|
| 43 | - protected $position = 0; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * Collection constructor. |
|
| 47 | - * |
|
| 48 | - * @param array $elements |
|
| 49 | - * @param array $config |
|
| 50 | - */ |
|
| 51 | - public function __construct( array $elements = array(), array $config = array() ) { |
|
| 52 | - $this->parse_config( $this->config = $config ); |
|
| 53 | - |
|
| 54 | - foreach ( $elements as $element ) { |
|
| 55 | - $this->add( $element ); |
|
| 56 | - } |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Adds a new element to the Collection. |
|
| 61 | - * |
|
| 62 | - * @param mixed $element |
|
| 63 | - * |
|
| 64 | - * @throws RuntimeException |
|
| 65 | - * |
|
| 66 | - * @return $this |
|
| 67 | - */ |
|
| 68 | - public function add( $element ) { |
|
| 69 | - if ( $this->model && is_array( $element ) ) { |
|
| 70 | - $element = new $this->model( $element ); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - if ( $this->model && ! ( $element instanceof $this->model ) ) { |
|
| 74 | - throw new RuntimeException; |
|
| 75 | - } |
|
| 76 | - |
|
| 77 | - $this->elements[] = $element; |
|
| 78 | - |
|
| 79 | - return $this; |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Removes an element by index or value. |
|
| 84 | - * |
|
| 85 | - * @param mixed $index |
|
| 86 | - * |
|
| 87 | - * @return $this |
|
| 88 | - */ |
|
| 89 | - public function remove( $index ) { |
|
| 90 | - if ( ! is_string( $index ) || ! is_numeric( $index ) || ! isset( $this->elements[ $index ] ) ) { |
|
| 91 | - foreach ( $this->elements as $key => $element ) { |
|
| 92 | - if ( $element === $index ) { |
|
| 93 | - $index = $key; |
|
| 94 | - break; |
|
| 95 | - } |
|
| 96 | - } |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - if ( isset( $this->elements[ $index ] ) ) { |
|
| 100 | - unset( $this->elements[ $index ] ); |
|
| 101 | - $this->elements = array_values( $this->elements ); |
|
| 102 | - } |
|
| 103 | - |
|
| 104 | - return $this; |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Fetches the element at the provided index. |
|
| 109 | - * |
|
| 110 | - * @param int $index |
|
| 111 | - * |
|
| 112 | - * @return mixed|null |
|
| 113 | - */ |
|
| 114 | - public function at( $index ) { |
|
| 115 | - return isset( $this->elements[ $index ] ) ? $this->elements[ $index ] : null; |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * Maps over the Collection's elements, |
|
| 120 | - * |
|
| 121 | - * @param callable $callback |
|
| 122 | - * |
|
| 123 | - * @return Collection |
|
| 124 | - */ |
|
| 125 | - public function map( callable $callback ) { |
|
| 126 | - return new Collection( array_map( $callback, $this->elements ) ); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Filters the Collection's elements. |
|
| 131 | - * |
|
| 132 | - * @param callable $callback |
|
| 133 | - * |
|
| 134 | - * @return Collection |
|
| 135 | - */ |
|
| 136 | - public function filter( callable $callback ) { |
|
| 137 | - return new Collection( array_filter( $this->elements, $callback ) ); |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * Fetches a single element in the Collection by callback. |
|
| 142 | - * |
|
| 143 | - * @param callable $callback |
|
| 144 | - * |
|
| 145 | - * @return mixed|null |
|
| 146 | - */ |
|
| 147 | - public function find( callable $callback ) { |
|
| 148 | - foreach ( $this->elements as $element ) { |
|
| 149 | - if ( call_user_func( $callback, $element ) ) { |
|
| 150 | - return $element; |
|
| 151 | - } |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - return null; |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * {@inheritDoc} |
|
| 159 | - * |
|
| 160 | - * @return array |
|
| 161 | - */ |
|
| 162 | - public function serialize() { |
|
| 163 | - return array_map(function( $element ) { |
|
| 164 | - if ( $element instanceof Serializes ) { |
|
| 165 | - return $element->serialize(); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - return $element; |
|
| 169 | - }, $this->elements); |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - /** |
|
| 173 | - * Return the current element. |
|
| 174 | - * |
|
| 175 | - * @return mixed |
|
| 176 | - */ |
|
| 177 | - public function current() { |
|
| 178 | - return $this->at( $this->position ); |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Move forward to next element. |
|
| 183 | - */ |
|
| 184 | - public function next() { |
|
| 185 | - $this->position ++; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * Return the key of the current element. |
|
| 190 | - * |
|
| 191 | - * @return mixed |
|
| 192 | - */ |
|
| 193 | - public function key() { |
|
| 194 | - return $this->position; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * Checks if current position is valid. |
|
| 199 | - * |
|
| 200 | - * @return bool |
|
| 201 | - */ |
|
| 202 | - public function valid() { |
|
| 203 | - return isset( $this->elements[ $this->position ] ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * Rewind the Iterator to the first element. |
|
| 208 | - */ |
|
| 209 | - public function rewind() { |
|
| 210 | - $this->position = 0; |
|
| 211 | - } |
|
| 212 | - |
|
| 213 | - /** |
|
| 214 | - * Count elements of an object. |
|
| 215 | - * |
|
| 216 | - * @return int |
|
| 217 | - */ |
|
| 218 | - public function count() { |
|
| 219 | - return count( $this->elements ); |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Parses the Collection config to set its properties. |
|
| 224 | - * |
|
| 225 | - * @param array $config |
|
| 226 | - * |
|
| 227 | - * @throws LogicException |
|
| 228 | - */ |
|
| 229 | - protected function parse_config( array $config ) { |
|
| 230 | - if ( isset( $config['model'] ) ) { |
|
| 231 | - $model = $config['model']; |
|
| 232 | - |
|
| 233 | - if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) { |
|
| 234 | - throw new LogicException; |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - $this->model = $model; |
|
| 238 | - } |
|
| 239 | - } |
|
| 17 | + /** |
|
| 18 | + * Collection elements. |
|
| 19 | + * |
|
| 20 | + * @var array |
|
| 21 | + */ |
|
| 22 | + protected $elements = array(); |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * Collection configuration. |
|
| 26 | + * |
|
| 27 | + * @var array |
|
| 28 | + */ |
|
| 29 | + protected $config = array(); |
|
| 30 | + |
|
| 31 | + /** |
|
| 32 | + * Models registered to the collection. |
|
| 33 | + * |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | + protected $model; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Where Collection is in loop. |
|
| 40 | + * |
|
| 41 | + * @var int |
|
| 42 | + */ |
|
| 43 | + protected $position = 0; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * Collection constructor. |
|
| 47 | + * |
|
| 48 | + * @param array $elements |
|
| 49 | + * @param array $config |
|
| 50 | + */ |
|
| 51 | + public function __construct( array $elements = array(), array $config = array() ) { |
|
| 52 | + $this->parse_config( $this->config = $config ); |
|
| 53 | + |
|
| 54 | + foreach ( $elements as $element ) { |
|
| 55 | + $this->add( $element ); |
|
| 56 | + } |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Adds a new element to the Collection. |
|
| 61 | + * |
|
| 62 | + * @param mixed $element |
|
| 63 | + * |
|
| 64 | + * @throws RuntimeException |
|
| 65 | + * |
|
| 66 | + * @return $this |
|
| 67 | + */ |
|
| 68 | + public function add( $element ) { |
|
| 69 | + if ( $this->model && is_array( $element ) ) { |
|
| 70 | + $element = new $this->model( $element ); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + if ( $this->model && ! ( $element instanceof $this->model ) ) { |
|
| 74 | + throw new RuntimeException; |
|
| 75 | + } |
|
| 76 | + |
|
| 77 | + $this->elements[] = $element; |
|
| 78 | + |
|
| 79 | + return $this; |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Removes an element by index or value. |
|
| 84 | + * |
|
| 85 | + * @param mixed $index |
|
| 86 | + * |
|
| 87 | + * @return $this |
|
| 88 | + */ |
|
| 89 | + public function remove( $index ) { |
|
| 90 | + if ( ! is_string( $index ) || ! is_numeric( $index ) || ! isset( $this->elements[ $index ] ) ) { |
|
| 91 | + foreach ( $this->elements as $key => $element ) { |
|
| 92 | + if ( $element === $index ) { |
|
| 93 | + $index = $key; |
|
| 94 | + break; |
|
| 95 | + } |
|
| 96 | + } |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + if ( isset( $this->elements[ $index ] ) ) { |
|
| 100 | + unset( $this->elements[ $index ] ); |
|
| 101 | + $this->elements = array_values( $this->elements ); |
|
| 102 | + } |
|
| 103 | + |
|
| 104 | + return $this; |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Fetches the element at the provided index. |
|
| 109 | + * |
|
| 110 | + * @param int $index |
|
| 111 | + * |
|
| 112 | + * @return mixed|null |
|
| 113 | + */ |
|
| 114 | + public function at( $index ) { |
|
| 115 | + return isset( $this->elements[ $index ] ) ? $this->elements[ $index ] : null; |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * Maps over the Collection's elements, |
|
| 120 | + * |
|
| 121 | + * @param callable $callback |
|
| 122 | + * |
|
| 123 | + * @return Collection |
|
| 124 | + */ |
|
| 125 | + public function map( callable $callback ) { |
|
| 126 | + return new Collection( array_map( $callback, $this->elements ) ); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Filters the Collection's elements. |
|
| 131 | + * |
|
| 132 | + * @param callable $callback |
|
| 133 | + * |
|
| 134 | + * @return Collection |
|
| 135 | + */ |
|
| 136 | + public function filter( callable $callback ) { |
|
| 137 | + return new Collection( array_filter( $this->elements, $callback ) ); |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * Fetches a single element in the Collection by callback. |
|
| 142 | + * |
|
| 143 | + * @param callable $callback |
|
| 144 | + * |
|
| 145 | + * @return mixed|null |
|
| 146 | + */ |
|
| 147 | + public function find( callable $callback ) { |
|
| 148 | + foreach ( $this->elements as $element ) { |
|
| 149 | + if ( call_user_func( $callback, $element ) ) { |
|
| 150 | + return $element; |
|
| 151 | + } |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + return null; |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * {@inheritDoc} |
|
| 159 | + * |
|
| 160 | + * @return array |
|
| 161 | + */ |
|
| 162 | + public function serialize() { |
|
| 163 | + return array_map(function( $element ) { |
|
| 164 | + if ( $element instanceof Serializes ) { |
|
| 165 | + return $element->serialize(); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + return $element; |
|
| 169 | + }, $this->elements); |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + /** |
|
| 173 | + * Return the current element. |
|
| 174 | + * |
|
| 175 | + * @return mixed |
|
| 176 | + */ |
|
| 177 | + public function current() { |
|
| 178 | + return $this->at( $this->position ); |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Move forward to next element. |
|
| 183 | + */ |
|
| 184 | + public function next() { |
|
| 185 | + $this->position ++; |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * Return the key of the current element. |
|
| 190 | + * |
|
| 191 | + * @return mixed |
|
| 192 | + */ |
|
| 193 | + public function key() { |
|
| 194 | + return $this->position; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * Checks if current position is valid. |
|
| 199 | + * |
|
| 200 | + * @return bool |
|
| 201 | + */ |
|
| 202 | + public function valid() { |
|
| 203 | + return isset( $this->elements[ $this->position ] ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * Rewind the Iterator to the first element. |
|
| 208 | + */ |
|
| 209 | + public function rewind() { |
|
| 210 | + $this->position = 0; |
|
| 211 | + } |
|
| 212 | + |
|
| 213 | + /** |
|
| 214 | + * Count elements of an object. |
|
| 215 | + * |
|
| 216 | + * @return int |
|
| 217 | + */ |
|
| 218 | + public function count() { |
|
| 219 | + return count( $this->elements ); |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Parses the Collection config to set its properties. |
|
| 224 | + * |
|
| 225 | + * @param array $config |
|
| 226 | + * |
|
| 227 | + * @throws LogicException |
|
| 228 | + */ |
|
| 229 | + protected function parse_config( array $config ) { |
|
| 230 | + if ( isset( $config['model'] ) ) { |
|
| 231 | + $model = $config['model']; |
|
| 232 | + |
|
| 233 | + if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) { |
|
| 234 | + throw new LogicException; |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + $this->model = $model; |
|
| 238 | + } |
|
| 239 | + } |
|
| 240 | 240 | } |