eventespresso / event-espresso-core

caffeinated/modules/recaptcha/ReCaptcha/Response.php

Indentation +61 added lines, -61 removed lines

@@ -28,74 +28,74 @@
  */
 class Response
 {
-    /**
-     * Succes or failure.
-     *
-     * @var boolean
-     */
-    private $success = false;
+	/**
+	 * Succes or failure.
+	 *
+	 * @var boolean
+	 */
+	private $success = false;
 
-    /**
-     * Error code strings.
-     *
-     * @var array
-     */
-    private $errorCodes = array();
+	/**
+	 * Error code strings.
+	 *
+	 * @var array
+	 */
+	private $errorCodes = array();
 
-    /**
-     * Build the response from the expected JSON returned by the service.
-     *
-     * @param string $json
-     * @return \ReCaptcha\Response
-     */
-    public static function fromJson($json)
-    {
-        $responseData = json_decode($json, true);
+	/**
+	 * Build the response from the expected JSON returned by the service.
+	 *
+	 * @param string $json
+	 * @return \ReCaptcha\Response
+	 */
+	public static function fromJson($json)
+	{
+		$responseData = json_decode($json, true);
 
-        if (! $responseData) {
-            return new Response(false, array('invalid-json'));
-        }
+		if (! $responseData) {
+			return new Response(false, array('invalid-json'));
+		}
 
-        if (isset($responseData['success']) && $responseData['success'] == true) {
-            return new Response(true);
-        }
+		if (isset($responseData['success']) && $responseData['success'] == true) {
+			return new Response(true);
+		}
 
-        if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
-            return new Response(false, $responseData['error-codes']);
-        }
+		if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
+			return new Response(false, $responseData['error-codes']);
+		}
 
-        return new Response(false);
-    }
+		return new Response(false);
+	}
 
-    /**
-     * Constructor.
-     *
-     * @param boolean $success
-     * @param array   $errorCodes
-     */
-    public function __construct($success, array $errorCodes = array())
-    {
-        $this->success = $success;
-        $this->errorCodes = $errorCodes;
-    }
+	/**
+	 * Constructor.
+	 *
+	 * @param boolean $success
+	 * @param array   $errorCodes
+	 */
+	public function __construct($success, array $errorCodes = array())
+	{
+		$this->success = $success;
+		$this->errorCodes = $errorCodes;
+	}
 
-    /**
-     * Is success?
-     *
-     * @return boolean
-     */
-    public function isSuccess()
-    {
-        return $this->success;
-    }
+	/**
+	 * Is success?
+	 *
+	 * @return boolean
+	 */
+	public function isSuccess()
+	{
+		return $this->success;
+	}
 
-    /**
-     * Get error codes.
-     *
-     * @return array
-     */
-    public function getErrorCodes()
-    {
-        return $this->errorCodes;
-    }
+	/**
+	 * Get error codes.
+	 *
+	 * @return array
+	 */
+	public function getErrorCodes()
+	{
+		return $this->errorCodes;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
     {
         $responseData = json_decode($json, true);
 
-        if (! $responseData) {
+        if ( ! $responseData) {
             return new Response(false, array('invalid-json'));
         }
 

core/services/cache/PostRelatedCacheManager.php

Indentation +117 added lines, -117 removed lines

@@ -13,121 +13,121 @@
 class PostRelatedCacheManager extends BasicCacheManager
 {
 
-    /**
-     * @type string
-     */
-    const POST_CACHE_PREFIX = 'ee_cache_post_';
-
-    /**
-     * wp-option option_name for tracking post related cache
-     *
-     * @type string
-     */
-    const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
-
-
-    /**
-     * PostRelatedCacheManager constructor.
-     *
-     * @param CacheStorageInterface $cache_storage
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        parent::__construct($cache_storage);
-        add_action('save_post', array($this, 'clearPostRelatedCache'));
-    }
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return PostRelatedCacheManager::POST_CACHE_PREFIX;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function getPostRelatedCache()
-    {
-        $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
-        // verify that cached data was not truncated or corrupted and no longer an array
-        if (! is_array($post_related_cache)) {
-            // uh-oh... let's get rid of any transients using our cache prefix
-            $this->clear(PostRelatedCacheManager::CACHE_PREFIX);
-            // then update the post related cache tracking option
-            $post_related_cache = array();
-            $this->updatePostRelatedCache($post_related_cache);
-        }
-        return $post_related_cache;
-    }
-
-
-    /**
-     * @param array $post_related_cache
-     */
-    protected function updatePostRelatedCache(array $post_related_cache = array())
-    {
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
-    }
-
-
-    /**
-     * If you are caching content that pertains to a Post of any type,
-     * then it is recommended to pass the post id and cache id prefix to this method
-     * so that it can be added to the post related cache tracking.
-     * Then, whenever that post is updated, the cache will automatically be deleted,
-     * which helps to ensure that outdated cache content will not be served
-     *
-     * @param int    $post_ID    [required]
-     * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     */
-    public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
-    {
-        $post_related_cache = $this->getPostRelatedCache();
-        // if post is not already being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
-            // add array to add cache ids to
-            $post_related_cache[ $post_ID ] = array();
-        }
-        if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
-            // add cache id to be tracked
-            $post_related_cache[ $post_ID ][] = $id_prefix;
-            $this->updatePostRelatedCache($post_related_cache);
-        }
-    }
-
-
-    /**
-     * callback hooked into the WordPress "save_post" action
-     * deletes any cache content associated with the post
-     *
-     * @param int $post_ID [required]
-     */
-    public function clearPostRelatedCache($post_ID)
-    {
-        $post_related_cache = $this->getPostRelatedCache();
-        // if post is not being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
-            // let's clean up some of the duplicate IDs that were getting added
-            foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
-                // remove duplicates
-                $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
-            }
-            $this->updatePostRelatedCache($post_related_cache);
-            return;
-        }
-        // get cache id prefixes for post, and delete their corresponding transients
-        $this->clear($post_related_cache[ $post_ID ]);
-        unset($post_related_cache[ $post_ID ]);
-        $this->updatePostRelatedCache($post_related_cache);
-    }
+	/**
+	 * @type string
+	 */
+	const POST_CACHE_PREFIX = 'ee_cache_post_';
+
+	/**
+	 * wp-option option_name for tracking post related cache
+	 *
+	 * @type string
+	 */
+	const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
+
+
+	/**
+	 * PostRelatedCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		parent::__construct($cache_storage);
+		add_action('save_post', array($this, 'clearPostRelatedCache'));
+	}
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return PostRelatedCacheManager::POST_CACHE_PREFIX;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function getPostRelatedCache()
+	{
+		$post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
+		// verify that cached data was not truncated or corrupted and no longer an array
+		if (! is_array($post_related_cache)) {
+			// uh-oh... let's get rid of any transients using our cache prefix
+			$this->clear(PostRelatedCacheManager::CACHE_PREFIX);
+			// then update the post related cache tracking option
+			$post_related_cache = array();
+			$this->updatePostRelatedCache($post_related_cache);
+		}
+		return $post_related_cache;
+	}
+
+
+	/**
+	 * @param array $post_related_cache
+	 */
+	protected function updatePostRelatedCache(array $post_related_cache = array())
+	{
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
+	}
+
+
+	/**
+	 * If you are caching content that pertains to a Post of any type,
+	 * then it is recommended to pass the post id and cache id prefix to this method
+	 * so that it can be added to the post related cache tracking.
+	 * Then, whenever that post is updated, the cache will automatically be deleted,
+	 * which helps to ensure that outdated cache content will not be served
+	 *
+	 * @param int    $post_ID    [required]
+	 * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 */
+	public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
+	{
+		$post_related_cache = $this->getPostRelatedCache();
+		// if post is not already being tracked
+		if (! isset($post_related_cache[ $post_ID ])) {
+			// add array to add cache ids to
+			$post_related_cache[ $post_ID ] = array();
+		}
+		if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
+			// add cache id to be tracked
+			$post_related_cache[ $post_ID ][] = $id_prefix;
+			$this->updatePostRelatedCache($post_related_cache);
+		}
+	}
+
+
+	/**
+	 * callback hooked into the WordPress "save_post" action
+	 * deletes any cache content associated with the post
+	 *
+	 * @param int $post_ID [required]
+	 */
+	public function clearPostRelatedCache($post_ID)
+	{
+		$post_related_cache = $this->getPostRelatedCache();
+		// if post is not being tracked
+		if (! isset($post_related_cache[ $post_ID ])) {
+			// let's clean up some of the duplicate IDs that were getting added
+			foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
+				// remove duplicates
+				$post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
+			}
+			$this->updatePostRelatedCache($post_related_cache);
+			return;
+		}
+		// get cache id prefixes for post, and delete their corresponding transients
+		$this->clear($post_related_cache[ $post_ID ]);
+		unset($post_related_cache[ $post_ID ]);
+		$this->updatePostRelatedCache($post_related_cache);
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -56,7 +56,7 @@ 
     {
         $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
         // verify that cached data was not truncated or corrupted and no longer an array
-        if (! is_array($post_related_cache)) {
+        if ( ! is_array($post_related_cache)) {
             // uh-oh... let's get rid of any transients using our cache prefix
             $this->clear(PostRelatedCacheManager::CACHE_PREFIX);
             // then update the post related cache tracking option
@@ -94,13 +94,13 @@ 
     {
         $post_related_cache = $this->getPostRelatedCache();
         // if post is not already being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
+        if ( ! isset($post_related_cache[$post_ID])) {
             // add array to add cache ids to
-            $post_related_cache[ $post_ID ] = array();
+            $post_related_cache[$post_ID] = array();
         }
-        if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
+        if ( ! in_array($id_prefix, $post_related_cache[$post_ID], true)) {
             // add cache id to be tracked
-            $post_related_cache[ $post_ID ][] = $id_prefix;
+            $post_related_cache[$post_ID][] = $id_prefix;
             $this->updatePostRelatedCache($post_related_cache);
         }
     }
@@ -116,18 +116,18 @@ 
     {
         $post_related_cache = $this->getPostRelatedCache();
         // if post is not being tracked
-        if (! isset($post_related_cache[ $post_ID ])) {
+        if ( ! isset($post_related_cache[$post_ID])) {
             // let's clean up some of the duplicate IDs that were getting added
             foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
                 // remove duplicates
-                $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
+                $post_related_cache[$other_post_ID] = array_unique($post_related_cache[$other_post_ID]);
             }
             $this->updatePostRelatedCache($post_related_cache);
             return;
         }
         // get cache id prefixes for post, and delete their corresponding transients
-        $this->clear($post_related_cache[ $post_ID ]);
-        unset($post_related_cache[ $post_ID ]);
+        $this->clear($post_related_cache[$post_ID]);
+        unset($post_related_cache[$post_ID]);
         $this->updatePostRelatedCache($post_related_cache);
     }
 }

core/services/Benchmark.php

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)];
     }
 
 

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;
-            return '';
-        }
-        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;
+			return '';
+		}
+		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);
+	}
 }

core/services/formatters/AsciiOnly.php

Indentation +52 added lines, -52 removed lines

@@ -15,58 +15,58 @@
 class AsciiOnly extends FormatterBase
 {
 
-    /**
-     * Removes all non Ascii characters from string
-     *
-     * @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;
-        $input = $this->convertAscii($input);
-        return $input;
-    }
+	/**
+	 * Removes all non Ascii characters from string
+	 *
+	 * @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;
+		$input = $this->convertAscii($input);
+		return $input;
+	}
 
 
-    /**
-     * Taken from https://gist.github.com/jaywilliams/119517
-     *
-     * @param $string
-     * @return string
-     */
-    protected function convertAscii($string)
-    {
-        // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
-        $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
-        $replace[] = "'";
-        // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
-        $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
-        $replace[] = '"';
-        // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
-        $replace[] = '--';
-        // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
-        $replace[] = '---';
-        // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
-        $replace[] = '*';
-        // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
-        $replace[] = '*';
-        // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
-        $replace[] = '...';
-        // Apply Replacements
-        $string = str_replace($search, $replace, $string);
-        // Remove any non-ASCII Characters
-        $string = preg_replace("/[^\x01-\x7F]/", "", $string);
-        return $string;
-    }
+	/**
+	 * Taken from https://gist.github.com/jaywilliams/119517
+	 *
+	 * @param $string
+	 * @return string
+	 */
+	protected function convertAscii($string)
+	{
+		// Replace Single Curly Quotes
+		$search[] = chr(226) . chr(128) . chr(152);
+		$replace[] = "'";
+		$search[] = chr(226) . chr(128) . chr(153);
+		$replace[] = "'";
+		// Replace Smart Double Curly Quotes
+		$search[] = chr(226) . chr(128) . chr(156);
+		$replace[] = '"';
+		$search[] = chr(226) . chr(128) . chr(157);
+		$replace[] = '"';
+		// Replace En Dash
+		$search[] = chr(226) . chr(128) . chr(147);
+		$replace[] = '--';
+		// Replace Em Dash
+		$search[] = chr(226) . chr(128) . chr(148);
+		$replace[] = '---';
+		// Replace Bullet
+		$search[] = chr(226) . chr(128) . chr(162);
+		$replace[] = '*';
+		// Replace Middle Dot
+		$search[] = chr(194) . chr(183);
+		$replace[] = '*';
+		// Replace Ellipsis with three consecutive dots
+		$search[] = chr(226) . chr(128) . chr(166);
+		$replace[] = '...';
+		// Apply Replacements
+		$string = str_replace($search, $replace, $string);
+		// Remove any non-ASCII Characters
+		$string = preg_replace("/[^\x01-\x7F]/", "", $string);
+		return $string;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -39,29 +39,29 @@
     protected function convertAscii($string)
     {
         // Replace Single Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(152);
+        $search[] = chr(226).chr(128).chr(152);
         $replace[] = "'";
-        $search[] = chr(226) . chr(128) . chr(153);
+        $search[] = chr(226).chr(128).chr(153);
         $replace[] = "'";
         // Replace Smart Double Curly Quotes
-        $search[] = chr(226) . chr(128) . chr(156);
+        $search[] = chr(226).chr(128).chr(156);
         $replace[] = '"';
-        $search[] = chr(226) . chr(128) . chr(157);
+        $search[] = chr(226).chr(128).chr(157);
         $replace[] = '"';
         // Replace En Dash
-        $search[] = chr(226) . chr(128) . chr(147);
+        $search[] = chr(226).chr(128).chr(147);
         $replace[] = '--';
         // Replace Em Dash
-        $search[] = chr(226) . chr(128) . chr(148);
+        $search[] = chr(226).chr(128).chr(148);
         $replace[] = '---';
         // Replace Bullet
-        $search[] = chr(226) . chr(128) . chr(162);
+        $search[] = chr(226).chr(128).chr(162);
         $replace[] = '*';
         // Replace Middle Dot
-        $search[] = chr(194) . chr(183);
+        $search[] = chr(194).chr(183);
         $replace[] = '*';
         // Replace Ellipsis with three consecutive dots
-        $search[] = chr(226) . chr(128) . chr(166);
+        $search[] = chr(226).chr(128).chr(166);
         $replace[] = '...';
         // Apply Replacements
         $string = str_replace($search, $replace, $string);

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/address/formatters/MultiLineAddressFormatter.php

Indentation +35 added lines, -35 removed lines

@@ -15,39 +15,39 @@
 {
 
 
-    /**
-     * @param string $address
-     * @param string $address2
-     * @param string $city
-     * @param string $state
-     * @param string $zip
-     * @param string $country
-     * @param string $CNT_ISO
-     * @return string
-     */
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
-    {
-        $address_formats = apply_filters(
-            'FHEE__EE_MultiLine_Address_Formatter__address_formats',
-            array(
-                'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}",
-                'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-            )
-        );
-        // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
-            : $address_formats['ZZ'];
-        return $this->parse_formatted_address(
-            $address,
-            $address2,
-            $city,
-            $state,
-            $zip,
-            $country,
-            $formatted_address,
-            '<br />'
-        );
-    }
+	/**
+	 * @param string $address
+	 * @param string $address2
+	 * @param string $city
+	 * @param string $state
+	 * @param string $zip
+	 * @param string $country
+	 * @param string $CNT_ISO
+	 * @return string
+	 */
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
+	{
+		$address_formats = apply_filters(
+			'FHEE__EE_MultiLine_Address_Formatter__address_formats',
+			array(
+				'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}",
+				'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+			)
+		);
+		// if the incoming country has a set format, use that, else use the default
+		$formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+			: $address_formats['ZZ'];
+		return $this->parse_formatted_address(
+			$address,
+			$address2,
+			$city,
+			$state,
+			$zip,
+			$country,
+			$formatted_address,
+			'<br />'
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
             )
         );
         // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+        $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO]
             : $address_formats['ZZ'];
         return $this->parse_formatted_address(
             $address,

core/services/address/formatters/InlineAddressFormatter.php

Indentation +35 added lines, -35 removed lines

@@ -14,39 +14,39 @@
 class InlineAddressFormatter extends AddressFormatter implements \EEI_Address_Formatter
 {
 
-    /**
-     * @param string $address
-     * @param string $address2
-     * @param string $city
-     * @param string $state
-     * @param string $zip
-     * @param string $country
-     * @param string $CNT_ISO
-     * @return string
-     */
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
-    {
-        $address_formats = apply_filters(
-            'FHEE__EE_Inline_Address_Formatter__address_formats',
-            array(
-                'CA'  => "{address}%{address2}%{city}%{state}%{country}%{zip}",
-                'GB'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'US'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-            )
-        );
-        // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
-            : $address_formats['ZZZ'];
-        return $this->parse_formatted_address(
-            $address,
-            $address2,
-            $city,
-            $state,
-            $zip,
-            $country,
-            $formatted_address,
-            ', '
-        );
-    }
+	/**
+	 * @param string $address
+	 * @param string $address2
+	 * @param string $city
+	 * @param string $state
+	 * @param string $zip
+	 * @param string $country
+	 * @param string $CNT_ISO
+	 * @return string
+	 */
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
+	{
+		$address_formats = apply_filters(
+			'FHEE__EE_Inline_Address_Formatter__address_formats',
+			array(
+				'CA'  => "{address}%{address2}%{city}%{state}%{country}%{zip}",
+				'GB'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'US'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+			)
+		);
+		// if the incoming country has a set format, use that, else use the default
+		$formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+			: $address_formats['ZZZ'];
+		return $this->parse_formatted_address(
+			$address,
+			$address2,
+			$city,
+			$state,
+			$zip,
+			$country,
+			$formatted_address,
+			', '
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
             )
         );
         // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+        $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO]
             : $address_formats['ZZZ'];
         return $this->parse_formatted_address(
             $address,

core/services/locators/FileLocator.php

Indentation +73 added lines, -73 removed lines

@@ -17,88 +17,88 @@
 class FileLocator extends Locator
 {
 
-    /**
-     * @var string $file_mask
-     */
-    protected $file_mask = '*.php';
+	/**
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '*.php';
 
-    /**
-     * @var array $filepaths
-     */
-    protected $filepaths = array();
+	/**
+	 * @var array $filepaths
+	 */
+	protected $filepaths = array();
 
 
-    /**
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setFileMask($file_mask)
-    {
-        if (! is_string($file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
-        }
-        $this->file_mask = $file_mask;
-    }
+	/**
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setFileMask($file_mask)
+	{
+		if (! is_string($file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
+		}
+		$this->file_mask = $file_mask;
+	}
 
 
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFilePaths()
-    {
-        return $this->filepaths;
-    }
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFilePaths()
+	{
+		return $this->filepaths;
+	}
 
 
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->filepaths);
-    }
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->filepaths);
+	}
 
 
-    /**
-     * given a path to a valid directory, or an array of valid paths,
-     * will find all files that match the provided mask
-     *
-     * @access public
-     * @param array|string $directory_paths
-     * @return \FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($directory_paths)
-    {
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
-            throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
-        }
-        foreach ((array) $directory_paths as $directory_path) {
-            foreach ($this->findFilesByPath($directory_path) as $key => $file) {
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
-            }
-        }
-        return $this->filepaths;
-    }
+	/**
+	 * given a path to a valid directory, or an array of valid paths,
+	 * will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param array|string $directory_paths
+	 * @return \FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($directory_paths)
+	{
+		if (! (is_string($directory_paths) || is_array($directory_paths))) {
+			throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
+		}
+		foreach ((array) $directory_paths as $directory_path) {
+			foreach ($this->findFilesByPath($directory_path) as $key => $file) {
+				$this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
+			}
+		}
+		return $this->filepaths;
+	}
 
 
-    /**
-     * given a path to a valid directory, will find all files that match the provided mask
-     *
-     * @access protected
-     * @param string $directory_path
-     * @return \FilesystemIterator
-     */
-    protected function findFilesByPath($directory_path = '')
-    {
-        $iterator = new GlobIterator(
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        return $iterator;
-    }
+	/**
+	 * given a path to a valid directory, will find all files that match the provided mask
+	 *
+	 * @access protected
+	 * @param string $directory_path
+	 * @return \FilesystemIterator
+	 */
+	protected function findFilesByPath($directory_path = '')
+	{
+		$iterator = new GlobIterator(
+			\EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		return $iterator;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function setFileMask($file_mask)
     {
-        if (! is_string($file_mask)) {
+        if ( ! is_string($file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
         }
         $this->file_mask = $file_mask;
@@ -72,12 +72,12 @@ 
      */
     public function locate($directory_paths)
     {
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
+        if ( ! (is_string($directory_paths) || is_array($directory_paths))) {
             throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
         }
         foreach ((array) $directory_paths as $directory_path) {
             foreach ($this->findFilesByPath($directory_path) as $key => $file) {
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
+                $this->filepaths[$key] = \EEH_File::standardise_directory_separators($file);
             }
         }
         return $this->filepaths;
@@ -94,7 +94,7 @@ 
     protected function findFilesByPath($directory_path = '')
     {
         $iterator = new GlobIterator(
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
+            \EEH_File::end_with_directory_separator($directory_path).$this->file_mask
         );
         foreach ($this->flags as $flag) {
             $iterator->setFlags($flag);

core/services/database/TableManager.php

Spacing +8 added lines, -8 removed lines

@@ -65,7 +65,7 @@ 
         global $wpdb;
         $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
+        if ( ! in_array($column_name, $columns)) {
             $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
             return $wpdb->query($alter_query);
         }
@@ -86,7 +86,7 @@ 
         global $wpdb;
         $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
         $field_array = array();
-        if (! empty($table_name)) {
+        if ( ! empty($table_name)) {
             $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
             if ($columns !== false) {
                 foreach ($columns as $column) {
@@ -132,14 +132,14 @@ 
         foreach ($table_names as $table_name) {
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
+                $tables_to_delete[$table_name] = $table_name;
             }
         }
-        if (! empty($tables_to_delete)) {
+        if ( ! empty($tables_to_delete)) {
             global $wpdb;
             // make sure we only have a unique strings in the array.
             $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+            $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
         }
         return $tables_to_delete;
     }
@@ -189,7 +189,7 @@ 
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             /** @var \wpdb $wpdb */
             global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} ".$wpdb->get_charset_collate();
 
             // get $wpdb to echo errors, but buffer them. This way at least WE know an error
             // happened. And then we can choose to tell the end user
@@ -201,7 +201,7 @@ 
             ob_end_clean();
             $wpdb->show_errors($old_show_errors_policy);
             $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
+            if ( ! empty($output)) {
                 throw new \EE_Error($output);
             }
         } else {
@@ -242,7 +242,7 @@ 
         if ($column_name === null) {
             $column_name = $index_name;
         }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
+        if ( ! $this->getTableAnalysis()->tableExists($table_name)) {
             return false;
         }
         $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);

Indentation +234 added lines, -234 removed lines

@@ -13,257 +13,257 @@
 class TableManager extends \EE_Base
 {
 
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private $table_analysis;
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private $table_analysis;
 
 
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
 
 
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function getTableAnalysis()
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function getTableAnalysis()
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     */
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 */
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns = $this->getTableColumns($table_name);
+		if (! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return array
-     */
-    public function getTableColumns($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = array();
-        if (! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return array
+	 */
+	public function getTableColumns($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = array();
+		if (! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
 
 
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return int
-     */
-    public function dropTable($table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return int
+	 */
+	public function dropTable($table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public function dropTables($table_names)
-    {
-        $tables_to_delete = array();
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
-            }
-        }
-        if (! empty($tables_to_delete)) {
-            global $wpdb;
-            // make sure we only have a unique strings in the array.
-            $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public function dropTables($table_names)
+	{
+		$tables_to_delete = array();
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[ $table_name ] = $table_name;
+			}
+		}
+		if (! empty($tables_to_delete)) {
+			global $wpdb;
+			// make sure we only have a unique strings in the array.
+			$tables_to_delete = array_unique($tables_to_delete);
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
 
 
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @param string $index_name
-     * @return int the number of indexes dropped. False if there was a datbase error
-     */
-    public function dropIndex($table_name, $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return 0;
-        }
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
-        if (
-            $this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name // using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int the number of indexes dropped. False if there was a datbase error
+	 */
+	public function dropIndex($table_name, $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return 0;
+		}
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
+		if (
+			$this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name // using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
-    {
-        $engine = apply_filters(
-            'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
-            $engine,
-            $table_name,
-            $create_sql
-        );
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var \wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
+	{
+		$engine = apply_filters(
+			'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
+			$engine,
+			$table_name,
+			$create_sql
+		);
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var \wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
 
-            // get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            // happened. And then we can choose to tell the end user
-            $old_show_errors_policy = $wpdb->show_errors(true);
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
-                throw new \EE_Error($output);
-            }
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+			// get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			// happened. And then we can choose to tell the end user
+			$old_show_errors_policy = $wpdb->show_errors(true);
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if (! empty($output)) {
+				throw new \EE_Error($output);
+			}
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					esc_html__(
+						'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Drops the specified index if it's size differs from $desired_index_size.
-     * WordPress' dbdelta method doesn't automatically change index sizes, so this
-     * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
-     * If the table doesn't exist, or it exists but the index does not, or returns false
-     *
-     * @param string     $table_name
-     * @param string     $index_name
-     * @param string     $column_name        if none is provided, we assume the column name matches the index (often
-     *                                       true in EE)
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
-     * @return bool whether an index was dropped or not
-     * @throws /EE_Error if table analysis object isn't defined
-     */
-    public function dropIndexIfSizeNot(
-        $table_name,
-        $index_name,
-        $column_name = null,
-        $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
-    ) {
-        if ($column_name === null) {
-            $column_name = $index_name;
-        }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
-            return false;
-        }
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
-        if (empty($index_entries)) {
-            return false;
-        }
-        foreach ($index_entries as $index_entry) {
-            if (
-                $column_name === $index_entry->Column_name
-                && (string) $desired_index_size !== $index_entry->Sub_part
-            ) {
-                return $this->dropIndex($table_name, $index_name);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Drops the specified index if it's size differs from $desired_index_size.
+	 * WordPress' dbdelta method doesn't automatically change index sizes, so this
+	 * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
+	 *
+	 * @param string     $table_name
+	 * @param string     $index_name
+	 * @param string     $column_name        if none is provided, we assume the column name matches the index (often
+	 *                                       true in EE)
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
+	 * @return bool whether an index was dropped or not
+	 * @throws /EE_Error if table analysis object isn't defined
+	 */
+	public function dropIndexIfSizeNot(
+		$table_name,
+		$index_name,
+		$column_name = null,
+		$desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
+	) {
+		if ($column_name === null) {
+			$column_name = $index_name;
+		}
+		if (! $this->getTableAnalysis()->tableExists($table_name)) {
+			return false;
+		}
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
+		if (empty($index_entries)) {
+			return false;
+		}
+		foreach ($index_entries as $index_entry) {
+			if (
+				$column_name === $index_entry->Column_name
+				&& (string) $desired_index_size !== $index_entry->Sub_part
+			) {
+				return $this->dropIndex($table_name, $index_name);
+			}
+		}
+		return false;
+	}
 }