eventespresso / event-espresso-core

core/services/shortcodes/EspressoShortcode.php

Indentation +217 added lines, -217 removed lines

@@ -19,221 +19,221 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array) $attributes)
-        );
-    }
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if ($shortcode->initialized() === false) {
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof EE_Event) {
-            return $event->ID();
-        }
-        global $post;
-        if ($post instanceof WP_Post) {
-            return $post->ID;
-        }
-        return 0;
-    }
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null:
-                case is_int($value):
-                case is_float($value):
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
-                    break;
-                case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
-                    break;
-                case is_array($value):
-                    $attributes[ $key ] = $this->sanitizeAttributes($value);
-                    break;
-                default:
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
-
-
-    /**
-     * Returns whether or not this shortcode has been initialized
-     *
-     * @return boolean
-     */
-    public function initialized()
-    {
-        return $this->initialized;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array) $attributes)
+		);
+	}
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if ($shortcode->initialized() === false) {
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof EE_Event) {
+			return $event->ID();
+		}
+		global $post;
+		if ($post instanceof WP_Post) {
+			return $post->ID;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[ $key ])) {
+				$callback = $custom_sanitization[ $key ];
+				if ($callback === 'skip_sanitization') {
+					$attributes[ $key ] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[ $key ] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null:
+				case is_int($value):
+				case is_float($value):
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
+					$attributes[ $key ] = $value;
+					break;
+				case is_string($value):
+					$attributes[ $key ] = sanitize_text_field($value);
+					break;
+				case is_array($value):
+					$attributes[ $key ] = $this->sanitizeAttributes($value);
+					break;
+				default:
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[ $key ] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
+
+
+	/**
+	 * Returns whether or not this shortcode has been initialized
+	 *
+	 * @return boolean
+	 */
+	public function initialized()
+	{
+		return $this->initialized;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -104,7 +104,7 @@ 
             // serialized attributes
             wp_json_encode($attributes),
             // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
+            function() use ($shortcode, $attributes) {
                 if ($shortcode->initialized() === false) {
                     $shortcode->initializeShortcode();
                 }
@@ -191,14 +191,14 @@ 
         $custom_sanitization = $this->customAttributeSanitizationMap();
         foreach ($attributes as $key => $value) {
             // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
+            if (isset($custom_sanitization[$key])) {
+                $callback = $custom_sanitization[$key];
                 if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     continue;
                 }
                 if (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
+                    $attributes[$key] = $callback($value);
                     continue;
                 }
             }
@@ -208,18 +208,18 @@ 
                 case is_float($value):
                     // typical booleans
                 case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     break;
                 case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
+                    $attributes[$key] = sanitize_text_field($value);
                     break;
                 case is_array($value):
-                    $attributes[ $key ] = $this->sanitizeAttributes($value);
+                    $attributes[$key] = $this->sanitizeAttributes($value);
                     break;
                 default:
                     // only remaining data types are Object and Resource
                     // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
+                    $attributes[$key] = null;
                     break;
             }
         }

core/services/notices/NoticeConverterInterface.php

Indentation +23 added lines, -23 removed lines

@@ -13,31 +13,31 @@
 interface NoticeConverterInterface
 {
 
-    /**
-     * @return NoticesContainerInterface
-     */
-    public function getNotices();
+	/**
+	 * @return NoticesContainerInterface
+	 */
+	public function getNotices();
 
-    /**
-     * @param bool $throw_exceptions
-     */
-    public function setThrowExceptions($throw_exceptions);
+	/**
+	 * @param bool $throw_exceptions
+	 */
+	public function setThrowExceptions($throw_exceptions);
 
-    /**
-     * @return bool
-     */
-    public function getThrowExceptions();
+	/**
+	 * @return bool
+	 */
+	public function getThrowExceptions();
 
-    /**
-     * Converts NoticesContainerInterface objects into other format
-     *
-     * @param NoticesContainerInterface $notices
-     * @return
-     */
-    public function process(NoticesContainerInterface $notices);
+	/**
+	 * Converts NoticesContainerInterface objects into other format
+	 *
+	 * @param NoticesContainerInterface $notices
+	 * @return
+	 */
+	public function process(NoticesContainerInterface $notices);
 
-    /**
-     * @return void;
-     */
-    public function clearNotices();
+	/**
+	 * @return void;
+	 */
+	public function clearNotices();
 }

core/services/notices/NoticeInterface.php

Indentation +24 added lines, -24 removed lines

@@ -13,38 +13,38 @@
 interface NoticeInterface
 {
 
-    /**
-     * @return string
-     */
-    public function type();
+	/**
+	 * @return string
+	 */
+	public function type();
 
 
-    /**
-     * @return string
-     */
-    public function message();
+	/**
+	 * @return string
+	 */
+	public function message();
 
 
-    /**
-     * @return bool
-     */
-    public function isDismissible();
+	/**
+	 * @return bool
+	 */
+	public function isDismissible();
 
 
-    /**
-     * @return string
-     */
-    public function file();
+	/**
+	 * @return string
+	 */
+	public function file();
 
 
-    /**
-     * @return string
-     */
-    public function func();
+	/**
+	 * @return string
+	 */
+	public function func();
 
 
-    /**
-     * @return string
-     */
-    public function line();
+	/**
+	 * @return string
+	 */
+	public function line();
 }

core/services/locators/LocatorInterface.php

Indentation +9 added lines, -9 removed lines

@@ -9,13 +9,13 @@
 interface LocatorInterface
 {
 
-    /**
-     * given a string or an array of information for where to look,
-     * will find all files in that location
-     *
-     * @access public
-     * @param array|string $location
-     * @return \FilesystemIterator
-     */
-    public function locate($location);
+	/**
+	 * given a string or an array of information for where to look,
+	 * will find all files in that location
+	 *
+	 * @access public
+	 * @param array|string $location
+	 * @return \FilesystemIterator
+	 */
+	public function locate($location);
 }

core/services/loaders/LoaderDecoratorInterface.php

Indentation +11 added lines, -11 removed lines

@@ -5,18 +5,18 @@
 interface LoaderDecoratorInterface
 {
 
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true);
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true);
 
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 }

core/services/payment_methods/gateways/GatewayDataFormatterInterface.php

Indentation +44 added lines, -44 removed lines

@@ -12,63 +12,63 @@
 interface GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(\EEI_Payment $payment);
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(\EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment);
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment);
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment);
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(\EEI_Payment $payment);
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(\EEI_Payment $payment);
 
 
 
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     */
-    public function formatCurrency($amount);
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 */
+	public function formatCurrency($amount);
 }

core/services/container/ContainerInterface.php

Indentation +17 added lines, -17 removed lines

@@ -12,24 +12,24 @@
 interface ContainerInterface
 {
 
-    /**
-     * Finds an entry of the container by its identifier and returns it.
-     *
-     * @param string $id Identifier of the entry to look for.
-     * @return mixed Entry.
-     */
-    public function get($id);
+	/**
+	 * Finds an entry of the container by its identifier and returns it.
+	 *
+	 * @param string $id Identifier of the entry to look for.
+	 * @return mixed Entry.
+	 */
+	public function get($id);
 
 
 
-    /**
-     * Returns true if the container can return an entry for the given identifier.
-     * Returns false otherwise.
-     * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
-     * It does however mean that `get($id)` will not throw a `NotFoundException`.
-     *
-     * @param string $id Identifier of the entry to look for.
-     * @return boolean
-     */
-    public function has($id);
+	/**
+	 * Returns true if the container can return an entry for the given identifier.
+	 * Returns false otherwise.
+	 * `has($id)` returning true does not mean that `get($id)` will not throw an exception.
+	 * It does however mean that `get($id)` will not throw a `NotFoundException`.
+	 *
+	 * @param string $id Identifier of the entry to look for.
+	 * @return boolean
+	 */
+	public function has($id);
 }

core/services/container/RecipeInterface.php

Indentation +67 added lines, -67 removed lines

@@ -11,82 +11,82 @@
 interface RecipeInterface
 {
 
-    /**
-     * @return string
-     */
-    public function identifier();
+	/**
+	 * @return string
+	 */
+	public function identifier();
 
-    /**
-     * @return string
-     */
-    public function fqcn();
+	/**
+	 * @return string
+	 */
+	public function fqcn();
 
-    /**
-     * @return array
-     */
-    public function ingredients();
+	/**
+	 * @return array
+	 */
+	public function ingredients();
 
-    /**
-     * @return string
-     */
-    public function type();
+	/**
+	 * @return string
+	 */
+	public function type();
 
-    /**
-     * @return array
-     */
-    public function filters();
+	/**
+	 * @return array
+	 */
+	public function filters();
 
-    /**
-     * @return array
-     */
-    public function paths();
+	/**
+	 * @return array
+	 */
+	public function paths();
 
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     */
-    public function setIdentifier($identifier);
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 */
+	public function setIdentifier($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
-     */
-    public function setFqcn($fqcn);
+	/**
+	 * 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
+	 */
+	public function setFqcn($fqcn);
 
-    /**
-     * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
-     *                              example:
-     *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     */
-    public function setIngredients(array $ingredients);
+	/**
+	 * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
+	 *                              example:
+	 *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 */
+	public function setIngredients(array $ingredients);
 
-    /**
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
-     */
-    public function setType($type = CoffeeMaker::BREW_NEW);
+	/**
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
+	 */
+	public function setType($type = CoffeeMaker::BREW_NEW);
 
-    /**
-     * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
-     *                          example:
-     *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     */
-    public function setFilters(array $filters);
+	/**
+	 * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
+	 *                          example:
+	 *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 */
+	public function setFilters(array $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
-     */
-    public function setPaths($paths = array());
+	/**
+	 * 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
+	 */
+	public function setPaths($paths = array());
 }

core/services/container/InjectorInterface.php

Indentation +30 added lines, -30 removed lines

@@ -11,37 +11,37 @@
 interface InjectorInterface
 {
 
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @access public
-     * @param string $class_name
-     * @return \ReflectionClass
-     */
-    public function getReflectionClass($class_name);
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @access public
+	 * @param string $class_name
+	 * @return \ReflectionClass
+	 */
+	public function getReflectionClass($class_name);
 
 
 
-    /**
-     * 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
-     *
-     * @access public
-     * @param \EventEspresso\core\services\container\RecipeInterface $recipe
-     * @param \ReflectionClass                                       $reflector
-     * @param array                                                  $arguments
-     * @return array
-     */
-    public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array());
+	/**
+	 * 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
+	 *
+	 * @access public
+	 * @param \EventEspresso\core\services\container\RecipeInterface $recipe
+	 * @param \ReflectionClass                                       $reflector
+	 * @param array                                                  $arguments
+	 * @return array
+	 */
+	public function resolveDependencies(RecipeInterface $recipe, \ReflectionClass $reflector, $arguments = array());
 }