eventespresso / event-espresso-core

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/cache/TransientCacheStorage.php

Indentation +362 added lines, -362 removed lines

@@ -16,366 +16,366 @@
 class TransientCacheStorage implements CacheStorageInterface
 {
 
-    /**
-     * wp-option option_name for tracking transients
-     *
-     * @type string
-     */
-    const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
-
-    /**
-     * @var int $current_time
-     */
-    private $current_time;
-
-    /**
-     * how often to perform transient cleanup
-     *
-     * @var string $transient_cleanup_frequency
-     */
-    private $transient_cleanup_frequency;
-
-    /**
-     * options for how often to perform transient cleanup
-     *
-     * @var array $transient_cleanup_frequency_options
-     */
-    private $transient_cleanup_frequency_options = array();
-
-    /**
-     * @var array $transients
-     */
-    private $transients;
-
-
-    /**
-     * TransientCacheStorage constructor.
-     */
-    public function __construct()
-    {
-        $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
-        // round current time down to closest 5 minutes to simplify scheduling
-        $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
-        $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
-            add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
-        }
-    }
-
-
-    /**
-     * Sets how often transient cleanup occurs
-     *
-     * @return string
-     */
-    private function setTransientCleanupFrequency()
-    {
-        // sets how often transients are cleaned up
-        $this->transient_cleanup_frequency_options = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
-            array(
-                'off',
-                '15-minutes',
-                'hour',
-                '12-hours',
-                'day',
-            )
-        );
-        $transient_cleanup_frequency = apply_filters(
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule',
-            'hour'
-        );
-        return in_array(
-            $transient_cleanup_frequency,
-            $this->transient_cleanup_frequency_options,
-            true
-        )
-            ? $transient_cleanup_frequency
-            : 'hour';
-    }
-
-
-    /**
-     * we need to be able to round timestamps off to match the set transient cleanup frequency
-     * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
-     * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
-     * during the next scheduled cleanup after its expiration.
-     * We also round off the current time timestamp to the closest 5 minutes
-     * just to make the timestamps a little easier to round which helps with debugging.
-     *
-     * @param int    $timestamp [required]
-     * @param string $cleanup_frequency
-     * @param bool   $round_up
-     * @return int
-     */
-    private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
-    {
-        $cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
-        // in order to round the time to the closest xx minutes (or hours),
-        // we take the minutes (or hours) portion of the timestamp and divide it by xx,
-        // round down to a whole number, then multiply by xx to bring us almost back up to where we were
-        // why round down ? so the minutes (or hours) don't go over 60 (or 24)
-        // and bump the hour, which could bump the day, which could bump the month, etc,
-        // which would be bad because we don't always want to round up,
-        // but when we do we can easily achieve that by simply adding the desired offset,
-        $minutes = '00';
-        $hours = 'H';
-        switch ($cleanup_frequency) {
-            case '5-minutes':
-                $minutes = floor((int) date('i', $timestamp) / 5) * 5;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 5;
-                break;
-            case '15-minutes':
-                $minutes = floor((int) date('i', $timestamp) / 15) * 15;
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
-                $offset = MINUTE_IN_SECONDS * 15;
-                break;
-            case '12-hours':
-                $hours = floor((int) date('H', $timestamp) / 12) * 12;
-                $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
-                $offset = HOUR_IN_SECONDS * 12;
-                break;
-            case 'day':
-                $hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
-                $offset = DAY_IN_SECONDS;
-                break;
-            case 'hour':
-            default:
-                $offset = HOUR_IN_SECONDS;
-                break;
-        }
-        $rounded_timestamp = (int) strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
-        $rounded_timestamp += $round_up ? $offset : 0;
-        return apply_filters(
-            'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
-            $rounded_timestamp,
-            $timestamp,
-            $cleanup_frequency,
-            $round_up
-        );
-    }
-
-
-    /**
-     * Saves supplied data to a transient
-     * if an expiration is set, then it automatically schedules the transient for cleanup
-     *
-     * @param string $transient_key [required]
-     * @param string $data          [required]
-     * @param int    $expiration    number of seconds until the cache expires
-     * @return bool
-     */
-    public function add($transient_key, $data, $expiration = 0)
-    {
-        $expiration = (int) abs($expiration);
-        $saved = set_transient($transient_key, $data, $expiration);
-        if ($saved && $expiration) {
-            $this->scheduleTransientCleanup($transient_key, $expiration);
-        }
-        return $saved;
-    }
-
-
-    /**
-     * retrieves transient data
-     * automatically triggers early cache refresh for standard cache items
-     * in order to avoid cache stampedes on busy sites.
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
-     * the $standard_cache parameter should be set to false when retrieving data
-     *
-     * @param string $transient_key [required]
-     * @param bool   $standard_cache
-     * @return mixed|null
-     */
-    public function get($transient_key, $standard_cache = true)
-    {
-        if (isset($this->transients[ $transient_key ])) {
-            // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
-            // check if known cache expires within the next minute,
-            // and if so, remove it from our tracking and and return nothing.
-            // this should trigger the cache content to be regenerated during this request,
-            // while allowing any following requests to still access the existing cache
-            // until it gets replaced with the refreshed content
-            if ($standard_cache
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
-            ) {
-                unset($this->transients[ $transient_key ]);
-                $this->updateTransients();
-                return null;
-            }
-
-            // for non standard cache items, remove the key from our tracking,
-            // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
-                $this->updateTransients();
-            }
-        }
-
-        $content = get_transient($transient_key);
-        return $content !== false ? $content : null;
-    }
-
-
-    /**
-     * delete a single transient and remove tracking
-     *
-     * @param string $transient_key [required] full or partial transient key to be deleted
-     */
-    public function delete($transient_key)
-    {
-        $this->deleteMany(array($transient_key));
-    }
-
-
-    /**
-     * delete multiple transients and remove tracking
-     *
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
-     * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
-     *                              and proceed directly to deleting those entries from the cache storage
-     */
-    public function deleteMany(array $transient_keys, $force_delete = false)
-    {
-        $full_transient_keys = $force_delete ? $transient_keys : array();
-        if (empty($full_transient_keys)) {
-            foreach ($this->transients as $transient_key => $expiration) {
-                foreach ($transient_keys as $transient_key_to_delete) {
-                    if (strpos($transient_key, $transient_key_to_delete) !== false) {
-                        $full_transient_keys[] = $transient_key;
-                    }
-                }
-            }
-        }
-        if ($this->deleteTransientKeys($full_transient_keys)) {
-            $this->updateTransients();
-        }
-    }
-
-
-    /**
-     * sorts transients numerically by timestamp
-     * then saves the transient schedule to a WP option
-     */
-    private function updateTransients()
-    {
-        asort($this->transients, SORT_NUMERIC);
-        update_option(
-            TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
-            $this->transients
-        );
-    }
-
-
-    /**
-     * schedules a transient for cleanup by adding it to the transient tracking
-     *
-     * @param string $transient_key [required]
-     * @param int    $expiration    [required]
-     */
-    private function scheduleTransientCleanup($transient_key, $expiration)
-    {
-        // make sure a valid future timestamp is set
-        $expiration += $expiration < time() ? time() : 0;
-        // and round to the closest 15 minutes
-        $expiration = $this->roundTimestamp($expiration);
-        // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[ $transient_key ] = $expiration;
-        $this->updateTransients();
-    }
-
-
-    /**
-     * Since our tracked transients are sorted by their timestamps
-     * we can grab the first transient and see when it is scheduled for cleanup.
-     * If that timestamp is less than or equal to the current time,
-     * then cleanup is triggered
-     */
-    public function checkTransientCleanupSchedule()
-    {
-        if (empty($this->transients)) {
-            return;
-        }
-        // when do we run the next cleanup job?
-        reset($this->transients);
-        $next_scheduled_cleanup = current($this->transients);
-        // if the next cleanup job is scheduled for the current hour
-        if ($next_scheduled_cleanup <= $this->current_time) {
-            if ($this->cleanupExpiredTransients()) {
-                $this->updateTransients();
-            }
-        }
-    }
-
-
-    /**
-     * loops through the array of tracked transients,
-     * compiles a list of those that have expired, and sends that list off for deletion.
-     * Also removes any bad records from the transients array
-     *
-     * @return bool
-     */
-    private function cleanupExpiredTransients()
-    {
-        $update = false;
-        // filter the query limit. Set to 0 to turn off garbage collection
-        $limit = (int) abs(
-            apply_filters(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                50
-            )
-        );
-        // non-zero LIMIT means take out the trash
-        if ($limit) {
-            $transient_keys = array();
-            foreach ($this->transients as $transient_key => $expiration) {
-                if ($expiration > $this->current_time) {
-                    continue;
-                }
-                if (! $expiration || ! $transient_key) {
-                    unset($this->transients[ $transient_key ]);
-                    $update = true;
-                    continue;
-                }
-                $transient_keys[] = $transient_key;
-            }
-            // delete expired keys, but maintain value of $update if nothing is deleted
-            $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
-            do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
-        }
-        return $update;
-    }
-
-
-    /**
-     * calls delete_transient() on each transient key provided, up to the specified limit
-     *
-     * @param array $transient_keys [required]
-     * @param int   $limit
-     * @return bool
-     */
-    private function deleteTransientKeys(array $transient_keys, $limit = 50)
-    {
-        if (empty($transient_keys)) {
-            return false;
-        }
-        $counter = 0;
-        foreach ($transient_keys as $transient_key) {
-            if ($counter === $limit) {
-                break;
-            }
-            // remove any transient prefixes
-            $transient_key = strpos($transient_key, '_transient_timeout_') === 0
-                ? str_replace('_transient_timeout_', '', $transient_key)
-                : $transient_key;
-            $transient_key = strpos($transient_key, '_transient_') === 0
-                ? str_replace('_transient_', '', $transient_key)
-                : $transient_key;
-            delete_transient($transient_key);
-            unset($this->transients[ $transient_key ]);
-            $counter++;
-        }
-        return $counter > 0;
-    }
+	/**
+	 * wp-option option_name for tracking transients
+	 *
+	 * @type string
+	 */
+	const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
+
+	/**
+	 * @var int $current_time
+	 */
+	private $current_time;
+
+	/**
+	 * how often to perform transient cleanup
+	 *
+	 * @var string $transient_cleanup_frequency
+	 */
+	private $transient_cleanup_frequency;
+
+	/**
+	 * options for how often to perform transient cleanup
+	 *
+	 * @var array $transient_cleanup_frequency_options
+	 */
+	private $transient_cleanup_frequency_options = array();
+
+	/**
+	 * @var array $transients
+	 */
+	private $transients;
+
+
+	/**
+	 * TransientCacheStorage constructor.
+	 */
+	public function __construct()
+	{
+		$this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
+		// round current time down to closest 5 minutes to simplify scheduling
+		$this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
+		$this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+			add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
+		}
+	}
+
+
+	/**
+	 * Sets how often transient cleanup occurs
+	 *
+	 * @return string
+	 */
+	private function setTransientCleanupFrequency()
+	{
+		// sets how often transients are cleaned up
+		$this->transient_cleanup_frequency_options = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
+			array(
+				'off',
+				'15-minutes',
+				'hour',
+				'12-hours',
+				'day',
+			)
+		);
+		$transient_cleanup_frequency = apply_filters(
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule',
+			'hour'
+		);
+		return in_array(
+			$transient_cleanup_frequency,
+			$this->transient_cleanup_frequency_options,
+			true
+		)
+			? $transient_cleanup_frequency
+			: 'hour';
+	}
+
+
+	/**
+	 * we need to be able to round timestamps off to match the set transient cleanup frequency
+	 * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
+	 * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
+	 * during the next scheduled cleanup after its expiration.
+	 * We also round off the current time timestamp to the closest 5 minutes
+	 * just to make the timestamps a little easier to round which helps with debugging.
+	 *
+	 * @param int    $timestamp [required]
+	 * @param string $cleanup_frequency
+	 * @param bool   $round_up
+	 * @return int
+	 */
+	private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
+	{
+		$cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
+		// in order to round the time to the closest xx minutes (or hours),
+		// we take the minutes (or hours) portion of the timestamp and divide it by xx,
+		// round down to a whole number, then multiply by xx to bring us almost back up to where we were
+		// why round down ? so the minutes (or hours) don't go over 60 (or 24)
+		// and bump the hour, which could bump the day, which could bump the month, etc,
+		// which would be bad because we don't always want to round up,
+		// but when we do we can easily achieve that by simply adding the desired offset,
+		$minutes = '00';
+		$hours = 'H';
+		switch ($cleanup_frequency) {
+			case '5-minutes':
+				$minutes = floor((int) date('i', $timestamp) / 5) * 5;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 5;
+				break;
+			case '15-minutes':
+				$minutes = floor((int) date('i', $timestamp) / 15) * 15;
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
+				$offset = MINUTE_IN_SECONDS * 15;
+				break;
+			case '12-hours':
+				$hours = floor((int) date('H', $timestamp) / 12) * 12;
+				$hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
+				$offset = HOUR_IN_SECONDS * 12;
+				break;
+			case 'day':
+				$hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
+				$offset = DAY_IN_SECONDS;
+				break;
+			case 'hour':
+			default:
+				$offset = HOUR_IN_SECONDS;
+				break;
+		}
+		$rounded_timestamp = (int) strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
+		$rounded_timestamp += $round_up ? $offset : 0;
+		return apply_filters(
+			'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
+			$rounded_timestamp,
+			$timestamp,
+			$cleanup_frequency,
+			$round_up
+		);
+	}
+
+
+	/**
+	 * Saves supplied data to a transient
+	 * if an expiration is set, then it automatically schedules the transient for cleanup
+	 *
+	 * @param string $transient_key [required]
+	 * @param string $data          [required]
+	 * @param int    $expiration    number of seconds until the cache expires
+	 * @return bool
+	 */
+	public function add($transient_key, $data, $expiration = 0)
+	{
+		$expiration = (int) abs($expiration);
+		$saved = set_transient($transient_key, $data, $expiration);
+		if ($saved && $expiration) {
+			$this->scheduleTransientCleanup($transient_key, $expiration);
+		}
+		return $saved;
+	}
+
+
+	/**
+	 * retrieves transient data
+	 * automatically triggers early cache refresh for standard cache items
+	 * in order to avoid cache stampedes on busy sites.
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
+	 * the $standard_cache parameter should be set to false when retrieving data
+	 *
+	 * @param string $transient_key [required]
+	 * @param bool   $standard_cache
+	 * @return mixed|null
+	 */
+	public function get($transient_key, $standard_cache = true)
+	{
+		if (isset($this->transients[ $transient_key ])) {
+			// to avoid cache stampedes (AKA:dogpiles) for standard cache items,
+			// check if known cache expires within the next minute,
+			// and if so, remove it from our tracking and and return nothing.
+			// this should trigger the cache content to be regenerated during this request,
+			// while allowing any following requests to still access the existing cache
+			// until it gets replaced with the refreshed content
+			if ($standard_cache
+				&& $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+			) {
+				unset($this->transients[ $transient_key ]);
+				$this->updateTransients();
+				return null;
+			}
+
+			// for non standard cache items, remove the key from our tracking,
+			// but proceed to retrieve the transient so that it also gets removed from the db
+			if ($this->transients[ $transient_key ] <= time()) {
+				unset($this->transients[ $transient_key ]);
+				$this->updateTransients();
+			}
+		}
+
+		$content = get_transient($transient_key);
+		return $content !== false ? $content : null;
+	}
+
+
+	/**
+	 * delete a single transient and remove tracking
+	 *
+	 * @param string $transient_key [required] full or partial transient key to be deleted
+	 */
+	public function delete($transient_key)
+	{
+		$this->deleteMany(array($transient_key));
+	}
+
+
+	/**
+	 * delete multiple transients and remove tracking
+	 *
+	 * @param array $transient_keys [required] array of full or partial transient keys to be deleted
+	 * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
+	 *                              and proceed directly to deleting those entries from the cache storage
+	 */
+	public function deleteMany(array $transient_keys, $force_delete = false)
+	{
+		$full_transient_keys = $force_delete ? $transient_keys : array();
+		if (empty($full_transient_keys)) {
+			foreach ($this->transients as $transient_key => $expiration) {
+				foreach ($transient_keys as $transient_key_to_delete) {
+					if (strpos($transient_key, $transient_key_to_delete) !== false) {
+						$full_transient_keys[] = $transient_key;
+					}
+				}
+			}
+		}
+		if ($this->deleteTransientKeys($full_transient_keys)) {
+			$this->updateTransients();
+		}
+	}
+
+
+	/**
+	 * sorts transients numerically by timestamp
+	 * then saves the transient schedule to a WP option
+	 */
+	private function updateTransients()
+	{
+		asort($this->transients, SORT_NUMERIC);
+		update_option(
+			TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
+			$this->transients
+		);
+	}
+
+
+	/**
+	 * schedules a transient for cleanup by adding it to the transient tracking
+	 *
+	 * @param string $transient_key [required]
+	 * @param int    $expiration    [required]
+	 */
+	private function scheduleTransientCleanup($transient_key, $expiration)
+	{
+		// make sure a valid future timestamp is set
+		$expiration += $expiration < time() ? time() : 0;
+		// and round to the closest 15 minutes
+		$expiration = $this->roundTimestamp($expiration);
+		// save transients to clear using their ID as the key to avoid duplicates
+		$this->transients[ $transient_key ] = $expiration;
+		$this->updateTransients();
+	}
+
+
+	/**
+	 * Since our tracked transients are sorted by their timestamps
+	 * we can grab the first transient and see when it is scheduled for cleanup.
+	 * If that timestamp is less than or equal to the current time,
+	 * then cleanup is triggered
+	 */
+	public function checkTransientCleanupSchedule()
+	{
+		if (empty($this->transients)) {
+			return;
+		}
+		// when do we run the next cleanup job?
+		reset($this->transients);
+		$next_scheduled_cleanup = current($this->transients);
+		// if the next cleanup job is scheduled for the current hour
+		if ($next_scheduled_cleanup <= $this->current_time) {
+			if ($this->cleanupExpiredTransients()) {
+				$this->updateTransients();
+			}
+		}
+	}
+
+
+	/**
+	 * loops through the array of tracked transients,
+	 * compiles a list of those that have expired, and sends that list off for deletion.
+	 * Also removes any bad records from the transients array
+	 *
+	 * @return bool
+	 */
+	private function cleanupExpiredTransients()
+	{
+		$update = false;
+		// filter the query limit. Set to 0 to turn off garbage collection
+		$limit = (int) abs(
+			apply_filters(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				50
+			)
+		);
+		// non-zero LIMIT means take out the trash
+		if ($limit) {
+			$transient_keys = array();
+			foreach ($this->transients as $transient_key => $expiration) {
+				if ($expiration > $this->current_time) {
+					continue;
+				}
+				if (! $expiration || ! $transient_key) {
+					unset($this->transients[ $transient_key ]);
+					$update = true;
+					continue;
+				}
+				$transient_keys[] = $transient_key;
+			}
+			// delete expired keys, but maintain value of $update if nothing is deleted
+			$update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
+			do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
+		}
+		return $update;
+	}
+
+
+	/**
+	 * calls delete_transient() on each transient key provided, up to the specified limit
+	 *
+	 * @param array $transient_keys [required]
+	 * @param int   $limit
+	 * @return bool
+	 */
+	private function deleteTransientKeys(array $transient_keys, $limit = 50)
+	{
+		if (empty($transient_keys)) {
+			return false;
+		}
+		$counter = 0;
+		foreach ($transient_keys as $transient_key) {
+			if ($counter === $limit) {
+				break;
+			}
+			// remove any transient prefixes
+			$transient_key = strpos($transient_key, '_transient_timeout_') === 0
+				? str_replace('_transient_timeout_', '', $transient_key)
+				: $transient_key;
+			$transient_key = strpos($transient_key, '_transient_') === 0
+				? str_replace('_transient_', '', $transient_key)
+				: $transient_key;
+			delete_transient($transient_key);
+			unset($this->transients[ $transient_key ]);
+			$counter++;
+		}
+		return $counter > 0;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -57,7 +57,7 @@ 
         // round current time down to closest 5 minutes to simplify scheduling
         $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
         $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
         }
     }
@@ -190,7 +190,7 @@ 
      */
     public function get($transient_key, $standard_cache = true)
     {
-        if (isset($this->transients[ $transient_key ])) {
+        if (isset($this->transients[$transient_key])) {
             // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
             // check if known cache expires within the next minute,
             // and if so, remove it from our tracking and and return nothing.
@@ -198,17 +198,17 @@ 
             // while allowing any following requests to still access the existing cache
             // until it gets replaced with the refreshed content
             if ($standard_cache
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
+                && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
             ) {
-                unset($this->transients[ $transient_key ]);
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
                 return null;
             }
 
             // for non standard cache items, remove the key from our tracking,
             // but proceed to retrieve the transient so that it also gets removed from the db
-            if ($this->transients[ $transient_key ] <= time()) {
-                unset($this->transients[ $transient_key ]);
+            if ($this->transients[$transient_key] <= time()) {
+                unset($this->transients[$transient_key]);
                 $this->updateTransients();
             }
         }
@@ -281,7 +281,7 @@ 
         // and round to the closest 15 minutes
         $expiration = $this->roundTimestamp($expiration);
         // save transients to clear using their ID as the key to avoid duplicates
-        $this->transients[ $transient_key ] = $expiration;
+        $this->transients[$transient_key] = $expiration;
         $this->updateTransients();
     }
 
@@ -333,8 +333,8 @@ 
                 if ($expiration > $this->current_time) {
                     continue;
                 }
-                if (! $expiration || ! $transient_key) {
-                    unset($this->transients[ $transient_key ]);
+                if ( ! $expiration || ! $transient_key) {
+                    unset($this->transients[$transient_key]);
                     $update = true;
                     continue;
                 }
@@ -373,7 +373,7 @@ 
                 ? str_replace('_transient_', '', $transient_key)
                 : $transient_key;
             delete_transient($transient_key);
-            unset($this->transients[ $transient_key ]);
+            unset($this->transients[$transient_key]);
             $counter++;
         }
         return $counter > 0;

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/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/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,