Completed
Pull Request — master (#1436)
by Darren
10:07
created
core/services/container/DependencyInjector.php 2 patches
Indentation   +205 added lines, -205 removed lines patch added patch discarded remove patch
@@ -21,209 +21,209 @@
 block discarded – undo
21 21
 class DependencyInjector implements InjectorInterface
22 22
 {
23 23
 
24
-    /**
25
-     * @var CoffeePotInterface $coffee_pot
26
-     */
27
-    private $coffee_pot;
28
-
29
-    /**
30
-     * @var EEH_Array $array_helper
31
-     */
32
-    private $array_helper;
33
-
34
-    /**
35
-     * @var ReflectionClass[] $reflectors
36
-     */
37
-    private $reflectors;
38
-
39
-    /**
40
-     * @var ReflectionMethod[] $constructors
41
-     */
42
-    private $constructors;
43
-
44
-    /**
45
-     * @var ReflectionParameter[] $parameters
46
-     */
47
-    private $parameters;
48
-
49
-
50
-    /**
51
-     * DependencyInjector constructor
52
-     *
53
-     * @param CoffeePotInterface $coffee_pot
54
-     * @param EEH_Array          $array_helper
55
-     */
56
-    public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
57
-    {
58
-        $this->coffee_pot = $coffee_pot;
59
-        $this->array_helper = $array_helper;
60
-    }
61
-
62
-
63
-    /**
64
-     * getReflectionClass
65
-     * checks if a ReflectionClass object has already been generated for a class
66
-     * and returns that instead of creating a new one
67
-     *
68
-     * @param string $class_name
69
-     * @return ReflectionClass
70
-     */
71
-    public function getReflectionClass($class_name)
72
-    {
73
-        if (! isset($this->reflectors[ $class_name ])
74
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
75
-        ) {
76
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
77
-        }
78
-        return $this->reflectors[ $class_name ];
79
-    }
80
-
81
-
82
-    /**
83
-     * getConstructor
84
-     * checks if a ReflectionMethod object has already been generated for the class constructor
85
-     * and returns that instead of creating a new one
86
-     *
87
-     * @param ReflectionClass $reflector
88
-     * @return ReflectionMethod
89
-     */
90
-    protected function getConstructor(ReflectionClass $reflector)
91
-    {
92
-        if (! isset($this->constructors[ $reflector->getName() ])
93
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
94
-        ) {
95
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
96
-        }
97
-        return $this->constructors[ $reflector->getName() ];
98
-    }
99
-
100
-
101
-    /**
102
-     * getParameters
103
-     * checks if an array of ReflectionParameter objects has already been generated for the class constructor
104
-     * and returns that instead of creating a new one
105
-     *
106
-     * @param ReflectionMethod $constructor
107
-     * @return ReflectionParameter[]
108
-     */
109
-    protected function getParameters(ReflectionMethod $constructor)
110
-    {
111
-        if (! isset($this->parameters[ $constructor->class ])) {
112
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
113
-        }
114
-        return $this->parameters[ $constructor->class ];
115
-    }
116
-
117
-
118
-    /**
119
-     * resolveDependencies
120
-     * examines the constructor for the requested class to determine
121
-     * if any dependencies exist, and if they can be injected.
122
-     * If so, then those classes will be added to the array of arguments passed to the constructor
123
-     * PLZ NOTE: this is achieved by type hinting the constructor params
124
-     * For example:
125
-     *        if attempting to load a class "Foo" with the following constructor:
126
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
127
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
128
-     *        but only IF they are NOT already present in the incoming arguments array,
129
-     *        and the correct classes can be loaded
130
-     *
131
-     * @param RecipeInterface $recipe
132
-     * @param ReflectionClass $reflector
133
-     * @param array           $arguments
134
-     * @return array
135
-     * @throws UnexpectedValueException
136
-     */
137
-    public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
138
-    {
139
-        // if arguments array is numerically and sequentially indexed, then we want it to remain as is,
140
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
141
-        $arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
142
-            ? $arguments
143
-            : array($arguments);
144
-        $resolved_parameters = array();
145
-        // let's examine the constructor
146
-        // let's examine the constructor
147
-        $constructor = $this->getConstructor($reflector);
148
-        // whu? huh? nothing?
149
-        if (! $constructor) {
150
-            return $arguments;
151
-        }
152
-        // get constructor parameters
153
-        $params = $this->getParameters($constructor);
154
-        if (empty($params)) {
155
-            return $resolved_parameters;
156
-        }
157
-        $ingredients = $recipe->ingredients();
158
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
159
-        $argument_keys = array_keys($arguments);
160
-        // now loop thru all of the constructors expected parameters
161
-        foreach ($params as $index => $param) {
162
-            if (! $param instanceof ReflectionParameter) {
163
-                continue;
164
-            }
165
-            // is this a dependency for a specific class ?
166
-            $param_class = $param->getClass() ? $param->getClass()->name : '';
167
-            $param_name = $param->getName() ? $param->getName() : '';
168
-            if (// param is not a class but is specified in the list of ingredients for this Recipe
169
-                is_string($param_name) && isset($ingredients[ $param_name ])
170
-            ) {
171
-                // attempt to inject the dependency
172
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
173
-            } elseif (// param is specified in the list of ingredients for this Recipe
174
-            isset($ingredients[ $param_class ])
175
-            ) { // attempt to inject the dependency
176
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
177
-            } elseif (// param is not even a class
178
-                empty($param_class)
179
-                // and something already exists in the incoming arguments for this param
180
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
181
-            ) {
182
-                // add parameter from incoming arguments
183
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
184
-            } elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
185
-                ! empty($param_class)
186
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
187
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
188
-            ) {
189
-                // add parameter from incoming arguments
190
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
191
-            } elseif (// parameter is type hinted as a class, and should be injected
192
-            ! empty($param_class)
193
-            ) {
194
-                // attempt to inject the dependency
195
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
196
-            } elseif ($param->isOptional()) {
197
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
198
-            } else {
199
-                $resolved_parameters[ $index ] = null;
200
-            }
201
-        }
202
-        return $resolved_parameters;
203
-    }
204
-
205
-
206
-    /**
207
-     * @param ReflectionClass $reflector
208
-     * @param string          $param_class
209
-     * @return mixed
210
-     * @throws UnexpectedValueException
211
-     */
212
-    private function injectDependency(ReflectionClass $reflector, $param_class)
213
-    {
214
-        $dependency = $this->coffee_pot->brew($param_class);
215
-        if (! $dependency instanceof $param_class) {
216
-            throw new UnexpectedValueException(
217
-                sprintf(
218
-                    esc_html__(
219
-                        'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
220
-                        'event_espresso'
221
-                    ),
222
-                    $param_class,
223
-                    $reflector->getName()
224
-                )
225
-            );
226
-        }
227
-        return $dependency;
228
-    }
24
+	/**
25
+	 * @var CoffeePotInterface $coffee_pot
26
+	 */
27
+	private $coffee_pot;
28
+
29
+	/**
30
+	 * @var EEH_Array $array_helper
31
+	 */
32
+	private $array_helper;
33
+
34
+	/**
35
+	 * @var ReflectionClass[] $reflectors
36
+	 */
37
+	private $reflectors;
38
+
39
+	/**
40
+	 * @var ReflectionMethod[] $constructors
41
+	 */
42
+	private $constructors;
43
+
44
+	/**
45
+	 * @var ReflectionParameter[] $parameters
46
+	 */
47
+	private $parameters;
48
+
49
+
50
+	/**
51
+	 * DependencyInjector constructor
52
+	 *
53
+	 * @param CoffeePotInterface $coffee_pot
54
+	 * @param EEH_Array          $array_helper
55
+	 */
56
+	public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
57
+	{
58
+		$this->coffee_pot = $coffee_pot;
59
+		$this->array_helper = $array_helper;
60
+	}
61
+
62
+
63
+	/**
64
+	 * getReflectionClass
65
+	 * checks if a ReflectionClass object has already been generated for a class
66
+	 * and returns that instead of creating a new one
67
+	 *
68
+	 * @param string $class_name
69
+	 * @return ReflectionClass
70
+	 */
71
+	public function getReflectionClass($class_name)
72
+	{
73
+		if (! isset($this->reflectors[ $class_name ])
74
+			|| ! $this->reflectors[ $class_name ] instanceof ReflectionClass
75
+		) {
76
+			$this->reflectors[ $class_name ] = new ReflectionClass($class_name);
77
+		}
78
+		return $this->reflectors[ $class_name ];
79
+	}
80
+
81
+
82
+	/**
83
+	 * getConstructor
84
+	 * checks if a ReflectionMethod object has already been generated for the class constructor
85
+	 * and returns that instead of creating a new one
86
+	 *
87
+	 * @param ReflectionClass $reflector
88
+	 * @return ReflectionMethod
89
+	 */
90
+	protected function getConstructor(ReflectionClass $reflector)
91
+	{
92
+		if (! isset($this->constructors[ $reflector->getName() ])
93
+			|| ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
94
+		) {
95
+			$this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
96
+		}
97
+		return $this->constructors[ $reflector->getName() ];
98
+	}
99
+
100
+
101
+	/**
102
+	 * getParameters
103
+	 * checks if an array of ReflectionParameter objects has already been generated for the class constructor
104
+	 * and returns that instead of creating a new one
105
+	 *
106
+	 * @param ReflectionMethod $constructor
107
+	 * @return ReflectionParameter[]
108
+	 */
109
+	protected function getParameters(ReflectionMethod $constructor)
110
+	{
111
+		if (! isset($this->parameters[ $constructor->class ])) {
112
+			$this->parameters[ $constructor->class ] = $constructor->getParameters();
113
+		}
114
+		return $this->parameters[ $constructor->class ];
115
+	}
116
+
117
+
118
+	/**
119
+	 * resolveDependencies
120
+	 * examines the constructor for the requested class to determine
121
+	 * if any dependencies exist, and if they can be injected.
122
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
123
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
124
+	 * For example:
125
+	 *        if attempting to load a class "Foo" with the following constructor:
126
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
127
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
128
+	 *        but only IF they are NOT already present in the incoming arguments array,
129
+	 *        and the correct classes can be loaded
130
+	 *
131
+	 * @param RecipeInterface $recipe
132
+	 * @param ReflectionClass $reflector
133
+	 * @param array           $arguments
134
+	 * @return array
135
+	 * @throws UnexpectedValueException
136
+	 */
137
+	public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
138
+	{
139
+		// if arguments array is numerically and sequentially indexed, then we want it to remain as is,
140
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
141
+		$arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
142
+			? $arguments
143
+			: array($arguments);
144
+		$resolved_parameters = array();
145
+		// let's examine the constructor
146
+		// let's examine the constructor
147
+		$constructor = $this->getConstructor($reflector);
148
+		// whu? huh? nothing?
149
+		if (! $constructor) {
150
+			return $arguments;
151
+		}
152
+		// get constructor parameters
153
+		$params = $this->getParameters($constructor);
154
+		if (empty($params)) {
155
+			return $resolved_parameters;
156
+		}
157
+		$ingredients = $recipe->ingredients();
158
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
159
+		$argument_keys = array_keys($arguments);
160
+		// now loop thru all of the constructors expected parameters
161
+		foreach ($params as $index => $param) {
162
+			if (! $param instanceof ReflectionParameter) {
163
+				continue;
164
+			}
165
+			// is this a dependency for a specific class ?
166
+			$param_class = $param->getClass() ? $param->getClass()->name : '';
167
+			$param_name = $param->getName() ? $param->getName() : '';
168
+			if (// param is not a class but is specified in the list of ingredients for this Recipe
169
+				is_string($param_name) && isset($ingredients[ $param_name ])
170
+			) {
171
+				// attempt to inject the dependency
172
+				$resolved_parameters[ $index ] = $ingredients[ $param_name ];
173
+			} elseif (// param is specified in the list of ingredients for this Recipe
174
+			isset($ingredients[ $param_class ])
175
+			) { // attempt to inject the dependency
176
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
177
+			} elseif (// param is not even a class
178
+				empty($param_class)
179
+				// and something already exists in the incoming arguments for this param
180
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
181
+			) {
182
+				// add parameter from incoming arguments
183
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
184
+			} elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
185
+				! empty($param_class)
186
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
187
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
188
+			) {
189
+				// add parameter from incoming arguments
190
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
191
+			} elseif (// parameter is type hinted as a class, and should be injected
192
+			! empty($param_class)
193
+			) {
194
+				// attempt to inject the dependency
195
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
196
+			} elseif ($param->isOptional()) {
197
+				$resolved_parameters[ $index ] = $param->getDefaultValue();
198
+			} else {
199
+				$resolved_parameters[ $index ] = null;
200
+			}
201
+		}
202
+		return $resolved_parameters;
203
+	}
204
+
205
+
206
+	/**
207
+	 * @param ReflectionClass $reflector
208
+	 * @param string          $param_class
209
+	 * @return mixed
210
+	 * @throws UnexpectedValueException
211
+	 */
212
+	private function injectDependency(ReflectionClass $reflector, $param_class)
213
+	{
214
+		$dependency = $this->coffee_pot->brew($param_class);
215
+		if (! $dependency instanceof $param_class) {
216
+			throw new UnexpectedValueException(
217
+				sprintf(
218
+					esc_html__(
219
+						'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
220
+						'event_espresso'
221
+					),
222
+					$param_class,
223
+					$reflector->getName()
224
+				)
225
+			);
226
+		}
227
+		return $dependency;
228
+	}
229 229
 }
Please login to merge, or discard this patch.
Spacing   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -70,12 +70,12 @@  discard block
 block discarded – undo
70 70
      */
71 71
     public function getReflectionClass($class_name)
72 72
     {
73
-        if (! isset($this->reflectors[ $class_name ])
74
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
73
+        if ( ! isset($this->reflectors[$class_name])
74
+            || ! $this->reflectors[$class_name] instanceof ReflectionClass
75 75
         ) {
76
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
76
+            $this->reflectors[$class_name] = new ReflectionClass($class_name);
77 77
         }
78
-        return $this->reflectors[ $class_name ];
78
+        return $this->reflectors[$class_name];
79 79
     }
80 80
 
81 81
 
@@ -89,12 +89,12 @@  discard block
 block discarded – undo
89 89
      */
90 90
     protected function getConstructor(ReflectionClass $reflector)
91 91
     {
92
-        if (! isset($this->constructors[ $reflector->getName() ])
93
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
92
+        if ( ! isset($this->constructors[$reflector->getName()])
93
+            || ! $this->constructors[$reflector->getName()] instanceof ReflectionMethod
94 94
         ) {
95
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
95
+            $this->constructors[$reflector->getName()] = $reflector->getConstructor();
96 96
         }
97
-        return $this->constructors[ $reflector->getName() ];
97
+        return $this->constructors[$reflector->getName()];
98 98
     }
99 99
 
100 100
 
@@ -108,10 +108,10 @@  discard block
 block discarded – undo
108 108
      */
109 109
     protected function getParameters(ReflectionMethod $constructor)
110 110
     {
111
-        if (! isset($this->parameters[ $constructor->class ])) {
112
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
111
+        if ( ! isset($this->parameters[$constructor->class])) {
112
+            $this->parameters[$constructor->class] = $constructor->getParameters();
113 113
         }
114
-        return $this->parameters[ $constructor->class ];
114
+        return $this->parameters[$constructor->class];
115 115
     }
116 116
 
117 117
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
         // let's examine the constructor
147 147
         $constructor = $this->getConstructor($reflector);
148 148
         // whu? huh? nothing?
149
-        if (! $constructor) {
149
+        if ( ! $constructor) {
150 150
             return $arguments;
151 151
         }
152 152
         // get constructor parameters
@@ -159,44 +159,44 @@  discard block
 block discarded – undo
159 159
         $argument_keys = array_keys($arguments);
160 160
         // now loop thru all of the constructors expected parameters
161 161
         foreach ($params as $index => $param) {
162
-            if (! $param instanceof ReflectionParameter) {
162
+            if ( ! $param instanceof ReflectionParameter) {
163 163
                 continue;
164 164
             }
165 165
             // is this a dependency for a specific class ?
166 166
             $param_class = $param->getClass() ? $param->getClass()->name : '';
167 167
             $param_name = $param->getName() ? $param->getName() : '';
168 168
             if (// param is not a class but is specified in the list of ingredients for this Recipe
169
-                is_string($param_name) && isset($ingredients[ $param_name ])
169
+                is_string($param_name) && isset($ingredients[$param_name])
170 170
             ) {
171 171
                 // attempt to inject the dependency
172
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
172
+                $resolved_parameters[$index] = $ingredients[$param_name];
173 173
             } elseif (// param is specified in the list of ingredients for this Recipe
174
-            isset($ingredients[ $param_class ])
174
+            isset($ingredients[$param_class])
175 175
             ) { // attempt to inject the dependency
176
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
176
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $ingredients[$param_class]);
177 177
             } elseif (// param is not even a class
178 178
                 empty($param_class)
179 179
                 // and something already exists in the incoming arguments for this param
180
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
180
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
181 181
             ) {
182 182
                 // add parameter from incoming arguments
183
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
183
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
184 184
             } elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
185 185
                 ! empty($param_class)
186
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
187
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
186
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
187
+                && $arguments[$argument_keys[$index]] instanceof $param_class
188 188
             ) {
189 189
                 // add parameter from incoming arguments
190
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
190
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
191 191
             } elseif (// parameter is type hinted as a class, and should be injected
192 192
             ! empty($param_class)
193 193
             ) {
194 194
                 // attempt to inject the dependency
195
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
195
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $param_class);
196 196
             } elseif ($param->isOptional()) {
197
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
197
+                $resolved_parameters[$index] = $param->getDefaultValue();
198 198
             } else {
199
-                $resolved_parameters[ $index ] = null;
199
+                $resolved_parameters[$index] = null;
200 200
             }
201 201
         }
202 202
         return $resolved_parameters;
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
     private function injectDependency(ReflectionClass $reflector, $param_class)
213 213
     {
214 214
         $dependency = $this->coffee_pot->brew($param_class);
215
-        if (! $dependency instanceof $param_class) {
215
+        if ( ! $dependency instanceof $param_class) {
216 216
             throw new UnexpectedValueException(
217 217
                 sprintf(
218 218
                     esc_html__(
Please login to merge, or discard this patch.
core/services/container/RegistryContainer.php 2 patches
Indentation   +126 added lines, -126 removed lines patch added patch discarded remove patch
@@ -17,130 +17,130 @@
 block discarded – undo
17 17
 class RegistryContainer implements ArrayAccess, CountableTraversableAggregate
18 18
 {
19 19
 
20
-    /**
21
-     * @var array $container
22
-     */
23
-    private $container;
24
-
25
-    /**
26
-     * RegistryContainer constructor.
27
-     * Container data can be seeded by passing parameters to constructor.
28
-     * Each parameter will become its own element in the container
29
-     */
30
-    public function __construct()
31
-    {
32
-        $this->container = func_get_args();
33
-        if (func_num_args() === 0) {
34
-            $this->container = array();
35
-        }
36
-    }
37
-
38
-
39
-    /**
40
-     * @param mixed $offset
41
-     * @param mixed $value
42
-     */
43
-    public function offsetSet($offset, $value)
44
-    {
45
-        $this->container[ $offset ] = $value;
46
-    }
47
-
48
-
49
-    /**
50
-     * @param mixed $offset
51
-     * @return bool
52
-     */
53
-    public function offsetExists($offset)
54
-    {
55
-        return isset($this->container[ $offset ]);
56
-    }
57
-
58
-
59
-    /**
60
-     * @param mixed $offset
61
-     */
62
-    public function offsetUnset($offset)
63
-    {
64
-        unset($this->container[ $offset ]);
65
-    }
66
-
67
-
68
-    /**
69
-     * @param mixed $offset
70
-     * @return mixed|null
71
-     */
72
-    public function offsetGet($offset)
73
-    {
74
-        return isset($this->container[ $offset ]) ? $this->container[ $offset ] : null;
75
-    }
76
-
77
-
78
-    /**
79
-     * @return int
80
-     */
81
-    public function count()
82
-    {
83
-        return count($this->container);
84
-    }
85
-
86
-
87
-    /**
88
-     * @return ArrayIterator
89
-     */
90
-    public function getIterator()
91
-    {
92
-        return new ArrayIterator($this->container);
93
-    }
94
-
95
-
96
-    /**
97
-     * @param $offset
98
-     * @param $value
99
-     */
100
-    public function __set($offset, $value)
101
-    {
102
-        $this->container[ $offset ] = $value;
103
-    }
104
-
105
-
106
-    /**
107
-     * @param $offset
108
-     * @return mixed
109
-     * @throws OutOfBoundsException
110
-     */
111
-    public function __get($offset)
112
-    {
113
-        if (array_key_exists($offset, $this->container)) {
114
-            return $this->container[ $offset ];
115
-        }
116
-        $trace = debug_backtrace();
117
-        throw new OutOfBoundsException(
118
-            sprintf(
119
-                esc_html__('Invalid offset: %1$s %2$sCalled from %3$s on line %4$d', 'event_espresso'),
120
-                $offset,
121
-                '<br  />',
122
-                $trace[0]['file'],
123
-                $trace[0]['line']
124
-            )
125
-        );
126
-    }
127
-
128
-
129
-    /**
130
-     * @param $offset
131
-     * @return bool
132
-     */
133
-    public function __isset($offset)
134
-    {
135
-        return isset($this->container[ $offset ]);
136
-    }
137
-
138
-
139
-    /**
140
-     * @param $offset
141
-     */
142
-    public function __unset($offset)
143
-    {
144
-        unset($this->container[ $offset ]);
145
-    }
20
+	/**
21
+	 * @var array $container
22
+	 */
23
+	private $container;
24
+
25
+	/**
26
+	 * RegistryContainer constructor.
27
+	 * Container data can be seeded by passing parameters to constructor.
28
+	 * Each parameter will become its own element in the container
29
+	 */
30
+	public function __construct()
31
+	{
32
+		$this->container = func_get_args();
33
+		if (func_num_args() === 0) {
34
+			$this->container = array();
35
+		}
36
+	}
37
+
38
+
39
+	/**
40
+	 * @param mixed $offset
41
+	 * @param mixed $value
42
+	 */
43
+	public function offsetSet($offset, $value)
44
+	{
45
+		$this->container[ $offset ] = $value;
46
+	}
47
+
48
+
49
+	/**
50
+	 * @param mixed $offset
51
+	 * @return bool
52
+	 */
53
+	public function offsetExists($offset)
54
+	{
55
+		return isset($this->container[ $offset ]);
56
+	}
57
+
58
+
59
+	/**
60
+	 * @param mixed $offset
61
+	 */
62
+	public function offsetUnset($offset)
63
+	{
64
+		unset($this->container[ $offset ]);
65
+	}
66
+
67
+
68
+	/**
69
+	 * @param mixed $offset
70
+	 * @return mixed|null
71
+	 */
72
+	public function offsetGet($offset)
73
+	{
74
+		return isset($this->container[ $offset ]) ? $this->container[ $offset ] : null;
75
+	}
76
+
77
+
78
+	/**
79
+	 * @return int
80
+	 */
81
+	public function count()
82
+	{
83
+		return count($this->container);
84
+	}
85
+
86
+
87
+	/**
88
+	 * @return ArrayIterator
89
+	 */
90
+	public function getIterator()
91
+	{
92
+		return new ArrayIterator($this->container);
93
+	}
94
+
95
+
96
+	/**
97
+	 * @param $offset
98
+	 * @param $value
99
+	 */
100
+	public function __set($offset, $value)
101
+	{
102
+		$this->container[ $offset ] = $value;
103
+	}
104
+
105
+
106
+	/**
107
+	 * @param $offset
108
+	 * @return mixed
109
+	 * @throws OutOfBoundsException
110
+	 */
111
+	public function __get($offset)
112
+	{
113
+		if (array_key_exists($offset, $this->container)) {
114
+			return $this->container[ $offset ];
115
+		}
116
+		$trace = debug_backtrace();
117
+		throw new OutOfBoundsException(
118
+			sprintf(
119
+				esc_html__('Invalid offset: %1$s %2$sCalled from %3$s on line %4$d', 'event_espresso'),
120
+				$offset,
121
+				'<br  />',
122
+				$trace[0]['file'],
123
+				$trace[0]['line']
124
+			)
125
+		);
126
+	}
127
+
128
+
129
+	/**
130
+	 * @param $offset
131
+	 * @return bool
132
+	 */
133
+	public function __isset($offset)
134
+	{
135
+		return isset($this->container[ $offset ]);
136
+	}
137
+
138
+
139
+	/**
140
+	 * @param $offset
141
+	 */
142
+	public function __unset($offset)
143
+	{
144
+		unset($this->container[ $offset ]);
145
+	}
146 146
 }
Please login to merge, or discard this patch.
Spacing   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -42,7 +42,7 @@  discard block
 block discarded – undo
42 42
      */
43 43
     public function offsetSet($offset, $value)
44 44
     {
45
-        $this->container[ $offset ] = $value;
45
+        $this->container[$offset] = $value;
46 46
     }
47 47
 
48 48
 
@@ -52,7 +52,7 @@  discard block
 block discarded – undo
52 52
      */
53 53
     public function offsetExists($offset)
54 54
     {
55
-        return isset($this->container[ $offset ]);
55
+        return isset($this->container[$offset]);
56 56
     }
57 57
 
58 58
 
@@ -61,7 +61,7 @@  discard block
 block discarded – undo
61 61
      */
62 62
     public function offsetUnset($offset)
63 63
     {
64
-        unset($this->container[ $offset ]);
64
+        unset($this->container[$offset]);
65 65
     }
66 66
 
67 67
 
@@ -71,7 +71,7 @@  discard block
 block discarded – undo
71 71
      */
72 72
     public function offsetGet($offset)
73 73
     {
74
-        return isset($this->container[ $offset ]) ? $this->container[ $offset ] : null;
74
+        return isset($this->container[$offset]) ? $this->container[$offset] : null;
75 75
     }
76 76
 
77 77
 
@@ -99,7 +99,7 @@  discard block
 block discarded – undo
99 99
      */
100 100
     public function __set($offset, $value)
101 101
     {
102
-        $this->container[ $offset ] = $value;
102
+        $this->container[$offset] = $value;
103 103
     }
104 104
 
105 105
 
@@ -111,7 +111,7 @@  discard block
 block discarded – undo
111 111
     public function __get($offset)
112 112
     {
113 113
         if (array_key_exists($offset, $this->container)) {
114
-            return $this->container[ $offset ];
114
+            return $this->container[$offset];
115 115
         }
116 116
         $trace = debug_backtrace();
117 117
         throw new OutOfBoundsException(
@@ -132,7 +132,7 @@  discard block
 block discarded – undo
132 132
      */
133 133
     public function __isset($offset)
134 134
     {
135
-        return isset($this->container[ $offset ]);
135
+        return isset($this->container[$offset]);
136 136
     }
137 137
 
138 138
 
@@ -141,6 +141,6 @@  discard block
 block discarded – undo
141 141
      */
142 142
     public function __unset($offset)
143 143
     {
144
-        unset($this->container[ $offset ]);
144
+        unset($this->container[$offset]);
145 145
     }
146 146
 }
Please login to merge, or discard this patch.
core/services/container/Recipe.php 2 patches
Indentation   +306 added lines, -306 removed lines patch added patch discarded remove patch
@@ -19,310 +19,310 @@
 block discarded – undo
19 19
 class Recipe implements RecipeInterface
20 20
 {
21 21
 
22
-    /**
23
-     * A default Recipe to use if none is specified for a class
24
-     */
25
-    const DEFAULT_ID = '*';
26
-
27
-    /**
28
-     * Identifier for the entity class to be constructed.
29
-     * Typically a Fully Qualified Class Name
30
-     *
31
-     * @var string $identifier
32
-     */
33
-    private $identifier;
34
-
35
-    /**
36
-     * Fully Qualified Class Name
37
-     *
38
-     * @var string $fqcn
39
-     */
40
-    private $fqcn;
41
-
42
-    /**
43
-     * a dependency class map array
44
-     * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
45
-     * and that class type hints for an interface, then this property allows you to configure what dependencies
46
-     * get used when instantiating the class.
47
-     * For example:
48
-     *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
49
-     *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
50
-     *  We want one Coffee object to use HonduranBean for its BeanInterface,
51
-     *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
52
-     *  To do this, we need to create two Recipes:
53
-     *      one with an identifier of 'HonduranCoffee' using the following ingredients :
54
-     *          array('BeanInterface' => 'HonduranBean')
55
-     *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
56
-     *          array('BeanInterface' => 'KenyanBean')
57
-     *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
58
-     *  an instance of HonduranBean will get injected for the BeanInterface dependency,
59
-     *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
60
-     *  an instance of KenyanBean will get injected for the BeanInterface dependency
61
-     *
62
-     * @var array $ingredients
63
-     */
64
-    private $ingredients = array();
65
-
66
-    /**
67
-     * one of the class constants from CoffeeShop:
68
-     *  CoffeeMaker::BREW_NEW - creates a new instance
69
-     *  CoffeeMaker::BREW_SHARED - creates a shared instance
70
-     *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
71
-     *
72
-     * @var string $type
73
-     */
74
-    private $type;
75
-
76
-    /**
77
-     * class name aliases - typically a Fully Qualified Interface that the class implements
78
-     * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
79
-     *
80
-     * @var array $filters
81
-     */
82
-    private $filters = array();
83
-
84
-    /**
85
-     * array of full server filepaths to files that may contain the class
86
-     *
87
-     * @var array $paths
88
-     */
89
-    private $paths = array();
90
-
91
-
92
-    /**
93
-     * Recipe constructor.
94
-     *
95
-     * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
96
-     * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
97
-     * @param array  $ingredients   array of dependencies that can not be resolved automatically,
98
-     *                              used for resolving concrete classes for type hinted interfaces
99
-     *                              for the dependencies of THIS class
100
-     * @param string $type          recipe type: one of the class constants on
101
-     *                              \EventEspresso\core\services\container\CoffeeMaker
102
-     * @param array  $filters       array of class aliases, or class interfaces
103
-     *                              this works somewhat opposite to the $ingredients array above,
104
-     *                              in that this array specifies interfaces or aliases
105
-     *                              that this Recipe can be used for when resolving OTHER class's dependencies
106
-     * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
107
-     *                              then supply a filepath, or array of filepaths, so that it can be included
108
-     * @throws InvalidIdentifierException
109
-     * @throws RuntimeException
110
-     * @throws InvalidInterfaceException
111
-     * @throws InvalidClassException
112
-     * @throws InvalidDataTypeException
113
-     */
114
-    public function __construct(
115
-        $identifier,
116
-        $fqcn = '',
117
-        array $filters = array(),
118
-        array $ingredients = array(),
119
-        $type = CoffeeMaker::BREW_NEW,
120
-        array $paths = array()
121
-    ) {
122
-        $this->setIdentifier($identifier);
123
-        $this->setFilters($filters);
124
-        $this->setIngredients($ingredients);
125
-        $this->setType($type);
126
-        $this->setPaths($paths);
127
-        $this->setFqcn($fqcn);
128
-    }
129
-
130
-
131
-    /**
132
-     * @return string
133
-     */
134
-    public function identifier()
135
-    {
136
-        return $this->identifier;
137
-    }
138
-
139
-
140
-    /**
141
-     * @return string
142
-     */
143
-    public function fqcn()
144
-    {
145
-        return $this->fqcn;
146
-    }
147
-
148
-
149
-    /**
150
-     * @return array
151
-     */
152
-    public function filters()
153
-    {
154
-        return $this->filters;
155
-    }
156
-
157
-
158
-    /**
159
-     * @return array
160
-     */
161
-    public function ingredients()
162
-    {
163
-        return $this->ingredients;
164
-    }
165
-
166
-
167
-    /**
168
-     * @return string
169
-     */
170
-    public function type()
171
-    {
172
-        return $this->type;
173
-    }
174
-
175
-
176
-    /**
177
-     * @return array
178
-     */
179
-    public function paths()
180
-    {
181
-        return $this->paths;
182
-    }
183
-
184
-
185
-    /**
186
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
187
-     *                            Typically a Fully Qualified Class Name
188
-     * @throws InvalidIdentifierException
189
-     */
190
-    public function setIdentifier($identifier)
191
-    {
192
-        if (! is_string($identifier) || empty($identifier)) {
193
-            throw new InvalidIdentifierException(
194
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
195
-                __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
196
-            );
197
-        }
198
-        $this->identifier = $identifier;
199
-    }
200
-
201
-
202
-    /**
203
-     * Ensures incoming string is a valid Fully Qualified Class Name,
204
-     * except if this is the default wildcard Recipe ( * ),
205
-     * or it's NOT an actual FQCN because the Recipe is using filepaths
206
-     * for classes that are not PSR-4 compatible
207
-     * PLZ NOTE:
208
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
209
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
210
-     *
211
-     * @param string $fqcn
212
-     * @throws InvalidDataTypeException
213
-     * @throws InvalidClassException
214
-     * @throws InvalidInterfaceException
215
-     */
216
-    public function setFqcn($fqcn)
217
-    {
218
-        $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
219
-        if (! is_string($fqcn)) {
220
-            throw new InvalidDataTypeException(
221
-                '$fqcn',
222
-                is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
223
-                __('string (Fully\Qualified\ClassName)', 'event_espresso')
224
-            );
225
-        }
226
-        $fqcn = ltrim($fqcn, '\\');
227
-        if ($fqcn !== Recipe::DEFAULT_ID
228
-            && ! empty($fqcn)
229
-            && empty($this->paths)
230
-            && ! (class_exists($fqcn) || interface_exists($fqcn))
231
-        ) {
232
-            throw new InvalidClassException($fqcn);
233
-        }
234
-        $this->fqcn = $fqcn;
235
-    }
236
-
237
-
238
-    /**
239
-     * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
240
-     *                              example:
241
-     *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
242
-     * @throws InvalidDataTypeException
243
-     */
244
-    public function setIngredients(array $ingredients)
245
-    {
246
-        if (empty($ingredients)) {
247
-            return;
248
-        }
249
-        if (! is_array($ingredients)) {
250
-            throw new InvalidDataTypeException(
251
-                '$ingredients',
252
-                is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
253
-                __('array of class dependencies', 'event_espresso')
254
-            );
255
-        }
256
-        $this->ingredients = array_merge($this->ingredients, $ingredients);
257
-    }
258
-
259
-
260
-    /**
261
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
262
-     * @throws InvalidIdentifierException
263
-     */
264
-    public function setType($type = CoffeeMaker::BREW_NEW)
265
-    {
266
-        $this->type = CoffeeMaker::validateType($type);
267
-    }
268
-
269
-
270
-    /**
271
-     * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
272
-     *                          example:
273
-     *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
274
-     * @throws InvalidDataTypeException
275
-     */
276
-    public function setFilters(array $filters)
277
-    {
278
-        if (empty($filters)) {
279
-            return;
280
-        }
281
-        if (! is_array($filters)) {
282
-            throw new InvalidDataTypeException(
283
-                '$filters',
284
-                is_object($filters) ? get_class($filters) : gettype($filters),
285
-                __('array of class aliases', 'event_espresso')
286
-            );
287
-        }
288
-        $this->filters = array_merge($this->filters, $filters);
289
-    }
290
-
291
-
292
-    /**
293
-     * Ensures incoming paths is a valid filepath, or array of valid filepaths,
294
-     * and merges them in with any existing filepaths
295
-     * PLZ NOTE:
296
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
297
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
298
-     *
299
-     * @param string|array $paths
300
-     * @throws RuntimeException
301
-     * @throws InvalidDataTypeException
302
-     */
303
-    public function setPaths($paths = array())
304
-    {
305
-        if (empty($paths)) {
306
-            return;
307
-        }
308
-        if (! (is_string($paths) || is_array($paths))) {
309
-            throw new InvalidDataTypeException(
310
-                '$path',
311
-                is_object($paths) ? get_class($paths) : gettype($paths),
312
-                __('string or array of strings (full server filepath(s))', 'event_espresso')
313
-            );
314
-        }
315
-        $paths = (array) $paths;
316
-        foreach ($paths as $path) {
317
-            if (strpos($path, '*') === false && ! is_readable($path)) {
318
-                throw new RuntimeException(
319
-                    sprintf(
320
-                        __('The following filepath is not readable: "%1$s"', 'event_espresso'),
321
-                        $path
322
-                    )
323
-                );
324
-            }
325
-        }
326
-        $this->paths = array_merge($this->paths, $paths);
327
-    }
22
+	/**
23
+	 * A default Recipe to use if none is specified for a class
24
+	 */
25
+	const DEFAULT_ID = '*';
26
+
27
+	/**
28
+	 * Identifier for the entity class to be constructed.
29
+	 * Typically a Fully Qualified Class Name
30
+	 *
31
+	 * @var string $identifier
32
+	 */
33
+	private $identifier;
34
+
35
+	/**
36
+	 * Fully Qualified Class Name
37
+	 *
38
+	 * @var string $fqcn
39
+	 */
40
+	private $fqcn;
41
+
42
+	/**
43
+	 * a dependency class map array
44
+	 * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
45
+	 * and that class type hints for an interface, then this property allows you to configure what dependencies
46
+	 * get used when instantiating the class.
47
+	 * For example:
48
+	 *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
49
+	 *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
50
+	 *  We want one Coffee object to use HonduranBean for its BeanInterface,
51
+	 *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
52
+	 *  To do this, we need to create two Recipes:
53
+	 *      one with an identifier of 'HonduranCoffee' using the following ingredients :
54
+	 *          array('BeanInterface' => 'HonduranBean')
55
+	 *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
56
+	 *          array('BeanInterface' => 'KenyanBean')
57
+	 *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
58
+	 *  an instance of HonduranBean will get injected for the BeanInterface dependency,
59
+	 *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
60
+	 *  an instance of KenyanBean will get injected for the BeanInterface dependency
61
+	 *
62
+	 * @var array $ingredients
63
+	 */
64
+	private $ingredients = array();
65
+
66
+	/**
67
+	 * one of the class constants from CoffeeShop:
68
+	 *  CoffeeMaker::BREW_NEW - creates a new instance
69
+	 *  CoffeeMaker::BREW_SHARED - creates a shared instance
70
+	 *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
71
+	 *
72
+	 * @var string $type
73
+	 */
74
+	private $type;
75
+
76
+	/**
77
+	 * class name aliases - typically a Fully Qualified Interface that the class implements
78
+	 * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
79
+	 *
80
+	 * @var array $filters
81
+	 */
82
+	private $filters = array();
83
+
84
+	/**
85
+	 * array of full server filepaths to files that may contain the class
86
+	 *
87
+	 * @var array $paths
88
+	 */
89
+	private $paths = array();
90
+
91
+
92
+	/**
93
+	 * Recipe constructor.
94
+	 *
95
+	 * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
96
+	 * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
97
+	 * @param array  $ingredients   array of dependencies that can not be resolved automatically,
98
+	 *                              used for resolving concrete classes for type hinted interfaces
99
+	 *                              for the dependencies of THIS class
100
+	 * @param string $type          recipe type: one of the class constants on
101
+	 *                              \EventEspresso\core\services\container\CoffeeMaker
102
+	 * @param array  $filters       array of class aliases, or class interfaces
103
+	 *                              this works somewhat opposite to the $ingredients array above,
104
+	 *                              in that this array specifies interfaces or aliases
105
+	 *                              that this Recipe can be used for when resolving OTHER class's dependencies
106
+	 * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
107
+	 *                              then supply a filepath, or array of filepaths, so that it can be included
108
+	 * @throws InvalidIdentifierException
109
+	 * @throws RuntimeException
110
+	 * @throws InvalidInterfaceException
111
+	 * @throws InvalidClassException
112
+	 * @throws InvalidDataTypeException
113
+	 */
114
+	public function __construct(
115
+		$identifier,
116
+		$fqcn = '',
117
+		array $filters = array(),
118
+		array $ingredients = array(),
119
+		$type = CoffeeMaker::BREW_NEW,
120
+		array $paths = array()
121
+	) {
122
+		$this->setIdentifier($identifier);
123
+		$this->setFilters($filters);
124
+		$this->setIngredients($ingredients);
125
+		$this->setType($type);
126
+		$this->setPaths($paths);
127
+		$this->setFqcn($fqcn);
128
+	}
129
+
130
+
131
+	/**
132
+	 * @return string
133
+	 */
134
+	public function identifier()
135
+	{
136
+		return $this->identifier;
137
+	}
138
+
139
+
140
+	/**
141
+	 * @return string
142
+	 */
143
+	public function fqcn()
144
+	{
145
+		return $this->fqcn;
146
+	}
147
+
148
+
149
+	/**
150
+	 * @return array
151
+	 */
152
+	public function filters()
153
+	{
154
+		return $this->filters;
155
+	}
156
+
157
+
158
+	/**
159
+	 * @return array
160
+	 */
161
+	public function ingredients()
162
+	{
163
+		return $this->ingredients;
164
+	}
165
+
166
+
167
+	/**
168
+	 * @return string
169
+	 */
170
+	public function type()
171
+	{
172
+		return $this->type;
173
+	}
174
+
175
+
176
+	/**
177
+	 * @return array
178
+	 */
179
+	public function paths()
180
+	{
181
+		return $this->paths;
182
+	}
183
+
184
+
185
+	/**
186
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
187
+	 *                            Typically a Fully Qualified Class Name
188
+	 * @throws InvalidIdentifierException
189
+	 */
190
+	public function setIdentifier($identifier)
191
+	{
192
+		if (! is_string($identifier) || empty($identifier)) {
193
+			throw new InvalidIdentifierException(
194
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
195
+				__('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
196
+			);
197
+		}
198
+		$this->identifier = $identifier;
199
+	}
200
+
201
+
202
+	/**
203
+	 * Ensures incoming string is a valid Fully Qualified Class Name,
204
+	 * except if this is the default wildcard Recipe ( * ),
205
+	 * or it's NOT an actual FQCN because the Recipe is using filepaths
206
+	 * for classes that are not PSR-4 compatible
207
+	 * PLZ NOTE:
208
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
209
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
210
+	 *
211
+	 * @param string $fqcn
212
+	 * @throws InvalidDataTypeException
213
+	 * @throws InvalidClassException
214
+	 * @throws InvalidInterfaceException
215
+	 */
216
+	public function setFqcn($fqcn)
217
+	{
218
+		$fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
219
+		if (! is_string($fqcn)) {
220
+			throw new InvalidDataTypeException(
221
+				'$fqcn',
222
+				is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
223
+				__('string (Fully\Qualified\ClassName)', 'event_espresso')
224
+			);
225
+		}
226
+		$fqcn = ltrim($fqcn, '\\');
227
+		if ($fqcn !== Recipe::DEFAULT_ID
228
+			&& ! empty($fqcn)
229
+			&& empty($this->paths)
230
+			&& ! (class_exists($fqcn) || interface_exists($fqcn))
231
+		) {
232
+			throw new InvalidClassException($fqcn);
233
+		}
234
+		$this->fqcn = $fqcn;
235
+	}
236
+
237
+
238
+	/**
239
+	 * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
240
+	 *                              example:
241
+	 *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
242
+	 * @throws InvalidDataTypeException
243
+	 */
244
+	public function setIngredients(array $ingredients)
245
+	{
246
+		if (empty($ingredients)) {
247
+			return;
248
+		}
249
+		if (! is_array($ingredients)) {
250
+			throw new InvalidDataTypeException(
251
+				'$ingredients',
252
+				is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
253
+				__('array of class dependencies', 'event_espresso')
254
+			);
255
+		}
256
+		$this->ingredients = array_merge($this->ingredients, $ingredients);
257
+	}
258
+
259
+
260
+	/**
261
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
262
+	 * @throws InvalidIdentifierException
263
+	 */
264
+	public function setType($type = CoffeeMaker::BREW_NEW)
265
+	{
266
+		$this->type = CoffeeMaker::validateType($type);
267
+	}
268
+
269
+
270
+	/**
271
+	 * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
272
+	 *                          example:
273
+	 *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
274
+	 * @throws InvalidDataTypeException
275
+	 */
276
+	public function setFilters(array $filters)
277
+	{
278
+		if (empty($filters)) {
279
+			return;
280
+		}
281
+		if (! is_array($filters)) {
282
+			throw new InvalidDataTypeException(
283
+				'$filters',
284
+				is_object($filters) ? get_class($filters) : gettype($filters),
285
+				__('array of class aliases', 'event_espresso')
286
+			);
287
+		}
288
+		$this->filters = array_merge($this->filters, $filters);
289
+	}
290
+
291
+
292
+	/**
293
+	 * Ensures incoming paths is a valid filepath, or array of valid filepaths,
294
+	 * and merges them in with any existing filepaths
295
+	 * PLZ NOTE:
296
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
297
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
298
+	 *
299
+	 * @param string|array $paths
300
+	 * @throws RuntimeException
301
+	 * @throws InvalidDataTypeException
302
+	 */
303
+	public function setPaths($paths = array())
304
+	{
305
+		if (empty($paths)) {
306
+			return;
307
+		}
308
+		if (! (is_string($paths) || is_array($paths))) {
309
+			throw new InvalidDataTypeException(
310
+				'$path',
311
+				is_object($paths) ? get_class($paths) : gettype($paths),
312
+				__('string or array of strings (full server filepath(s))', 'event_espresso')
313
+			);
314
+		}
315
+		$paths = (array) $paths;
316
+		foreach ($paths as $path) {
317
+			if (strpos($path, '*') === false && ! is_readable($path)) {
318
+				throw new RuntimeException(
319
+					sprintf(
320
+						__('The following filepath is not readable: "%1$s"', 'event_espresso'),
321
+						$path
322
+					)
323
+				);
324
+			}
325
+		}
326
+		$this->paths = array_merge($this->paths, $paths);
327
+	}
328 328
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -189,7 +189,7 @@  discard block
 block discarded – undo
189 189
      */
190 190
     public function setIdentifier($identifier)
191 191
     {
192
-        if (! is_string($identifier) || empty($identifier)) {
192
+        if ( ! is_string($identifier) || empty($identifier)) {
193 193
             throw new InvalidIdentifierException(
194 194
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
195 195
                 __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
@@ -216,7 +216,7 @@  discard block
 block discarded – undo
216 216
     public function setFqcn($fqcn)
217 217
     {
218 218
         $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
219
-        if (! is_string($fqcn)) {
219
+        if ( ! is_string($fqcn)) {
220 220
             throw new InvalidDataTypeException(
221 221
                 '$fqcn',
222 222
                 is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
@@ -246,7 +246,7 @@  discard block
 block discarded – undo
246 246
         if (empty($ingredients)) {
247 247
             return;
248 248
         }
249
-        if (! is_array($ingredients)) {
249
+        if ( ! is_array($ingredients)) {
250 250
             throw new InvalidDataTypeException(
251 251
                 '$ingredients',
252 252
                 is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
@@ -278,7 +278,7 @@  discard block
 block discarded – undo
278 278
         if (empty($filters)) {
279 279
             return;
280 280
         }
281
-        if (! is_array($filters)) {
281
+        if ( ! is_array($filters)) {
282 282
             throw new InvalidDataTypeException(
283 283
                 '$filters',
284 284
                 is_object($filters) ? get_class($filters) : gettype($filters),
@@ -305,7 +305,7 @@  discard block
 block discarded – undo
305 305
         if (empty($paths)) {
306 306
             return;
307 307
         }
308
-        if (! (is_string($paths) || is_array($paths))) {
308
+        if ( ! (is_string($paths) || is_array($paths))) {
309 309
             throw new InvalidDataTypeException(
310 310
                 '$path',
311 311
                 is_object($paths) ? get_class($paths) : gettype($paths),
Please login to merge, or discard this patch.
core/services/formatters/Windows1252.php 1 patch
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -17,34 +17,34 @@
 block discarded – undo
17 17
 class Windows1252 extends FormatterBase
18 18
 {
19 19
 
20
-    /**
21
-     * Converts the string to windows-1252 encoding.
22
-     *
23
-     * @param string|int|float $input anything easily cast into a string
24
-     * @return string
25
-     */
26
-    public function format($input)
27
-    {
28
-        // in case an int or float etc was passed in
29
-        $input = (string) $input;
30
-        if (function_exists('iconv')) {
31
-            $input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
32
-        } elseif (WP_DEBUG) {
33
-            trigger_error(
34
-                sprintf(
35
-                // @codingStandardsIgnoreStart
36
-                    esc_html__(
37
-                        '%1$s could not format the string "%2$s" because the function "%3$s" does not exist. Please verify PHP is installed with this function, see %4$s',
38
-                        'event_espresso'
39
-                    ),
40
-                    // @codingStandardsIgnoreEnd
41
-                    get_class($this),
42
-                    $input,
43
-                    'iconv',
44
-                    '<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
45
-                )
46
-            );
47
-        }
48
-        return $input;
49
-    }
20
+	/**
21
+	 * Converts the string to windows-1252 encoding.
22
+	 *
23
+	 * @param string|int|float $input anything easily cast into a string
24
+	 * @return string
25
+	 */
26
+	public function format($input)
27
+	{
28
+		// in case an int or float etc was passed in
29
+		$input = (string) $input;
30
+		if (function_exists('iconv')) {
31
+			$input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
32
+		} elseif (WP_DEBUG) {
33
+			trigger_error(
34
+				sprintf(
35
+				// @codingStandardsIgnoreStart
36
+					esc_html__(
37
+						'%1$s could not format the string "%2$s" because the function "%3$s" does not exist. Please verify PHP is installed with this function, see %4$s',
38
+						'event_espresso'
39
+					),
40
+					// @codingStandardsIgnoreEnd
41
+					get_class($this),
42
+					$input,
43
+					'iconv',
44
+					'<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
45
+				)
46
+			);
47
+		}
48
+		return $input;
49
+	}
50 50
 }
Please login to merge, or discard this patch.
core/services/collections/CollectionDetails.php 2 patches
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -192,7 +192,7 @@  discard block
 block discarded – undo
192 192
      */
193 193
     protected function setCollectionInterface($collection_interface)
194 194
     {
195
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
195
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
196 196
             throw new InvalidInterfaceException($collection_interface);
197 197
         }
198 198
         $this->collection_interface = $collection_interface;
@@ -220,7 +220,7 @@  discard block
 block discarded – undo
220 220
      */
221 221
     protected function setCollectionName($collection_name)
222 222
     {
223
-        if (! is_string($collection_name)) {
223
+        if ( ! is_string($collection_name)) {
224 224
             throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
225 225
         }
226 226
         $this->collection_name = str_replace(
@@ -248,7 +248,7 @@  discard block
 block discarded – undo
248 248
      */
249 249
     protected function setIdentifierType($identifier_type)
250 250
     {
251
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
251
+        if ( ! ($identifier_type === CollectionDetails::ID_CLASS_NAME
252 252
                || $identifier_type === CollectionDetails::ID_OBJECT_HASH
253 253
                || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
254 254
         )) {
@@ -278,7 +278,7 @@  discard block
 block discarded – undo
278 278
      */
279 279
     protected function setIdentifierCallback($identifier_callback = 'identifier')
280 280
     {
281
-        if (! is_string($identifier_callback)) {
281
+        if ( ! is_string($identifier_callback)) {
282 282
             throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
283 283
         }
284 284
         $this->identifier_callback = $identifier_callback;
@@ -308,7 +308,7 @@  discard block
 block discarded – undo
308 308
         $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
309 309
         // we know our default is a string, so if it's not a string now,
310 310
         // then that means the incoming parameter was something else
311
-        if (! is_string($this->file_mask)) {
311
+        if ( ! is_string($this->file_mask)) {
312 312
             throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
313 313
         }
314 314
     }
@@ -333,7 +333,7 @@  discard block
 block discarded – undo
333 333
     public function setCollectionFQCNs($collection_FQCNs)
334 334
     {
335 335
         foreach ((array) $collection_FQCNs as $collection_FQCN) {
336
-            if (! empty($collection_FQCN)) {
336
+            if ( ! empty($collection_FQCN)) {
337 337
                 if (class_exists($collection_FQCN)) {
338 338
                     $this->collection_FQCNs[] = $collection_FQCN;
339 339
                 } else {
@@ -355,7 +355,7 @@  discard block
 block discarded – undo
355 355
      */
356 356
     protected function getFQCNsFromPartialNamespace($partial_FQCN)
357 357
     {
358
-        if (! $this->file_locator instanceof FqcnLocator) {
358
+        if ( ! $this->file_locator instanceof FqcnLocator) {
359 359
             $this->file_locator = new FqcnLocator();
360 360
         }
361 361
         $this->file_locator->locate($partial_FQCN);
@@ -381,8 +381,8 @@  discard block
 block discarded – undo
381 381
     public function setCollectionPaths($collection_paths)
382 382
     {
383 383
         foreach ((array) $collection_paths as $collection_path) {
384
-            if (! empty($collection_path)) {
385
-                if (! is_readable($collection_path)) {
384
+            if ( ! empty($collection_path)) {
385
+                if ( ! is_readable($collection_path)) {
386 386
                     throw new InvalidFilePathException($collection_path);
387 387
                 }
388 388
                 $this->collection_paths[] = $collection_path;
Please login to merge, or discard this patch.
Indentation   +347 added lines, -347 removed lines patch added patch discarded remove patch
@@ -43,351 +43,351 @@
 block discarded – undo
43 43
 class CollectionDetails implements CollectionDetailsInterface
44 44
 {
45 45
 
46
-    /**
47
-     * if $identifier_type is set to this,
48
-     * then the collection will use each object's spl_object_hash() as it's identifier
49
-     */
50
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
51
-
52
-    /**
53
-     * if $identifier_type is set to this,
54
-     * then the collection will use each object's class name as it's identifier
55
-     */
56
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
57
-
58
-    /**
59
-     * if $identifier_type is set to this,
60
-     * then the collection will use the return value from a specified callback method on each object
61
-     */
62
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
63
-
64
-    /**
65
-     * The interface used for controlling what gets added to the collection
66
-     *
67
-     * @var string $collection_interface
68
-     */
69
-    protected $collection_interface = '';
70
-
71
-    /**
72
-     * a unique name used to identify the collection in filter names
73
-     * supplied value is run through sanitize_title_with_dashes(),
74
-     * but then also converts dashes to underscores
75
-     *
76
-     * @var string $collection_name
77
-     */
78
-    protected $collection_name = '';
79
-
80
-    /**
81
-     * what the collection uses for the object identifier.
82
-     * corresponds to one of the class constants above.
83
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
84
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
85
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
86
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
87
-     *
88
-     * @var string $identifier_type
89
-     */
90
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
91
-
92
-    /**
93
-     * the pattern applied to paths when searching for class files to add to the collection
94
-     * ie: "My_Awesome_*.class.php"
95
-     * defaults to "*.php"
96
-     *
97
-     * @var string $file_mask
98
-     */
99
-    protected $file_mask = '';
100
-
101
-    /**
102
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
103
-     * then this specifies the method to use on each entity.
104
-     * If the callback method does not exist, then an exception will be thrown
105
-     *
106
-     * @var string $identifier_callback
107
-     */
108
-    protected $identifier_callback = '';
109
-
110
-    /**
111
-     * an array of Fully Qualified Class Names
112
-     *  for example:
113
-     *  $FQCNs = array(
114
-     *      '/Fully/Qualified/ClassNameA'
115
-     *      '/Fully/Qualified/Other/ClassNameB'
116
-     *  );
117
-     *
118
-     * @var array $collection_FQCNs
119
-     */
120
-    protected $collection_FQCNs = array();
121
-
122
-    /**
123
-     * an array of full server paths to folders containing files to be loaded into collection
124
-     *  for example:
125
-     *  $paths = array(
126
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
127
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
128
-     *  );
129
-     *
130
-     * @var array $collection_paths
131
-     */
132
-    protected $collection_paths = array();
133
-
134
-    /**
135
-     * @var LocatorInterface $file_locator
136
-     */
137
-    protected $file_locator;
138
-
139
-
140
-    /**
141
-     * CollectionDetails constructor.
142
-     *
143
-     * @access public
144
-     * @param string           $collection_name
145
-     * @param string           $collection_interface
146
-     * @param array            $collection_FQCNs
147
-     * @param array            $collection_paths
148
-     * @param string           $file_mask
149
-     * @param string           $identifier_type
150
-     * @param string           $identifier_callback
151
-     * @param LocatorInterface $file_locator
152
-     * @throws CollectionDetailsException
153
-     */
154
-    public function __construct(
155
-        $collection_name,
156
-        $collection_interface,
157
-        array $collection_FQCNs = array(),
158
-        array $collection_paths = array(),
159
-        $file_mask = '',
160
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
161
-        $identifier_callback = '',
162
-        LocatorInterface $file_locator = null
163
-    ) {
164
-        try {
165
-            $this->setCollectionName($collection_name);
166
-            $this->setCollectionInterface($collection_interface);
167
-            $this->setCollectionFQCNs($collection_FQCNs);
168
-            $this->setCollectionPaths($collection_paths);
169
-            $this->setFileMasks($file_mask);
170
-            $this->setIdentifierType($identifier_type);
171
-            $this->setIdentifierCallback($identifier_callback);
172
-            $this->file_locator = $file_locator;
173
-        } catch (Exception $exception) {
174
-            throw new CollectionDetailsException($exception);
175
-        }
176
-    }
177
-
178
-
179
-    /**
180
-     * @access public
181
-     * @return mixed
182
-     */
183
-    public function getCollectionInterface()
184
-    {
185
-        return $this->collection_interface;
186
-    }
187
-
188
-
189
-    /**
190
-     * @access protected
191
-     * @param string $collection_interface
192
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
193
-     */
194
-    protected function setCollectionInterface($collection_interface)
195
-    {
196
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
197
-            throw new InvalidInterfaceException($collection_interface);
198
-        }
199
-        $this->collection_interface = $collection_interface;
200
-    }
201
-
202
-
203
-    /**
204
-     * the collection name will be used for creating dynamic filters
205
-     *
206
-     * @access public
207
-     * @return string
208
-     */
209
-    public function collectionName()
210
-    {
211
-        return $this->collection_name;
212
-    }
213
-
214
-
215
-    /**
216
-     * sanitizes collection name and converts spaces and dashes to underscores
217
-     *
218
-     * @access protected
219
-     * @param string $collection_name
220
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
221
-     */
222
-    protected function setCollectionName($collection_name)
223
-    {
224
-        if (! is_string($collection_name)) {
225
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
226
-        }
227
-        $this->collection_name = str_replace(
228
-            '-',
229
-            '_',
230
-            sanitize_title_with_dashes($collection_name, '', 'save')
231
-        );
232
-    }
233
-
234
-
235
-    /**
236
-     * @access public
237
-     * @return string
238
-     */
239
-    public function identifierType()
240
-    {
241
-        return $this->identifier_type;
242
-    }
243
-
244
-
245
-    /**
246
-     * @access protected
247
-     * @param string $identifier_type
248
-     * @throws InvalidIdentifierException
249
-     */
250
-    protected function setIdentifierType($identifier_type)
251
-    {
252
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
253
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
254
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
255
-        )) {
256
-            throw new InvalidIdentifierException(
257
-                $identifier_type,
258
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
259
-            );
260
-        }
261
-        $this->identifier_type = $identifier_type;
262
-    }
263
-
264
-
265
-    /**
266
-     * @access public
267
-     * @return string
268
-     */
269
-    public function identifierCallback()
270
-    {
271
-        return $this->identifier_callback;
272
-    }
273
-
274
-
275
-    /**
276
-     * @access protected
277
-     * @param string $identifier_callback
278
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
279
-     */
280
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
281
-    {
282
-        if (! is_string($identifier_callback)) {
283
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
284
-        }
285
-        $this->identifier_callback = $identifier_callback;
286
-    }
287
-
288
-
289
-    /**
290
-     * @access public
291
-     * @return string
292
-     */
293
-    public function getFileMask()
294
-    {
295
-        return $this->file_mask;
296
-    }
297
-
298
-
299
-    /**
300
-     * sets the file mask which is then used to filter what files get loaded
301
-     * when searching for classes to add to the collection. Defaults to '*.php'
302
-     *
303
-     * @access protected
304
-     * @param string $file_mask
305
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
306
-     */
307
-    protected function setFileMasks($file_mask)
308
-    {
309
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
310
-        // we know our default is a string, so if it's not a string now,
311
-        // then that means the incoming parameter was something else
312
-        if (! is_string($this->file_mask)) {
313
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
314
-        }
315
-    }
316
-
317
-
318
-    /**
319
-     * @access public
320
-     * @return array
321
-     */
322
-    public function getCollectionFQCNs()
323
-    {
324
-        return $this->collection_FQCNs;
325
-    }
326
-
327
-
328
-    /**
329
-     * @access public
330
-     * @param string|array $collection_FQCNs
331
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
332
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
333
-     */
334
-    public function setCollectionFQCNs($collection_FQCNs)
335
-    {
336
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
337
-            if (! empty($collection_FQCN)) {
338
-                if (class_exists($collection_FQCN)) {
339
-                    $this->collection_FQCNs[] = $collection_FQCN;
340
-                } else {
341
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
342
-                        $this->collection_FQCNs[] = $FQCN;
343
-                    }
344
-                }
345
-            }
346
-        }
347
-    }
348
-
349
-
350
-    /**
351
-     * @access protected
352
-     * @param  string $partial_FQCN
353
-     * @return array
354
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
355
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
356
-     */
357
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
358
-    {
359
-        if (! $this->file_locator instanceof FqcnLocator) {
360
-            $this->file_locator = new FqcnLocator();
361
-        }
362
-        $this->file_locator->locate($partial_FQCN);
363
-        return $this->file_locator->getFQCNs();
364
-    }
365
-
366
-
367
-    /**
368
-     * @access public
369
-     * @return array
370
-     */
371
-    public function getCollectionPaths()
372
-    {
373
-        return $this->collection_paths;
374
-    }
375
-
376
-
377
-    /**
378
-     * @access public
379
-     * @param string|array $collection_paths
380
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
381
-     */
382
-    public function setCollectionPaths($collection_paths)
383
-    {
384
-        foreach ((array) $collection_paths as $collection_path) {
385
-            if (! empty($collection_path)) {
386
-                if (! is_readable($collection_path)) {
387
-                    throw new InvalidFilePathException($collection_path);
388
-                }
389
-                $this->collection_paths[] = $collection_path;
390
-            }
391
-        }
392
-    }
46
+	/**
47
+	 * if $identifier_type is set to this,
48
+	 * then the collection will use each object's spl_object_hash() as it's identifier
49
+	 */
50
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
51
+
52
+	/**
53
+	 * if $identifier_type is set to this,
54
+	 * then the collection will use each object's class name as it's identifier
55
+	 */
56
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
57
+
58
+	/**
59
+	 * if $identifier_type is set to this,
60
+	 * then the collection will use the return value from a specified callback method on each object
61
+	 */
62
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
63
+
64
+	/**
65
+	 * The interface used for controlling what gets added to the collection
66
+	 *
67
+	 * @var string $collection_interface
68
+	 */
69
+	protected $collection_interface = '';
70
+
71
+	/**
72
+	 * a unique name used to identify the collection in filter names
73
+	 * supplied value is run through sanitize_title_with_dashes(),
74
+	 * but then also converts dashes to underscores
75
+	 *
76
+	 * @var string $collection_name
77
+	 */
78
+	protected $collection_name = '';
79
+
80
+	/**
81
+	 * what the collection uses for the object identifier.
82
+	 * corresponds to one of the class constants above.
83
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
84
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
85
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
86
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
87
+	 *
88
+	 * @var string $identifier_type
89
+	 */
90
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
91
+
92
+	/**
93
+	 * the pattern applied to paths when searching for class files to add to the collection
94
+	 * ie: "My_Awesome_*.class.php"
95
+	 * defaults to "*.php"
96
+	 *
97
+	 * @var string $file_mask
98
+	 */
99
+	protected $file_mask = '';
100
+
101
+	/**
102
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
103
+	 * then this specifies the method to use on each entity.
104
+	 * If the callback method does not exist, then an exception will be thrown
105
+	 *
106
+	 * @var string $identifier_callback
107
+	 */
108
+	protected $identifier_callback = '';
109
+
110
+	/**
111
+	 * an array of Fully Qualified Class Names
112
+	 *  for example:
113
+	 *  $FQCNs = array(
114
+	 *      '/Fully/Qualified/ClassNameA'
115
+	 *      '/Fully/Qualified/Other/ClassNameB'
116
+	 *  );
117
+	 *
118
+	 * @var array $collection_FQCNs
119
+	 */
120
+	protected $collection_FQCNs = array();
121
+
122
+	/**
123
+	 * an array of full server paths to folders containing files to be loaded into collection
124
+	 *  for example:
125
+	 *  $paths = array(
126
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
127
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
128
+	 *  );
129
+	 *
130
+	 * @var array $collection_paths
131
+	 */
132
+	protected $collection_paths = array();
133
+
134
+	/**
135
+	 * @var LocatorInterface $file_locator
136
+	 */
137
+	protected $file_locator;
138
+
139
+
140
+	/**
141
+	 * CollectionDetails constructor.
142
+	 *
143
+	 * @access public
144
+	 * @param string           $collection_name
145
+	 * @param string           $collection_interface
146
+	 * @param array            $collection_FQCNs
147
+	 * @param array            $collection_paths
148
+	 * @param string           $file_mask
149
+	 * @param string           $identifier_type
150
+	 * @param string           $identifier_callback
151
+	 * @param LocatorInterface $file_locator
152
+	 * @throws CollectionDetailsException
153
+	 */
154
+	public function __construct(
155
+		$collection_name,
156
+		$collection_interface,
157
+		array $collection_FQCNs = array(),
158
+		array $collection_paths = array(),
159
+		$file_mask = '',
160
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
161
+		$identifier_callback = '',
162
+		LocatorInterface $file_locator = null
163
+	) {
164
+		try {
165
+			$this->setCollectionName($collection_name);
166
+			$this->setCollectionInterface($collection_interface);
167
+			$this->setCollectionFQCNs($collection_FQCNs);
168
+			$this->setCollectionPaths($collection_paths);
169
+			$this->setFileMasks($file_mask);
170
+			$this->setIdentifierType($identifier_type);
171
+			$this->setIdentifierCallback($identifier_callback);
172
+			$this->file_locator = $file_locator;
173
+		} catch (Exception $exception) {
174
+			throw new CollectionDetailsException($exception);
175
+		}
176
+	}
177
+
178
+
179
+	/**
180
+	 * @access public
181
+	 * @return mixed
182
+	 */
183
+	public function getCollectionInterface()
184
+	{
185
+		return $this->collection_interface;
186
+	}
187
+
188
+
189
+	/**
190
+	 * @access protected
191
+	 * @param string $collection_interface
192
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
193
+	 */
194
+	protected function setCollectionInterface($collection_interface)
195
+	{
196
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
197
+			throw new InvalidInterfaceException($collection_interface);
198
+		}
199
+		$this->collection_interface = $collection_interface;
200
+	}
201
+
202
+
203
+	/**
204
+	 * the collection name will be used for creating dynamic filters
205
+	 *
206
+	 * @access public
207
+	 * @return string
208
+	 */
209
+	public function collectionName()
210
+	{
211
+		return $this->collection_name;
212
+	}
213
+
214
+
215
+	/**
216
+	 * sanitizes collection name and converts spaces and dashes to underscores
217
+	 *
218
+	 * @access protected
219
+	 * @param string $collection_name
220
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
221
+	 */
222
+	protected function setCollectionName($collection_name)
223
+	{
224
+		if (! is_string($collection_name)) {
225
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
226
+		}
227
+		$this->collection_name = str_replace(
228
+			'-',
229
+			'_',
230
+			sanitize_title_with_dashes($collection_name, '', 'save')
231
+		);
232
+	}
233
+
234
+
235
+	/**
236
+	 * @access public
237
+	 * @return string
238
+	 */
239
+	public function identifierType()
240
+	{
241
+		return $this->identifier_type;
242
+	}
243
+
244
+
245
+	/**
246
+	 * @access protected
247
+	 * @param string $identifier_type
248
+	 * @throws InvalidIdentifierException
249
+	 */
250
+	protected function setIdentifierType($identifier_type)
251
+	{
252
+		if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
253
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
254
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
255
+		)) {
256
+			throw new InvalidIdentifierException(
257
+				$identifier_type,
258
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
259
+			);
260
+		}
261
+		$this->identifier_type = $identifier_type;
262
+	}
263
+
264
+
265
+	/**
266
+	 * @access public
267
+	 * @return string
268
+	 */
269
+	public function identifierCallback()
270
+	{
271
+		return $this->identifier_callback;
272
+	}
273
+
274
+
275
+	/**
276
+	 * @access protected
277
+	 * @param string $identifier_callback
278
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
279
+	 */
280
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
281
+	{
282
+		if (! is_string($identifier_callback)) {
283
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
284
+		}
285
+		$this->identifier_callback = $identifier_callback;
286
+	}
287
+
288
+
289
+	/**
290
+	 * @access public
291
+	 * @return string
292
+	 */
293
+	public function getFileMask()
294
+	{
295
+		return $this->file_mask;
296
+	}
297
+
298
+
299
+	/**
300
+	 * sets the file mask which is then used to filter what files get loaded
301
+	 * when searching for classes to add to the collection. Defaults to '*.php'
302
+	 *
303
+	 * @access protected
304
+	 * @param string $file_mask
305
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
306
+	 */
307
+	protected function setFileMasks($file_mask)
308
+	{
309
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
310
+		// we know our default is a string, so if it's not a string now,
311
+		// then that means the incoming parameter was something else
312
+		if (! is_string($this->file_mask)) {
313
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
314
+		}
315
+	}
316
+
317
+
318
+	/**
319
+	 * @access public
320
+	 * @return array
321
+	 */
322
+	public function getCollectionFQCNs()
323
+	{
324
+		return $this->collection_FQCNs;
325
+	}
326
+
327
+
328
+	/**
329
+	 * @access public
330
+	 * @param string|array $collection_FQCNs
331
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
332
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
333
+	 */
334
+	public function setCollectionFQCNs($collection_FQCNs)
335
+	{
336
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
337
+			if (! empty($collection_FQCN)) {
338
+				if (class_exists($collection_FQCN)) {
339
+					$this->collection_FQCNs[] = $collection_FQCN;
340
+				} else {
341
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
342
+						$this->collection_FQCNs[] = $FQCN;
343
+					}
344
+				}
345
+			}
346
+		}
347
+	}
348
+
349
+
350
+	/**
351
+	 * @access protected
352
+	 * @param  string $partial_FQCN
353
+	 * @return array
354
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
355
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
356
+	 */
357
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
358
+	{
359
+		if (! $this->file_locator instanceof FqcnLocator) {
360
+			$this->file_locator = new FqcnLocator();
361
+		}
362
+		$this->file_locator->locate($partial_FQCN);
363
+		return $this->file_locator->getFQCNs();
364
+	}
365
+
366
+
367
+	/**
368
+	 * @access public
369
+	 * @return array
370
+	 */
371
+	public function getCollectionPaths()
372
+	{
373
+		return $this->collection_paths;
374
+	}
375
+
376
+
377
+	/**
378
+	 * @access public
379
+	 * @param string|array $collection_paths
380
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
381
+	 */
382
+	public function setCollectionPaths($collection_paths)
383
+	{
384
+		foreach ((array) $collection_paths as $collection_path) {
385
+			if (! empty($collection_path)) {
386
+				if (! is_readable($collection_path)) {
387
+					throw new InvalidFilePathException($collection_path);
388
+				}
389
+				$this->collection_paths[] = $collection_path;
390
+			}
391
+		}
392
+	}
393 393
 }
Please login to merge, or discard this patch.
core/services/request/Request.php 3 patches
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -163,7 +163,7 @@  discard block
 block discarded – undo
163 163
             || ($key === 'ee' && empty($this->request['ee']))
164 164
             || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
165 165
         ) {
166
-            $this->request[ $key ] = $value;
166
+            $this->request[$key] = $value;
167 167
         }
168 168
     }
169 169
 
@@ -254,10 +254,10 @@  discard block
 block discarded – undo
254 254
             preg_quote($pattern, '/')
255 255
         );
256 256
         foreach ($request_params as $key => $request_param) {
257
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
257
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
258 258
                 // return value for request param
259 259
                 if ($return === 'value') {
260
-                    return $request_params[ $key ];
260
+                    return $request_params[$key];
261 261
                 }
262 262
                 // or actual key or true just to indicate it was found
263 263
                 return $return === 'key' ? $key : true;
@@ -314,29 +314,29 @@  discard block
 block discarded – undo
314 314
                 $key = $real_key ? $real_key : $key;
315 315
             }
316 316
             // check if top level key exists
317
-            if (isset($request_params[ $key ])) {
317
+            if (isset($request_params[$key])) {
318 318
                 // build a new key to pass along like: 'second[third]'
319 319
                 // or just 'second' depending on depth of keys
320 320
                 $key_string = array_shift($keys);
321
-                if (! empty($keys)) {
322
-                    $key_string .= '[' . implode('][', $keys) . ']';
321
+                if ( ! empty($keys)) {
322
+                    $key_string .= '['.implode('][', $keys).']';
323 323
                 }
324 324
                 return $this->requestParameterDrillDown(
325 325
                     $key_string,
326 326
                     $default,
327 327
                     $callback,
328
-                    $request_params[ $key ]
328
+                    $request_params[$key]
329 329
                 );
330 330
             }
331 331
         }
332 332
         if ($callback === 'is_set') {
333
-            return isset($request_params[ $key ]);
333
+            return isset($request_params[$key]);
334 334
         }
335 335
         if ($callback === 'match') {
336 336
             return $this->match($key, $request_params, $default);
337 337
         }
338
-        return isset($request_params[ $key ])
339
-            ? $request_params[ $key ]
338
+        return isset($request_params[$key])
339
+            ? $request_params[$key]
340 340
             : $default;
341 341
     }
342 342
 
@@ -349,9 +349,9 @@  discard block
 block discarded – undo
349 349
      */
350 350
     public function unSetRequestParam($key, $unset_from_global_too = false)
351 351
     {
352
-        unset($this->request[ $key ]);
352
+        unset($this->request[$key]);
353 353
         if ($unset_from_global_too) {
354
-            unset($_REQUEST[ $key ]);
354
+            unset($_REQUEST[$key]);
355 355
         }
356 356
     }
357 357
 
@@ -385,8 +385,8 @@  discard block
 block discarded – undo
385 385
             'REMOTE_ADDR',
386 386
         );
387 387
         foreach ($server_keys as $key) {
388
-            if (isset($this->server[ $key ])) {
389
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
388
+            if (isset($this->server[$key])) {
389
+                foreach (array_map('trim', explode(',', $this->server[$key])) as $ip) {
390 390
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
391 391
                         $visitor_ip = $ip;
392 392
                     }
Please login to merge, or discard this patch.
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -174,7 +174,7 @@  discard block
 block discarded – undo
174 174
      *
175 175
      * @param       $key
176 176
      * @param null  $default
177
-     * @return mixed
177
+     * @return integer
178 178
      */
179 179
     public function getRequestParam($key, $default = null)
180 180
     {
@@ -287,7 +287,7 @@  discard block
 block discarded – undo
287 287
      * would return true if default parameters were set
288 288
      *
289 289
      * @param string $callback
290
-     * @param        $key
290
+     * @param        string $key
291 291
      * @param null   $default
292 292
      * @param array  $request_params
293 293
      * @return bool|mixed|null
Please login to merge, or discard this patch.
Indentation   +636 added lines, -636 removed lines patch added patch discarded remove patch
@@ -17,640 +17,640 @@
 block discarded – undo
17 17
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
18 18
 {
19 19
 
20
-    /**
21
-     * $_GET parameters
22
-     *
23
-     * @var array $get
24
-     */
25
-    private $get;
26
-
27
-    /**
28
-     * $_POST parameters
29
-     *
30
-     * @var array $post
31
-     */
32
-    private $post;
33
-
34
-    /**
35
-     * $_COOKIE parameters
36
-     *
37
-     * @var array $cookie
38
-     */
39
-    private $cookie;
40
-
41
-    /**
42
-     * $_SERVER parameters
43
-     *
44
-     * @var array $server
45
-     */
46
-    private $server;
47
-
48
-    /**
49
-     * $_FILES parameters
50
-     *
51
-     * @var array $files
52
-     */
53
-    private $files;
54
-
55
-    /**
56
-     * $_REQUEST parameters
57
-     *
58
-     * @var array $request
59
-     */
60
-    private $request;
61
-
62
-    /**
63
-     * @var RequestTypeContextCheckerInterface
64
-     */
65
-    private $request_type;
66
-
67
-    /**
68
-     * IP address for request
69
-     *
70
-     * @var string $ip_address
71
-     */
72
-    private $ip_address;
73
-
74
-    /**
75
-     * @var string $user_agent
76
-     */
77
-    private $user_agent;
78
-
79
-    /**
80
-     * true if current user appears to be some kind of bot
81
-     *
82
-     * @var bool $is_bot
83
-     */
84
-    private $is_bot;
85
-
86
-
87
-    /**
88
-     * @param array $get
89
-     * @param array $post
90
-     * @param array $cookie
91
-     * @param array $server
92
-     * @param array $files
93
-     */
94
-    public function __construct(array $get, array $post, array $cookie, array $server, array $files = array())
95
-    {
96
-        // grab request vars
97
-        $this->get = $get;
98
-        $this->post = $post;
99
-        $this->cookie = $cookie;
100
-        $this->server = $server;
101
-        $this->files = $files;
102
-        $this->request = array_merge($this->get, $this->post);
103
-        $this->ip_address = $this->visitorIp();
104
-    }
105
-
106
-
107
-    /**
108
-     * @param RequestTypeContextCheckerInterface $type
109
-     */
110
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
111
-    {
112
-        $this->request_type = $type;
113
-    }
114
-
115
-
116
-    /**
117
-     * @return array
118
-     */
119
-    public function getParams()
120
-    {
121
-        return $this->get;
122
-    }
123
-
124
-
125
-    /**
126
-     * @return array
127
-     */
128
-    public function postParams()
129
-    {
130
-        return $this->post;
131
-    }
132
-
133
-
134
-    /**
135
-     * @return array
136
-     */
137
-    public function cookieParams()
138
-    {
139
-        return $this->cookie;
140
-    }
141
-
142
-
143
-    /**
144
-     * @return array
145
-     */
146
-    public function serverParams()
147
-    {
148
-        return $this->server;
149
-    }
150
-
151
-
152
-    /**
153
-     * @return array
154
-     */
155
-    public function filesParams()
156
-    {
157
-        return $this->files;
158
-    }
159
-
160
-
161
-    /**
162
-     * returns contents of $_REQUEST
163
-     *
164
-     * @return array
165
-     */
166
-    public function requestParams()
167
-    {
168
-        return $this->request;
169
-    }
170
-
171
-
172
-    /**
173
-     * @param      $key
174
-     * @param      $value
175
-     * @param bool $override_ee
176
-     * @return    void
177
-     */
178
-    public function setRequestParam($key, $value, $override_ee = false)
179
-    {
180
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
181
-        if ($key !== 'ee'
182
-            || ($key === 'ee' && empty($this->request['ee']))
183
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
184
-        ) {
185
-            $this->request[ $key ] = $value;
186
-        }
187
-    }
188
-
189
-
190
-    /**
191
-     * returns   the value for a request param if the given key exists
192
-     *
193
-     * @param       $key
194
-     * @param null  $default
195
-     * @return mixed
196
-     */
197
-    public function getRequestParam($key, $default = null)
198
-    {
199
-        return $this->requestParameterDrillDown($key, $default, 'get');
200
-    }
201
-
202
-
203
-    /**
204
-     * check if param exists
205
-     *
206
-     * @param       $key
207
-     * @return bool
208
-     */
209
-    public function requestParamIsSet($key)
210
-    {
211
-        return $this->requestParameterDrillDown($key);
212
-    }
213
-
214
-
215
-    /**
216
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
217
-     * and return the value for the first match found
218
-     * wildcards can be either of the following:
219
-     *      ? to represent a single character of any type
220
-     *      * to represent one or more characters of any type
221
-     *
222
-     * @param string     $pattern
223
-     * @param null|mixed $default
224
-     * @return mixed
225
-     */
226
-    public function getMatch($pattern, $default = null)
227
-    {
228
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
229
-    }
230
-
231
-
232
-    /**
233
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
234
-     * wildcards can be either of the following:
235
-     *      ? to represent a single character of any type
236
-     *      * to represent one or more characters of any type
237
-     * returns true if a match is found or false if not
238
-     *
239
-     * @param string $pattern
240
-     * @return bool
241
-     */
242
-    public function matches($pattern)
243
-    {
244
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
245
-    }
246
-
247
-
248
-    /**
249
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
250
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
251
-     *                                      and used to search through the current request's parameter keys
252
-     * @param array  $request_params        The array of request parameters to search through
253
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
254
-     *                                      Default is null
255
-     * @param string $return                [optional] Controls what kind of value is returned.
256
-     *                                      Options are:
257
-     *                                      'bool' will return true or false if match is found or not
258
-     *                                      'key' will return the first key found that matches the supplied pattern
259
-     *                                      'value' will return the value for the first request parameter
260
-     *                                      whose key matches the supplied pattern
261
-     *                                      Default is 'value'
262
-     * @return boolean|string
263
-     */
264
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
265
-    {
266
-        $return = in_array($return, array('bool', 'key', 'value'), true)
267
-            ? $return
268
-            : 'is_set';
269
-        // replace wildcard chars with regex chars
270
-        $pattern = str_replace(
271
-            array("\*", "\?"),
272
-            array('.*', '.'),
273
-            preg_quote($pattern, '/')
274
-        );
275
-        foreach ($request_params as $key => $request_param) {
276
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
277
-                // return value for request param
278
-                if ($return === 'value') {
279
-                    return $request_params[ $key ];
280
-                }
281
-                // or actual key or true just to indicate it was found
282
-                return $return === 'key' ? $key : true;
283
-            }
284
-        }
285
-        // match not found so return default value or false
286
-        return $return === 'value' ? $default : false;
287
-    }
288
-
289
-
290
-    /**
291
-     * the supplied key can be a simple string to represent a "top-level" request parameter
292
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
293
-     * by using square brackets to surround keys for deeper array elements.
294
-     * For example :
295
-     * if the supplied $key was: "first[second][third]"
296
-     * then this will attempt to drill down into the request parameter array to find a value.
297
-     * Given the following request parameters:
298
-     *  array(
299
-     *      'first' => array(
300
-     *          'second' => array(
301
-     *              'third' => 'has a value'
302
-     *          )
303
-     *      )
304
-     *  )
305
-     * would return true if default parameters were set
306
-     *
307
-     * @param string $callback
308
-     * @param        $key
309
-     * @param null   $default
310
-     * @param array  $request_params
311
-     * @return bool|mixed|null
312
-     */
313
-    private function requestParameterDrillDown(
314
-        $key,
315
-        $default = null,
316
-        $callback = 'is_set',
317
-        array $request_params = array()
318
-    ) {
319
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
320
-            ? $callback
321
-            : 'is_set';
322
-        $request_params = ! empty($request_params)
323
-            ? $request_params
324
-            : $this->request;
325
-        // does incoming key represent an array like 'first[second][third]'  ?
326
-        if (strpos($key, '[') !== false) {
327
-            // turn it into an actual array
328
-            $key = str_replace(']', '', $key);
329
-            $keys = explode('[', $key);
330
-            $key = array_shift($keys);
331
-            if ($callback === 'match') {
332
-                $real_key = $this->match($key, $request_params, $default, 'key');
333
-                $key = $real_key ? $real_key : $key;
334
-            }
335
-            // check if top level key exists
336
-            if (isset($request_params[ $key ])) {
337
-                // build a new key to pass along like: 'second[third]'
338
-                // or just 'second' depending on depth of keys
339
-                $key_string = array_shift($keys);
340
-                if (! empty($keys)) {
341
-                    $key_string .= '[' . implode('][', $keys) . ']';
342
-                }
343
-                return $this->requestParameterDrillDown(
344
-                    $key_string,
345
-                    $default,
346
-                    $callback,
347
-                    $request_params[ $key ]
348
-                );
349
-            }
350
-        }
351
-        if ($callback === 'is_set') {
352
-            return isset($request_params[ $key ]);
353
-        }
354
-        if ($callback === 'match') {
355
-            return $this->match($key, $request_params, $default);
356
-        }
357
-        return isset($request_params[ $key ])
358
-            ? $request_params[ $key ]
359
-            : $default;
360
-    }
361
-
362
-
363
-    /**
364
-     * remove param
365
-     *
366
-     * @param      $key
367
-     * @param bool $unset_from_global_too
368
-     */
369
-    public function unSetRequestParam($key, $unset_from_global_too = false)
370
-    {
371
-        unset($this->request[ $key ]);
372
-        if ($unset_from_global_too) {
373
-            unset($_REQUEST[ $key ]);
374
-        }
375
-    }
376
-
377
-
378
-    /**
379
-     * @return string
380
-     */
381
-    public function ipAddress()
382
-    {
383
-        return $this->ip_address;
384
-    }
385
-
386
-
387
-    /**
388
-     * attempt to get IP address of current visitor from server
389
-     * plz see: http://stackoverflow.com/a/2031935/1475279
390
-     *
391
-     * @access public
392
-     * @return string
393
-     */
394
-    private function visitorIp()
395
-    {
396
-        $visitor_ip = '0.0.0.0';
397
-        $server_keys = array(
398
-            'HTTP_CLIENT_IP',
399
-            'HTTP_X_FORWARDED_FOR',
400
-            'HTTP_X_FORWARDED',
401
-            'HTTP_X_CLUSTER_CLIENT_IP',
402
-            'HTTP_FORWARDED_FOR',
403
-            'HTTP_FORWARDED',
404
-            'REMOTE_ADDR',
405
-        );
406
-        foreach ($server_keys as $key) {
407
-            if (isset($this->server[ $key ])) {
408
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
409
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
410
-                        $visitor_ip = $ip;
411
-                    }
412
-                }
413
-            }
414
-        }
415
-        return $visitor_ip;
416
-    }
417
-
418
-
419
-    /**
420
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
421
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
422
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
423
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
424
-     * @return string
425
-     */
426
-    public function requestUri($relativeToWpRoot = false)
427
-    {
428
-        $request_uri = filter_input(
429
-            INPUT_SERVER,
430
-            'REQUEST_URI',
431
-            FILTER_SANITIZE_URL,
432
-            FILTER_NULL_ON_FAILURE
433
-        );
434
-        if (empty($request_uri)) {
435
-            // fallback sanitization if the above fails
436
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
437
-        }
438
-        if ($relativeToWpRoot) {
439
-            $home_path = untrailingslashit(
440
-                parse_url(
441
-                    home_url(),
442
-                    PHP_URL_PATH
443
-                )
444
-            );
445
-            $request_uri = str_replace(
446
-                $home_path,
447
-                '',
448
-                $request_uri
449
-            );
450
-        }
451
-        return $request_uri;
452
-    }
453
-
454
-    /**
455
-     * @return string
456
-     */
457
-    public function userAgent()
458
-    {
459
-        return $this->user_agent;
460
-    }
461
-
462
-
463
-    /**
464
-     * @param string $user_agent
465
-     */
466
-    public function setUserAgent($user_agent = '')
467
-    {
468
-        if ($user_agent === '' || ! is_string($user_agent)) {
469
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
470
-        }
471
-        $this->user_agent = $user_agent;
472
-    }
473
-
474
-
475
-    /**
476
-     * @return bool
477
-     */
478
-    public function isBot()
479
-    {
480
-        return $this->is_bot;
481
-    }
482
-
483
-
484
-    /**
485
-     * @param bool $is_bot
486
-     */
487
-    public function setIsBot($is_bot)
488
-    {
489
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
490
-    }
491
-
492
-
493
-    /**
494
-     * @return bool
495
-     */
496
-    public function isActivation()
497
-    {
498
-        return $this->request_type->isActivation();
499
-    }
500
-
501
-
502
-    /**
503
-     * @param $is_activation
504
-     * @return bool
505
-     */
506
-    public function setIsActivation($is_activation)
507
-    {
508
-        return $this->request_type->setIsActivation($is_activation);
509
-    }
510
-
511
-
512
-    /**
513
-     * @return bool
514
-     */
515
-    public function isAdmin()
516
-    {
517
-        return $this->request_type->isAdmin();
518
-    }
519
-
520
-
521
-    /**
522
-     * @return bool
523
-     */
524
-    public function isAdminAjax()
525
-    {
526
-        return $this->request_type->isAdminAjax();
527
-    }
528
-
529
-
530
-    /**
531
-     * @return bool
532
-     */
533
-    public function isAjax()
534
-    {
535
-        return $this->request_type->isAjax();
536
-    }
537
-
538
-
539
-    /**
540
-     * @return bool
541
-     */
542
-    public function isEeAjax()
543
-    {
544
-        return $this->request_type->isEeAjax();
545
-    }
546
-
547
-
548
-    /**
549
-     * @return bool
550
-     */
551
-    public function isOtherAjax()
552
-    {
553
-        return $this->request_type->isOtherAjax();
554
-    }
555
-
556
-
557
-    /**
558
-     * @return bool
559
-     */
560
-    public function isApi()
561
-    {
562
-        return $this->request_type->isApi();
563
-    }
564
-
565
-
566
-    /**
567
-     * @return bool
568
-     */
569
-    public function isCli()
570
-    {
571
-        return $this->request_type->isCli();
572
-    }
573
-
574
-
575
-    /**
576
-     * @return bool
577
-     */
578
-    public function isCron()
579
-    {
580
-        return $this->request_type->isCron();
581
-    }
582
-
583
-
584
-    /**
585
-     * @return bool
586
-     */
587
-    public function isFeed()
588
-    {
589
-        return $this->request_type->isFeed();
590
-    }
591
-
592
-
593
-    /**
594
-     * @return bool
595
-     */
596
-    public function isFrontend()
597
-    {
598
-        return $this->request_type->isFrontend();
599
-    }
600
-
601
-
602
-    /**
603
-     * @return bool
604
-     */
605
-    public function isFrontAjax()
606
-    {
607
-        return $this->request_type->isFrontAjax();
608
-    }
609
-
610
-
611
-    /**
612
-     * @return bool
613
-     */
614
-    public function isIframe()
615
-    {
616
-        return $this->request_type->isIframe();
617
-    }
618
-
619
-
620
-    /**
621
-     * @return bool
622
-     */
623
-    public function isWordPressApi()
624
-    {
625
-        return $this->request_type->isWordPressApi();
626
-    }
627
-
628
-
629
-
630
-    /**
631
-     * @return bool
632
-     */
633
-    public function isWordPressHeartbeat()
634
-    {
635
-        return $this->request_type->isWordPressHeartbeat();
636
-    }
637
-
638
-
639
-
640
-    /**
641
-     * @return bool
642
-     */
643
-    public function isWordPressScrape()
644
-    {
645
-        return $this->request_type->isWordPressScrape();
646
-    }
647
-
648
-
649
-    /**
650
-     * @return string
651
-     */
652
-    public function slug()
653
-    {
654
-        return $this->request_type->slug();
655
-    }
20
+	/**
21
+	 * $_GET parameters
22
+	 *
23
+	 * @var array $get
24
+	 */
25
+	private $get;
26
+
27
+	/**
28
+	 * $_POST parameters
29
+	 *
30
+	 * @var array $post
31
+	 */
32
+	private $post;
33
+
34
+	/**
35
+	 * $_COOKIE parameters
36
+	 *
37
+	 * @var array $cookie
38
+	 */
39
+	private $cookie;
40
+
41
+	/**
42
+	 * $_SERVER parameters
43
+	 *
44
+	 * @var array $server
45
+	 */
46
+	private $server;
47
+
48
+	/**
49
+	 * $_FILES parameters
50
+	 *
51
+	 * @var array $files
52
+	 */
53
+	private $files;
54
+
55
+	/**
56
+	 * $_REQUEST parameters
57
+	 *
58
+	 * @var array $request
59
+	 */
60
+	private $request;
61
+
62
+	/**
63
+	 * @var RequestTypeContextCheckerInterface
64
+	 */
65
+	private $request_type;
66
+
67
+	/**
68
+	 * IP address for request
69
+	 *
70
+	 * @var string $ip_address
71
+	 */
72
+	private $ip_address;
73
+
74
+	/**
75
+	 * @var string $user_agent
76
+	 */
77
+	private $user_agent;
78
+
79
+	/**
80
+	 * true if current user appears to be some kind of bot
81
+	 *
82
+	 * @var bool $is_bot
83
+	 */
84
+	private $is_bot;
85
+
86
+
87
+	/**
88
+	 * @param array $get
89
+	 * @param array $post
90
+	 * @param array $cookie
91
+	 * @param array $server
92
+	 * @param array $files
93
+	 */
94
+	public function __construct(array $get, array $post, array $cookie, array $server, array $files = array())
95
+	{
96
+		// grab request vars
97
+		$this->get = $get;
98
+		$this->post = $post;
99
+		$this->cookie = $cookie;
100
+		$this->server = $server;
101
+		$this->files = $files;
102
+		$this->request = array_merge($this->get, $this->post);
103
+		$this->ip_address = $this->visitorIp();
104
+	}
105
+
106
+
107
+	/**
108
+	 * @param RequestTypeContextCheckerInterface $type
109
+	 */
110
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
111
+	{
112
+		$this->request_type = $type;
113
+	}
114
+
115
+
116
+	/**
117
+	 * @return array
118
+	 */
119
+	public function getParams()
120
+	{
121
+		return $this->get;
122
+	}
123
+
124
+
125
+	/**
126
+	 * @return array
127
+	 */
128
+	public function postParams()
129
+	{
130
+		return $this->post;
131
+	}
132
+
133
+
134
+	/**
135
+	 * @return array
136
+	 */
137
+	public function cookieParams()
138
+	{
139
+		return $this->cookie;
140
+	}
141
+
142
+
143
+	/**
144
+	 * @return array
145
+	 */
146
+	public function serverParams()
147
+	{
148
+		return $this->server;
149
+	}
150
+
151
+
152
+	/**
153
+	 * @return array
154
+	 */
155
+	public function filesParams()
156
+	{
157
+		return $this->files;
158
+	}
159
+
160
+
161
+	/**
162
+	 * returns contents of $_REQUEST
163
+	 *
164
+	 * @return array
165
+	 */
166
+	public function requestParams()
167
+	{
168
+		return $this->request;
169
+	}
170
+
171
+
172
+	/**
173
+	 * @param      $key
174
+	 * @param      $value
175
+	 * @param bool $override_ee
176
+	 * @return    void
177
+	 */
178
+	public function setRequestParam($key, $value, $override_ee = false)
179
+	{
180
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
181
+		if ($key !== 'ee'
182
+			|| ($key === 'ee' && empty($this->request['ee']))
183
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
184
+		) {
185
+			$this->request[ $key ] = $value;
186
+		}
187
+	}
188
+
189
+
190
+	/**
191
+	 * returns   the value for a request param if the given key exists
192
+	 *
193
+	 * @param       $key
194
+	 * @param null  $default
195
+	 * @return mixed
196
+	 */
197
+	public function getRequestParam($key, $default = null)
198
+	{
199
+		return $this->requestParameterDrillDown($key, $default, 'get');
200
+	}
201
+
202
+
203
+	/**
204
+	 * check if param exists
205
+	 *
206
+	 * @param       $key
207
+	 * @return bool
208
+	 */
209
+	public function requestParamIsSet($key)
210
+	{
211
+		return $this->requestParameterDrillDown($key);
212
+	}
213
+
214
+
215
+	/**
216
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
217
+	 * and return the value for the first match found
218
+	 * wildcards can be either of the following:
219
+	 *      ? to represent a single character of any type
220
+	 *      * to represent one or more characters of any type
221
+	 *
222
+	 * @param string     $pattern
223
+	 * @param null|mixed $default
224
+	 * @return mixed
225
+	 */
226
+	public function getMatch($pattern, $default = null)
227
+	{
228
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
229
+	}
230
+
231
+
232
+	/**
233
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
234
+	 * wildcards can be either of the following:
235
+	 *      ? to represent a single character of any type
236
+	 *      * to represent one or more characters of any type
237
+	 * returns true if a match is found or false if not
238
+	 *
239
+	 * @param string $pattern
240
+	 * @return bool
241
+	 */
242
+	public function matches($pattern)
243
+	{
244
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
245
+	}
246
+
247
+
248
+	/**
249
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
250
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
251
+	 *                                      and used to search through the current request's parameter keys
252
+	 * @param array  $request_params        The array of request parameters to search through
253
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
254
+	 *                                      Default is null
255
+	 * @param string $return                [optional] Controls what kind of value is returned.
256
+	 *                                      Options are:
257
+	 *                                      'bool' will return true or false if match is found or not
258
+	 *                                      'key' will return the first key found that matches the supplied pattern
259
+	 *                                      'value' will return the value for the first request parameter
260
+	 *                                      whose key matches the supplied pattern
261
+	 *                                      Default is 'value'
262
+	 * @return boolean|string
263
+	 */
264
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
265
+	{
266
+		$return = in_array($return, array('bool', 'key', 'value'), true)
267
+			? $return
268
+			: 'is_set';
269
+		// replace wildcard chars with regex chars
270
+		$pattern = str_replace(
271
+			array("\*", "\?"),
272
+			array('.*', '.'),
273
+			preg_quote($pattern, '/')
274
+		);
275
+		foreach ($request_params as $key => $request_param) {
276
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
277
+				// return value for request param
278
+				if ($return === 'value') {
279
+					return $request_params[ $key ];
280
+				}
281
+				// or actual key or true just to indicate it was found
282
+				return $return === 'key' ? $key : true;
283
+			}
284
+		}
285
+		// match not found so return default value or false
286
+		return $return === 'value' ? $default : false;
287
+	}
288
+
289
+
290
+	/**
291
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
292
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
293
+	 * by using square brackets to surround keys for deeper array elements.
294
+	 * For example :
295
+	 * if the supplied $key was: "first[second][third]"
296
+	 * then this will attempt to drill down into the request parameter array to find a value.
297
+	 * Given the following request parameters:
298
+	 *  array(
299
+	 *      'first' => array(
300
+	 *          'second' => array(
301
+	 *              'third' => 'has a value'
302
+	 *          )
303
+	 *      )
304
+	 *  )
305
+	 * would return true if default parameters were set
306
+	 *
307
+	 * @param string $callback
308
+	 * @param        $key
309
+	 * @param null   $default
310
+	 * @param array  $request_params
311
+	 * @return bool|mixed|null
312
+	 */
313
+	private function requestParameterDrillDown(
314
+		$key,
315
+		$default = null,
316
+		$callback = 'is_set',
317
+		array $request_params = array()
318
+	) {
319
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
320
+			? $callback
321
+			: 'is_set';
322
+		$request_params = ! empty($request_params)
323
+			? $request_params
324
+			: $this->request;
325
+		// does incoming key represent an array like 'first[second][third]'  ?
326
+		if (strpos($key, '[') !== false) {
327
+			// turn it into an actual array
328
+			$key = str_replace(']', '', $key);
329
+			$keys = explode('[', $key);
330
+			$key = array_shift($keys);
331
+			if ($callback === 'match') {
332
+				$real_key = $this->match($key, $request_params, $default, 'key');
333
+				$key = $real_key ? $real_key : $key;
334
+			}
335
+			// check if top level key exists
336
+			if (isset($request_params[ $key ])) {
337
+				// build a new key to pass along like: 'second[third]'
338
+				// or just 'second' depending on depth of keys
339
+				$key_string = array_shift($keys);
340
+				if (! empty($keys)) {
341
+					$key_string .= '[' . implode('][', $keys) . ']';
342
+				}
343
+				return $this->requestParameterDrillDown(
344
+					$key_string,
345
+					$default,
346
+					$callback,
347
+					$request_params[ $key ]
348
+				);
349
+			}
350
+		}
351
+		if ($callback === 'is_set') {
352
+			return isset($request_params[ $key ]);
353
+		}
354
+		if ($callback === 'match') {
355
+			return $this->match($key, $request_params, $default);
356
+		}
357
+		return isset($request_params[ $key ])
358
+			? $request_params[ $key ]
359
+			: $default;
360
+	}
361
+
362
+
363
+	/**
364
+	 * remove param
365
+	 *
366
+	 * @param      $key
367
+	 * @param bool $unset_from_global_too
368
+	 */
369
+	public function unSetRequestParam($key, $unset_from_global_too = false)
370
+	{
371
+		unset($this->request[ $key ]);
372
+		if ($unset_from_global_too) {
373
+			unset($_REQUEST[ $key ]);
374
+		}
375
+	}
376
+
377
+
378
+	/**
379
+	 * @return string
380
+	 */
381
+	public function ipAddress()
382
+	{
383
+		return $this->ip_address;
384
+	}
385
+
386
+
387
+	/**
388
+	 * attempt to get IP address of current visitor from server
389
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
390
+	 *
391
+	 * @access public
392
+	 * @return string
393
+	 */
394
+	private function visitorIp()
395
+	{
396
+		$visitor_ip = '0.0.0.0';
397
+		$server_keys = array(
398
+			'HTTP_CLIENT_IP',
399
+			'HTTP_X_FORWARDED_FOR',
400
+			'HTTP_X_FORWARDED',
401
+			'HTTP_X_CLUSTER_CLIENT_IP',
402
+			'HTTP_FORWARDED_FOR',
403
+			'HTTP_FORWARDED',
404
+			'REMOTE_ADDR',
405
+		);
406
+		foreach ($server_keys as $key) {
407
+			if (isset($this->server[ $key ])) {
408
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
409
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
410
+						$visitor_ip = $ip;
411
+					}
412
+				}
413
+			}
414
+		}
415
+		return $visitor_ip;
416
+	}
417
+
418
+
419
+	/**
420
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
421
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
422
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
423
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
424
+	 * @return string
425
+	 */
426
+	public function requestUri($relativeToWpRoot = false)
427
+	{
428
+		$request_uri = filter_input(
429
+			INPUT_SERVER,
430
+			'REQUEST_URI',
431
+			FILTER_SANITIZE_URL,
432
+			FILTER_NULL_ON_FAILURE
433
+		);
434
+		if (empty($request_uri)) {
435
+			// fallback sanitization if the above fails
436
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
437
+		}
438
+		if ($relativeToWpRoot) {
439
+			$home_path = untrailingslashit(
440
+				parse_url(
441
+					home_url(),
442
+					PHP_URL_PATH
443
+				)
444
+			);
445
+			$request_uri = str_replace(
446
+				$home_path,
447
+				'',
448
+				$request_uri
449
+			);
450
+		}
451
+		return $request_uri;
452
+	}
453
+
454
+	/**
455
+	 * @return string
456
+	 */
457
+	public function userAgent()
458
+	{
459
+		return $this->user_agent;
460
+	}
461
+
462
+
463
+	/**
464
+	 * @param string $user_agent
465
+	 */
466
+	public function setUserAgent($user_agent = '')
467
+	{
468
+		if ($user_agent === '' || ! is_string($user_agent)) {
469
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
470
+		}
471
+		$this->user_agent = $user_agent;
472
+	}
473
+
474
+
475
+	/**
476
+	 * @return bool
477
+	 */
478
+	public function isBot()
479
+	{
480
+		return $this->is_bot;
481
+	}
482
+
483
+
484
+	/**
485
+	 * @param bool $is_bot
486
+	 */
487
+	public function setIsBot($is_bot)
488
+	{
489
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
490
+	}
491
+
492
+
493
+	/**
494
+	 * @return bool
495
+	 */
496
+	public function isActivation()
497
+	{
498
+		return $this->request_type->isActivation();
499
+	}
500
+
501
+
502
+	/**
503
+	 * @param $is_activation
504
+	 * @return bool
505
+	 */
506
+	public function setIsActivation($is_activation)
507
+	{
508
+		return $this->request_type->setIsActivation($is_activation);
509
+	}
510
+
511
+
512
+	/**
513
+	 * @return bool
514
+	 */
515
+	public function isAdmin()
516
+	{
517
+		return $this->request_type->isAdmin();
518
+	}
519
+
520
+
521
+	/**
522
+	 * @return bool
523
+	 */
524
+	public function isAdminAjax()
525
+	{
526
+		return $this->request_type->isAdminAjax();
527
+	}
528
+
529
+
530
+	/**
531
+	 * @return bool
532
+	 */
533
+	public function isAjax()
534
+	{
535
+		return $this->request_type->isAjax();
536
+	}
537
+
538
+
539
+	/**
540
+	 * @return bool
541
+	 */
542
+	public function isEeAjax()
543
+	{
544
+		return $this->request_type->isEeAjax();
545
+	}
546
+
547
+
548
+	/**
549
+	 * @return bool
550
+	 */
551
+	public function isOtherAjax()
552
+	{
553
+		return $this->request_type->isOtherAjax();
554
+	}
555
+
556
+
557
+	/**
558
+	 * @return bool
559
+	 */
560
+	public function isApi()
561
+	{
562
+		return $this->request_type->isApi();
563
+	}
564
+
565
+
566
+	/**
567
+	 * @return bool
568
+	 */
569
+	public function isCli()
570
+	{
571
+		return $this->request_type->isCli();
572
+	}
573
+
574
+
575
+	/**
576
+	 * @return bool
577
+	 */
578
+	public function isCron()
579
+	{
580
+		return $this->request_type->isCron();
581
+	}
582
+
583
+
584
+	/**
585
+	 * @return bool
586
+	 */
587
+	public function isFeed()
588
+	{
589
+		return $this->request_type->isFeed();
590
+	}
591
+
592
+
593
+	/**
594
+	 * @return bool
595
+	 */
596
+	public function isFrontend()
597
+	{
598
+		return $this->request_type->isFrontend();
599
+	}
600
+
601
+
602
+	/**
603
+	 * @return bool
604
+	 */
605
+	public function isFrontAjax()
606
+	{
607
+		return $this->request_type->isFrontAjax();
608
+	}
609
+
610
+
611
+	/**
612
+	 * @return bool
613
+	 */
614
+	public function isIframe()
615
+	{
616
+		return $this->request_type->isIframe();
617
+	}
618
+
619
+
620
+	/**
621
+	 * @return bool
622
+	 */
623
+	public function isWordPressApi()
624
+	{
625
+		return $this->request_type->isWordPressApi();
626
+	}
627
+
628
+
629
+
630
+	/**
631
+	 * @return bool
632
+	 */
633
+	public function isWordPressHeartbeat()
634
+	{
635
+		return $this->request_type->isWordPressHeartbeat();
636
+	}
637
+
638
+
639
+
640
+	/**
641
+	 * @return bool
642
+	 */
643
+	public function isWordPressScrape()
644
+	{
645
+		return $this->request_type->isWordPressScrape();
646
+	}
647
+
648
+
649
+	/**
650
+	 * @return string
651
+	 */
652
+	public function slug()
653
+	{
654
+		return $this->request_type->slug();
655
+	}
656 656
 }
Please login to merge, or discard this patch.
core/services/address/formatters/MultiLineAddressFormatter.php 2 patches
Indentation   +35 added lines, -35 removed lines patch added patch discarded remove patch
@@ -15,39 +15,39 @@
 block discarded – undo
15 15
 {
16 16
 
17 17
 
18
-    /**
19
-     * @param string $address
20
-     * @param string $address2
21
-     * @param string $city
22
-     * @param string $state
23
-     * @param string $zip
24
-     * @param string $country
25
-     * @param string $CNT_ISO
26
-     * @return string
27
-     */
28
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
29
-    {
30
-        $address_formats = apply_filters(
31
-            'FHEE__EE_MultiLine_Address_Formatter__address_formats',
32
-            array(
33
-                'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}",
34
-                'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
35
-                'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
36
-                'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
37
-            )
38
-        );
39
-        // if the incoming country has a set format, use that, else use the default
40
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
41
-            : $address_formats['ZZ'];
42
-        return $this->parse_formatted_address(
43
-            $address,
44
-            $address2,
45
-            $city,
46
-            $state,
47
-            $zip,
48
-            $country,
49
-            $formatted_address,
50
-            '<br />'
51
-        );
52
-    }
18
+	/**
19
+	 * @param string $address
20
+	 * @param string $address2
21
+	 * @param string $city
22
+	 * @param string $state
23
+	 * @param string $zip
24
+	 * @param string $country
25
+	 * @param string $CNT_ISO
26
+	 * @return string
27
+	 */
28
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
29
+	{
30
+		$address_formats = apply_filters(
31
+			'FHEE__EE_MultiLine_Address_Formatter__address_formats',
32
+			array(
33
+				'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}",
34
+				'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
35
+				'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
36
+				'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
37
+			)
38
+		);
39
+		// if the incoming country has a set format, use that, else use the default
40
+		$formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
41
+			: $address_formats['ZZ'];
42
+		return $this->parse_formatted_address(
43
+			$address,
44
+			$address2,
45
+			$city,
46
+			$state,
47
+			$zip,
48
+			$country,
49
+			$formatted_address,
50
+			'<br />'
51
+		);
52
+	}
53 53
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -37,7 +37,7 @@
 block discarded – undo
37 37
             )
38 38
         );
39 39
         // if the incoming country has a set format, use that, else use the default
40
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
40
+        $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO]
41 41
             : $address_formats['ZZ'];
42 42
         return $this->parse_formatted_address(
43 43
             $address,
Please login to merge, or discard this patch.
core/services/address/formatters/InlineAddressFormatter.php 2 patches
Indentation   +35 added lines, -35 removed lines patch added patch discarded remove patch
@@ -14,39 +14,39 @@
 block discarded – undo
14 14
 class InlineAddressFormatter extends AddressFormatter implements \EEI_Address_Formatter
15 15
 {
16 16
 
17
-    /**
18
-     * @param string $address
19
-     * @param string $address2
20
-     * @param string $city
21
-     * @param string $state
22
-     * @param string $zip
23
-     * @param string $country
24
-     * @param string $CNT_ISO
25
-     * @return string
26
-     */
27
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
28
-    {
29
-        $address_formats = apply_filters(
30
-            'FHEE__EE_Inline_Address_Formatter__address_formats',
31
-            array(
32
-                'CA'  => "{address}%{address2}%{city}%{state}%{country}%{zip}",
33
-                'GB'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
34
-                'US'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
35
-                'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
36
-            )
37
-        );
38
-        // if the incoming country has a set format, use that, else use the default
39
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
40
-            : $address_formats['ZZZ'];
41
-        return $this->parse_formatted_address(
42
-            $address,
43
-            $address2,
44
-            $city,
45
-            $state,
46
-            $zip,
47
-            $country,
48
-            $formatted_address,
49
-            ', '
50
-        );
51
-    }
17
+	/**
18
+	 * @param string $address
19
+	 * @param string $address2
20
+	 * @param string $city
21
+	 * @param string $state
22
+	 * @param string $zip
23
+	 * @param string $country
24
+	 * @param string $CNT_ISO
25
+	 * @return string
26
+	 */
27
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
28
+	{
29
+		$address_formats = apply_filters(
30
+			'FHEE__EE_Inline_Address_Formatter__address_formats',
31
+			array(
32
+				'CA'  => "{address}%{address2}%{city}%{state}%{country}%{zip}",
33
+				'GB'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
34
+				'US'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
35
+				'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
36
+			)
37
+		);
38
+		// if the incoming country has a set format, use that, else use the default
39
+		$formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
40
+			: $address_formats['ZZZ'];
41
+		return $this->parse_formatted_address(
42
+			$address,
43
+			$address2,
44
+			$city,
45
+			$state,
46
+			$zip,
47
+			$country,
48
+			$formatted_address,
49
+			', '
50
+		);
51
+	}
52 52
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -36,7 +36,7 @@
 block discarded – undo
36 36
             )
37 37
         );
38 38
         // if the incoming country has a set format, use that, else use the default
39
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
39
+        $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO]
40 40
             : $address_formats['ZZZ'];
41 41
         return $this->parse_formatted_address(
42 42
             $address,
Please login to merge, or discard this patch.
core/services/locators/FileLocator.php 2 patches
Indentation   +73 added lines, -73 removed lines patch added patch discarded remove patch
@@ -17,88 +17,88 @@
 block discarded – undo
17 17
 class FileLocator extends Locator
18 18
 {
19 19
 
20
-    /**
21
-     * @var string $file_mask
22
-     */
23
-    protected $file_mask = '*.php';
20
+	/**
21
+	 * @var string $file_mask
22
+	 */
23
+	protected $file_mask = '*.php';
24 24
 
25
-    /**
26
-     * @var array $filepaths
27
-     */
28
-    protected $filepaths = array();
25
+	/**
26
+	 * @var array $filepaths
27
+	 */
28
+	protected $filepaths = array();
29 29
 
30 30
 
31
-    /**
32
-     * @param string $file_mask
33
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
34
-     */
35
-    public function setFileMask($file_mask)
36
-    {
37
-        if (! is_string($file_mask)) {
38
-            throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
39
-        }
40
-        $this->file_mask = $file_mask;
41
-    }
31
+	/**
32
+	 * @param string $file_mask
33
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
34
+	 */
35
+	public function setFileMask($file_mask)
36
+	{
37
+		if (! is_string($file_mask)) {
38
+			throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
39
+		}
40
+		$this->file_mask = $file_mask;
41
+	}
42 42
 
43 43
 
44
-    /**
45
-     * @access public
46
-     * @return array
47
-     */
48
-    public function getFilePaths()
49
-    {
50
-        return $this->filepaths;
51
-    }
44
+	/**
45
+	 * @access public
46
+	 * @return array
47
+	 */
48
+	public function getFilePaths()
49
+	{
50
+		return $this->filepaths;
51
+	}
52 52
 
53 53
 
54
-    /**
55
-     * @access public
56
-     * @return int
57
-     */
58
-    public function count()
59
-    {
60
-        return count($this->filepaths);
61
-    }
54
+	/**
55
+	 * @access public
56
+	 * @return int
57
+	 */
58
+	public function count()
59
+	{
60
+		return count($this->filepaths);
61
+	}
62 62
 
63 63
 
64
-    /**
65
-     * given a path to a valid directory, or an array of valid paths,
66
-     * will find all files that match the provided mask
67
-     *
68
-     * @access public
69
-     * @param array|string $directory_paths
70
-     * @return \FilesystemIterator
71
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
72
-     */
73
-    public function locate($directory_paths)
74
-    {
75
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
76
-            throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
77
-        }
78
-        foreach ((array) $directory_paths as $directory_path) {
79
-            foreach ($this->findFilesByPath($directory_path) as $key => $file) {
80
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
81
-            }
82
-        }
83
-        return $this->filepaths;
84
-    }
64
+	/**
65
+	 * given a path to a valid directory, or an array of valid paths,
66
+	 * will find all files that match the provided mask
67
+	 *
68
+	 * @access public
69
+	 * @param array|string $directory_paths
70
+	 * @return \FilesystemIterator
71
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
72
+	 */
73
+	public function locate($directory_paths)
74
+	{
75
+		if (! (is_string($directory_paths) || is_array($directory_paths))) {
76
+			throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
77
+		}
78
+		foreach ((array) $directory_paths as $directory_path) {
79
+			foreach ($this->findFilesByPath($directory_path) as $key => $file) {
80
+				$this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
81
+			}
82
+		}
83
+		return $this->filepaths;
84
+	}
85 85
 
86 86
 
87
-    /**
88
-     * given a path to a valid directory, will find all files that match the provided mask
89
-     *
90
-     * @access protected
91
-     * @param string $directory_path
92
-     * @return \FilesystemIterator
93
-     */
94
-    protected function findFilesByPath($directory_path = '')
95
-    {
96
-        $iterator = new GlobIterator(
97
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
98
-        );
99
-        foreach ($this->flags as $flag) {
100
-            $iterator->setFlags($flag);
101
-        }
102
-        return $iterator;
103
-    }
87
+	/**
88
+	 * given a path to a valid directory, will find all files that match the provided mask
89
+	 *
90
+	 * @access protected
91
+	 * @param string $directory_path
92
+	 * @return \FilesystemIterator
93
+	 */
94
+	protected function findFilesByPath($directory_path = '')
95
+	{
96
+		$iterator = new GlobIterator(
97
+			\EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
98
+		);
99
+		foreach ($this->flags as $flag) {
100
+			$iterator->setFlags($flag);
101
+		}
102
+		return $iterator;
103
+	}
104 104
 }
Please login to merge, or discard this patch.
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -34,7 +34,7 @@  discard block
 block discarded – undo
34 34
      */
35 35
     public function setFileMask($file_mask)
36 36
     {
37
-        if (! is_string($file_mask)) {
37
+        if ( ! is_string($file_mask)) {
38 38
             throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
39 39
         }
40 40
         $this->file_mask = $file_mask;
@@ -72,12 +72,12 @@  discard block
 block discarded – undo
72 72
      */
73 73
     public function locate($directory_paths)
74 74
     {
75
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
75
+        if ( ! (is_string($directory_paths) || is_array($directory_paths))) {
76 76
             throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
77 77
         }
78 78
         foreach ((array) $directory_paths as $directory_path) {
79 79
             foreach ($this->findFilesByPath($directory_path) as $key => $file) {
80
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
80
+                $this->filepaths[$key] = \EEH_File::standardise_directory_separators($file);
81 81
             }
82 82
         }
83 83
         return $this->filepaths;
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
94 94
     protected function findFilesByPath($directory_path = '')
95 95
     {
96 96
         $iterator = new GlobIterator(
97
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
97
+            \EEH_File::end_with_directory_separator($directory_path).$this->file_mask
98 98
         );
99 99
         foreach ($this->flags as $flag) {
100 100
             $iterator->setFlags($flag);
Please login to merge, or discard this patch.