eventespresso / event-espresso-core

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/CoffeeMill.php

Indentation +47 added lines, -47 removed lines

@@ -14,59 +14,59 @@
  */
 class CoffeeMill
 {
-    /**
-     * @var CoffeeShop $coffee_shop
-     */
-    private static $coffee_shop;
+	/**
+	 * @var CoffeeShop $coffee_shop
+	 */
+	private static $coffee_shop;
 
 
-    /**
-     * @return mixed
-     */
-    public static function getCoffeeShop()
-    {
-        return self::$coffee_shop;
-    }
+	/**
+	 * @return mixed
+	 */
+	public static function getCoffeeShop()
+	{
+		return self::$coffee_shop;
+	}
 
 
-    /**
-     * @param CoffeeShop $coffee_shop
-     */
-    public static function setCoffeeShop(CoffeeShop $coffee_shop)
-    {
-        self::$coffee_shop = $coffee_shop;
-    }
+	/**
+	 * @param CoffeeShop $coffee_shop
+	 */
+	public static function setCoffeeShop(CoffeeShop $coffee_shop)
+	{
+		self::$coffee_shop = $coffee_shop;
+	}
 
 
-    /**
-     * @param string $identifier
-     * @param array  $arguments
-     * @param string $type
-     * @return mixed
-     * @throws ServiceNotFoundException
-     */
-    public static function createNew($identifier, $arguments = array(), $type = CoffeeMaker::BREW_NEW)
-    {
-        return self::$coffee_shop->brew($identifier, $arguments, $type);
-    }
+	/**
+	 * @param string $identifier
+	 * @param array  $arguments
+	 * @param string $type
+	 * @return mixed
+	 * @throws ServiceNotFoundException
+	 */
+	public static function createNew($identifier, $arguments = array(), $type = CoffeeMaker::BREW_NEW)
+	{
+		return self::$coffee_shop->brew($identifier, $arguments, $type);
+	}
 
 
-    /**
-     * IMPORTANT!!!
-     * Usage of this method is discouraged as it promotes service location.
-     * It's current use is only as a stop gap measure until the CoffeeShop
-     * Dependency Injection Container can be implemented properly for all classes.
-     * If it is at all possible, inject your dependencies via your class constructor.
-     * This method WILL BE DEPRECATED at some point in the near future.
-     *
-     * @param string $identifier
-     * @param array  $arguments
-     * @param string $type
-     * @return mixed
-     * @throws ServiceNotFoundException
-     */
-    public static function getService($identifier, $arguments = array(), $type = CoffeeMaker::BREW_SHARED)
-    {
-        return self::$coffee_shop->brew($identifier, $arguments, $type);
-    }
+	/**
+	 * IMPORTANT!!!
+	 * Usage of this method is discouraged as it promotes service location.
+	 * It's current use is only as a stop gap measure until the CoffeeShop
+	 * Dependency Injection Container can be implemented properly for all classes.
+	 * If it is at all possible, inject your dependencies via your class constructor.
+	 * This method WILL BE DEPRECATED at some point in the near future.
+	 *
+	 * @param string $identifier
+	 * @param array  $arguments
+	 * @param string $type
+	 * @return mixed
+	 * @throws ServiceNotFoundException
+	 */
+	public static function getService($identifier, $arguments = array(), $type = CoffeeMaker::BREW_SHARED)
+	{
+		return self::$coffee_shop->brew($identifier, $arguments, $type);
+	}
 }

core/services/container/exceptions/ServiceNotFoundException.php

Indentation +22 added lines, -22 removed lines

@@ -11,26 +11,26 @@
  */
 class ServiceNotFoundException extends \RuntimeException
 {
-    /**
-     * ServiceNotFoundException constructor
-     *
-     * @param string     $service_name the name of the requested service
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct(
-        $service_name,
-        $message = '',
-        $code = 0,
-        \Exception $previous = null
-    ) {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__('The requested service "%1$s" could not found be found in the CoffeeShop.', 'event_espresso'),
-                $service_name
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * ServiceNotFoundException constructor
+	 *
+	 * @param string     $service_name the name of the requested service
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct(
+		$service_name,
+		$message = '',
+		$code = 0,
+		\Exception $previous = null
+	) {
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__('The requested service "%1$s" could not found be found in the CoffeeShop.', 'event_espresso'),
+				$service_name
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/container/exceptions/ServiceExistsException.php

Indentation +22 added lines, -22 removed lines

@@ -12,26 +12,26 @@
  */
 class ServiceExistsException extends \OutOfRangeException
 {
-    /**
-     * ServiceExistsException constructor
-     *
-     * @param string     $service_name the name of the requested service
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct(
-        $service_name,
-        $message = '',
-        $code = 0,
-        \Exception $previous = null
-    ) {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__('The "%1$s" service already exists in the CoffeeShop and can not be added again.', 'event_espresso'),
-                $service_name
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * ServiceExistsException constructor
+	 *
+	 * @param string     $service_name the name of the requested service
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct(
+		$service_name,
+		$message = '',
+		$code = 0,
+		\Exception $previous = null
+	) {
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__('The "%1$s" service already exists in the CoffeeShop and can not be added again.', 'event_espresso'),
+				$service_name
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/container/exceptions/InvalidServiceException.php

Indentation +23 added lines, -23 removed lines

@@ -12,27 +12,27 @@
  */
 class InvalidServiceException extends \UnexpectedValueException
 {
-    /**
-     * InvalidServiceException constructor.
-     *
-     * @param string     $service_name the name of the requested service
-     * @param string     $actual       classname of what we got
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($service_name, $actual, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The "%1$s" service could not be retrieved from the CoffeeShop, but "%2$s" was received.',
-                    'event_espresso'
-                ),
-                $service_name,
-                print_r($actual, true)
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidServiceException constructor.
+	 *
+	 * @param string     $service_name the name of the requested service
+	 * @param string     $actual       classname of what we got
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($service_name, $actual, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The "%1$s" service could not be retrieved from the CoffeeShop, but "%2$s" was received.',
+					'event_espresso'
+				),
+				$service_name,
+				print_r($actual, true)
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/container/exceptions/InstantiationException.php

Indentation +21 added lines, -21 removed lines

@@ -14,25 +14,25 @@
  */
 class InstantiationException extends BadMethodCallException
 {
-    /**
-     * InstantiationException constructor.
-     *
-     * @param string     $identifier the name of the requested entity or service
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($identifier, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The "%1$s" class could not be constructed.',
-                    'event_espresso'
-                ),
-                $identifier
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InstantiationException constructor.
+	 *
+	 * @param string     $identifier the name of the requested entity or service
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($identifier, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The "%1$s" class could not be constructed.',
+					'event_espresso'
+				),
+				$identifier
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/container/CoffeePotInterface.php

Indentation +64 added lines, -64 removed lines

@@ -10,68 +10,68 @@
  */
 interface CoffeePotInterface extends ContainerInterface
 {
-    /**
-     * returns an instance of the requested entity type using the supplied arguments.
-     * If a shared service is requested and an instance is already in the carafe, then it will be returned.
-     * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
-     * If the request is for a new entity and a closure exists in the reservoir for creating it,
-     * then a new entity will be instantiated from the closure and returned.
-     * If a closure does not exist, then one will be built and added to the reservoir
-     * before instantiating the requested entity.
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @param array   $arguments  an array of arguments to be passed to the entity constructor
-     * @param string  $type
-     * @return mixed
-     */
-    public function brew($identifier, $arguments = array(), $type = '');
-
-
-
-    /**
-     * @param string   $identifier
-     * @param callable $closure
-     */
-    public function addClosure($identifier, $closure);
-
-
-
-    /**
-     * @param string $identifier
-     * @param mixed  $service
-     * @return boolean
-     */
-    public function addService($identifier, $service);
-
-
-
-    /**
-     * Adds instructions on how to brew objects
-     *
-     * @param RecipeInterface $recipe
-     * @return mixed
-     */
-    public function addRecipe(RecipeInterface $recipe);
-
-
-
-    /**
-     * Get instructions on how to brew objects
-     *
-     * @param string $identifier
-     * @return Recipe
-     */
-    public function getRecipe($identifier);
-
-
-
-    /**
-     * adds class name aliases to list of filters
-     *
-     * @param  string $identifier
-     * @param  array  $aliases
-     * @return string
-     */
-    public function addAliases($identifier, $aliases);
+	/**
+	 * returns an instance of the requested entity type using the supplied arguments.
+	 * If a shared service is requested and an instance is already in the carafe, then it will be returned.
+	 * If it is not already in the carafe, then the service will be constructed, added to the carafe, and returned
+	 * If the request is for a new entity and a closure exists in the reservoir for creating it,
+	 * then a new entity will be instantiated from the closure and returned.
+	 * If a closure does not exist, then one will be built and added to the reservoir
+	 * before instantiating the requested entity.
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @param array   $arguments  an array of arguments to be passed to the entity constructor
+	 * @param string  $type
+	 * @return mixed
+	 */
+	public function brew($identifier, $arguments = array(), $type = '');
+
+
+
+	/**
+	 * @param string   $identifier
+	 * @param callable $closure
+	 */
+	public function addClosure($identifier, $closure);
+
+
+
+	/**
+	 * @param string $identifier
+	 * @param mixed  $service
+	 * @return boolean
+	 */
+	public function addService($identifier, $service);
+
+
+
+	/**
+	 * Adds instructions on how to brew objects
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return mixed
+	 */
+	public function addRecipe(RecipeInterface $recipe);
+
+
+
+	/**
+	 * Get instructions on how to brew objects
+	 *
+	 * @param string $identifier
+	 * @return Recipe
+	 */
+	public function getRecipe($identifier);
+
+
+
+	/**
+	 * adds class name aliases to list of filters
+	 *
+	 * @param  string $identifier
+	 * @param  array  $aliases
+	 * @return string
+	 */
+	public function addAliases($identifier, $aliases);
 }

core/services/container/CoffeeMakerInterface.php

Indentation +18 added lines, -18 removed lines

@@ -11,31 +11,31 @@
  */
 interface CoffeeMakerInterface
 {
-    /**
-     * @return array
-     */
-    public static function getTypes();
+	/**
+	 * @return array
+	 */
+	public static function getTypes();
 
 
 
-    /**
-     * @param $type
-     */
-    public static function validateType($type);
+	/**
+	 * @param $type
+	 */
+	public static function validateType($type);
 
 
 
-    /**
-     * @param RecipeInterface $recipe
-     * @param array           $arguments
-     * @return mixed
-     */
-    public function brew(RecipeInterface $recipe, $arguments = array());
+	/**
+	 * @param RecipeInterface $recipe
+	 * @param array           $arguments
+	 * @return mixed
+	 */
+	public function brew(RecipeInterface $recipe, $arguments = array());
 
 
 
-    /**
-     * @return string
-     */
-    public function type();
+	/**
+	 * @return string
+	 */
+	public function type();
 }

core/services/container/LoadOnlyCoffeeMaker.php

Indentation +17 added lines, -17 removed lines

@@ -20,23 +20,23 @@
  */
 class LoadOnlyCoffeeMaker extends CoffeeMaker
 {
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return CoffeeMaker::BREW_LOAD_ONLY;
-    }
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return CoffeeMaker::BREW_LOAD_ONLY;
+	}
 
 
-    /**
-     * @param RecipeInterface $recipe
-     * @param array           $arguments
-     * @return mixed
-     * @throws InvalidClassException
-     */
-    public function brew(RecipeInterface $recipe, $arguments = array())
-    {
-        return $this->resolveClassAndFilepath($recipe);
-    }
+	/**
+	 * @param RecipeInterface $recipe
+	 * @param array           $arguments
+	 * @return mixed
+	 * @throws InvalidClassException
+	 */
+	public function brew(RecipeInterface $recipe, $arguments = array())
+	{
+		return $this->resolveClassAndFilepath($recipe);
+	}
 }