eventespresso / event-espresso-core

core/services/Benchmark.php

Indentation +320 added lines, -320 removed lines

@@ -15,324 +15,324 @@
 class Benchmark
 {
 
-    /**
-     * @var string $output
-     */
-    private static $output;
-
-    /**
-     * @var array $start_times array containing the start time for the timers
-     */
-    private static $start_times;
-
-    /**
-     * @var array $times array containing all the timer'd times, which can be outputted via show_times()
-     */
-    private static $times = array();
-
-    /**
-     * @var array $memory_usage
-     */
-    protected static $memory_usage = array();
-
-
-    /**
-     * @param string $output
-     * @param bool   $formatted
-     */
-    public static function addOutput($output, $formatted = true)
-    {
-        Benchmark::$output .= $formatted
-            ? "<br />{$output}"
-            : "\n{$output}";
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function resetOutput()
-    {
-        Benchmark::$output = '';
-    }
-
-    /**
-     * whether to benchmark code or not
-     */
-    public static function doNotRun()
-    {
-        return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
-    }
-
-
-    /**
-     * resetTimes
-     */
-    public static function resetTimes()
-    {
-        Benchmark::$times = array();
-    }
-
-
-    /**
-     * Add Benchmark::startTimer() before a block of code you want to measure the performance of
-     *
-     * @param null $timer_name
-     */
-    public static function startTimer($timer_name = null)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        Benchmark::$start_times[ $timer_name ] = microtime(true);
-    }
-
-
-    /**
-     * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
-     *
-     * @param string $timer_name
-     */
-    public static function stopTimer($timer_name = '')
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        if (isset(Benchmark::$start_times[ $timer_name ])) {
-            $start_time = Benchmark::$start_times[ $timer_name ];
-            unset(Benchmark::$start_times[ $timer_name ]);
-        } else {
-            $start_time = array_pop(Benchmark::$start_times);
-        }
-        Benchmark::$times[ $timer_name ] = number_format(microtime(true) - $start_time, 8);
-    }
-
-
-    /**
-     * Measure the memory usage by PHP so far.
-     *
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @param bool    $formatted
-     * @return void
-     */
-    public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $memory_used = Benchmark::convert(memory_get_usage(true));
-        Benchmark::$memory_usage[ $label ] = $memory_used;
-        if ($output_now) {
-            echo $formatted
-                ? "<br>{$label} : {$memory_used}"
-                : "\n {$label} : {$memory_used}";
-        }
-    }
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param bool $formatted
-     * @return void
-     */
-    public static function displayResultsAtShutdown($formatted = true)
-    {
-        Benchmark::resetOutput();
-        add_action(
-            'shutdown',
-            function () use ($formatted) {
-                Benchmark::displayResults(true, $formatted);
-            },
-            999999
-        );
-    }
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     * @return void
-     */
-    public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
-    {
-        Benchmark::resetOutput();
-        add_action(
-            'shutdown',
-            function () use ($filepath, $formatted, $append) {
-                Benchmark::writeResultsToFile($filepath, $formatted, $append);
-            },
-            999999
-        );
-    }
-
-
-    /**
-     * @param bool $formatted
-     * @return string
-     */
-    private static function generateResults($formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return '';
-        }
-        if (! empty(Benchmark::$times)) {
-            $total = 0;
-            Benchmark::$output .= $formatted
-                ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
-                : '';
-            foreach (Benchmark::$times as $timer_name => $total_time) {
-                Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                Benchmark::$output .= $formatted ? '<br />' : "\n";
-                $total += $total_time;
-            }
-            if ($formatted) {
-                Benchmark::$output .= '<br />';
-                Benchmark::$output .= '<h4>TOTAL TIME</h4>';
-                Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
-                Benchmark::$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
-                Benchmark::$output .= '<br />';
-                Benchmark::$output .= '<h5>Performance scale (from best to worse)</h5>';
-                Benchmark::$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
-                Benchmark::$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
-                Benchmark::$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
-                Benchmark::$output .= '<span style="color:gold">Ruh Oh</span><br />';
-                Benchmark::$output .= '<span style="color:darkorange">Zoinks!</span><br />';
-                Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
-            }
-        }
-        if (! empty(Benchmark::$memory_usage)) {
-            Benchmark::$output .= $formatted
-                ? '<h5>Memory</h5>'
-                : "\nMemory";
-            foreach (Benchmark::$memory_usage as $label => $memory_usage) {
-                Benchmark::$output .= $formatted
-                    ? "<br />{$memory_usage} : {$label}"
-                    : "\n{$memory_usage} : {$label}";
-            }
-        }
-        if (empty(Benchmark::$output)) {
-            return '';
-        }
-        Benchmark::$output = $formatted
-            ? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
-              . (is_admin()
-                ? ' margin:2em 2em 2em 180px;'
-                : ' margin:2em;')
-              . ' padding:2em;">'
-              . '<h4>BENCHMARKING</h4>'
-              . Benchmark::$output
-              . '</div>'
-            : Benchmark::$output;
-        return Benchmark::$output;
-    }
-
-
-    /**
-     * @param bool $echo
-     * @param bool $formatted
-     * @return string
-     */
-    public static function displayResults($echo = true, $formatted = true)
-    {
-        $results = Benchmark::generateResults($formatted);
-        if ($echo) {
-            echo $results;
-            $results = '';
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     * @throws EE_Error
-     */
-    public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
-    {
-        $filepath = ! empty($filepath) && is_readable(dirname($filepath))
-            ? $filepath
-            : '';
-        if (empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
-        }
-        EEH_File::ensure_file_exists_and_is_writable($filepath);
-        file_put_contents(
-            $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
-            $append ? FILE_APPEND | LOCK_EX : LOCK_EX
-        );
-    }
-
-
-    /**
-     * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
-     *
-     * @param int $size
-     * @return string
-     */
-    public static function convert($size)
-    {
-        $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
-        return round(
-            $size / pow(1024, $i = floor(log($size, 1024))),
-            2
-        ) . ' ' . $unit[ absint($i) ];
-    }
-
-
-    /**
-     * @param string $timer_name
-     * @param float  $total_time
-     * @param bool   $formatted
-     * @return string
-     */
-    public static function formatTime($timer_name, $total_time, $formatted = true)
-    {
-        $total_time *= 1000;
-        switch ($total_time) {
-            case $total_time > 12500:
-                $color = 'red';
-                $bold = 'bold';
-                break;
-            case $total_time > 2500:
-                $color = 'darkorange';
-                $bold = 'bold';
-                break;
-            case $total_time > 500:
-                $color = 'gold';
-                $bold = 'bold';
-                break;
-            case $total_time > 100:
-                $color = 'limegreen';
-                $bold = 'normal';
-                break;
-            case $total_time > 20:
-                $color = 'deepskyblue';
-                $bold = 'normal';
-                break;
-            default:
-                $color = 'mediumpurple';
-                $bold = 'normal';
-                break;
-        }
-        return $formatted
-            ? '<span style="min-width: 10px; margin:0 1em; color:'
-              . $color
-              . '; font-weight:'
-              . $bold
-              . '; font-size:1.2em;">'
-              . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
-              . '</span> '
-              . $timer_name
-            : str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
-    }
+	/**
+	 * @var string $output
+	 */
+	private static $output;
+
+	/**
+	 * @var array $start_times array containing the start time for the timers
+	 */
+	private static $start_times;
+
+	/**
+	 * @var array $times array containing all the timer'd times, which can be outputted via show_times()
+	 */
+	private static $times = array();
+
+	/**
+	 * @var array $memory_usage
+	 */
+	protected static $memory_usage = array();
+
+
+	/**
+	 * @param string $output
+	 * @param bool   $formatted
+	 */
+	public static function addOutput($output, $formatted = true)
+	{
+		Benchmark::$output .= $formatted
+			? "<br />{$output}"
+			: "\n{$output}";
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function resetOutput()
+	{
+		Benchmark::$output = '';
+	}
+
+	/**
+	 * whether to benchmark code or not
+	 */
+	public static function doNotRun()
+	{
+		return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
+	}
+
+
+	/**
+	 * resetTimes
+	 */
+	public static function resetTimes()
+	{
+		Benchmark::$times = array();
+	}
+
+
+	/**
+	 * Add Benchmark::startTimer() before a block of code you want to measure the performance of
+	 *
+	 * @param null $timer_name
+	 */
+	public static function startTimer($timer_name = null)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		Benchmark::$start_times[ $timer_name ] = microtime(true);
+	}
+
+
+	/**
+	 * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
+	 *
+	 * @param string $timer_name
+	 */
+	public static function stopTimer($timer_name = '')
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		if (isset(Benchmark::$start_times[ $timer_name ])) {
+			$start_time = Benchmark::$start_times[ $timer_name ];
+			unset(Benchmark::$start_times[ $timer_name ]);
+		} else {
+			$start_time = array_pop(Benchmark::$start_times);
+		}
+		Benchmark::$times[ $timer_name ] = number_format(microtime(true) - $start_time, 8);
+	}
+
+
+	/**
+	 * Measure the memory usage by PHP so far.
+	 *
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @param bool    $formatted
+	 * @return void
+	 */
+	public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$memory_used = Benchmark::convert(memory_get_usage(true));
+		Benchmark::$memory_usage[ $label ] = $memory_used;
+		if ($output_now) {
+			echo $formatted
+				? "<br>{$label} : {$memory_used}"
+				: "\n {$label} : {$memory_used}";
+		}
+	}
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param bool $formatted
+	 * @return void
+	 */
+	public static function displayResultsAtShutdown($formatted = true)
+	{
+		Benchmark::resetOutput();
+		add_action(
+			'shutdown',
+			function () use ($formatted) {
+				Benchmark::displayResults(true, $formatted);
+			},
+			999999
+		);
+	}
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 * @return void
+	 */
+	public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
+	{
+		Benchmark::resetOutput();
+		add_action(
+			'shutdown',
+			function () use ($filepath, $formatted, $append) {
+				Benchmark::writeResultsToFile($filepath, $formatted, $append);
+			},
+			999999
+		);
+	}
+
+
+	/**
+	 * @param bool $formatted
+	 * @return string
+	 */
+	private static function generateResults($formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return '';
+		}
+		if (! empty(Benchmark::$times)) {
+			$total = 0;
+			Benchmark::$output .= $formatted
+				? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
+				: '';
+			foreach (Benchmark::$times as $timer_name => $total_time) {
+				Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
+				Benchmark::$output .= $formatted ? '<br />' : "\n";
+				$total += $total_time;
+			}
+			if ($formatted) {
+				Benchmark::$output .= '<br />';
+				Benchmark::$output .= '<h4>TOTAL TIME</h4>';
+				Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
+				Benchmark::$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
+				Benchmark::$output .= '<br />';
+				Benchmark::$output .= '<h5>Performance scale (from best to worse)</h5>';
+				Benchmark::$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
+				Benchmark::$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
+				Benchmark::$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
+				Benchmark::$output .= '<span style="color:gold">Ruh Oh</span><br />';
+				Benchmark::$output .= '<span style="color:darkorange">Zoinks!</span><br />';
+				Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
+			}
+		}
+		if (! empty(Benchmark::$memory_usage)) {
+			Benchmark::$output .= $formatted
+				? '<h5>Memory</h5>'
+				: "\nMemory";
+			foreach (Benchmark::$memory_usage as $label => $memory_usage) {
+				Benchmark::$output .= $formatted
+					? "<br />{$memory_usage} : {$label}"
+					: "\n{$memory_usage} : {$label}";
+			}
+		}
+		if (empty(Benchmark::$output)) {
+			return '';
+		}
+		Benchmark::$output = $formatted
+			? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
+			  . (is_admin()
+				? ' margin:2em 2em 2em 180px;'
+				: ' margin:2em;')
+			  . ' padding:2em;">'
+			  . '<h4>BENCHMARKING</h4>'
+			  . Benchmark::$output
+			  . '</div>'
+			: Benchmark::$output;
+		return Benchmark::$output;
+	}
+
+
+	/**
+	 * @param bool $echo
+	 * @param bool $formatted
+	 * @return string
+	 */
+	public static function displayResults($echo = true, $formatted = true)
+	{
+		$results = Benchmark::generateResults($formatted);
+		if ($echo) {
+			echo $results;
+			$results = '';
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 * @throws EE_Error
+	 */
+	public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
+	{
+		$filepath = ! empty($filepath) && is_readable(dirname($filepath))
+			? $filepath
+			: '';
+		if (empty($filepath)) {
+			$filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+		}
+		EEH_File::ensure_file_exists_and_is_writable($filepath);
+		file_put_contents(
+			$filepath,
+			"\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+			$append ? FILE_APPEND | LOCK_EX : LOCK_EX
+		);
+	}
+
+
+	/**
+	 * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
+	 *
+	 * @param int $size
+	 * @return string
+	 */
+	public static function convert($size)
+	{
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
+		return round(
+			$size / pow(1024, $i = floor(log($size, 1024))),
+			2
+		) . ' ' . $unit[ absint($i) ];
+	}
+
+
+	/**
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @param bool   $formatted
+	 * @return string
+	 */
+	public static function formatTime($timer_name, $total_time, $formatted = true)
+	{
+		$total_time *= 1000;
+		switch ($total_time) {
+			case $total_time > 12500:
+				$color = 'red';
+				$bold = 'bold';
+				break;
+			case $total_time > 2500:
+				$color = 'darkorange';
+				$bold = 'bold';
+				break;
+			case $total_time > 500:
+				$color = 'gold';
+				$bold = 'bold';
+				break;
+			case $total_time > 100:
+				$color = 'limegreen';
+				$bold = 'normal';
+				break;
+			case $total_time > 20:
+				$color = 'deepskyblue';
+				$bold = 'normal';
+				break;
+			default:
+				$color = 'mediumpurple';
+				$bold = 'normal';
+				break;
+		}
+		return $formatted
+			? '<span style="min-width: 10px; margin:0 1em; color:'
+			  . $color
+			  . '; font-weight:'
+			  . $bold
+			  . '; font-size:1.2em;">'
+			  . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
+			  . '</span> '
+			  . $timer_name
+			: str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -85,7 +85,7 @@ 
             return;
         }
         $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        Benchmark::$start_times[ $timer_name ] = microtime(true);
+        Benchmark::$start_times[$timer_name] = microtime(true);
     }
 
 
@@ -100,13 +100,13 @@ 
             return;
         }
         $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        if (isset(Benchmark::$start_times[ $timer_name ])) {
-            $start_time = Benchmark::$start_times[ $timer_name ];
-            unset(Benchmark::$start_times[ $timer_name ]);
+        if (isset(Benchmark::$start_times[$timer_name])) {
+            $start_time = Benchmark::$start_times[$timer_name];
+            unset(Benchmark::$start_times[$timer_name]);
         } else {
             $start_time = array_pop(Benchmark::$start_times);
         }
-        Benchmark::$times[ $timer_name ] = number_format(microtime(true) - $start_time, 8);
+        Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
     }
 
 
@@ -124,7 +124,7 @@ 
             return;
         }
         $memory_used = Benchmark::convert(memory_get_usage(true));
-        Benchmark::$memory_usage[ $label ] = $memory_used;
+        Benchmark::$memory_usage[$label] = $memory_used;
         if ($output_now) {
             echo $formatted
                 ? "<br>{$label} : {$memory_used}"
@@ -144,7 +144,7 @@ 
         Benchmark::resetOutput();
         add_action(
             'shutdown',
-            function () use ($formatted) {
+            function() use ($formatted) {
                 Benchmark::displayResults(true, $formatted);
             },
             999999
@@ -165,7 +165,7 @@ 
         Benchmark::resetOutput();
         add_action(
             'shutdown',
-            function () use ($filepath, $formatted, $append) {
+            function() use ($filepath, $formatted, $append) {
                 Benchmark::writeResultsToFile($filepath, $formatted, $append);
             },
             999999
@@ -182,7 +182,7 @@ 
         if (Benchmark::doNotRun()) {
             return '';
         }
-        if (! empty(Benchmark::$times)) {
+        if ( ! empty(Benchmark::$times)) {
             $total = 0;
             Benchmark::$output .= $formatted
                 ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
@@ -207,7 +207,7 @@ 
                 Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
             }
         }
-        if (! empty(Benchmark::$memory_usage)) {
+        if ( ! empty(Benchmark::$memory_usage)) {
             Benchmark::$output .= $formatted
                 ? '<h5>Memory</h5>'
                 : "\nMemory";
@@ -262,12 +262,12 @@ 
             ? $filepath
             : '';
         if (empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+            $filepath = EVENT_ESPRESSO_UPLOAD_DIR.'logs/benchmarking-'.date('Y-m-d').'.html';
         }
         EEH_File::ensure_file_exists_and_is_writable($filepath);
         file_put_contents(
             $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+            "\n".date('Y-m-d H:i:s').Benchmark::generateResults($formatted),
             $append ? FILE_APPEND | LOCK_EX : LOCK_EX
         );
     }
@@ -285,7 +285,7 @@ 
         return round(
             $size / pow(1024, $i = floor(log($size, 1024))),
             2
-        ) . ' ' . $unit[ absint($i) ];
+        ).' '.$unit[absint($i)];
     }
 
 

core/services/container/DependencyInjector.php

Indentation +205 added lines, -205 removed lines

@@ -21,209 +21,209 @@
 class DependencyInjector implements InjectorInterface
 {
 
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var EEH_Array $array_helper
-     */
-    private $array_helper;
-
-    /**
-     * @var ReflectionClass[] $reflectors
-     */
-    private $reflectors;
-
-    /**
-     * @var ReflectionMethod[] $constructors
-     */
-    private $constructors;
-
-    /**
-     * @var ReflectionParameter[] $parameters
-     */
-    private $parameters;
-
-
-    /**
-     * DependencyInjector constructor
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param EEH_Array          $array_helper
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->array_helper = $array_helper;
-    }
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (! isset($this->reflectors[ $class_name ])
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
-        ) {
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
-        }
-        return $this->reflectors[ $class_name ];
-    }
-
-
-    /**
-     * getConstructor
-     * checks if a ReflectionMethod object has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param ReflectionClass $reflector
-     * @return ReflectionMethod
-     */
-    protected function getConstructor(ReflectionClass $reflector)
-    {
-        if (! isset($this->constructors[ $reflector->getName() ])
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
-        ) {
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
-        }
-        return $this->constructors[ $reflector->getName() ];
-    }
-
-
-    /**
-     * getParameters
-     * checks if an array of ReflectionParameter objects has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param ReflectionMethod $constructor
-     * @return ReflectionParameter[]
-     */
-    protected function getParameters(ReflectionMethod $constructor)
-    {
-        if (! isset($this->parameters[ $constructor->class ])) {
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
-        }
-        return $this->parameters[ $constructor->class ];
-    }
-
-
-    /**
-     * resolveDependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param RecipeInterface $recipe
-     * @param ReflectionClass $reflector
-     * @param array           $arguments
-     * @return array
-     * @throws UnexpectedValueException
-     */
-    public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
-    {
-        // if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        $resolved_parameters = array();
-        // let's examine the constructor
-        // let's examine the constructor
-        $constructor = $this->getConstructor($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->getParameters($constructor);
-        if (empty($params)) {
-            return $resolved_parameters;
-        }
-        $ingredients = $recipe->ingredients();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            if (! $param instanceof ReflectionParameter) {
-                continue;
-            }
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : '';
-            $param_name = $param->getName() ? $param->getName() : '';
-            if (// param is not a class but is specified in the list of ingredients for this Recipe
-                is_string($param_name) && isset($ingredients[ $param_name ])
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
-            } elseif (// param is specified in the list of ingredients for this Recipe
-            isset($ingredients[ $param_class ])
-            ) { // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
-            } elseif (// param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
-            } elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
-            } elseif (// parameter is type hinted as a class, and should be injected
-            ! empty($param_class)
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
-            } elseif ($param->isOptional()) {
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
-            } else {
-                $resolved_parameters[ $index ] = null;
-            }
-        }
-        return $resolved_parameters;
-    }
-
-
-    /**
-     * @param ReflectionClass $reflector
-     * @param string          $param_class
-     * @return mixed
-     * @throws UnexpectedValueException
-     */
-    private function injectDependency(ReflectionClass $reflector, $param_class)
-    {
-        $dependency = $this->coffee_pot->brew($param_class);
-        if (! $dependency instanceof $param_class) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
-                        'event_espresso'
-                    ),
-                    $param_class,
-                    $reflector->getName()
-                )
-            );
-        }
-        return $dependency;
-    }
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var EEH_Array $array_helper
+	 */
+	private $array_helper;
+
+	/**
+	 * @var ReflectionClass[] $reflectors
+	 */
+	private $reflectors;
+
+	/**
+	 * @var ReflectionMethod[] $constructors
+	 */
+	private $constructors;
+
+	/**
+	 * @var ReflectionParameter[] $parameters
+	 */
+	private $parameters;
+
+
+	/**
+	 * DependencyInjector constructor
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param EEH_Array          $array_helper
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->array_helper = $array_helper;
+	}
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (! isset($this->reflectors[ $class_name ])
+			|| ! $this->reflectors[ $class_name ] instanceof ReflectionClass
+		) {
+			$this->reflectors[ $class_name ] = new ReflectionClass($class_name);
+		}
+		return $this->reflectors[ $class_name ];
+	}
+
+
+	/**
+	 * getConstructor
+	 * checks if a ReflectionMethod object has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param ReflectionClass $reflector
+	 * @return ReflectionMethod
+	 */
+	protected function getConstructor(ReflectionClass $reflector)
+	{
+		if (! isset($this->constructors[ $reflector->getName() ])
+			|| ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
+		) {
+			$this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
+		}
+		return $this->constructors[ $reflector->getName() ];
+	}
+
+
+	/**
+	 * getParameters
+	 * checks if an array of ReflectionParameter objects has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param ReflectionMethod $constructor
+	 * @return ReflectionParameter[]
+	 */
+	protected function getParameters(ReflectionMethod $constructor)
+	{
+		if (! isset($this->parameters[ $constructor->class ])) {
+			$this->parameters[ $constructor->class ] = $constructor->getParameters();
+		}
+		return $this->parameters[ $constructor->class ];
+	}
+
+
+	/**
+	 * resolveDependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param RecipeInterface $recipe
+	 * @param ReflectionClass $reflector
+	 * @param array           $arguments
+	 * @return array
+	 * @throws UnexpectedValueException
+	 */
+	public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
+	{
+		// if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		$resolved_parameters = array();
+		// let's examine the constructor
+		// let's examine the constructor
+		$constructor = $this->getConstructor($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->getParameters($constructor);
+		if (empty($params)) {
+			return $resolved_parameters;
+		}
+		$ingredients = $recipe->ingredients();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			if (! $param instanceof ReflectionParameter) {
+				continue;
+			}
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : '';
+			$param_name = $param->getName() ? $param->getName() : '';
+			if (// param is not a class but is specified in the list of ingredients for this Recipe
+				is_string($param_name) && isset($ingredients[ $param_name ])
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[ $index ] = $ingredients[ $param_name ];
+			} elseif (// param is specified in the list of ingredients for this Recipe
+			isset($ingredients[ $param_class ])
+			) { // attempt to inject the dependency
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
+			} elseif (// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+			} elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				! empty($param_class)
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+			} elseif (// parameter is type hinted as a class, and should be injected
+			! empty($param_class)
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
+			} elseif ($param->isOptional()) {
+				$resolved_parameters[ $index ] = $param->getDefaultValue();
+			} else {
+				$resolved_parameters[ $index ] = null;
+			}
+		}
+		return $resolved_parameters;
+	}
+
+
+	/**
+	 * @param ReflectionClass $reflector
+	 * @param string          $param_class
+	 * @return mixed
+	 * @throws UnexpectedValueException
+	 */
+	private function injectDependency(ReflectionClass $reflector, $param_class)
+	{
+		$dependency = $this->coffee_pot->brew($param_class);
+		if (! $dependency instanceof $param_class) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
+						'event_espresso'
+					),
+					$param_class,
+					$reflector->getName()
+				)
+			);
+		}
+		return $dependency;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -70,12 +70,12 @@ 
      */
     public function getReflectionClass($class_name)
     {
-        if (! isset($this->reflectors[ $class_name ])
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
+        if ( ! isset($this->reflectors[$class_name])
+            || ! $this->reflectors[$class_name] instanceof ReflectionClass
         ) {
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
+            $this->reflectors[$class_name] = new ReflectionClass($class_name);
         }
-        return $this->reflectors[ $class_name ];
+        return $this->reflectors[$class_name];
     }
 
 
@@ -89,12 +89,12 @@ 
      */
     protected function getConstructor(ReflectionClass $reflector)
     {
-        if (! isset($this->constructors[ $reflector->getName() ])
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
+        if ( ! isset($this->constructors[$reflector->getName()])
+            || ! $this->constructors[$reflector->getName()] instanceof ReflectionMethod
         ) {
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
+            $this->constructors[$reflector->getName()] = $reflector->getConstructor();
         }
-        return $this->constructors[ $reflector->getName() ];
+        return $this->constructors[$reflector->getName()];
     }
 
 
@@ -108,10 +108,10 @@ 
      */
     protected function getParameters(ReflectionMethod $constructor)
     {
-        if (! isset($this->parameters[ $constructor->class ])) {
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
+        if ( ! isset($this->parameters[$constructor->class])) {
+            $this->parameters[$constructor->class] = $constructor->getParameters();
         }
-        return $this->parameters[ $constructor->class ];
+        return $this->parameters[$constructor->class];
     }
 
 
@@ -146,7 +146,7 @@ 
         // let's examine the constructor
         $constructor = $this->getConstructor($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -159,44 +159,44 @@ 
         $argument_keys = array_keys($arguments);
         // now loop thru all of the constructors expected parameters
         foreach ($params as $index => $param) {
-            if (! $param instanceof ReflectionParameter) {
+            if ( ! $param instanceof ReflectionParameter) {
                 continue;
             }
             // is this a dependency for a specific class ?
             $param_class = $param->getClass() ? $param->getClass()->name : '';
             $param_name = $param->getName() ? $param->getName() : '';
             if (// param is not a class but is specified in the list of ingredients for this Recipe
-                is_string($param_name) && isset($ingredients[ $param_name ])
+                is_string($param_name) && isset($ingredients[$param_name])
             ) {
                 // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
+                $resolved_parameters[$index] = $ingredients[$param_name];
             } elseif (// param is specified in the list of ingredients for this Recipe
-            isset($ingredients[ $param_class ])
+            isset($ingredients[$param_class])
             ) { // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $ingredients[$param_class]);
             } elseif (// param is not even a class
                 empty($param_class)
                 // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
             ) {
                 // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
             } elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
                 ! empty($param_class)
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+                && $arguments[$argument_keys[$index]] instanceof $param_class
             ) {
                 // add parameter from incoming arguments
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
             } elseif (// parameter is type hinted as a class, and should be injected
             ! empty($param_class)
             ) {
                 // attempt to inject the dependency
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $param_class);
             } elseif ($param->isOptional()) {
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
+                $resolved_parameters[$index] = $param->getDefaultValue();
             } else {
-                $resolved_parameters[ $index ] = null;
+                $resolved_parameters[$index] = null;
             }
         }
         return $resolved_parameters;
@@ -212,7 +212,7 @@ 
     private function injectDependency(ReflectionClass $reflector, $param_class)
     {
         $dependency = $this->coffee_pot->brew($param_class);
-        if (! $dependency instanceof $param_class) {
+        if ( ! $dependency instanceof $param_class) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(

core/services/container/RegistryContainer.php

Indentation +126 added lines, -126 removed lines

@@ -17,130 +17,130 @@
 class RegistryContainer implements ArrayAccess, CountableTraversableAggregate
 {
 
-    /**
-     * @var array $container
-     */
-    private $container;
-
-    /**
-     * RegistryContainer constructor.
-     * Container data can be seeded by passing parameters to constructor.
-     * Each parameter will become its own element in the container
-     */
-    public function __construct()
-    {
-        $this->container = func_get_args();
-        if (func_num_args() === 0) {
-            $this->container = array();
-        }
-    }
-
-
-    /**
-     * @param mixed $offset
-     * @param mixed $value
-     */
-    public function offsetSet($offset, $value)
-    {
-        $this->container[ $offset ] = $value;
-    }
-
-
-    /**
-     * @param mixed $offset
-     * @return bool
-     */
-    public function offsetExists($offset)
-    {
-        return isset($this->container[ $offset ]);
-    }
-
-
-    /**
-     * @param mixed $offset
-     */
-    public function offsetUnset($offset)
-    {
-        unset($this->container[ $offset ]);
-    }
-
-
-    /**
-     * @param mixed $offset
-     * @return mixed|null
-     */
-    public function offsetGet($offset)
-    {
-        return isset($this->container[ $offset ]) ? $this->container[ $offset ] : null;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->container);
-    }
-
-
-    /**
-     * @return ArrayIterator
-     */
-    public function getIterator()
-    {
-        return new ArrayIterator($this->container);
-    }
-
-
-    /**
-     * @param $offset
-     * @param $value
-     */
-    public function __set($offset, $value)
-    {
-        $this->container[ $offset ] = $value;
-    }
-
-
-    /**
-     * @param $offset
-     * @return mixed
-     * @throws OutOfBoundsException
-     */
-    public function __get($offset)
-    {
-        if (array_key_exists($offset, $this->container)) {
-            return $this->container[ $offset ];
-        }
-        $trace = debug_backtrace();
-        throw new OutOfBoundsException(
-            sprintf(
-                esc_html__('Invalid offset: %1$s %2$sCalled from %3$s on line %4$d', 'event_espresso'),
-                $offset,
-                '<br  />',
-                $trace[0]['file'],
-                $trace[0]['line']
-            )
-        );
-    }
-
-
-    /**
-     * @param $offset
-     * @return bool
-     */
-    public function __isset($offset)
-    {
-        return isset($this->container[ $offset ]);
-    }
-
-
-    /**
-     * @param $offset
-     */
-    public function __unset($offset)
-    {
-        unset($this->container[ $offset ]);
-    }
+	/**
+	 * @var array $container
+	 */
+	private $container;
+
+	/**
+	 * RegistryContainer constructor.
+	 * Container data can be seeded by passing parameters to constructor.
+	 * Each parameter will become its own element in the container
+	 */
+	public function __construct()
+	{
+		$this->container = func_get_args();
+		if (func_num_args() === 0) {
+			$this->container = array();
+		}
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 * @param mixed $value
+	 */
+	public function offsetSet($offset, $value)
+	{
+		$this->container[ $offset ] = $value;
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 * @return bool
+	 */
+	public function offsetExists($offset)
+	{
+		return isset($this->container[ $offset ]);
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 */
+	public function offsetUnset($offset)
+	{
+		unset($this->container[ $offset ]);
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 * @return mixed|null
+	 */
+	public function offsetGet($offset)
+	{
+		return isset($this->container[ $offset ]) ? $this->container[ $offset ] : null;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->container);
+	}
+
+
+	/**
+	 * @return ArrayIterator
+	 */
+	public function getIterator()
+	{
+		return new ArrayIterator($this->container);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @param $value
+	 */
+	public function __set($offset, $value)
+	{
+		$this->container[ $offset ] = $value;
+	}
+
+
+	/**
+	 * @param $offset
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 */
+	public function __get($offset)
+	{
+		if (array_key_exists($offset, $this->container)) {
+			return $this->container[ $offset ];
+		}
+		$trace = debug_backtrace();
+		throw new OutOfBoundsException(
+			sprintf(
+				esc_html__('Invalid offset: %1$s %2$sCalled from %3$s on line %4$d', 'event_espresso'),
+				$offset,
+				'<br  />',
+				$trace[0]['file'],
+				$trace[0]['line']
+			)
+		);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @return bool
+	 */
+	public function __isset($offset)
+	{
+		return isset($this->container[ $offset ]);
+	}
+
+
+	/**
+	 * @param $offset
+	 */
+	public function __unset($offset)
+	{
+		unset($this->container[ $offset ]);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -42,7 +42,7 @@ 
      */
     public function offsetSet($offset, $value)
     {
-        $this->container[ $offset ] = $value;
+        $this->container[$offset] = $value;
     }
 
 
@@ -52,7 +52,7 @@ 
      */
     public function offsetExists($offset)
     {
-        return isset($this->container[ $offset ]);
+        return isset($this->container[$offset]);
     }
 
 
@@ -61,7 +61,7 @@ 
      */
     public function offsetUnset($offset)
     {
-        unset($this->container[ $offset ]);
+        unset($this->container[$offset]);
     }
 
 
@@ -71,7 +71,7 @@ 
      */
     public function offsetGet($offset)
     {
-        return isset($this->container[ $offset ]) ? $this->container[ $offset ] : null;
+        return isset($this->container[$offset]) ? $this->container[$offset] : null;
     }
 
 
@@ -99,7 +99,7 @@ 
      */
     public function __set($offset, $value)
     {
-        $this->container[ $offset ] = $value;
+        $this->container[$offset] = $value;
     }
 
 
@@ -111,7 +111,7 @@ 
     public function __get($offset)
     {
         if (array_key_exists($offset, $this->container)) {
-            return $this->container[ $offset ];
+            return $this->container[$offset];
         }
         $trace = debug_backtrace();
         throw new OutOfBoundsException(
@@ -132,7 +132,7 @@ 
      */
     public function __isset($offset)
     {
-        return isset($this->container[ $offset ]);
+        return isset($this->container[$offset]);
     }
 
 
@@ -141,6 +141,6 @@ 
      */
     public function __unset($offset)
     {
-        unset($this->container[ $offset ]);
+        unset($this->container[$offset]);
     }
 }

core/services/container/Recipe.php

Indentation +306 added lines, -306 removed lines

@@ -19,310 +19,310 @@
 class Recipe implements RecipeInterface
 {
 
-    /**
-     * A default Recipe to use if none is specified for a class
-     */
-    const DEFAULT_ID = '*';
-
-    /**
-     * Identifier for the entity class to be constructed.
-     * Typically a Fully Qualified Class Name
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * Fully Qualified Class Name
-     *
-     * @var string $fqcn
-     */
-    private $fqcn;
-
-    /**
-     * a dependency class map array
-     * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
-     * and that class type hints for an interface, then this property allows you to configure what dependencies
-     * get used when instantiating the class.
-     * For example:
-     *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
-     *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
-     *  We want one Coffee object to use HonduranBean for its BeanInterface,
-     *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
-     *  To do this, we need to create two Recipes:
-     *      one with an identifier of 'HonduranCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'HonduranBean')
-     *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'KenyanBean')
-     *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
-     *  an instance of HonduranBean will get injected for the BeanInterface dependency,
-     *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
-     *  an instance of KenyanBean will get injected for the BeanInterface dependency
-     *
-     * @var array $ingredients
-     */
-    private $ingredients = array();
-
-    /**
-     * one of the class constants from CoffeeShop:
-     *  CoffeeMaker::BREW_NEW - creates a new instance
-     *  CoffeeMaker::BREW_SHARED - creates a shared instance
-     *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
-     *
-     * @var string $type
-     */
-    private $type;
-
-    /**
-     * class name aliases - typically a Fully Qualified Interface that the class implements
-     * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
-     *
-     * @var array $filters
-     */
-    private $filters = array();
-
-    /**
-     * array of full server filepaths to files that may contain the class
-     *
-     * @var array $paths
-     */
-    private $paths = array();
-
-
-    /**
-     * Recipe constructor.
-     *
-     * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
-     * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
-     * @param array  $ingredients   array of dependencies that can not be resolved automatically,
-     *                              used for resolving concrete classes for type hinted interfaces
-     *                              for the dependencies of THIS class
-     * @param string $type          recipe type: one of the class constants on
-     *                              \EventEspresso\core\services\container\CoffeeMaker
-     * @param array  $filters       array of class aliases, or class interfaces
-     *                              this works somewhat opposite to the $ingredients array above,
-     *                              in that this array specifies interfaces or aliases
-     *                              that this Recipe can be used for when resolving OTHER class's dependencies
-     * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
-     *                              then supply a filepath, or array of filepaths, so that it can be included
-     * @throws InvalidIdentifierException
-     * @throws RuntimeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $identifier,
-        $fqcn = '',
-        array $filters = array(),
-        array $ingredients = array(),
-        $type = CoffeeMaker::BREW_NEW,
-        array $paths = array()
-    ) {
-        $this->setIdentifier($identifier);
-        $this->setFilters($filters);
-        $this->setIngredients($ingredients);
-        $this->setType($type);
-        $this->setPaths($paths);
-        $this->setFqcn($fqcn);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function fqcn()
-    {
-        return $this->fqcn;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filters()
-    {
-        return $this->filters;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ingredients()
-    {
-        return $this->ingredients;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function paths()
-    {
-        return $this->paths;
-    }
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @throws InvalidIdentifierException
-     */
-    public function setIdentifier($identifier)
-    {
-        if (! is_string($identifier) || empty($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * Ensures incoming string is a valid Fully Qualified Class Name,
-     * except if this is the default wildcard Recipe ( * ),
-     * or it's NOT an actual FQCN because the Recipe is using filepaths
-     * for classes that are not PSR-4 compatible
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string $fqcn
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     */
-    public function setFqcn($fqcn)
-    {
-        $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if (! is_string($fqcn)) {
-            throw new InvalidDataTypeException(
-                '$fqcn',
-                is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
-                __('string (Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $fqcn = ltrim($fqcn, '\\');
-        if ($fqcn !== Recipe::DEFAULT_ID
-            && ! empty($fqcn)
-            && empty($this->paths)
-            && ! (class_exists($fqcn) || interface_exists($fqcn))
-        ) {
-            throw new InvalidClassException($fqcn);
-        }
-        $this->fqcn = $fqcn;
-    }
-
-
-    /**
-     * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
-     *                              example:
-     *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     * @throws InvalidDataTypeException
-     */
-    public function setIngredients(array $ingredients)
-    {
-        if (empty($ingredients)) {
-            return;
-        }
-        if (! is_array($ingredients)) {
-            throw new InvalidDataTypeException(
-                '$ingredients',
-                is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
-                __('array of class dependencies', 'event_espresso')
-            );
-        }
-        $this->ingredients = array_merge($this->ingredients, $ingredients);
-    }
-
-
-    /**
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
-     * @throws InvalidIdentifierException
-     */
-    public function setType($type = CoffeeMaker::BREW_NEW)
-    {
-        $this->type = CoffeeMaker::validateType($type);
-    }
-
-
-    /**
-     * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
-     *                          example:
-     *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     * @throws InvalidDataTypeException
-     */
-    public function setFilters(array $filters)
-    {
-        if (empty($filters)) {
-            return;
-        }
-        if (! is_array($filters)) {
-            throw new InvalidDataTypeException(
-                '$filters',
-                is_object($filters) ? get_class($filters) : gettype($filters),
-                __('array of class aliases', 'event_espresso')
-            );
-        }
-        $this->filters = array_merge($this->filters, $filters);
-    }
-
-
-    /**
-     * Ensures incoming paths is a valid filepath, or array of valid filepaths,
-     * and merges them in with any existing filepaths
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string|array $paths
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     */
-    public function setPaths($paths = array())
-    {
-        if (empty($paths)) {
-            return;
-        }
-        if (! (is_string($paths) || is_array($paths))) {
-            throw new InvalidDataTypeException(
-                '$path',
-                is_object($paths) ? get_class($paths) : gettype($paths),
-                __('string or array of strings (full server filepath(s))', 'event_espresso')
-            );
-        }
-        $paths = (array) $paths;
-        foreach ($paths as $path) {
-            if (strpos($path, '*') === false && ! is_readable($path)) {
-                throw new RuntimeException(
-                    sprintf(
-                        __('The following filepath is not readable: "%1$s"', 'event_espresso'),
-                        $path
-                    )
-                );
-            }
-        }
-        $this->paths = array_merge($this->paths, $paths);
-    }
+	/**
+	 * A default Recipe to use if none is specified for a class
+	 */
+	const DEFAULT_ID = '*';
+
+	/**
+	 * Identifier for the entity class to be constructed.
+	 * Typically a Fully Qualified Class Name
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * Fully Qualified Class Name
+	 *
+	 * @var string $fqcn
+	 */
+	private $fqcn;
+
+	/**
+	 * a dependency class map array
+	 * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
+	 * and that class type hints for an interface, then this property allows you to configure what dependencies
+	 * get used when instantiating the class.
+	 * For example:
+	 *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
+	 *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
+	 *  We want one Coffee object to use HonduranBean for its BeanInterface,
+	 *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
+	 *  To do this, we need to create two Recipes:
+	 *      one with an identifier of 'HonduranCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'HonduranBean')
+	 *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'KenyanBean')
+	 *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
+	 *  an instance of HonduranBean will get injected for the BeanInterface dependency,
+	 *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
+	 *  an instance of KenyanBean will get injected for the BeanInterface dependency
+	 *
+	 * @var array $ingredients
+	 */
+	private $ingredients = array();
+
+	/**
+	 * one of the class constants from CoffeeShop:
+	 *  CoffeeMaker::BREW_NEW - creates a new instance
+	 *  CoffeeMaker::BREW_SHARED - creates a shared instance
+	 *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
+	 *
+	 * @var string $type
+	 */
+	private $type;
+
+	/**
+	 * class name aliases - typically a Fully Qualified Interface that the class implements
+	 * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
+	 *
+	 * @var array $filters
+	 */
+	private $filters = array();
+
+	/**
+	 * array of full server filepaths to files that may contain the class
+	 *
+	 * @var array $paths
+	 */
+	private $paths = array();
+
+
+	/**
+	 * Recipe constructor.
+	 *
+	 * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
+	 * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
+	 * @param array  $ingredients   array of dependencies that can not be resolved automatically,
+	 *                              used for resolving concrete classes for type hinted interfaces
+	 *                              for the dependencies of THIS class
+	 * @param string $type          recipe type: one of the class constants on
+	 *                              \EventEspresso\core\services\container\CoffeeMaker
+	 * @param array  $filters       array of class aliases, or class interfaces
+	 *                              this works somewhat opposite to the $ingredients array above,
+	 *                              in that this array specifies interfaces or aliases
+	 *                              that this Recipe can be used for when resolving OTHER class's dependencies
+	 * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
+	 *                              then supply a filepath, or array of filepaths, so that it can be included
+	 * @throws InvalidIdentifierException
+	 * @throws RuntimeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$identifier,
+		$fqcn = '',
+		array $filters = array(),
+		array $ingredients = array(),
+		$type = CoffeeMaker::BREW_NEW,
+		array $paths = array()
+	) {
+		$this->setIdentifier($identifier);
+		$this->setFilters($filters);
+		$this->setIngredients($ingredients);
+		$this->setType($type);
+		$this->setPaths($paths);
+		$this->setFqcn($fqcn);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function fqcn()
+	{
+		return $this->fqcn;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filters()
+	{
+		return $this->filters;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ingredients()
+	{
+		return $this->ingredients;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function paths()
+	{
+		return $this->paths;
+	}
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @throws InvalidIdentifierException
+	 */
+	public function setIdentifier($identifier)
+	{
+		if (! is_string($identifier) || empty($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				__('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * Ensures incoming string is a valid Fully Qualified Class Name,
+	 * except if this is the default wildcard Recipe ( * ),
+	 * or it's NOT an actual FQCN because the Recipe is using filepaths
+	 * for classes that are not PSR-4 compatible
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string $fqcn
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setFqcn($fqcn)
+	{
+		$fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
+		if (! is_string($fqcn)) {
+			throw new InvalidDataTypeException(
+				'$fqcn',
+				is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
+				__('string (Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$fqcn = ltrim($fqcn, '\\');
+		if ($fqcn !== Recipe::DEFAULT_ID
+			&& ! empty($fqcn)
+			&& empty($this->paths)
+			&& ! (class_exists($fqcn) || interface_exists($fqcn))
+		) {
+			throw new InvalidClassException($fqcn);
+		}
+		$this->fqcn = $fqcn;
+	}
+
+
+	/**
+	 * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
+	 *                              example:
+	 *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 * @throws InvalidDataTypeException
+	 */
+	public function setIngredients(array $ingredients)
+	{
+		if (empty($ingredients)) {
+			return;
+		}
+		if (! is_array($ingredients)) {
+			throw new InvalidDataTypeException(
+				'$ingredients',
+				is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
+				__('array of class dependencies', 'event_espresso')
+			);
+		}
+		$this->ingredients = array_merge($this->ingredients, $ingredients);
+	}
+
+
+	/**
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
+	 * @throws InvalidIdentifierException
+	 */
+	public function setType($type = CoffeeMaker::BREW_NEW)
+	{
+		$this->type = CoffeeMaker::validateType($type);
+	}
+
+
+	/**
+	 * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
+	 *                          example:
+	 *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFilters(array $filters)
+	{
+		if (empty($filters)) {
+			return;
+		}
+		if (! is_array($filters)) {
+			throw new InvalidDataTypeException(
+				'$filters',
+				is_object($filters) ? get_class($filters) : gettype($filters),
+				__('array of class aliases', 'event_espresso')
+			);
+		}
+		$this->filters = array_merge($this->filters, $filters);
+	}
+
+
+	/**
+	 * Ensures incoming paths is a valid filepath, or array of valid filepaths,
+	 * and merges them in with any existing filepaths
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string|array $paths
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 */
+	public function setPaths($paths = array())
+	{
+		if (empty($paths)) {
+			return;
+		}
+		if (! (is_string($paths) || is_array($paths))) {
+			throw new InvalidDataTypeException(
+				'$path',
+				is_object($paths) ? get_class($paths) : gettype($paths),
+				__('string or array of strings (full server filepath(s))', 'event_espresso')
+			);
+		}
+		$paths = (array) $paths;
+		foreach ($paths as $path) {
+			if (strpos($path, '*') === false && ! is_readable($path)) {
+				throw new RuntimeException(
+					sprintf(
+						__('The following filepath is not readable: "%1$s"', 'event_espresso'),
+						$path
+					)
+				);
+			}
+		}
+		$this->paths = array_merge($this->paths, $paths);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -189,7 +189,7 @@ 
      */
     public function setIdentifier($identifier)
     {
-        if (! is_string($identifier) || empty($identifier)) {
+        if ( ! is_string($identifier) || empty($identifier)) {
             throw new InvalidIdentifierException(
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
                 __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
@@ -216,7 +216,7 @@ 
     public function setFqcn($fqcn)
     {
         $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if (! is_string($fqcn)) {
+        if ( ! is_string($fqcn)) {
             throw new InvalidDataTypeException(
                 '$fqcn',
                 is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
@@ -246,7 +246,7 @@ 
         if (empty($ingredients)) {
             return;
         }
-        if (! is_array($ingredients)) {
+        if ( ! is_array($ingredients)) {
             throw new InvalidDataTypeException(
                 '$ingredients',
                 is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
@@ -278,7 +278,7 @@ 
         if (empty($filters)) {
             return;
         }
-        if (! is_array($filters)) {
+        if ( ! is_array($filters)) {
             throw new InvalidDataTypeException(
                 '$filters',
                 is_object($filters) ? get_class($filters) : gettype($filters),
@@ -305,7 +305,7 @@ 
         if (empty($paths)) {
             return;
         }
-        if (! (is_string($paths) || is_array($paths))) {
+        if ( ! (is_string($paths) || is_array($paths))) {
             throw new InvalidDataTypeException(
                 '$path',
                 is_object($paths) ? get_class($paths) : gettype($paths),

core/services/shortcodes/LegacyShortcodesManager.php

Indentation +405 added lines, -405 removed lines

@@ -21,409 +21,409 @@
 class LegacyShortcodesManager
 {
 
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-    /**
-     * LegacyShortcodesManager constructor.
-     *
-     * @param \EE_Registry $registry
-     */
-    public function __construct(EE_Registry $registry)
-    {
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function registry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * registerShortcodes
-     *
-     * @return void
-     */
-    public function registerShortcodes()
-    {
-        $this->registry->shortcodes = $this->getShortcodes();
-    }
-
-
-    /**
-     * getShortcodes
-     *
-     * @return array
-     */
-    public function getShortcodes()
-    {
-        // previously this method would glob the shortcodes directory
-        // then filter that list of shortcodes to register,
-        // but now we are going to just supply an empty array.
-        // this allows any shortcodes that have not yet been converted to the new system
-        // to still get loaded and processed, albeit using the same legacy logic as before
-        $shortcodes_to_register = apply_filters(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array()
-        );
-        if (! empty($shortcodes_to_register)) {
-            // cycle thru shortcode folders
-            foreach ($shortcodes_to_register as $shortcode_path) {
-                // add to list of installed shortcode modules
-                $this->registerShortcode($shortcode_path);
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
-            ! empty($this->registry->shortcodes)
-                ? $this->registry->shortcodes
-                : array()
-        );
-    }
-
-
-    /**
-     *    register_shortcode - makes core aware of this shortcode
-     *
-     * @access    public
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public function registerShortcode($shortcode_path = null)
-    {
-        do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
-        $shortcode_ext = '.shortcode.php';
-        // make all separators match
-        $shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($shortcode_path, $shortcode_ext) !== false) {
-            // grab shortcode file name from directory name and break apart at dots
-            $shortcode_file = explode('.', basename($shortcode_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $shortcode = strpos($shortcode_file[0], 'EES_') === 0
-                ? substr($shortcode_file[0], 4)
-                : $shortcode_file[0];
-            // sanitize shortcode directory name
-            $shortcode = sanitize_key($shortcode);
-            // now we need to rebuild the shortcode path
-            $shortcode_path = explode(DS, $shortcode_path);
-            // remove last segment
-            array_pop($shortcode_path);
-            // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize shortcode directory name
-            $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
-        }
-        // create classname from shortcode directory or file name
-        $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
-        // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
-        // does the shortcode exist ?
-        if (! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
-                    'event_espresso'
-                ),
-                $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
-        // verify that class exists
-        if (! class_exists($shortcode_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
-                $shortcode_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $shortcode = strtoupper($shortcode);
-        // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
-        return true;
-    }
-
-
-    /**
-     *    _initialize_shortcodes
-     *    allow shortcodes to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        // cycle thru shortcode folders
-        foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
-            // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($shortcode_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($shortcode_class, 'set_hooks')
-                );
-                // convert classname to UPPERCASE and create WP shortcode.
-                $shortcode_tag = strtoupper($shortcode);
-                // but first check if the shortcode has already
-                // been added before assigning 'fallback_shortcode_processor'
-                if (! shortcode_exists($shortcode_tag)) {
-                    // NOTE: this shortcode declaration will get overridden if the shortcode
-                    // is successfully detected in the post content in initializeShortcode()
-                    add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
-                }
-            }
-        }
-    }
-
-
-    /**
-     * callback for the WP "get_header" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @param \WP_Query $wp_query
-     * @return void
-     */
-    public function initializeShortcodes(WP_Query $wp_query)
-    {
-        if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
-            return;
-        }
-        global $wp;
-        /** @var EE_Front_controller $Front_Controller */
-        $Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
-        $Front_Controller->Request_Handler()->set_request_vars();
-        // grab post_name from request
-        $current_post = apply_filters(
-            'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
-            $Front_Controller->Request_Handler()->get('post_name')
-        );
-        $show_on_front = get_option('show_on_front');
-        // if it's not set, then check if frontpage is blog
-        if (empty($current_post)) {
-            // yup.. this is the posts page, prepare to load all shortcode modules
-            $current_post = 'posts';
-            // unless..
-            if ($show_on_front === 'page') {
-                // some other page is set as the homepage
-                $page_on_front = get_option('page_on_front');
-                if ($page_on_front) {
-                    // k now we need to find the post_name for this page
-                    global $wpdb;
-                    $page_on_front = $wpdb->get_var(
-                        $wpdb->prepare(
-                            "SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
-                            $page_on_front
-                        )
-                    );
-                    // set the current post slug to what it actually is
-                    $current_post = $page_on_front ? $page_on_front : $current_post;
-                }
-            }
-        }
-        // in case $current_post is hierarchical like: /parent-page/current-page
-        $current_post = basename($current_post);
-        if (// is current page/post the "blog" page ?
-            $current_post === EE_Config::get_page_for_posts()
-            // or are we on a category page?
-            || (
-                is_array(term_exists($current_post, 'category'))
-                || array_key_exists('category_name', $wp->query_vars)
-            )
-        ) {
-            // initialize all legacy shortcodes
-            $load_assets = $this->parseContentForShortcodes('', true);
-        } else {
-            global $wpdb;
-            $post_content = $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
-                    $current_post
-                )
-            );
-            $load_assets = $this->parseContentForShortcodes($post_content);
-        }
-        if ($load_assets) {
-            $this->registry->REQ->set_espresso_page(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
-    }
-
-
-    /**
-     * checks supplied content against list of legacy shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
-     * @return bool
-     */
-    public function parseContentForShortcodes($content = '', $load_all = false)
-    {
-        $has_shortcode = false;
-        foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class)) {
-                // load up the shortcode
-                $this->initializeShortcode($shortcode_class);
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
-
-
-    /**
-     * given a shortcode name, will instantiate the shortcode and call it's run() method
-     *
-     * @param string $shortcode_class
-     * @param WP     $wp
-     */
-    public function initializeShortcode($shortcode_class = '', WP $wp = null)
-    {
-        // don't do anything if shortcode is already initialized
-        if (empty($this->registry->shortcodes->{$shortcode_class})
-            || ! is_string($this->registry->shortcodes->{$shortcode_class})
-        ) {
-            return;
-        }
-        // let's pause to reflect on this...
-        $sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
-        // ensure that class is actually a shortcode
-        if (defined('WP_DEBUG')
-            && WP_DEBUG === true
-            && ! $sc_reflector->isSubclassOf('EES_Shortcode')
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
-                        'event_espresso'
-                    ),
-                    $shortcode_class
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            add_filter('FHEE_run_EE_the_content', '__return_true');
-            return;
-        }
-        global $wp;
-        // and pass the request object to the run method
-        $this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
-        // fire the shortcode class's run method, so that it can activate resources
-        $this->registry->shortcodes->{$shortcode_class}->run($wp);
-    }
-
-
-    /**
-     * get classname, remove EES_prefix, and convert to UPPERCASE
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function generateShortcodeTagFromClassName($class_name)
-    {
-        return strtoupper(str_replace('EES_', '', $class_name));
-    }
-
-
-    /**
-     * add EES_prefix and Capitalize words
-     *
-     * @param string $tag
-     * @return string
-     */
-    public static function generateShortcodeClassNameFromTag($tag)
-    {
-        // order of operation runs from inside to out
-        // 5) maybe add prefix
-        return LegacyShortcodesManager::addShortcodeClassPrefix(
-            // 4) find spaces, replace with underscores
-            str_replace(
-                ' ',
-                '_',
-                // 3) capitalize first letter of each word
-                ucwords(
-                    // 2) also change to lowercase so ucwords() will work
-                    strtolower(
-                        // 1) find underscores, replace with spaces so ucwords() will work
-                        str_replace(
-                            '_',
-                            ' ',
-                            $tag
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * maybe add EES_prefix
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function addShortcodeClassPrefix($class_name)
-    {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getEspressoShortcodeTags()
-    {
-        static $shortcode_tags = array();
-        if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array) $this->registry->shortcodes);
-        }
-        return $shortcode_tags;
-    }
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    public function doShortcode($content)
-    {
-        foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
-            if (strpos($content, $shortcode_tag) !== false) {
-                $shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
-                $this->initializeShortcode($shortcode_class);
-            }
-        }
-        return do_shortcode($content);
-    }
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+	/**
+	 * LegacyShortcodesManager constructor.
+	 *
+	 * @param \EE_Registry $registry
+	 */
+	public function __construct(EE_Registry $registry)
+	{
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function registry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * registerShortcodes
+	 *
+	 * @return void
+	 */
+	public function registerShortcodes()
+	{
+		$this->registry->shortcodes = $this->getShortcodes();
+	}
+
+
+	/**
+	 * getShortcodes
+	 *
+	 * @return array
+	 */
+	public function getShortcodes()
+	{
+		// previously this method would glob the shortcodes directory
+		// then filter that list of shortcodes to register,
+		// but now we are going to just supply an empty array.
+		// this allows any shortcodes that have not yet been converted to the new system
+		// to still get loaded and processed, albeit using the same legacy logic as before
+		$shortcodes_to_register = apply_filters(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array()
+		);
+		if (! empty($shortcodes_to_register)) {
+			// cycle thru shortcode folders
+			foreach ($shortcodes_to_register as $shortcode_path) {
+				// add to list of installed shortcode modules
+				$this->registerShortcode($shortcode_path);
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
+			! empty($this->registry->shortcodes)
+				? $this->registry->shortcodes
+				: array()
+		);
+	}
+
+
+	/**
+	 *    register_shortcode - makes core aware of this shortcode
+	 *
+	 * @access    public
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public function registerShortcode($shortcode_path = null)
+	{
+		do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
+		$shortcode_ext = '.shortcode.php';
+		// make all separators match
+		$shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($shortcode_path, $shortcode_ext) !== false) {
+			// grab shortcode file name from directory name and break apart at dots
+			$shortcode_file = explode('.', basename($shortcode_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$shortcode = strpos($shortcode_file[0], 'EES_') === 0
+				? substr($shortcode_file[0], 4)
+				: $shortcode_file[0];
+			// sanitize shortcode directory name
+			$shortcode = sanitize_key($shortcode);
+			// now we need to rebuild the shortcode path
+			$shortcode_path = explode(DS, $shortcode_path);
+			// remove last segment
+			array_pop($shortcode_path);
+			// glue it back together
+			$shortcode_path = implode(DS, $shortcode_path) . DS;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize shortcode directory name
+			$shortcode = sanitize_key(basename($shortcode_path));
+			$shortcode_path = rtrim($shortcode_path, DS) . DS;
+		}
+		// create classname from shortcode directory or file name
+		$shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
+		// add class prefix
+		$shortcode_class = 'EES_' . $shortcode;
+		// does the shortcode exist ?
+		if (! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
+					'event_espresso'
+				),
+				$shortcode_class,
+				$shortcode_path . DS . $shortcode_class . $shortcode_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the shortcode class file
+		require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+		// verify that class exists
+		if (! class_exists($shortcode_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
+				$shortcode_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$shortcode = strtoupper($shortcode);
+		// add to array of registered shortcodes
+		$this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_shortcodes
+	 *    allow shortcodes to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		// cycle thru shortcode folders
+		foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
+			// add class prefix
+			$shortcode_class = 'EES_' . $shortcode;
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($shortcode_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($shortcode_class, 'set_hooks')
+				);
+				// convert classname to UPPERCASE and create WP shortcode.
+				$shortcode_tag = strtoupper($shortcode);
+				// but first check if the shortcode has already
+				// been added before assigning 'fallback_shortcode_processor'
+				if (! shortcode_exists($shortcode_tag)) {
+					// NOTE: this shortcode declaration will get overridden if the shortcode
+					// is successfully detected in the post content in initializeShortcode()
+					add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * callback for the WP "get_header" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @param \WP_Query $wp_query
+	 * @return void
+	 */
+	public function initializeShortcodes(WP_Query $wp_query)
+	{
+		if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
+			return;
+		}
+		global $wp;
+		/** @var EE_Front_controller $Front_Controller */
+		$Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
+		$Front_Controller->Request_Handler()->set_request_vars();
+		// grab post_name from request
+		$current_post = apply_filters(
+			'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
+			$Front_Controller->Request_Handler()->get('post_name')
+		);
+		$show_on_front = get_option('show_on_front');
+		// if it's not set, then check if frontpage is blog
+		if (empty($current_post)) {
+			// yup.. this is the posts page, prepare to load all shortcode modules
+			$current_post = 'posts';
+			// unless..
+			if ($show_on_front === 'page') {
+				// some other page is set as the homepage
+				$page_on_front = get_option('page_on_front');
+				if ($page_on_front) {
+					// k now we need to find the post_name for this page
+					global $wpdb;
+					$page_on_front = $wpdb->get_var(
+						$wpdb->prepare(
+							"SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
+							$page_on_front
+						)
+					);
+					// set the current post slug to what it actually is
+					$current_post = $page_on_front ? $page_on_front : $current_post;
+				}
+			}
+		}
+		// in case $current_post is hierarchical like: /parent-page/current-page
+		$current_post = basename($current_post);
+		if (// is current page/post the "blog" page ?
+			$current_post === EE_Config::get_page_for_posts()
+			// or are we on a category page?
+			|| (
+				is_array(term_exists($current_post, 'category'))
+				|| array_key_exists('category_name', $wp->query_vars)
+			)
+		) {
+			// initialize all legacy shortcodes
+			$load_assets = $this->parseContentForShortcodes('', true);
+		} else {
+			global $wpdb;
+			$post_content = $wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
+					$current_post
+				)
+			);
+			$load_assets = $this->parseContentForShortcodes($post_content);
+		}
+		if ($load_assets) {
+			$this->registry->REQ->set_espresso_page(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
+	}
+
+
+	/**
+	 * checks supplied content against list of legacy shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content = '', $load_all = false)
+	{
+		$has_shortcode = false;
+		foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
+			if ($load_all || has_shortcode($content, $shortcode_class)) {
+				// load up the shortcode
+				$this->initializeShortcode($shortcode_class);
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
+
+
+	/**
+	 * given a shortcode name, will instantiate the shortcode and call it's run() method
+	 *
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 */
+	public function initializeShortcode($shortcode_class = '', WP $wp = null)
+	{
+		// don't do anything if shortcode is already initialized
+		if (empty($this->registry->shortcodes->{$shortcode_class})
+			|| ! is_string($this->registry->shortcodes->{$shortcode_class})
+		) {
+			return;
+		}
+		// let's pause to reflect on this...
+		$sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
+		// ensure that class is actually a shortcode
+		if (defined('WP_DEBUG')
+			&& WP_DEBUG === true
+			&& ! $sc_reflector->isSubclassOf('EES_Shortcode')
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
+						'event_espresso'
+					),
+					$shortcode_class
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			add_filter('FHEE_run_EE_the_content', '__return_true');
+			return;
+		}
+		global $wp;
+		// and pass the request object to the run method
+		$this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
+		// fire the shortcode class's run method, so that it can activate resources
+		$this->registry->shortcodes->{$shortcode_class}->run($wp);
+	}
+
+
+	/**
+	 * get classname, remove EES_prefix, and convert to UPPERCASE
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function generateShortcodeTagFromClassName($class_name)
+	{
+		return strtoupper(str_replace('EES_', '', $class_name));
+	}
+
+
+	/**
+	 * add EES_prefix and Capitalize words
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public static function generateShortcodeClassNameFromTag($tag)
+	{
+		// order of operation runs from inside to out
+		// 5) maybe add prefix
+		return LegacyShortcodesManager::addShortcodeClassPrefix(
+			// 4) find spaces, replace with underscores
+			str_replace(
+				' ',
+				'_',
+				// 3) capitalize first letter of each word
+				ucwords(
+					// 2) also change to lowercase so ucwords() will work
+					strtolower(
+						// 1) find underscores, replace with spaces so ucwords() will work
+						str_replace(
+							'_',
+							' ',
+							$tag
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * maybe add EES_prefix
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function addShortcodeClassPrefix($class_name)
+	{
+		return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getEspressoShortcodeTags()
+	{
+		static $shortcode_tags = array();
+		if (empty($shortcode_tags)) {
+			$shortcode_tags = array_keys((array) $this->registry->shortcodes);
+		}
+		return $shortcode_tags;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	public function doShortcode($content)
+	{
+		foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
+			if (strpos($content, $shortcode_tag) !== false) {
+				$shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
+				$this->initializeShortcode($shortcode_class);
+			}
+		}
+		return do_shortcode($content);
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -74,7 +74,7 @@ 
             'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
             array()
         );
-        if (! empty($shortcodes_to_register)) {
+        if ( ! empty($shortcodes_to_register)) {
             // cycle thru shortcode folders
             foreach ($shortcodes_to_register as $shortcode_path) {
                 // add to list of installed shortcode modules
@@ -119,44 +119,44 @@ 
             // remove last segment
             array_pop($shortcode_path);
             // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
+            $shortcode_path = implode(DS, $shortcode_path).DS;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize shortcode directory name
             $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
+            $shortcode_path = rtrim($shortcode_path, DS).DS;
         }
         // create classname from shortcode directory or file name
         $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
         // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
+        $shortcode_class = 'EES_'.$shortcode;
         // does the shortcode exist ?
-        if (! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+        if ( ! is_readable($shortcode_path.DS.$shortcode_class.$shortcode_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
                     'event_espresso'
                 ),
                 $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
+                $shortcode_path.DS.$shortcode_class.$shortcode_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+        require_once($shortcode_path.$shortcode_class.$shortcode_ext);
         // verify that class exists
-        if (! class_exists($shortcode_class)) {
+        if ( ! class_exists($shortcode_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
                 $shortcode_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $shortcode = strtoupper($shortcode);
         // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+        $this->registry->shortcodes->{$shortcode} = $shortcode_path.$shortcode_class.$shortcode_ext;
         return true;
     }
 
@@ -173,7 +173,7 @@ 
         // cycle thru shortcode folders
         foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
             // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
+            $shortcode_class = 'EES_'.$shortcode;
             // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
             // which set hooks ?
             if (is_admin()) {
@@ -189,7 +189,7 @@ 
                 $shortcode_tag = strtoupper($shortcode);
                 // but first check if the shortcode has already
                 // been added before assigning 'fallback_shortcode_processor'
-                if (! shortcode_exists($shortcode_tag)) {
+                if ( ! shortcode_exists($shortcode_tag)) {
                     // NOTE: this shortcode declaration will get overridden if the shortcode
                     // is successfully detected in the post content in initializeShortcode()
                     add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
@@ -395,7 +395,7 @@ 
      */
     public static function addShortcodeClassPrefix($class_name)
     {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_'.$class_name;
     }
 
 

core/services/formatters/Windows1252.php

Indentation +30 added lines, -30 removed lines

@@ -17,34 +17,34 @@
 class Windows1252 extends FormatterBase
 {
 
-    /**
-     * Converts the string to windows-1252 encoding.
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input)
-    {
-        // in case an int or float etc was passed in
-        $input = (string) $input;
-        if (function_exists('iconv')) {
-            $input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
-        } elseif (WP_DEBUG) {
-            trigger_error(
-                sprintf(
-                // @codingStandardsIgnoreStart
-                    esc_html__(
-                        '%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',
-                        'event_espresso'
-                    ),
-                    // @codingStandardsIgnoreEnd
-                    get_class($this),
-                    $input,
-                    'iconv',
-                    '<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
-                )
-            );
-        }
-        return $input;
-    }
+	/**
+	 * Converts the string to windows-1252 encoding.
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input)
+	{
+		// in case an int or float etc was passed in
+		$input = (string) $input;
+		if (function_exists('iconv')) {
+			$input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
+		} elseif (WP_DEBUG) {
+			trigger_error(
+				sprintf(
+				// @codingStandardsIgnoreStart
+					esc_html__(
+						'%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',
+						'event_espresso'
+					),
+					// @codingStandardsIgnoreEnd
+					get_class($this),
+					$input,
+					'iconv',
+					'<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
+				)
+			);
+		}
+		return $input;
+	}
 }

core/services/collections/CollectionDetails.php

Spacing +9 added lines, -9 removed lines

@@ -192,7 +192,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -220,7 +220,7 @@ 
      */
     protected function setCollectionName($collection_name)
     {
-        if (! is_string($collection_name)) {
+        if ( ! is_string($collection_name)) {
             throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
         }
         $this->collection_name = str_replace(
@@ -248,7 +248,7 @@ 
      */
     protected function setIdentifierType($identifier_type)
     {
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+        if ( ! ($identifier_type === CollectionDetails::ID_CLASS_NAME
                || $identifier_type === CollectionDetails::ID_OBJECT_HASH
                || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
         )) {
@@ -278,7 +278,7 @@ 
      */
     protected function setIdentifierCallback($identifier_callback = 'identifier')
     {
-        if (! is_string($identifier_callback)) {
+        if ( ! is_string($identifier_callback)) {
             throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
         }
         $this->identifier_callback = $identifier_callback;
@@ -308,7 +308,7 @@ 
         $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
         // we know our default is a string, so if it's not a string now,
         // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
+        if ( ! is_string($this->file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
         }
     }
@@ -333,7 +333,7 @@ 
     public function setCollectionFQCNs($collection_FQCNs)
     {
         foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
+            if ( ! empty($collection_FQCN)) {
                 if (class_exists($collection_FQCN)) {
                     $this->collection_FQCNs[] = $collection_FQCN;
                 } else {
@@ -355,7 +355,7 @@ 
      */
     protected function getFQCNsFromPartialNamespace($partial_FQCN)
     {
-        if (! $this->file_locator instanceof FqcnLocator) {
+        if ( ! $this->file_locator instanceof FqcnLocator) {
             $this->file_locator = new FqcnLocator();
         }
         $this->file_locator->locate($partial_FQCN);
@@ -381,8 +381,8 @@ 
     public function setCollectionPaths($collection_paths)
     {
         foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
+            if ( ! empty($collection_path)) {
+                if ( ! is_readable($collection_path)) {
                     throw new InvalidFilePathException($collection_path);
                 }
                 $this->collection_paths[] = $collection_path;

Indentation +347 added lines, -347 removed lines

@@ -43,351 +43,351 @@
 class CollectionDetails implements CollectionDetailsInterface
 {
 
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's spl_object_hash() as it's identifier
-     */
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's class name as it's identifier
-     */
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use the return value from a specified callback method on each object
-     */
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
-
-    /**
-     * The interface used for controlling what gets added to the collection
-     *
-     * @var string $collection_interface
-     */
-    protected $collection_interface = '';
-
-    /**
-     * a unique name used to identify the collection in filter names
-     * supplied value is run through sanitize_title_with_dashes(),
-     * but then also converts dashes to underscores
-     *
-     * @var string $collection_name
-     */
-    protected $collection_name = '';
-
-    /**
-     * what the collection uses for the object identifier.
-     * corresponds to one of the class constants above.
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
-     *
-     * @var string $identifier_type
-     */
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
-
-    /**
-     * the pattern applied to paths when searching for class files to add to the collection
-     * ie: "My_Awesome_*.class.php"
-     * defaults to "*.php"
-     *
-     * @var string $file_mask
-     */
-    protected $file_mask = '';
-
-    /**
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
-     * then this specifies the method to use on each entity.
-     * If the callback method does not exist, then an exception will be thrown
-     *
-     * @var string $identifier_callback
-     */
-    protected $identifier_callback = '';
-
-    /**
-     * an array of Fully Qualified Class Names
-     *  for example:
-     *  $FQCNs = array(
-     *      '/Fully/Qualified/ClassNameA'
-     *      '/Fully/Qualified/Other/ClassNameB'
-     *  );
-     *
-     * @var array $collection_FQCNs
-     */
-    protected $collection_FQCNs = array();
-
-    /**
-     * an array of full server paths to folders containing files to be loaded into collection
-     *  for example:
-     *  $paths = array(
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
-     *  );
-     *
-     * @var array $collection_paths
-     */
-    protected $collection_paths = array();
-
-    /**
-     * @var LocatorInterface $file_locator
-     */
-    protected $file_locator;
-
-
-    /**
-     * CollectionDetails constructor.
-     *
-     * @access public
-     * @param string           $collection_name
-     * @param string           $collection_interface
-     * @param array            $collection_FQCNs
-     * @param array            $collection_paths
-     * @param string           $file_mask
-     * @param string           $identifier_type
-     * @param string           $identifier_callback
-     * @param LocatorInterface $file_locator
-     * @throws CollectionDetailsException
-     */
-    public function __construct(
-        $collection_name,
-        $collection_interface,
-        array $collection_FQCNs = array(),
-        array $collection_paths = array(),
-        $file_mask = '',
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
-        $identifier_callback = '',
-        LocatorInterface $file_locator = null
-    ) {
-        try {
-            $this->setCollectionName($collection_name);
-            $this->setCollectionInterface($collection_interface);
-            $this->setCollectionFQCNs($collection_FQCNs);
-            $this->setCollectionPaths($collection_paths);
-            $this->setFileMasks($file_mask);
-            $this->setIdentifierType($identifier_type);
-            $this->setIdentifierCallback($identifier_callback);
-            $this->file_locator = $file_locator;
-        } catch (Exception $exception) {
-            throw new CollectionDetailsException($exception);
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return mixed
-     */
-    public function getCollectionInterface()
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * the collection name will be used for creating dynamic filters
-     *
-     * @access public
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * sanitizes collection name and converts spaces and dashes to underscores
-     *
-     * @access protected
-     * @param string $collection_name
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setCollectionName($collection_name)
-    {
-        if (! is_string($collection_name)) {
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
-        }
-        $this->collection_name = str_replace(
-            '-',
-            '_',
-            sanitize_title_with_dashes($collection_name, '', 'save')
-        );
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType()
-    {
-        return $this->identifier_type;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_type
-     * @throws InvalidIdentifierException
-     */
-    protected function setIdentifierType($identifier_type)
-    {
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
-        )) {
-            throw new InvalidIdentifierException(
-                $identifier_type,
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
-            );
-        }
-        $this->identifier_type = $identifier_type;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback()
-    {
-        return $this->identifier_callback;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_callback
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
-    {
-        if (! is_string($identifier_callback)) {
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
-        }
-        $this->identifier_callback = $identifier_callback;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask()
-    {
-        return $this->file_mask;
-    }
-
-
-    /**
-     * sets the file mask which is then used to filter what files get loaded
-     * when searching for classes to add to the collection. Defaults to '*.php'
-     *
-     * @access protected
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setFileMasks($file_mask)
-    {
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
-        // we know our default is a string, so if it's not a string now,
-        // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionFQCNs()
-    {
-        return $this->collection_FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_FQCNs
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setCollectionFQCNs($collection_FQCNs)
-    {
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
-                if (class_exists($collection_FQCN)) {
-                    $this->collection_FQCNs[] = $collection_FQCN;
-                } else {
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
-                        $this->collection_FQCNs[] = $FQCN;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $partial_FQCN
-     * @return array
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
-    {
-        if (! $this->file_locator instanceof FqcnLocator) {
-            $this->file_locator = new FqcnLocator();
-        }
-        $this->file_locator->locate($partial_FQCN);
-        return $this->file_locator->getFQCNs();
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionPaths()
-    {
-        return $this->collection_paths;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_paths
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     */
-    public function setCollectionPaths($collection_paths)
-    {
-        foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
-                    throw new InvalidFilePathException($collection_path);
-                }
-                $this->collection_paths[] = $collection_path;
-            }
-        }
-    }
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's spl_object_hash() as it's identifier
+	 */
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's class name as it's identifier
+	 */
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use the return value from a specified callback method on each object
+	 */
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
+
+	/**
+	 * The interface used for controlling what gets added to the collection
+	 *
+	 * @var string $collection_interface
+	 */
+	protected $collection_interface = '';
+
+	/**
+	 * a unique name used to identify the collection in filter names
+	 * supplied value is run through sanitize_title_with_dashes(),
+	 * but then also converts dashes to underscores
+	 *
+	 * @var string $collection_name
+	 */
+	protected $collection_name = '';
+
+	/**
+	 * what the collection uses for the object identifier.
+	 * corresponds to one of the class constants above.
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
+	 *
+	 * @var string $identifier_type
+	 */
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
+
+	/**
+	 * the pattern applied to paths when searching for class files to add to the collection
+	 * ie: "My_Awesome_*.class.php"
+	 * defaults to "*.php"
+	 *
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '';
+
+	/**
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
+	 * then this specifies the method to use on each entity.
+	 * If the callback method does not exist, then an exception will be thrown
+	 *
+	 * @var string $identifier_callback
+	 */
+	protected $identifier_callback = '';
+
+	/**
+	 * an array of Fully Qualified Class Names
+	 *  for example:
+	 *  $FQCNs = array(
+	 *      '/Fully/Qualified/ClassNameA'
+	 *      '/Fully/Qualified/Other/ClassNameB'
+	 *  );
+	 *
+	 * @var array $collection_FQCNs
+	 */
+	protected $collection_FQCNs = array();
+
+	/**
+	 * an array of full server paths to folders containing files to be loaded into collection
+	 *  for example:
+	 *  $paths = array(
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
+	 *  );
+	 *
+	 * @var array $collection_paths
+	 */
+	protected $collection_paths = array();
+
+	/**
+	 * @var LocatorInterface $file_locator
+	 */
+	protected $file_locator;
+
+
+	/**
+	 * CollectionDetails constructor.
+	 *
+	 * @access public
+	 * @param string           $collection_name
+	 * @param string           $collection_interface
+	 * @param array            $collection_FQCNs
+	 * @param array            $collection_paths
+	 * @param string           $file_mask
+	 * @param string           $identifier_type
+	 * @param string           $identifier_callback
+	 * @param LocatorInterface $file_locator
+	 * @throws CollectionDetailsException
+	 */
+	public function __construct(
+		$collection_name,
+		$collection_interface,
+		array $collection_FQCNs = array(),
+		array $collection_paths = array(),
+		$file_mask = '',
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
+		$identifier_callback = '',
+		LocatorInterface $file_locator = null
+	) {
+		try {
+			$this->setCollectionName($collection_name);
+			$this->setCollectionInterface($collection_interface);
+			$this->setCollectionFQCNs($collection_FQCNs);
+			$this->setCollectionPaths($collection_paths);
+			$this->setFileMasks($file_mask);
+			$this->setIdentifierType($identifier_type);
+			$this->setIdentifierCallback($identifier_callback);
+			$this->file_locator = $file_locator;
+		} catch (Exception $exception) {
+			throw new CollectionDetailsException($exception);
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return mixed
+	 */
+	public function getCollectionInterface()
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * the collection name will be used for creating dynamic filters
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * sanitizes collection name and converts spaces and dashes to underscores
+	 *
+	 * @access protected
+	 * @param string $collection_name
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		if (! is_string($collection_name)) {
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
+		}
+		$this->collection_name = str_replace(
+			'-',
+			'_',
+			sanitize_title_with_dashes($collection_name, '', 'save')
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType()
+	{
+		return $this->identifier_type;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_type
+	 * @throws InvalidIdentifierException
+	 */
+	protected function setIdentifierType($identifier_type)
+	{
+		if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
+		)) {
+			throw new InvalidIdentifierException(
+				$identifier_type,
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
+			);
+		}
+		$this->identifier_type = $identifier_type;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback()
+	{
+		return $this->identifier_callback;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_callback
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
+	{
+		if (! is_string($identifier_callback)) {
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
+		}
+		$this->identifier_callback = $identifier_callback;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask()
+	{
+		return $this->file_mask;
+	}
+
+
+	/**
+	 * sets the file mask which is then used to filter what files get loaded
+	 * when searching for classes to add to the collection. Defaults to '*.php'
+	 *
+	 * @access protected
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setFileMasks($file_mask)
+	{
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
+		// we know our default is a string, so if it's not a string now,
+		// then that means the incoming parameter was something else
+		if (! is_string($this->file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionFQCNs()
+	{
+		return $this->collection_FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_FQCNs
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setCollectionFQCNs($collection_FQCNs)
+	{
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
+			if (! empty($collection_FQCN)) {
+				if (class_exists($collection_FQCN)) {
+					$this->collection_FQCNs[] = $collection_FQCN;
+				} else {
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
+						$this->collection_FQCNs[] = $FQCN;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $partial_FQCN
+	 * @return array
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
+	{
+		if (! $this->file_locator instanceof FqcnLocator) {
+			$this->file_locator = new FqcnLocator();
+		}
+		$this->file_locator->locate($partial_FQCN);
+		return $this->file_locator->getFQCNs();
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionPaths()
+	{
+		return $this->collection_paths;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_paths
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 */
+	public function setCollectionPaths($collection_paths)
+	{
+		foreach ((array) $collection_paths as $collection_path) {
+			if (! empty($collection_path)) {
+				if (! is_readable($collection_path)) {
+					throw new InvalidFilePathException($collection_path);
+				}
+				$this->collection_paths[] = $collection_path;
+			}
+		}
+	}
 }

core/services/licensing/LicenseService.php

Indentation +90 added lines, -90 removed lines

@@ -15,94 +15,94 @@
  */
 class LicenseService
 {
-    /**
-     * @var Config
-     */
-    private $config;
-
-
-    /**
-     * @var Stats
-     */
-    private $stats_collection;
-
-    public function __construct(Stats $stats_collection, Config $config)
-    {
-        $this->config = $config;
-        $this->stats_collection = $stats_collection;
-        $this->loadPueClient();
-    }
-
-    private function loadPueClient()
-    {
-        // PUE Auto Upgrades stuff
-        if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { // include the file
-            require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
-
-            // $options needs to be an array with the included keys as listed.
-            $options = array(
-                // 'optionName' => '', //(optional) - used as the reference for saving update information in the
-                // clients options table.  Will be automatically set if left blank.
-                'apikey'                => $this->config->siteLicenseKey(),
-                // (required), you will need to obtain the apikey that the client gets from your site and
-                // then saves in their sites options table (see 'getting an api-key' below)
-                'lang_domain'           => $this->config->i18nDomain(),
-                // (optional) - put here whatever reference you are using for the localization of your plugin (if it's
-                // localized).  That way strings in this file will be included in the translation for your plugin.
-                'checkPeriod'           => $this->config->checkPeriod(),
-                // (optional) - use this parameter to indicate how often you want the client's install to ping your
-                // server for update checks.  The integer indicates hours.  If you don't include this parameter it will
-                // default to 12 hours.
-                'option_key'            => $this->config->optionKey(),
-                // this is what is used to reference the api_key in your plugin options.  PUE uses this to trigger
-                // updating your information message whenever this option_key is modified.
-                'options_page_slug'     => $this->config->optionsPageSlug(),
-                'plugin_basename'       => EE_PLUGIN_BASENAME,
-                'use_wp_update'         => true,
-                // if TRUE then you want FREE versions of the plugin to be updated from WP
-                'extra_stats'           => $this->stats_collection->statsCallback(),
-                'turn_on_notices_saved' => true,
-            );
-            // initiate the class and start the plugin update engine!
-            new PluginUpdateEngineChecker(
-                $this->config->hostServerUrl(),
-                $this->config->pluginSlug(),
-                $options
-            );
-        }
-    }
-
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     */
-    public static function isUpdateAvailable($basename = '')
-    {
-        $basename = ! empty($basename) ? $basename : EE_PLUGIN_BASENAME;
-
-        $update = false;
-
-        // should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
-        $folder = DS . dirname($basename);
-
-        $plugins = get_plugins($folder);
-        $current = get_site_transient('update_plugins');
-
-        foreach ((array) $plugins as $plugin_file => $plugin_data) {
-            if (isset($current->response['plugin_file'])) {
-                $update = true;
-            }
-        }
-
-        // it's possible that there is an update but an invalid site-license-key is in use
-        if (get_site_option('pue_json_error_' . $basename)) {
-            $update = true;
-        }
-
-        return $update;
-    }
+	/**
+	 * @var Config
+	 */
+	private $config;
+
+
+	/**
+	 * @var Stats
+	 */
+	private $stats_collection;
+
+	public function __construct(Stats $stats_collection, Config $config)
+	{
+		$this->config = $config;
+		$this->stats_collection = $stats_collection;
+		$this->loadPueClient();
+	}
+
+	private function loadPueClient()
+	{
+		// PUE Auto Upgrades stuff
+		if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { // include the file
+			require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
+
+			// $options needs to be an array with the included keys as listed.
+			$options = array(
+				// 'optionName' => '', //(optional) - used as the reference for saving update information in the
+				// clients options table.  Will be automatically set if left blank.
+				'apikey'                => $this->config->siteLicenseKey(),
+				// (required), you will need to obtain the apikey that the client gets from your site and
+				// then saves in their sites options table (see 'getting an api-key' below)
+				'lang_domain'           => $this->config->i18nDomain(),
+				// (optional) - put here whatever reference you are using for the localization of your plugin (if it's
+				// localized).  That way strings in this file will be included in the translation for your plugin.
+				'checkPeriod'           => $this->config->checkPeriod(),
+				// (optional) - use this parameter to indicate how often you want the client's install to ping your
+				// server for update checks.  The integer indicates hours.  If you don't include this parameter it will
+				// default to 12 hours.
+				'option_key'            => $this->config->optionKey(),
+				// this is what is used to reference the api_key in your plugin options.  PUE uses this to trigger
+				// updating your information message whenever this option_key is modified.
+				'options_page_slug'     => $this->config->optionsPageSlug(),
+				'plugin_basename'       => EE_PLUGIN_BASENAME,
+				'use_wp_update'         => true,
+				// if TRUE then you want FREE versions of the plugin to be updated from WP
+				'extra_stats'           => $this->stats_collection->statsCallback(),
+				'turn_on_notices_saved' => true,
+			);
+			// initiate the class and start the plugin update engine!
+			new PluginUpdateEngineChecker(
+				$this->config->hostServerUrl(),
+				$this->config->pluginSlug(),
+				$options
+			);
+		}
+	}
+
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 */
+	public static function isUpdateAvailable($basename = '')
+	{
+		$basename = ! empty($basename) ? $basename : EE_PLUGIN_BASENAME;
+
+		$update = false;
+
+		// should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
+		$folder = DS . dirname($basename);
+
+		$plugins = get_plugins($folder);
+		$current = get_site_transient('update_plugins');
+
+		foreach ((array) $plugins as $plugin_file => $plugin_data) {
+			if (isset($current->response['plugin_file'])) {
+				$update = true;
+			}
+		}
+
+		// it's possible that there is an update but an invalid site-license-key is in use
+		if (get_site_option('pue_json_error_' . $basename)) {
+			$update = true;
+		}
+
+		return $update;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -36,8 +36,8 @@ 
     private function loadPueClient()
     {
         // PUE Auto Upgrades stuff
-        if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { // include the file
-            require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
+        if (is_readable(EE_THIRD_PARTY.'pue/pue-client.php')) { // include the file
+            require_once(EE_THIRD_PARTY.'pue/pue-client.php');
 
             // $options needs to be an array with the included keys as listed.
             $options = array(
@@ -87,7 +87,7 @@ 
         $update = false;
 
         // should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
-        $folder = DS . dirname($basename);
+        $folder = DS.dirname($basename);
 
         $plugins = get_plugins($folder);
         $current = get_site_transient('update_plugins');
@@ -99,7 +99,7 @@ 
         }
 
         // it's possible that there is an update but an invalid site-license-key is in use
-        if (get_site_option('pue_json_error_' . $basename)) {
+        if (get_site_option('pue_json_error_'.$basename)) {
             $update = true;
         }
 

core/services/request/Request.php

Spacing +14 added lines, -14 removed lines

@@ -163,7 +163,7 @@ 
             || ($key === 'ee' && empty($this->request['ee']))
             || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
         ) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -254,10 +254,10 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === 'value') {
-                    return $request_params[ $key ];
+                    return $request_params[$key];
                 }
                 // or actual key or true just to indicate it was found
                 return $return === 'key' ? $key : true;
@@ -314,29 +314,29 @@ 
                 $key = $real_key ? $real_key : $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->requestParameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -349,9 +349,9 @@ 
      */
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
-        unset($this->request[ $key ]);
+        unset($this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
+            unset($_REQUEST[$key]);
         }
     }
 
@@ -385,8 +385,8 @@ 
             'REMOTE_ADDR',
         );
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+            if (isset($this->server[$key])) {
+                foreach (array_map('trim', explode(',', $this->server[$key])) as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;
                     }

Doc Comments +2 added lines, -2 removed lines

@@ -174,7 +174,7 @@ 
      *
      * @param       $key
      * @param null  $default
-     * @return mixed
+     * @return integer
      */
     public function getRequestParam($key, $default = null)
     {
@@ -287,7 +287,7 @@ 
      * would return true if default parameters were set
      *
      * @param string $callback
-     * @param        $key
+     * @param        string $key
      * @param null   $default
      * @param array  $request_params
      * @return bool|mixed|null

Indentation +592 added lines, -592 removed lines

@@ -17,596 +17,596 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-    /**
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server)
-    {
-        // grab request vars
-        $this->get = $get;
-        $this->post = $post;
-        $this->cookie = $cookie;
-        $this->server = $server;
-        $this->request = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return mixed
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function requestUri()
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        return $request_uri;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $user_agent;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressApi()
-    {
-        return $this->request_type->isWordPressApi();
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+	/**
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server)
+	{
+		// grab request vars
+		$this->get = $get;
+		$this->post = $post;
+		$this->cookie = $cookie;
+		$this->server = $server;
+		$this->request = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return mixed
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function requestUri()
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		return $request_uri;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $user_agent;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressApi()
+	{
+		return $this->request_type->isWordPressApi();
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 }