eventespresso / event-espresso-core

core/services/container/CoffeeShop.php

Doc Comments +2 added lines, -2 removed lines

@@ -361,7 +361,7 @@ 
      * Adds instructions on how to brew objects
      *
      * @param RecipeInterface $recipe
-     * @return mixed
+     * @return boolean
      * @throws InvalidIdentifierException
      */
     public function addRecipe(RecipeInterface $recipe)
@@ -461,7 +461,7 @@ 
     /**
      * Adds a service to one of the internal collections
      *
-     * @param        $identifier
+     * @param        string $identifier
      * @param array  $arguments
      * @param string $type
      * @return mixed

Indentation +588 added lines, -588 removed lines

@@ -33,594 +33,594 @@
 {
 
 
-    /**
-     * This was the best coffee related name I could think of to represent class name "aliases"
-     * So classes can be found via an alias identifier,
-     * that is revealed when it is run through... the filters... eh? get it?
-     *
-     * @var array $filters
-     */
-    private $filters;
-
-    /**
-     * These are the classes that will actually build the objects (to order of course)
-     *
-     * @var array $coffee_makers
-     */
-    private $coffee_makers;
-
-    /**
-     * where the instantiated "singleton" objects are stored
-     *
-     * @var CollectionInterface $carafe
-     */
-    private $carafe;
-
-    /**
-     * collection of Recipes that instruct us how to brew objects
-     *
-     * @var CollectionInterface $recipes
-     */
-    private $recipes;
-
-    /**
-     * collection of closures for brewing objects
-     *
-     * @var CollectionInterface $reservoir
-     */
-    private $reservoir;
-
-
-
-    /**
-     * CoffeeShop constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        // array for storing class aliases
-        $this->filters = array();
-        // create collection for storing shared services
-        $this->carafe = new LooseCollection( '' );
-        // create collection for storing recipes that tell us how to build services and entities
-        $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
-        // create collection for storing closures for constructing new entities
-        $this->reservoir = new Collection('Closure');
-        // create collection for storing the generators that build our services and entity closures
-        $this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
-    }
-
-
-
-    /**
-     * Returns true if the container can return an entry for the given identifier.
-     * Returns false otherwise.
-     * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
-     * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
-     *
-     * @param string $identifier  Identifier of the entry to look for.
-     *                            Typically a Fully Qualified Class Name
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function has($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        return $this->carafe->has($identifier);
-    }
-
-
-
-    /**
-     * finds a previously brewed (SHARED) service and returns it
-     *
-     * @param  string $identifier Identifier for the entity class to be constructed.
-     *                            Typically a Fully Qualified Class Name
-     * @return mixed
-     * @throws InvalidIdentifierException
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function get($identifier)
-    {
-        $identifier = $this->filterIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->get($identifier);
-        }
-        throw new ServiceNotFoundException($identifier);
-    }
-
-
-
-    /**
-     * 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
-     * @throws OutOfBoundsException
-     * @throws InstantiationException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidIdentifierException
-     * @throws ServiceExistsException
-     * @throws ServiceNotFoundException No service was found for this identifier.
-     */
-    public function brew($identifier, $arguments = array(), $type = '')
-    {
-        // resolve any class aliases that may exist
-        $identifier = $this->filterIdentifier($identifier);
-        // is a shared service being requested and already exists in the carafe?
-        $brewed = $this->getShared($identifier, $type);
-        // then return whatever was found
-        if($brewed !== false) {
-            return $brewed;
-        }
-        // if the reservoir doesn't have a closure already for the requested identifier,
-        // then neither a shared service nor a closure for making entities has been built yet
-        if (! $this->reservoir->has($identifier)) {
-            // so let's brew something up and add it to the proper collection
-            $brewed = $this->makeCoffee($identifier, $arguments, $type);
-        }
-        // did the requested class only require loading, and if so, was that successful?
-        if($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
-            return true;
-        }
-        // was the brewed item a callable factory function ?
-        if (is_callable($brewed)) {
-            // then instantiate a new entity from the cached closure
-            return $brewed($arguments);
-        }
-        if ($brewed) {
-            // requested object was a shared entity, so attempt to get it from the carafe again
-            // because if it wasn't there before, then it should have just been brewed and added,
-            // but if it still isn't there, then this time the thrown ServiceNotFoundException will not be caught
-            return $this->get($identifier);
-        }
-        // if identifier is for a non-shared entity,
-        // then either a cached closure already existed, or was just brewed
-        return $this->brewedClosure($identifier, $arguments);
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @param string $type
-     * @return bool|mixed
-     * @throws InvalidIdentifierException
-     */
-    protected function getShared($identifier, $type)
-    {
-        try {
-            if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
-                // if a shared service was requested and an instance is in the carafe, then return it
-                return $this->get($identifier);
-            }
-        } catch (ServiceNotFoundException $e) {
-            // if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
-            // and instead, attempt to build whatever was requested
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param mixed  $brewed
-     * @param string $identifier
-     * @param string $type
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws OutOfBoundsException
-     * @throws ServiceExistsException
-     * @throws ServiceNotFoundException
-     */
-    protected function brewedLoadOnly($brewed, $identifier, $type)
-    {
-        if ($type === CoffeeMaker::BREW_LOAD_ONLY) {
-            if ($brewed !== true) {
-                throw new ServiceNotFoundException(
-                    sprintf(
-                        esc_html__(
-                            'The "%1$s" class could not be loaded.',
-                            'event_espresso'
-                        ),
-                        $identifier
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @param array  $arguments
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function brewedClosure($identifier, array $arguments)
-    {
-        $closure = $this->reservoir->get($identifier);
-        if (empty($closure)) {
-            throw new InstantiationException(
-                sprintf(
-                    esc_html__(
-                        'Could not brew an instance of "%1$s".',
-                        'event_espresso'
-                    ),
-                    $identifier
-                )
-            );
-        }
-        return $closure($arguments);
-    }
-
-
-
-    /**
-     * @param CoffeeMakerInterface $coffee_maker
-     * @param string               $type
-     * @return bool
-     * @throws InvalidIdentifierException
-     * @throws InvalidEntityException
-     */
-    public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
-    {
-        $type = CoffeeMaker::validateType($type);
-        return $this->coffee_makers->add($coffee_maker, $type);
-    }
-
-
-
-    /**
-     * @param string   $identifier
-     * @param callable $closure
-     * @return callable|null
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     */
-    public function addClosure($identifier, $closure)
-    {
-        if ( ! is_callable($closure)) {
-            throw new InvalidDataTypeException('$closure', $closure, 'Closure');
-        }
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->add($closure, $identifier)) {
-            return $closure;
-        }
-        return null;
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function removeClosure($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->reservoir->has($identifier)) {
-            return $this->reservoir->remove($this->reservoir->get($identifier));
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed   $service
-     * @return bool
-     * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException
-     * @throws InvalidIdentifierException
-     */
-    public function addService($identifier, $service)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        $service = $this->validateService($identifier, $service);
-        return $this->carafe->add($service, $identifier);
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function removeService($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->carafe->has($identifier)) {
-            return $this->carafe->remove($this->carafe->get($identifier));
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Adds instructions on how to brew objects
-     *
-     * @param RecipeInterface $recipe
-     * @return mixed
-     * @throws InvalidIdentifierException
-     */
-    public function addRecipe(RecipeInterface $recipe)
-    {
-        $this->addAliases($recipe->identifier(), $recipe->filters());
-        $identifier = $this->processIdentifier($recipe->identifier());
-        return $this->recipes->add($recipe, $identifier);
-    }
-
-
-
-    /**
-     * @param string $identifier The Recipe's identifier
-     * @return boolean
-     * @throws InvalidIdentifierException
-     */
-    public function removeRecipe($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->remove($this->recipes->get($identifier));
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Get instructions on how to brew objects
-     *
-     * @param  string $identifier Identifier for the entity class that the recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param string  $type
-     * @return RecipeInterface
-     * @throws OutOfBoundsException
-     * @throws InvalidIdentifierException
-     */
-    public function getRecipe($identifier, $type = '')
-    {
-        $identifier = $this->processIdentifier($identifier);
-        if ($this->recipes->has($identifier)) {
-            return $this->recipes->get($identifier);
-        }
-        $default_recipes = $this->getDefaultRecipes();
-        $matches = array();
-        foreach ($default_recipes as $wildcard => $default_recipe) {
-            // is the wildcard recipe prefix in the identifier ?
-            if (strpos($identifier, $wildcard) !== false) {
-                // track matches and use the number of wildcard characters matched for the key
-                $matches[strlen($wildcard)] = $default_recipe;
-            }
-        }
-        if (count($matches) > 0) {
-            // sort our recipes by the number of wildcard characters matched
-            ksort($matches);
-            // then grab the last recipe form the list, since it had the most matching characters
-            $match = array_pop($matches);
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($match, $identifier, $type);
-        }
-        if ($this->recipes->has(Recipe::DEFAULT_ID)) {
-            // since we are using a default recipe, we need to set it's identifier and fqcn
-            return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
-        }
-        throw new OutOfBoundsException(
-            sprintf(
-                __('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
-                $identifier
-            )
-        );
-    }
-
-
-
-    /**
-     * adds class name aliases to list of filters
-     *
-     * @param  string $identifier Identifier for the entity class that the alias applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param  array  $aliases
-     * @return void
-     * @throws InvalidIdentifierException
-     */
-    public function addAliases($identifier, $aliases)
-    {
-        if (empty($aliases)) {
-            return;
-        }
-        $identifier = $this->processIdentifier($identifier);
-        foreach ((array)$aliases as $alias) {
-            $this->filters[$this->processIdentifier($alias)] = $identifier;
-        }
-    }
-
-
-
-    /**
-     * Adds a service to one of the internal collections
-     *
-     * @param        $identifier
-     * @param array  $arguments
-     * @param string $type
-     * @return mixed
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws OutOfBoundsException
-     * @throws InvalidIdentifierException
-     * @throws ServiceExistsException
-     */
-    private function makeCoffee($identifier, $arguments = array(), $type = '')
-    {
-        if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
-            throw new ServiceExistsException($identifier);
-        }
-        $identifier = $this->filterIdentifier($identifier);
-        $recipe = $this->getRecipe($identifier, $type);
-        $type = ! empty($type) ? $type : $recipe->type();
-        $coffee_maker = $this->getCoffeeMaker($type);
-        return $coffee_maker->brew($recipe, $arguments);
-    }
-
-
-
-    /**
-     * filters alias identifiers to find the real class name
-     *
-     * @param  string $identifier Identifier for the entity class that the filter applies to
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function filterIdentifier($identifier)
-    {
-        $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
-            ? $this->filters[$identifier]
-            : $identifier;
-    }
-
-
-
-    /**
-     * verifies and standardizes identifiers
-     *
-     * @param  string $identifier Identifier for the entity class
-     *                            Typically a Fully Qualified Class Name
-     * @return string
-     * @throws InvalidIdentifierException
-     */
-    private function processIdentifier($identifier)
-    {
-        if ( ! is_string($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                '\Fully\Qualified\ClassName'
-            );
-        }
-        return ltrim($identifier, '\\');
-    }
-
-
-
-    /**
-     * @param string $type
-     * @return CoffeeMakerInterface
-     * @throws OutOfBoundsException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    private function getCoffeeMaker($type)
-    {
-        if ( ! $this->coffee_makers->has($type)) {
-            throw new OutOfBoundsException(
-                __('The requested coffee maker is either missing or invalid.', 'event_espresso')
-            );
-        }
-        return $this->coffee_makers->get($type);
-    }
-
-
-
-    /**
-     * Retrieves all recipes that use a wildcard "*" in their identifier
-     * This allows recipes to be set up for handling
-     * legacy classes that do not support PSR-4 autoloading.
-     * for example:
-     * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
-     *
-     * @return array
-     */
-    private function getDefaultRecipes()
-    {
-        $default_recipes = array();
-        $this->recipes->rewind();
-        while ($this->recipes->valid()) {
-            $identifier = $this->recipes->getInfo();
-            // does this recipe use a wildcard ? (but is NOT the global default)
-            if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
-                // strip the wildcard and use identifier as key
-                $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
-            }
-            $this->recipes->next();
-        }
-        return $default_recipes;
-    }
-
-
-
-    /**
-     * clones a default recipe and then copies details
-     * from the incoming request to it so that it can be used
-     *
-     * @param RecipeInterface $default_recipe
-     * @param string          $identifier
-     * @param string          $type
-     * @return RecipeInterface
-     */
-    private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
-    {
-        $recipe = clone $default_recipe;
-        if ( ! empty($type)) {
-            $recipe->setType($type);
-        }
-        // is this the base default recipe ?
-        if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
-            $recipe->setIdentifier($identifier);
-            $recipe->setFqcn($identifier);
-            return $recipe;
-        }
-        $recipe->setIdentifier($identifier);
-        foreach ($default_recipe->paths() as $path) {
-            $path = str_replace('*', $identifier, $path);
-            if (is_readable($path)) {
-                $recipe->setPaths($path);
-            }
-        }
-        $recipe->setFqcn($identifier);
-        return $recipe;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the service applies to
-     *                            Typically a Fully Qualified Class Name
-     * @param mixed  $service
-     * @return mixed
-     * @throws InvalidServiceException
-     */
-    private function validateService($identifier, $service)
-    {
-        if ( ! is_object($service)) {
-            throw new InvalidServiceException(
-                $identifier,
-                $service
-            );
-        }
-        return $service;
-    }
+	/**
+	 * This was the best coffee related name I could think of to represent class name "aliases"
+	 * So classes can be found via an alias identifier,
+	 * that is revealed when it is run through... the filters... eh? get it?
+	 *
+	 * @var array $filters
+	 */
+	private $filters;
+
+	/**
+	 * These are the classes that will actually build the objects (to order of course)
+	 *
+	 * @var array $coffee_makers
+	 */
+	private $coffee_makers;
+
+	/**
+	 * where the instantiated "singleton" objects are stored
+	 *
+	 * @var CollectionInterface $carafe
+	 */
+	private $carafe;
+
+	/**
+	 * collection of Recipes that instruct us how to brew objects
+	 *
+	 * @var CollectionInterface $recipes
+	 */
+	private $recipes;
+
+	/**
+	 * collection of closures for brewing objects
+	 *
+	 * @var CollectionInterface $reservoir
+	 */
+	private $reservoir;
+
+
+
+	/**
+	 * CoffeeShop constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		// array for storing class aliases
+		$this->filters = array();
+		// create collection for storing shared services
+		$this->carafe = new LooseCollection( '' );
+		// create collection for storing recipes that tell us how to build services and entities
+		$this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
+		// create collection for storing closures for constructing new entities
+		$this->reservoir = new Collection('Closure');
+		// create collection for storing the generators that build our services and entity closures
+		$this->coffee_makers = new Collection('EventEspresso\core\services\container\CoffeeMakerInterface');
+	}
+
+
+
+	/**
+	 * Returns true if the container can return an entry for the given identifier.
+	 * Returns false otherwise.
+	 * `has($identifier)` returning true does not mean that `get($identifier)` will not throw an exception.
+	 * It does however mean that `get($identifier)` will not throw a `ServiceNotFoundException`.
+	 *
+	 * @param string $identifier  Identifier of the entry to look for.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function has($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		return $this->carafe->has($identifier);
+	}
+
+
+
+	/**
+	 * finds a previously brewed (SHARED) service and returns it
+	 *
+	 * @param  string $identifier Identifier for the entity class to be constructed.
+	 *                            Typically a Fully Qualified Class Name
+	 * @return mixed
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function get($identifier)
+	{
+		$identifier = $this->filterIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->get($identifier);
+		}
+		throw new ServiceNotFoundException($identifier);
+	}
+
+
+
+	/**
+	 * 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
+	 * @throws OutOfBoundsException
+	 * @throws InstantiationException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceExistsException
+	 * @throws ServiceNotFoundException No service was found for this identifier.
+	 */
+	public function brew($identifier, $arguments = array(), $type = '')
+	{
+		// resolve any class aliases that may exist
+		$identifier = $this->filterIdentifier($identifier);
+		// is a shared service being requested and already exists in the carafe?
+		$brewed = $this->getShared($identifier, $type);
+		// then return whatever was found
+		if($brewed !== false) {
+			return $brewed;
+		}
+		// if the reservoir doesn't have a closure already for the requested identifier,
+		// then neither a shared service nor a closure for making entities has been built yet
+		if (! $this->reservoir->has($identifier)) {
+			// so let's brew something up and add it to the proper collection
+			$brewed = $this->makeCoffee($identifier, $arguments, $type);
+		}
+		// did the requested class only require loading, and if so, was that successful?
+		if($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
+			return true;
+		}
+		// was the brewed item a callable factory function ?
+		if (is_callable($brewed)) {
+			// then instantiate a new entity from the cached closure
+			return $brewed($arguments);
+		}
+		if ($brewed) {
+			// requested object was a shared entity, so attempt to get it from the carafe again
+			// because if it wasn't there before, then it should have just been brewed and added,
+			// but if it still isn't there, then this time the thrown ServiceNotFoundException will not be caught
+			return $this->get($identifier);
+		}
+		// if identifier is for a non-shared entity,
+		// then either a cached closure already existed, or was just brewed
+		return $this->brewedClosure($identifier, $arguments);
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @param string $type
+	 * @return bool|mixed
+	 * @throws InvalidIdentifierException
+	 */
+	protected function getShared($identifier, $type)
+	{
+		try {
+			if (empty($type) || $type === CoffeeMaker::BREW_SHARED) {
+				// if a shared service was requested and an instance is in the carafe, then return it
+				return $this->get($identifier);
+			}
+		} catch (ServiceNotFoundException $e) {
+			// if not then we'll just catch the ServiceNotFoundException but not do anything just yet,
+			// and instead, attempt to build whatever was requested
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param mixed  $brewed
+	 * @param string $identifier
+	 * @param string $type
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws OutOfBoundsException
+	 * @throws ServiceExistsException
+	 * @throws ServiceNotFoundException
+	 */
+	protected function brewedLoadOnly($brewed, $identifier, $type)
+	{
+		if ($type === CoffeeMaker::BREW_LOAD_ONLY) {
+			if ($brewed !== true) {
+				throw new ServiceNotFoundException(
+					sprintf(
+						esc_html__(
+							'The "%1$s" class could not be loaded.',
+							'event_espresso'
+						),
+						$identifier
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function brewedClosure($identifier, array $arguments)
+	{
+		$closure = $this->reservoir->get($identifier);
+		if (empty($closure)) {
+			throw new InstantiationException(
+				sprintf(
+					esc_html__(
+						'Could not brew an instance of "%1$s".',
+						'event_espresso'
+					),
+					$identifier
+				)
+			);
+		}
+		return $closure($arguments);
+	}
+
+
+
+	/**
+	 * @param CoffeeMakerInterface $coffee_maker
+	 * @param string               $type
+	 * @return bool
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidEntityException
+	 */
+	public function addCoffeeMaker(CoffeeMakerInterface $coffee_maker, $type)
+	{
+		$type = CoffeeMaker::validateType($type);
+		return $this->coffee_makers->add($coffee_maker, $type);
+	}
+
+
+
+	/**
+	 * @param string   $identifier
+	 * @param callable $closure
+	 * @return callable|null
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 */
+	public function addClosure($identifier, $closure)
+	{
+		if ( ! is_callable($closure)) {
+			throw new InvalidDataTypeException('$closure', $closure, 'Closure');
+		}
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->add($closure, $identifier)) {
+			return $closure;
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeClosure($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->reservoir->has($identifier)) {
+			return $this->reservoir->remove($this->reservoir->get($identifier));
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed   $service
+	 * @return bool
+	 * @throws \EventEspresso\core\services\container\exceptions\InvalidServiceException
+	 * @throws InvalidIdentifierException
+	 */
+	public function addService($identifier, $service)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		$service = $this->validateService($identifier, $service);
+		return $this->carafe->add($service, $identifier);
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeService($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->carafe->has($identifier)) {
+			return $this->carafe->remove($this->carafe->get($identifier));
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Adds instructions on how to brew objects
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return mixed
+	 * @throws InvalidIdentifierException
+	 */
+	public function addRecipe(RecipeInterface $recipe)
+	{
+		$this->addAliases($recipe->identifier(), $recipe->filters());
+		$identifier = $this->processIdentifier($recipe->identifier());
+		return $this->recipes->add($recipe, $identifier);
+	}
+
+
+
+	/**
+	 * @param string $identifier The Recipe's identifier
+	 * @return boolean
+	 * @throws InvalidIdentifierException
+	 */
+	public function removeRecipe($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->remove($this->recipes->get($identifier));
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Get instructions on how to brew objects
+	 *
+	 * @param  string $identifier Identifier for the entity class that the recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param string  $type
+	 * @return RecipeInterface
+	 * @throws OutOfBoundsException
+	 * @throws InvalidIdentifierException
+	 */
+	public function getRecipe($identifier, $type = '')
+	{
+		$identifier = $this->processIdentifier($identifier);
+		if ($this->recipes->has($identifier)) {
+			return $this->recipes->get($identifier);
+		}
+		$default_recipes = $this->getDefaultRecipes();
+		$matches = array();
+		foreach ($default_recipes as $wildcard => $default_recipe) {
+			// is the wildcard recipe prefix in the identifier ?
+			if (strpos($identifier, $wildcard) !== false) {
+				// track matches and use the number of wildcard characters matched for the key
+				$matches[strlen($wildcard)] = $default_recipe;
+			}
+		}
+		if (count($matches) > 0) {
+			// sort our recipes by the number of wildcard characters matched
+			ksort($matches);
+			// then grab the last recipe form the list, since it had the most matching characters
+			$match = array_pop($matches);
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($match, $identifier, $type);
+		}
+		if ($this->recipes->has(Recipe::DEFAULT_ID)) {
+			// since we are using a default recipe, we need to set it's identifier and fqcn
+			return $this->copyDefaultRecipe($this->recipes->get(Recipe::DEFAULT_ID), $identifier, $type);
+		}
+		throw new OutOfBoundsException(
+			sprintf(
+				__('Could not brew coffee because no recipes were found for class "%1$s".', 'event_espresso'),
+				$identifier
+			)
+		);
+	}
+
+
+
+	/**
+	 * adds class name aliases to list of filters
+	 *
+	 * @param  string $identifier Identifier for the entity class that the alias applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param  array  $aliases
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 */
+	public function addAliases($identifier, $aliases)
+	{
+		if (empty($aliases)) {
+			return;
+		}
+		$identifier = $this->processIdentifier($identifier);
+		foreach ((array)$aliases as $alias) {
+			$this->filters[$this->processIdentifier($alias)] = $identifier;
+		}
+	}
+
+
+
+	/**
+	 * Adds a service to one of the internal collections
+	 *
+	 * @param        $identifier
+	 * @param array  $arguments
+	 * @param string $type
+	 * @return mixed
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws OutOfBoundsException
+	 * @throws InvalidIdentifierException
+	 * @throws ServiceExistsException
+	 */
+	private function makeCoffee($identifier, $arguments = array(), $type = '')
+	{
+		if ((empty($type) || $type === CoffeeMaker::BREW_SHARED) && $this->has($identifier)) {
+			throw new ServiceExistsException($identifier);
+		}
+		$identifier = $this->filterIdentifier($identifier);
+		$recipe = $this->getRecipe($identifier, $type);
+		$type = ! empty($type) ? $type : $recipe->type();
+		$coffee_maker = $this->getCoffeeMaker($type);
+		return $coffee_maker->brew($recipe, $arguments);
+	}
+
+
+
+	/**
+	 * filters alias identifiers to find the real class name
+	 *
+	 * @param  string $identifier Identifier for the entity class that the filter applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function filterIdentifier($identifier)
+	{
+		$identifier = $this->processIdentifier($identifier);
+		return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
+			? $this->filters[$identifier]
+			: $identifier;
+	}
+
+
+
+	/**
+	 * verifies and standardizes identifiers
+	 *
+	 * @param  string $identifier Identifier for the entity class
+	 *                            Typically a Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidIdentifierException
+	 */
+	private function processIdentifier($identifier)
+	{
+		if ( ! is_string($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				'\Fully\Qualified\ClassName'
+			);
+		}
+		return ltrim($identifier, '\\');
+	}
+
+
+
+	/**
+	 * @param string $type
+	 * @return CoffeeMakerInterface
+	 * @throws OutOfBoundsException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	private function getCoffeeMaker($type)
+	{
+		if ( ! $this->coffee_makers->has($type)) {
+			throw new OutOfBoundsException(
+				__('The requested coffee maker is either missing or invalid.', 'event_espresso')
+			);
+		}
+		return $this->coffee_makers->get($type);
+	}
+
+
+
+	/**
+	 * Retrieves all recipes that use a wildcard "*" in their identifier
+	 * This allows recipes to be set up for handling
+	 * legacy classes that do not support PSR-4 autoloading.
+	 * for example:
+	 * using "EEM_*" for a recipe identifier would target all legacy models like EEM_Attendee
+	 *
+	 * @return array
+	 */
+	private function getDefaultRecipes()
+	{
+		$default_recipes = array();
+		$this->recipes->rewind();
+		while ($this->recipes->valid()) {
+			$identifier = $this->recipes->getInfo();
+			// does this recipe use a wildcard ? (but is NOT the global default)
+			if ($identifier !== Recipe::DEFAULT_ID && strpos($identifier, '*') !== false) {
+				// strip the wildcard and use identifier as key
+				$default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
+			}
+			$this->recipes->next();
+		}
+		return $default_recipes;
+	}
+
+
+
+	/**
+	 * clones a default recipe and then copies details
+	 * from the incoming request to it so that it can be used
+	 *
+	 * @param RecipeInterface $default_recipe
+	 * @param string          $identifier
+	 * @param string          $type
+	 * @return RecipeInterface
+	 */
+	private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
+	{
+		$recipe = clone $default_recipe;
+		if ( ! empty($type)) {
+			$recipe->setType($type);
+		}
+		// is this the base default recipe ?
+		if ($default_recipe->identifier() === Recipe::DEFAULT_ID) {
+			$recipe->setIdentifier($identifier);
+			$recipe->setFqcn($identifier);
+			return $recipe;
+		}
+		$recipe->setIdentifier($identifier);
+		foreach ($default_recipe->paths() as $path) {
+			$path = str_replace('*', $identifier, $path);
+			if (is_readable($path)) {
+				$recipe->setPaths($path);
+			}
+		}
+		$recipe->setFqcn($identifier);
+		return $recipe;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the service applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @param mixed  $service
+	 * @return mixed
+	 * @throws InvalidServiceException
+	 */
+	private function validateService($identifier, $service)
+	{
+		if ( ! is_object($service)) {
+			throw new InvalidServiceException(
+				$identifier,
+				$service
+			);
+		}
+		return $service;
+	}
 
 }
 // End of file CoffeeShop.php

Spacing +5 added lines, -5 removed lines

@@ -82,7 +82,7 @@ 
         // array for storing class aliases
         $this->filters = array();
         // create collection for storing shared services
-        $this->carafe = new LooseCollection( '' );
+        $this->carafe = new LooseCollection('');
         // create collection for storing recipes that tell us how to build services and entities
         $this->recipes = new Collection('EventEspresso\core\services\container\RecipeInterface');
         // create collection for storing closures for constructing new entities
@@ -161,17 +161,17 @@ 
         // is a shared service being requested and already exists in the carafe?
         $brewed = $this->getShared($identifier, $type);
         // then return whatever was found
-        if($brewed !== false) {
+        if ($brewed !== false) {
             return $brewed;
         }
         // if the reservoir doesn't have a closure already for the requested identifier,
         // then neither a shared service nor a closure for making entities has been built yet
-        if (! $this->reservoir->has($identifier)) {
+        if ( ! $this->reservoir->has($identifier)) {
             // so let's brew something up and add it to the proper collection
             $brewed = $this->makeCoffee($identifier, $arguments, $type);
         }
         // did the requested class only require loading, and if so, was that successful?
-        if($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
+        if ($this->brewedLoadOnly($brewed, $identifier, $type) === true) {
             return true;
         }
         // was the brewed item a callable factory function ?
@@ -451,7 +451,7 @@ 
             return;
         }
         $identifier = $this->processIdentifier($identifier);
-        foreach ((array)$aliases as $alias) {
+        foreach ((array) $aliases as $alias) {
             $this->filters[$this->processIdentifier($alias)] = $identifier;
         }
     }

core/services/container/LoadOnlyCoffeeMaker.php

Indentation +21 added lines, -21 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\exceptions\InvalidClassException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -26,26 +26,26 @@ 
 class LoadOnlyCoffeeMaker extends CoffeeMaker
 {
 
-    /**
-     * @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);
-    }
+	/**
+	 * @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);
+	}
 
 
 

core/services/container/Recipe.php

Indentation +311 added lines, -311 removed lines

@@ -8,7 +8,7 @@ 
 use RuntimeException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,316 +24,316 @@ 
 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
-     */
-    public function __construct(
-	    $identifier,
-        $fqcn = '',
-        $filters = array(),
-        $ingredients = array(),
-	    $type = CoffeeMaker::BREW_NEW,
-	    $paths = array()
-    )
-    {
-        $this->setIdentifier($identifier);
-        $this->setFilters((array)$filters);
-        $this->setIngredients((array)$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 (array)$this->filters;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function ingredients()
-    {
-        return $this->ingredients;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function paths()
-    {
-        return (array)$this->paths;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     */
-    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' )
-     */
-    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()
-     */
-    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' )
-     */
-    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
-     */
-    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
+	 */
+	public function __construct(
+		$identifier,
+		$fqcn = '',
+		$filters = array(),
+		$ingredients = array(),
+		$type = CoffeeMaker::BREW_NEW,
+		$paths = array()
+	)
+	{
+		$this->setIdentifier($identifier);
+		$this->setFilters((array)$filters);
+		$this->setIngredients((array)$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 (array)$this->filters;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function ingredients()
+	{
+		return $this->ingredients;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function paths()
+	{
+		return (array)$this->paths;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 */
+	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' )
+	 */
+	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()
+	 */
+	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' )
+	 */
+	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
+	 */
+	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);
+	}
 
 
 

core/services/container/OpenCoffeeShop.php

Indentation +100 added lines, -100 removed lines

@@ -30,16 +30,16 @@ 
 
 
 
-    /**
-     * OpenCoffeeShop constructor
-     *
-     * @throws InvalidInterfaceException
-     */
+	/**
+	 * OpenCoffeeShop constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
 	public function __construct()
-    {
-        // instantiate the DI container
+	{
+		// instantiate the DI container
 		$this->CoffeeShop = new CoffeeShop();
-    }
+	}
 
 
 
@@ -52,60 +52,60 @@ 
 
 
 
-    /**
-     * configure coffee makers which control the different kinds of brews
-     * ( shared services, new factory objects, etc )
-     *
-     * @throws InvalidEntityException
-     */
+	/**
+	 * configure coffee makers which control the different kinds of brews
+	 * ( shared services, new factory objects, etc )
+	 *
+	 * @throws InvalidEntityException
+	 */
 	public function setupCoffeeMakers() {
-        // create a dependency injector class for resolving class constructor arguments
-        $DependencyInjector = new DependencyInjector(
-            $this->CoffeeShop,
-            new \EEH_Array()
-        );
-        // and some coffeemakers, one for creating new instances
-        $this->CoffeeShop->addCoffeeMaker(
-            new NewCoffeeMaker($this->CoffeeShop, $DependencyInjector),
-            CoffeeMaker::BREW_NEW
-        );
-        // one for shared services
-        $this->CoffeeShop->addCoffeeMaker(
-            new SharedCoffeeMaker($this->CoffeeShop, $DependencyInjector),
-            CoffeeMaker::BREW_SHARED
-        );
-        // and one for classes that only get loaded
-        $this->CoffeeShop->addCoffeeMaker(
-            new LoadOnlyCoffeeMaker($this->CoffeeShop, $DependencyInjector),
-            CoffeeMaker::BREW_LOAD_ONLY
-        );
-    }
-
-
-
-    /**
-     * Recipes define how to load legacy classes
-     *
-     * @throws InvalidIdentifierException
-     */
-    public function addRecipes() {
-        // add default recipe, which should handle loading for most PSR-4 compatible classes
-        // as long as they are not type hinting for interfaces
-        $this->CoffeeShop->addRecipe(
-            new Recipe(
-                Recipe::DEFAULT_ID
-            )
-        );
-        // PSR-4 compatible class with aliases
+		// create a dependency injector class for resolving class constructor arguments
+		$DependencyInjector = new DependencyInjector(
+			$this->CoffeeShop,
+			new \EEH_Array()
+		);
+		// and some coffeemakers, one for creating new instances
+		$this->CoffeeShop->addCoffeeMaker(
+			new NewCoffeeMaker($this->CoffeeShop, $DependencyInjector),
+			CoffeeMaker::BREW_NEW
+		);
+		// one for shared services
+		$this->CoffeeShop->addCoffeeMaker(
+			new SharedCoffeeMaker($this->CoffeeShop, $DependencyInjector),
+			CoffeeMaker::BREW_SHARED
+		);
+		// and one for classes that only get loaded
+		$this->CoffeeShop->addCoffeeMaker(
+			new LoadOnlyCoffeeMaker($this->CoffeeShop, $DependencyInjector),
+			CoffeeMaker::BREW_LOAD_ONLY
+		);
+	}
+
+
+
+	/**
+	 * Recipes define how to load legacy classes
+	 *
+	 * @throws InvalidIdentifierException
+	 */
+	public function addRecipes() {
+		// add default recipe, which should handle loading for most PSR-4 compatible classes
+		// as long as they are not type hinting for interfaces
+		$this->CoffeeShop->addRecipe(
+			new Recipe(
+				Recipe::DEFAULT_ID
+			)
+		);
+		// PSR-4 compatible class with aliases
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'CommandHandlerManager',
 				'EventEspresso\core\services\commands\CommandHandlerManager',
-                array(
-                    'CommandHandlerManagerInterface',
-                    'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-                ),
-                array(),
+				array(
+					'CommandHandlerManagerInterface',
+					'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+				),
+				array(),
 				CoffeeMaker::BREW_SHARED
 			)
 		);
@@ -114,11 +114,11 @@ 
 			new Recipe(
 				'CommandBus',
 				'EventEspresso\core\services\commands\CommandBus',
-                array(
-                    'CommandBusInterface',
-                    'EventEspresso\core\services\commands\CommandBusInterface',
-                ),
-                array(),
+				array(
+					'CommandBusInterface',
+					'EventEspresso\core\services\commands\CommandBusInterface',
+				),
+				array(),
 				CoffeeMaker::BREW_SHARED
 			)
 		);
@@ -128,22 +128,22 @@ 
 			new Recipe(
 				'EEI_*',
 				'',
-                array(),
-                array(),
+				array(),
+				array(),
 				CoffeeMaker::BREW_LOAD_ONLY,
-                array(
-                    EE_INTERFACES . '*.php',
-                    EE_INTERFACES . '*.interfaces.php',
-                )
+				array(
+					EE_INTERFACES . '*.php',
+					EE_INTERFACES . '*.interfaces.php',
+				)
 			)
 		);
 		// add a wildcard recipe for loading models
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'EEM_*',
-                '',
-                array(),
-                array(),
+				'',
+				array(),
+				array(),
 				CoffeeMaker::BREW_SHARED,
 				EE_MODELS . '*.model.php'
 			)
@@ -152,10 +152,10 @@ 
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'EE_*',
-                '',
-                array(),
-                array(),
-                CoffeeMaker::BREW_SHARED,
+				'',
+				array(),
+				array(),
+				CoffeeMaker::BREW_SHARED,
 				array(
 					EE_CORE . '*.core.php',
 					EE_ADMIN . '*.core.php',
@@ -170,10 +170,10 @@ 
 		$this->CoffeeShop->addRecipe(
 			new Recipe(
 				'EE_Admin_Page*',
-                '',
-                array(),
-                array(),
-                CoffeeMaker::BREW_LOAD_ONLY,
+				'',
+				array(),
+				array(),
+				CoffeeMaker::BREW_LOAD_ONLY,
 				array( EE_ADMIN . '*.core.php' )
 			)
 		);
@@ -181,10 +181,10 @@ 
 		// $this->CoffeeShop->addRecipe(
 		// 	new Recipe(
 		// 		'*_Admin_Page',
-        //      '',
-        //      array(),
-        // 		array(),
-        // 		CoffeeMaker::BREW_SHARED,
+		//      '',
+		//      array(),
+		// 		array(),
+		// 		CoffeeMaker::BREW_SHARED,
 		// 		array(
 		// 			EE_ADMIN_PAGES . 'transactions' . DS . '*.core.php',
 		// 		)
@@ -194,23 +194,23 @@ 
 
 
 
-    /**
-     * bootstrap EE and the request stack
-     *
-     * @throws ServiceNotFoundException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws exceptions\ServiceExistsException
-     * @throws OutOfBoundsException
-     * @throws exceptions\InstantiationException
-     */
-    public function firstBrew()
-    {
-        $this->CoffeeShop->brew('EE_Request', array($_GET, $_POST, $_COOKIE));
-        $this->CoffeeShop->brew('EE_Response');
-        $this->CoffeeShop->brew('EE_Bootstrap');
-    }
+	/**
+	 * bootstrap EE and the request stack
+	 *
+	 * @throws ServiceNotFoundException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws exceptions\ServiceExistsException
+	 * @throws OutOfBoundsException
+	 * @throws exceptions\InstantiationException
+	 */
+	public function firstBrew()
+	{
+		$this->CoffeeShop->brew('EE_Request', array($_GET, $_POST, $_COOKIE));
+		$this->CoffeeShop->brew('EE_Response');
+		$this->CoffeeShop->brew('EE_Bootstrap');
+	}
 
 
 }

Spacing +10 added lines, -10 removed lines

@@ -132,8 +132,8 @@ 
                 array(),
 				CoffeeMaker::BREW_LOAD_ONLY,
                 array(
-                    EE_INTERFACES . '*.php',
-                    EE_INTERFACES . '*.interfaces.php',
+                    EE_INTERFACES.'*.php',
+                    EE_INTERFACES.'*.interfaces.php',
                 )
 			)
 		);
@@ -145,7 +145,7 @@ 
                 array(),
                 array(),
 				CoffeeMaker::BREW_SHARED,
-				EE_MODELS . '*.model.php'
+				EE_MODELS.'*.model.php'
 			)
 		);
 		// add a wildcard recipe for loading core classes
@@ -157,12 +157,12 @@ 
                 array(),
                 CoffeeMaker::BREW_SHARED,
 				array(
-					EE_CORE . '*.core.php',
-					EE_ADMIN . '*.core.php',
-					EE_CPTS . '*.core.php',
-					EE_CORE . 'data_migration_scripts' . DS . '*.core.php',
-					EE_CORE . 'request_stack' . DS . '*.core.php',
-					EE_CORE . 'middleware' . DS . '*.core.php',
+					EE_CORE.'*.core.php',
+					EE_ADMIN.'*.core.php',
+					EE_CPTS.'*.core.php',
+					EE_CORE.'data_migration_scripts'.DS.'*.core.php',
+					EE_CORE.'request_stack'.DS.'*.core.php',
+					EE_CORE.'middleware'.DS.'*.core.php',
 				)
 			)
 		);
@@ -174,7 +174,7 @@ 
                 array(),
                 array(),
                 CoffeeMaker::BREW_LOAD_ONLY,
-				array( EE_ADMIN . '*.core.php' )
+				array(EE_ADMIN.'*.core.php')
 			)
 		);
 		// add a wildcard recipe for loading core classes

core/EE_Error.core.php

Spacing +247 added lines, -247 removed lines

@@ -1,8 +1,8 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 // if you're a dev and want to receive all errors via email add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE );
-if ( defined( 'WP_DEBUG' ) && WP_DEBUG === TRUE && defined( 'EE_ERROR_EMAILS' ) && EE_ERROR_EMAILS === TRUE ) {
-	set_error_handler( array( 'EE_Error', 'error_handler' ));
-	register_shutdown_function( array( 'EE_Error', 'fatal_error_handler' ));
+if (defined('WP_DEBUG') && WP_DEBUG === TRUE && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === TRUE) {
+	set_error_handler(array('EE_Error', 'error_handler'));
+	register_shutdown_function(array('EE_Error', 'fatal_error_handler'));
 }
 /**
  *
@@ -64,7 +64,7 @@ 
 	* 	@access	private
     *	@var boolean
 	*/
-	private static $_espresso_notices = array( 'success' => FALSE, 'errors' => FALSE, 'attention' => FALSE );
+	private static $_espresso_notices = array('success' => FALSE, 'errors' => FALSE, 'attention' => FALSE);
 
 
 
@@ -75,11 +75,11 @@ 
 	*	@access public
 	*	@echo string
 	*/
-	function __construct( $message, $code = 0, Exception $previous = NULL ) {
-		if ( version_compare( phpversion(), '5.3.0', '<' )) {
-			parent::__construct( $message, $code );
+	function __construct($message, $code = 0, Exception $previous = NULL) {
+		if (version_compare(phpversion(), '5.3.0', '<')) {
+			parent::__construct($message, $code);
 		} else {
-			parent::__construct( $message, $code, $previous );
+			parent::__construct($message, $code, $previous);
 		}
 	}
 
@@ -94,10 +94,10 @@ 
 	 * @param $line
 	 * @return void
 	 */
-	public static function error_handler( $code, $message, $file, $line ) {
-		$type = EE_Error::error_type( $code );
+	public static function error_handler($code, $message, $file, $line) {
+		$type = EE_Error::error_type($code);
 		$site = site_url();
-		switch ( $site ) {
+		switch ($site) {
 			case 'http://ee4.eventespresso.com/' :
 			case 'http://ee4decaf.eventespresso.com/' :
 			case 'http://ee4hf.eventespresso.com/' :
@@ -110,16 +110,16 @@ 
 				$to = 'developers@eventespresso.com';
 				break;
 			default :
-				$to = get_option( 'admin_email' );
+				$to = get_option('admin_email');
 		}
-		$subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url();
-		$msg = EE_Error::_format_error( $type, $message, $file, $line );
-		if ( function_exists( 'wp_mail' )) {
-			add_filter( 'wp_mail_content_type', array( 'EE_Error', 'set_content_type' ));
-			wp_mail( $to, $subject, $msg );
+		$subject = $type.' '.$message.' in '.EVENT_ESPRESSO_VERSION.' on '.site_url();
+		$msg = EE_Error::_format_error($type, $message, $file, $line);
+		if (function_exists('wp_mail')) {
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			wp_mail($to, $subject, $msg);
 		}
 		echo '<div id="message" class="espresso-notices error"><p>';
-		echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line;
+		echo $type.': '.$message.'<br />'.$file.' line '.$line;
 		echo '<br /></p></div>';
 	}
 
@@ -132,8 +132,8 @@ 
 	 * @param $code
 	 * @return string
 	 */
-	public static function error_type( $code ) {
-		switch( $code ) {
+	public static function error_type($code) {
+		switch ($code) {
 			case E_ERROR: // 1 //
 			return 'E_ERROR';
 			case E_WARNING: // 2 //
@@ -179,8 +179,8 @@ 
 	*/
 	public static function fatal_error_handler() {
 		$last_error = error_get_last();
-		if ( $last_error['type'] === E_ERROR ) {
-			EE_Error::error_handler( E_ERROR, $last_error['message'], $last_error['file'], $last_error['line'] );
+		if ($last_error['type'] === E_ERROR) {
+			EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']);
 		}
 	}
 
@@ -195,7 +195,7 @@ 
 	 * @param $line
 	 * @return string
 	 */
-	private static function _format_error( $code, $message, $file, $line ) {
+	private static function _format_error($code, $message, $file, $line) {
 		$html  = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>";
 		$html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>";
 		$html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>";
@@ -213,7 +213,7 @@ 
 	 * @param $content_type
 	 * @return string
 	 */
-	public static function set_content_type( $content_type ) {
+	public static function set_content_type($content_type) {
 		return 'text/html';
 	}
 
@@ -227,24 +227,24 @@ 
 	*/
     public function get_error() {
 
-		if( apply_filters( 'FHEE__EE_Error__get_error__show_normal_exceptions', FALSE ) ){
+		if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', FALSE)) {
 			throw $this;
 		}
 		// get separate user and developer messages if they exist
-		$msg = explode( '||', $this->getMessage() );
+		$msg = explode('||', $this->getMessage());
 		$user_msg = $msg[0];
-		$dev_msg = isset( $msg[1] ) ? $msg[1] : $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
 		$msg = WP_DEBUG ? $dev_msg : $user_msg;
 
 		// add details to _all_exceptions array
 		$x_time = time();
-		self::$_all_exceptions[ $x_time ]['name'] 	= get_class( $this );
-		self::$_all_exceptions[ $x_time ]['file'] 		= $this->getFile();
-		self::$_all_exceptions[ $x_time ]['line'] 		= $this->getLine();
-		self::$_all_exceptions[ $x_time ]['msg'] 	= $msg;
-		self::$_all_exceptions[ $x_time ]['code'] 	= $this->getCode();
-		self::$_all_exceptions[ $x_time ]['trace'] 	= $this->getTrace();
-		self::$_all_exceptions[ $x_time ]['string'] 	= $this->getTraceAsString();
+		self::$_all_exceptions[$x_time]['name'] = get_class($this);
+		self::$_all_exceptions[$x_time]['file'] 		= $this->getFile();
+		self::$_all_exceptions[$x_time]['line'] 		= $this->getLine();
+		self::$_all_exceptions[$x_time]['msg'] = $msg;
+		self::$_all_exceptions[$x_time]['code'] = $this->getCode();
+		self::$_all_exceptions[$x_time]['trace'] 	= $this->getTrace();
+		self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString();
 		self::$_error_count++;
 
 		//add_action( 'shutdown', array( $this, 'display_errors' ));
@@ -262,14 +262,14 @@ 
      * @param string $type_to_check
      * @return bool
      */
-    public static function has_error( $check_stored = false, $type_to_check = 'errors' ){
+    public static function has_error($check_stored = false, $type_to_check = 'errors') {
 	    $has_error = isset(self::$_espresso_notices[$type_to_check]) && ! empty(self::$_espresso_notices[$type_to_check])
             ? true
             : false;
-	    if ( $check_stored && ! $has_error ) {
-		    $notices = (array) get_option( 'ee_notices', array() );
-		    foreach ( $notices as $type => $notice ) {
-			    if ( $type === $type_to_check && $notice ) {
+	    if ($check_stored && ! $has_error) {
+		    $notices = (array) get_option('ee_notices', array());
+		    foreach ($notices as $type => $notice) {
+			    if ($type === $type_to_check && $notice) {
 				    return true;
 			    }
 		    }
@@ -284,7 +284,7 @@ 
 	*	@access public
 	*	@echo string
 	*/
-    public function display_errors(){
+    public function display_errors() {
 
 		$trace_details = '';
 
@@ -345,18 +345,18 @@ 
 </style>
 <div id="ee-error-message" class="error">';
 
-		if ( ! WP_DEBUG ) {
+		if ( ! WP_DEBUG) {
 			$output .= '
 	<p>';
 		}
 
 		// cycle thru errors
-		foreach ( self::$_all_exceptions as $time => $ex ) {
+		foreach (self::$_all_exceptions as $time => $ex) {
 
 			// process trace info
-			if ( empty( $ex['trace'] )) {
+			if (empty($ex['trace'])) {
 
-	            $trace_details .= __( 'Sorry, but no trace information was available for this exception.', 'event_espresso' );
+	            $trace_details .= __('Sorry, but no trace information was available for this exception.', 'event_espresso');
 
 			} else {
 
@@ -371,50 +371,50 @@ 
 					<th scope="col" align="left">Method( arguments )</th>
 				</tr>';
 
-				$last_on_stack = count( $ex['trace'] ) - 1;
+				$last_on_stack = count($ex['trace']) - 1;
 				// reverse array so that stack is in proper chronological order
-				$sorted_trace = array_reverse( $ex['trace'] );
+				$sorted_trace = array_reverse($ex['trace']);
 
-				foreach ( $sorted_trace as $nmbr => $trace ) {
+				foreach ($sorted_trace as $nmbr => $trace) {
 
-					$file = isset( $trace['file'] ) ? $trace['file'] : '' ;
-					$class = isset( $trace['class'] ) ? $trace['class'] : '';
-					$type = isset( $trace['type'] ) ? $trace['type'] : '';
-					$function = isset( $trace['function'] ) ? $trace['function'] : '';
-					$args = isset( $trace['args'] ) ? $this->_convert_args_to_string( $trace['args'] ) : '';
-					$line = isset( $trace['line'] ) ? $trace['line'] : '';
+					$file = isset($trace['file']) ? $trace['file'] : '';
+					$class = isset($trace['class']) ? $trace['class'] : '';
+					$type = isset($trace['type']) ? $trace['type'] : '';
+					$function = isset($trace['function']) ? $trace['function'] : '';
+					$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+					$line = isset($trace['line']) ? $trace['line'] : '';
 					$zebra = $nmbr % 2 ? ' odd' : '';
 
-					if ( empty( $file ) && ! empty( $class )) {
-						$a = new ReflectionClass( $class );
+					if (empty($file) && ! empty($class)) {
+						$a = new ReflectionClass($class);
 						$file = $a->getFileName();
-						if ( empty( $line ) && ! empty( $function )) {
-							$b = new ReflectionMethod( $class, $function );
+						if (empty($line) && ! empty($function)) {
+							$b = new ReflectionMethod($class, $function);
 							$line = $b->getStartLine();
 						}
 					}
 
-					if ( $nmbr == $last_on_stack ) {
+					if ($nmbr == $last_on_stack) {
 						$file = $ex['file'] != '' ? $ex['file'] : $file;
 						$line = $ex['line'] != '' ? $ex['line'] : $line;
-						$error_code = self::generate_error_code ( $file, $trace['function'], $line );
+						$error_code = self::generate_error_code($file, $trace['function'], $line);
 					}
 
-					$nmbr_dsply = ! empty( $nmbr ) ? $nmbr : '&nbsp;';
-					$line_dsply = ! empty( $line ) ? $line : '&nbsp;';
-					$file_dsply = ! empty( $file ) ? $file : '&nbsp;';
-					$class_dsply = ! empty( $class ) ? $class : '&nbsp;';
-					$type_dsply = ! empty( $type ) ? $type : '&nbsp;';
-					$function_dsply = ! empty( $function ) ? $function : '&nbsp;';
-					$args_dsply = ! empty( $args ) ? '( ' . $args . ' )' : '';
+					$nmbr_dsply = ! empty($nmbr) ? $nmbr : '&nbsp;';
+					$line_dsply = ! empty($line) ? $line : '&nbsp;';
+					$file_dsply = ! empty($file) ? $file : '&nbsp;';
+					$class_dsply = ! empty($class) ? $class : '&nbsp;';
+					$type_dsply = ! empty($type) ? $type : '&nbsp;';
+					$function_dsply = ! empty($function) ? $function : '&nbsp;';
+					$args_dsply = ! empty($args) ? '( '.$args.' )' : '';
 
 		              $trace_details .= '
 					<tr>
-						<td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td>
-						<td align="right" class="' . $zebra . '">' . $line_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $file_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $class_dsply . '</td>
-						<td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td>
+						<td align="right" class="' . $zebra.'">'.$nmbr_dsply.'</td>
+						<td align="right" class="' . $zebra.'">'.$line_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$file_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$class_dsply.'</td>
+						<td align="left" class="' . $zebra.'">'.$type_dsply.$function_dsply.$args_dsply.'</td>
 					</tr>';
 
 
@@ -429,9 +429,9 @@ 
 			$ex['code'] = $ex['code'] ? $ex['code'] : $error_code;
 
 			// add generic non-identifying messages for non-privileged uesrs
-			if ( ! WP_DEBUG ) {
+			if ( ! WP_DEBUG) {
 
-				$output .= '<span class="ee-error-user-msg-spn">' . trim( $ex['msg'] )  . '</span> &nbsp; <sup>' . $ex['code'] . '</sup><br />';
+				$output .= '<span class="ee-error-user-msg-spn">'.trim($ex['msg']).'</span> &nbsp; <sup>'.$ex['code'].'</sup><br />';
 
 			} else {
 
@@ -439,24 +439,24 @@ 
 				$output .= '
 		<div class="ee-error-dev-msg-dv">
 			<p class="ee-error-dev-msg-pg">
-				<strong class="ee-error-dev-msg-str">An ' . $ex['name'] . ' exception was thrown!</strong>  &nbsp; <span>code: ' . $ex['code'] . '</span><br />
-				<span class="big-text">"' . trim( $ex['msg'] ) . '"</span><br/>
-				<a id="display-ee-error-trace-' . self::$_error_count . $time . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-' . self::$_error_count . $time . '">
-					' . __( 'click to view backtrace and class/method details', 'event_espresso' ) . '
+				<strong class="ee-error-dev-msg-str">An ' . $ex['name'].' exception was thrown!</strong>  &nbsp; <span>code: '.$ex['code'].'</span><br />
+				<span class="big-text">"' . trim($ex['msg']).'"</span><br/>
+				<a id="display-ee-error-trace-' . self::$_error_count.$time.'" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'.self::$_error_count.$time.'">
+					' . __('click to view backtrace and class/method details', 'event_espresso').'
 				</a><br />
 				<span class="small-text lt-grey-text">'.$ex['file'].' &nbsp; ( line no: '.$ex['line'].' )</span>
 			</p>
-			<div id="ee-error-trace-' . self::$_error_count . $time . '-dv" class="ee-error-trace-dv" style="display: none;">
+			<div id="ee-error-trace-' . self::$_error_count.$time.'-dv" class="ee-error-trace-dv" style="display: none;">
 				' . $trace_details;
 
-				if ( ! empty( $class )) {
+				if ( ! empty($class)) {
 					$output .= '
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;">
 					<div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;">
 						<h3>Class Details</h3>';
-						$a = new ReflectionClass( $class );
+						$a = new ReflectionClass($class);
 						$output .= '
-						<pre>' . $a . '</pre>
+						<pre>' . $a.'</pre>
 					</div>
 				</div>';
 				}
@@ -468,14 +468,14 @@ 
 
 			}
 
-			$this->write_to_error_log( $time, $ex );
+			$this->write_to_error_log($time, $ex);
 
 		}
 
 		// remove last linebreak
-		$output = substr( $output, 0, ( count( $output ) - 7 ));
+		$output = substr($output, 0, (count($output) - 7));
 
-		if ( ! WP_DEBUG ) {
+		if ( ! WP_DEBUG) {
 			$output .= '
 	</p>';
 		}
@@ -483,10 +483,10 @@ 
 		$output .= '
 </div>';
 
-		$output .= self::_print_scripts( TRUE );
+		$output .= self::_print_scripts(TRUE);
 
-		if ( defined( 'DOING_AJAX' )) {
-			echo wp_json_encode( array( 'error' => $output ));
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output));
 			exit();
 		}
 
@@ -506,29 +506,29 @@ 
 	*	@ param array $arguments
 	*	@ return string
 	*/
-	private function _convert_args_to_string ( $arguments = array(), $array = FALSE ) {
+	private function _convert_args_to_string($arguments = array(), $array = FALSE) {
 
 		$arg_string = '';
-		if ( ! empty( $arguments )) {
+		if ( ! empty($arguments)) {
 
 			$args = array();
 
-			foreach ( $arguments as $arg ) {
+			foreach ($arguments as $arg) {
 
-				if ( ! empty( $arg )) {
+				if ( ! empty($arg)) {
 
-					if ( is_string( $arg )) {
-						$args[] = " '" . $arg . "'";
-					} elseif ( is_array( $arg )) {
-						$args[] = 'ARRAY(' . $this->_convert_args_to_string( $arg, TRUE );
-					} elseif ( is_null( $arg )) {
+					if (is_string($arg)) {
+						$args[] = " '".$arg."'";
+					} elseif (is_array($arg)) {
+						$args[] = 'ARRAY('.$this->_convert_args_to_string($arg, TRUE);
+					} elseif (is_null($arg)) {
 						$args[] = ' NULL';
-					} elseif ( is_bool( $arg )) {
-						$args[] = ( $arg ) ? ' TRUE' : ' FALSE';
-					} elseif ( is_object( $arg )) {
-						$args[] = ' OBJECT ' . get_class( $arg );
-					} elseif ( is_resource( $arg )) {
-						$args[] = get_resource_type( $arg );
+					} elseif (is_bool($arg)) {
+						$args[] = ($arg) ? ' TRUE' : ' FALSE';
+					} elseif (is_object($arg)) {
+						$args[] = ' OBJECT '.get_class($arg);
+					} elseif (is_resource($arg)) {
+						$args[] = get_resource_type($arg);
 					} else {
 						$args[] = $arg;
 					}
@@ -536,9 +536,9 @@ 
 				}
 
 			}
-			$arg_string = implode( ', ', $args );
+			$arg_string = implode(', ', $args);
 		}
-		if ( $array ) {
+		if ($array) {
 			$arg_string .= ' )';
 		}
 		return $arg_string;
@@ -558,8 +558,8 @@ 
 	* 	@param		string		$line	the line number where the error occurred - just use __LINE__
 	* 	@return 		void
 	*/
-	public static function add_error( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) {
-		self::_add_notice ( 'errors', $msg, $file, $func, $line );
+	public static function add_error($msg = NULL, $file = NULL, $func = NULL, $line = NULL) {
+		self::_add_notice('errors', $msg, $file, $func, $line);
 		self::$_error_count++;
 	}
 
@@ -572,11 +572,11 @@ 
 	 * @param string $line
 	 * @throws EE_Error
 	 */
-	public static function throw_exception_if_debugging( $msg = null, $file = null, $func = null, $line = null ) {
-		if( WP_DEBUG ) {
-			throw new EE_Error( $msg );
-		} else  {
-			EE_Error::add_error( $msg, $file, $func, $line );
+	public static function throw_exception_if_debugging($msg = null, $file = null, $func = null, $line = null) {
+		if (WP_DEBUG) {
+			throw new EE_Error($msg);
+		} else {
+			EE_Error::add_error($msg, $file, $func, $line);
 		}
 	}
 
@@ -594,8 +594,8 @@ 
 	* 	@param		string		$line	the line number where the error occurred - just use __LINE__
 	* 	@return 		void
 	*/
-	public static function add_success( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) {
-		self::_add_notice ( 'success', $msg, $file, $func, $line );
+	public static function add_success($msg = NULL, $file = NULL, $func = NULL, $line = NULL) {
+		self::_add_notice('success', $msg, $file, $func, $line);
 	}
 
 
@@ -612,8 +612,8 @@ 
 	* 	@param		string		$line	the line number where the error occurred - just use __LINE__
 	* 	@return 		void
 	*/
-	public static function add_attention( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) {
-		self::_add_notice ( 'attention', $msg, $file, $func, $line );
+	public static function add_attention($msg = NULL, $file = NULL, $func = NULL, $line = NULL) {
+		self::_add_notice('attention', $msg, $file, $func, $line);
 	}
 
 
@@ -631,12 +631,12 @@ 
 	* 	@param		string		$line	the line number where the error occurred - just use __LINE__
 	* 	@return 		void
 	*/
-	private static function _add_notice( $type = 'success', $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) {
-		if ( empty( $msg )) {
+	private static function _add_notice($type = 'success', $msg = NULL, $file = NULL, $func = NULL, $line = NULL) {
+		if (empty($msg)) {
 			EE_Error::doing_it_wrong(
-				'EE_Error::add_' . $type . '()',
+				'EE_Error::add_'.$type.'()',
 				sprintf(
-					__( 'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', 'event_espresso' ),
+					__('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', 'event_espresso'),
 					$type,
 					$file,
 					$line
@@ -644,17 +644,17 @@ 
 				EVENT_ESPRESSO_VERSION
 			);
 		}
-		if ( $type == 'errors' && ( empty( $file ) || empty( $func ) || empty( $line ))) {
+		if ($type == 'errors' && (empty($file) || empty($func) || empty($line))) {
 			EE_Error::doing_it_wrong(
 				'EE_Error::add_error()',
-				__('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', 'event_espresso' ),
+				__('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', 'event_espresso'),
 				EVENT_ESPRESSO_VERSION
 			);
 		}
 		// get separate user and developer messages if they exist
-		$msg = explode( '||', $msg );
+		$msg = explode('||', $msg);
 		$user_msg = $msg[0];
-		$dev_msg = isset( $msg[1] ) ? $msg[1] : $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
 		/**
 		 * Do an action so other code can be triggered when a notice is created
 		 * @param string $type can be 'errors', 'attention', or 'success'
@@ -664,22 +664,22 @@ 
 		 * @param string $func function where error was generated
 		 * @param string $line line where error was generated
 		 */
-		do_action( 'AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line );
+		do_action('AHEE__EE_Error___add_notice', $type, $user_msg, $dev_msg, $file, $func, $line);
 		$msg = WP_DEBUG ? $dev_msg : $user_msg;
 		// add notice if message exists
-		if ( ! empty( $msg )) {
+		if ( ! empty($msg)) {
 			// get error code
-			$notice_code = EE_Error::generate_error_code( $file, $func, $line );
-			if ( WP_DEBUG && $type == 'errors' ) {
-				$msg .= '<br/><span class="tiny-text">' . $notice_code . '</span>';
+			$notice_code = EE_Error::generate_error_code($file, $func, $line);
+			if (WP_DEBUG && $type == 'errors') {
+				$msg .= '<br/><span class="tiny-text">'.$notice_code.'</span>';
 			}
 			// add notice. Index by code if it's not blank
-			if( $notice_code ) {
-				self::$_espresso_notices[ $type ][ $notice_code ] = $msg;
+			if ($notice_code) {
+				self::$_espresso_notices[$type][$notice_code] = $msg;
 			} else {
-				self::$_espresso_notices[ $type ][] = $msg;
+				self::$_espresso_notices[$type][] = $msg;
 			}
-			add_action( 'wp_footer', array( 'EE_Error', 'enqueue_error_scripts' ), 1 );
+			add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1);
 		}
 
 	}
@@ -733,7 +733,7 @@ 
 	*	@access private
 	*	@return void
 	*/
-	public static function reset_notices(){
+	public static function reset_notices() {
     	self::$_espresso_notices['success'] = FALSE;
     	self::$_espresso_notices['attention'] = FALSE;
     	self::$_espresso_notices['errors'] = FALSE;
@@ -746,14 +746,14 @@ 
 	*	@access public
 	*	@return int
 	*/
-    public static function has_notices(){
+    public static function has_notices() {
 		$has_notices = 0;
 		// check for success messages
-		$has_notices = self::$_espresso_notices['success'] && ! empty(  self::$_espresso_notices['success'] ) ? 3 : $has_notices;
+		$has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3 : $has_notices;
 		// check for attention messages
-		$has_notices = self::$_espresso_notices['attention'] && ! empty(  self::$_espresso_notices['attention'] ) ? 2 : $has_notices;
+		$has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2 : $has_notices;
 		// check for error messages
-		$has_notices = self::$_espresso_notices['errors'] && ! empty(  self::$_espresso_notices['errors'] ) ? 1 : $has_notices;
+		$has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1 : $has_notices;
 		return $has_notices;
 	}
 
@@ -768,9 +768,9 @@ 
 	 */
 	public static function get_vanilla_notices() {
 		return array(
-			'success' => isset( self::$_espresso_notices['success'] ) ? self::$_espresso_notices['success'] : array(),
-			'attention' => isset( self::$_espresso_notices['attention'] )  ? self::$_espresso_notices['attention'] : array(),
-			'errors' => isset( self::$_espresso_notices['errors'] ) ? self::$_espresso_notices['errors'] : array(),
+			'success' => isset(self::$_espresso_notices['success']) ? self::$_espresso_notices['success'] : array(),
+			'attention' => isset(self::$_espresso_notices['attention']) ? self::$_espresso_notices['attention'] : array(),
+			'errors' => isset(self::$_espresso_notices['errors']) ? self::$_espresso_notices['errors'] : array(),
 		);
 	}
 
@@ -786,8 +786,8 @@ 
 	* 	@param		boolean		$remove_empty		whether or not to unset empty messages
 	* 	@return 		array
 	*/
-	public static function get_notices( $format_output = TRUE, $save_to_transient = FALSE, $remove_empty = TRUE ) {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+	public static function get_notices($format_output = TRUE, $save_to_transient = FALSE, $remove_empty = TRUE) {
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 
 		$success_messages = '';
 		$attention_messages = '';
@@ -797,44 +797,44 @@ 
 		// EEH_Debug_Tools::printr( self::$_espresso_notices, 'espresso_notices  <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' );
 
 		// either save notices to the db
-		if ( $save_to_transient ) {
-			update_option( 'ee_notices', self::$_espresso_notices );
+		if ($save_to_transient) {
+			update_option('ee_notices', self::$_espresso_notices);
 			return;
 		}
 		// grab any notices that have been previously saved
-		if ( $notices = get_option( 'ee_notices', FALSE )) {
-			foreach ( $notices as $type => $notice ) {
-				if ( is_array( $notice ) && ! empty( $notice )) {
+		if ($notices = get_option('ee_notices', FALSE)) {
+			foreach ($notices as $type => $notice) {
+				if (is_array($notice) && ! empty($notice)) {
 					// make sure that existing notice type is an array
-					self::$_espresso_notices[ $type ] =  is_array( self::$_espresso_notices[ $type ] ) && ! empty( self::$_espresso_notices[ $type ] ) ? self::$_espresso_notices[ $type ] : array();
+					self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type]) && ! empty(self::$_espresso_notices[$type]) ? self::$_espresso_notices[$type] : array();
 					// merge stored notices with any newly created ones
-					self::$_espresso_notices[ $type ] = array_merge( self::$_espresso_notices[ $type ], $notice );
+					self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice);
 					$print_scripts = TRUE;
 				}
 			}
 			// now clear any stored notices
-			update_option( 'ee_notices', FALSE );
+			update_option('ee_notices', FALSE);
 		}
 
 		// check for success messages
-		if ( self::$_espresso_notices['success'] && ! empty(  self::$_espresso_notices['success'] )) {
+		if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) {
 			// combine messages
-			$success_messages .= implode( self::$_espresso_notices['success'], '<br />' );
+			$success_messages .= implode(self::$_espresso_notices['success'], '<br />');
 			$print_scripts = TRUE;
 		}
 
 		// check for attention messages
-		if ( self::$_espresso_notices['attention'] && ! empty(  self::$_espresso_notices['attention'] ) ) {
+		if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) {
 			// combine messages
-			$attention_messages .= implode( self::$_espresso_notices['attention'], '<br />' );
+			$attention_messages .= implode(self::$_espresso_notices['attention'], '<br />');
 			$print_scripts = TRUE;
 		}
 
 		// check for error messages
-		if ( self::$_espresso_notices['errors'] && ! empty(  self::$_espresso_notices['errors'] ) ) {
-			$error_messages .= count( self::$_espresso_notices['errors'] ) > 1 ? __( 'The following errors have occurred:<br />', 'event_espresso' ) : __( 'An error has occurred:<br />', 'event_espresso' );
+		if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) {
+			$error_messages .= count(self::$_espresso_notices['errors']) > 1 ? __('The following errors have occurred:<br />', 'event_espresso') : __('An error has occurred:<br />', 'event_espresso');
 			// combine messages
-			$error_messages .= implode( self::$_espresso_notices['errors'], '<br />' );
+			$error_messages .= implode(self::$_espresso_notices['errors'], '<br />');
 			$print_scripts = TRUE;
 		}
 
@@ -848,21 +848,21 @@ 
 				$css_id = is_admin() ? 'message' : 'espresso-notices-success';
 				$css_class = is_admin() ? 'updated fade' : 'success fade-away';
 				//showMessage( $success_messages );
-				$notices .= '<div id="' . $css_id . '" class="espresso-notices ' . $css_class . '" style="display:none;"><p>' . $success_messages . '</p>' . $close . '</div>';
+				$notices .= '<div id="'.$css_id.'" class="espresso-notices '.$css_class.'" style="display:none;"><p>'.$success_messages.'</p>'.$close.'</div>';
 			}
 
 			if ($attention_messages !== '') {
 				$css_id = is_admin() ? 'message' : 'espresso-notices-attention';
 				$css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away';
 				//showMessage( $error_messages, TRUE );
-				$notices .= '<div id="' . $css_id . '" class="espresso-notices ' . $css_class . '" style="display:none;"><p>' . $attention_messages . '</p>' . $close . '</div>';
+				$notices .= '<div id="'.$css_id.'" class="espresso-notices '.$css_class.'" style="display:none;"><p>'.$attention_messages.'</p>'.$close.'</div>';
 			}
 
 			if ($error_messages !== '') {
 				$css_id = is_admin() ? 'message' : 'espresso-notices-error';
 				$css_class = is_admin() ? 'error' : 'error fade-away';
 				//showMessage( $error_messages, TRUE );
-				$notices .= '<div id="' . $css_id . '" class="espresso-notices ' . $css_class . '" style="display:none;"><p>' . $error_messages . '</p>' . $close . '</div>';
+				$notices .= '<div id="'.$css_id.'" class="espresso-notices '.$css_class.'" style="display:none;"><p>'.$error_messages.'</p>'.$close.'</div>';
 			}
 
 			$notices .= '</div>';
@@ -875,7 +875,7 @@ 
 					'errors' => $error_messages
 			);
 
-			if ( $remove_empty ) {
+			if ($remove_empty) {
 				// remove empty notices
 				foreach ($notices as $type => $notice) {
 					if (empty($notice)) {
@@ -885,7 +885,7 @@ 
 			}
 		}
 
-		if ( $print_scripts ) {
+		if ($print_scripts) {
 			self::_print_scripts();
 		}
 
@@ -905,17 +905,17 @@ 
 	* 	@param bool $force_update allows one to enforce the reappearance of a persistent message.
 	* 	@return 		void
 	*/
-	public static function add_persistent_admin_notice( $pan_name = '', $pan_message, $force_update = FALSE ) {
-		if ( ! empty( $pan_name ) && ! empty( $pan_message )) {
-			$persistent_admin_notices = get_option( 'ee_pers_admin_notices', array() );
+	public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = FALSE) {
+		if ( ! empty($pan_name) && ! empty($pan_message)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
 			//maybe initialize persistent_admin_notices
-			if ( empty( $persistent_admin_notices )) {
-				add_option( 'ee_pers_admin_notices', array(), '', 'no' );
+			if (empty($persistent_admin_notices)) {
+				add_option('ee_pers_admin_notices', array(), '', 'no');
 			}
-			$pan_name = sanitize_key( $pan_name );
-			if ( ! array_key_exists( $pan_name, $persistent_admin_notices ) || $force_update ) {
-				$persistent_admin_notices[ $pan_name ] = $pan_message;
-				update_option( 'ee_pers_admin_notices', $persistent_admin_notices );
+			$pan_name = sanitize_key($pan_name);
+			if ( ! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) {
+				$persistent_admin_notices[$pan_name] = $pan_message;
+				update_option('ee_pers_admin_notices', $persistent_admin_notices);
 			}
 		}
 	}
@@ -931,34 +931,34 @@ 
 	 * @param bool          $return_immediately
 	 * @return        void
 	 */
-	public static function dismiss_persistent_admin_notice( $pan_name = '', $purge = FALSE, $return_immediately = FALSE ) {
-		$pan_name = EE_Registry::instance()->REQ->is_set( 'ee_nag_notice' ) ? EE_Registry::instance()->REQ->get( 'ee_nag_notice' ) : $pan_name;
-		if ( ! empty( $pan_name )) {
-			$persistent_admin_notices = get_option( 'ee_pers_admin_notices', array() );
+	public static function dismiss_persistent_admin_notice($pan_name = '', $purge = FALSE, $return_immediately = FALSE) {
+		$pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice') ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name;
+		if ( ! empty($pan_name)) {
+			$persistent_admin_notices = get_option('ee_pers_admin_notices', array());
 			// check if notice we wish to dismiss is actually in the $persistent_admin_notices array
-			if ( is_array( $persistent_admin_notices ) && isset( $persistent_admin_notices[ $pan_name ] )) {
+			if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) {
 				// completely delete nag notice, or just NULL message so that it can NOT be added again ?
-				if ( $purge ) {
-					unset( $persistent_admin_notices[ $pan_name ] );
+				if ($purge) {
+					unset($persistent_admin_notices[$pan_name]);
 				} else {
-					$persistent_admin_notices[ $pan_name ] = NULL;
+					$persistent_admin_notices[$pan_name] = NULL;
 				}
-				if ( update_option( 'ee_pers_admin_notices', $persistent_admin_notices ) === FALSE ) {
-					EE_Error::add_error( sprintf( __( 'The persistent admin notice for "%s" could not be deleted.', 'event_espresso' ), $pan_name ), __FILE__, __FUNCTION__, __LINE__ );
+				if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === FALSE) {
+					EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.', 'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__);
 				}
 			}
 		}
-		if ( $return_immediately ) {
+		if ($return_immediately) {
 			return;
-		} else if ( EE_Registry::instance()->REQ->ajax ) {
+		} else if (EE_Registry::instance()->REQ->ajax) {
 			// grab any notices and concatenate into string
-			echo wp_json_encode( array( 'errors' => implode( '<br />', EE_Error::get_notices( FALSE ))));
+			echo wp_json_encode(array('errors' => implode('<br />', EE_Error::get_notices(FALSE))));
 			exit();
 		} else {
 			// save errors to a transient to be displayed on next request (after redirect)
-			EE_Error::get_notices( FALSE, TRUE );
-			$return_url = EE_Registry::instance()->REQ->is_set( 'return_url' ) ? EE_Registry::instance()->REQ->get( 'return_url' ) : '';
-			wp_safe_redirect( urldecode( $return_url ));
+			EE_Error::get_notices(FALSE, TRUE);
+			$return_url = EE_Registry::instance()->REQ->is_set('return_url') ? EE_Registry::instance()->REQ->get('return_url') : '';
+			wp_safe_redirect(urldecode($return_url));
 		}
 	}
 
@@ -973,20 +973,20 @@ 
 	 * @param  string $return_url  URL to go back to after nag notice is dismissed
 	 * @return string
 	 */
-	public static function display_persistent_admin_notices( $pan_name = '', $pan_message = '', $return_url = '' ) {
-		if ( ! empty( $pan_name ) && ! empty( $pan_message )&& ! is_array( $pan_message )) {
+	public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '') {
+		if ( ! empty($pan_name) && ! empty($pan_message) && ! is_array($pan_message)) {
 			$args = array(
 				'nag_notice' => $pan_name,
-				'return_url' => urlencode( $return_url ),
+				'return_url' => urlencode($return_url),
 				'ajax_url' => WP_AJAX_URL,
-				'unknown_error' => __( 'An unknown error has occurred on the server while attempting to dismiss this notice.', 'event_espresso' )
+				'unknown_error' => __('An unknown error has occurred on the server while attempting to dismiss this notice.', 'event_espresso')
 			);
-			wp_localize_script( 'espresso_core', 'ee_dismiss', $args );
+			wp_localize_script('espresso_core', 'ee_dismiss', $args);
 			return '
-			<div id="' . $pan_name . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
-				<p>' . $pan_message . '</p>
-				<a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="' . $pan_name . '">
-					<span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'.__( 'Dismiss', 'event_espresso' ) .'
+			<div id="' . $pan_name.'" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;">
+				<p>' . $pan_message.'</p>
+				<a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="' . $pan_name.'">
+					<span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'.__('Dismiss', 'event_espresso').'
 				</a>
 				<div style="clear:both;"></div>
 			</div>';
@@ -1003,24 +1003,24 @@ 
 	 * @param string $return_url
 	 * @return    array
 	 */
-	public static function get_persistent_admin_notices( $return_url = '' ) {
+	public static function get_persistent_admin_notices($return_url = '') {
 		$notices = '';
 		// check for persistent admin notices
 		//filter the list though so plugins can notify the admin in a different way if they want
 		$persistent_admin_notices = apply_filters(
 			'FHEE__EE_Error__get_persistent_admin_notices',
-			get_option( 'ee_pers_admin_notices', FALSE ),
+			get_option('ee_pers_admin_notices', FALSE),
 			'ee_pers_admin_notices',
 			$return_url
 		);
-		if ( $persistent_admin_notices ) {
+		if ($persistent_admin_notices) {
 			// load scripts
-			wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE );
-			wp_register_script( 'ee_error_js', EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, TRUE );
-			wp_enqueue_script( 'ee_error_js' );
+			wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE);
+			wp_register_script('ee_error_js', EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, TRUE);
+			wp_enqueue_script('ee_error_js');
 			// and display notices
-			foreach( $persistent_admin_notices as $pan_name => $pan_message ) {
-				$notices .= self::display_persistent_admin_notices( $pan_name, $pan_message, $return_url );
+			foreach ($persistent_admin_notices as $pan_name => $pan_message) {
+				$notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url);
 			}
 		}
 		return $notices;
@@ -1035,26 +1035,26 @@ 
 	 * @param 	bool $force_print
 	 * @return 	void
 	 */
-	private static function _print_scripts( $force_print = FALSE ) {
-		if (( did_action( 'admin_enqueue_scripts' ) || did_action( 'wp_enqueue_scripts' )) && ! $force_print ) {
-			if ( wp_script_is( 'ee_error_js', 'enqueued' )) {
+	private static function _print_scripts($force_print = FALSE) {
+		if ((did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts')) && ! $force_print) {
+			if (wp_script_is('ee_error_js', 'enqueued')) {
 				return;
-			} else if ( wp_script_is( 'ee_error_js', 'registered' )) {
-				add_filter( 'FHEE_load_css', '__return_true' );
-				add_filter( 'FHEE_load_js', '__return_true' );
-				wp_enqueue_script( 'ee_error_js' );
-				wp_localize_script( 'ee_error_js','ee_settings', array( 'wp_debug'=>WP_DEBUG ));
+			} else if (wp_script_is('ee_error_js', 'registered')) {
+				add_filter('FHEE_load_css', '__return_true');
+				add_filter('FHEE_load_js', '__return_true');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug'=>WP_DEBUG));
 			}
 		} else {
 			return '
 <script>
 /* <![CDATA[ */
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
 /* ]]> */
 </script>
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
 ';
 
 		}
@@ -1088,11 +1088,11 @@ 
 	*	@param string $line
 	*	@return string
 	*/
-	public static function generate_error_code ( $file = '', $func = '', $line = '' ) {
-		$file = explode( '.', basename( $file ));
-		$error_code = ! empty( $file[0] ) ? $file[0] : '';
-		$error_code .= ! empty( $func ) ? ' - ' . $func : '';
-		$error_code .= ! empty( $line ) ? ' - ' . $line : '';
+	public static function generate_error_code($file = '', $func = '', $line = '') {
+		$file = explode('.', basename($file));
+		$error_code = ! empty($file[0]) ? $file[0] : '';
+		$error_code .= ! empty($func) ? ' - '.$func : '';
+		$error_code .= ! empty($line) ? ' - '.$line : '';
 		return $error_code;
 	}
 
@@ -1108,36 +1108,36 @@ 
 	*	@ param object $ex
 	*	@ return void
 	*/
-	public function write_to_error_log ( $time = FALSE, $ex = FALSE, $clear = FALSE ) {
+	public function write_to_error_log($time = FALSE, $ex = FALSE, $clear = FALSE) {
 
-		if ( ! $ex ) {
+		if ( ! $ex) {
 			return;
 		}
 
-		if ( ! $time ) {
+		if ( ! $time) {
 			$time = time();
 		}
 
-		$exception_log = '----------------------------------------------------------------------------------------' . PHP_EOL;
-		$exception_log .= '[' . date( 'Y-m-d H:i:s', $time ) . ']  Exception Details' . PHP_EOL;
-		$exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL;
-		$exception_log .= 'Code: '. $ex['code'] . PHP_EOL;
-		$exception_log .= 'File: '. $ex['file'] . PHP_EOL;
-		$exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL;
-		$exception_log .= 'Stack trace: ' . PHP_EOL;
-		$exception_log .= $ex['string'] . PHP_EOL;
-		$exception_log .= '----------------------------------------------------------------------------------------' . PHP_EOL;
+		$exception_log = '----------------------------------------------------------------------------------------'.PHP_EOL;
+		$exception_log .= '['.date('Y-m-d H:i:s', $time).']  Exception Details'.PHP_EOL;
+		$exception_log .= 'Message: '.$ex['msg'].PHP_EOL;
+		$exception_log .= 'Code: '.$ex['code'].PHP_EOL;
+		$exception_log .= 'File: '.$ex['file'].PHP_EOL;
+		$exception_log .= 'Line No: '.$ex['line'].PHP_EOL;
+		$exception_log .= 'Stack trace: '.PHP_EOL;
+		$exception_log .= $ex['string'].PHP_EOL;
+		$exception_log .= '----------------------------------------------------------------------------------------'.PHP_EOL;
 
 		try {
-			EEH_File::ensure_file_exists_and_is_writable( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file );
-			EEH_File::add_htaccess_deny_from_all( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' );
-			if ( ! $clear ) {
+			EEH_File::ensure_file_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.self::$_exception_log_file);
+			EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR.'logs');
+			if ( ! $clear) {
 				//get existing log file and append new log info
-				$exception_log = EEH_File::get_file_contents( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file ) . $exception_log;
+				$exception_log = EEH_File::get_file_contents(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.self::$_exception_log_file).$exception_log;
 			}
-			EEH_File::write_to_file( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file, $exception_log );
-		} catch( EE_Error $e ){
-			EE_Error::add_error( sprintf( __(  'Event Espresso error logging could not be setup because: %s', 'event_espresso' ), $e->getMessage() ));
+			EEH_File::write_to_file(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.self::$_exception_log_file, $exception_log);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s', 'event_espresso'), $e->getMessage()));
 			return;
 		}
 
@@ -1173,8 +1173,8 @@ 
 		$applies_when = '',
 		$error_type = null
 	) {
-		if ( defined('WP_DEBUG') && WP_DEBUG ) {
-			EEH_Debug_Tools::instance()->doing_it_wrong( $function, $message, $version, $applies_when, $error_type );
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version, $applies_when, $error_type);
 		}
 	}
 
@@ -1208,13 +1208,13 @@ 
  */
 function espresso_error_enqueue_scripts() {
 	// js for error handling
-	wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, FALSE );
-	wp_register_script( 'ee_error_js', EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, FALSE );
+	wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, FALSE);
+	wp_register_script('ee_error_js', EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, FALSE);
 }
-if ( is_admin() ) {
-	add_action( 'admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2 );
+if (is_admin()) {
+	add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 } else {
-	add_action( 'wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2 );
+	add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2);
 }
 
 

core/interfaces/EEI_Attendee.interface.php

Indentation +21 added lines, -21 removed lines

@@ -9,69 +9,69 @@
 interface EEI_Attendee
 {
 
-    public function fname();
+	public function fname();
 
 
 
-    public function lname();
+	public function lname();
 
 
 
-    public function full_name();
+	public function full_name();
 
 
 
-    public function email();
+	public function email();
 
 
 
-    public function phone();
+	public function phone();
 
 
 
-    public function address();
+	public function address();
 
 
 
-    public function address2();
+	public function address2();
 
 
 
-    public function city();
+	public function city();
 
 
 
-    public function state_ID();
+	public function state_ID();
 
 
 
-    public function state_name();
+	public function state_name();
 
 
 
-    /**
-     * @return EE_State
-     */
-    public function state_obj();
+	/**
+	 * @return EE_State
+	 */
+	public function state_obj();
 
 
 
-    public function country_ID();
+	public function country_ID();
 
 
 
-    public function country_name();
+	public function country_name();
 
 
 
-    /**
-     * @return EE_Country
-     */
-    public function country_obj();
+	/**
+	 * @return EE_Country
+	 */
+	public function country_obj();
 
 
 
-    public function zip();
+	public function zip();
 
 }
 // End of file EEI_Attendee.interface.php

core/interfaces/line_items/EEHI_Line_Item.interface.php

Indentation +84 added lines, -84 removed lines

@@ -9,90 +9,90 @@
 interface EEHI_Line_Item
 {
 
-    /**
-     * Adds an item to the purchase in the right spot
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $line_item
-     */
-    public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item);
-
-
-
-    /**
-     * Overwrites the previous tax by clearing out the old taxes, and creates a new
-     * tax and updates the total line item accordingly
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param float        $amount
-     * @param string       $name
-     * @param string       $description
-     * @param string       $code
-     * @param boolean      $add_to_existing_line_item if true and a duplicate line item with
-     *                                                the same code is found, $amount will be added onto it; otherwise will simply
-     *                                                set the taxes to match $amount
-     * @return EE_Line_Item the new tax created
-     */
-    public function set_total_tax_to(
-        EE_Line_Item $total_line_item,
-        $amount,
-        $name = null,
-        $description = null,
-        $code = null,
-        $add_to_existing_line_item = false
-    );
-
-
-
-    /**
-     * Makes all the line items which are children of $line_item taxable (or not).
-     * Does NOT save the line items
-     *
-     * @param EE_Line_Item $line_item
-     * @param boolean      $taxable
-     * @param string       $code_substring_for_whitelist if this string is part of the line item's code
-     *                                                   it will be whitelisted (ie, except from becoming taxable)
-     */
-    public static function set_line_items_taxable(
-        EE_Line_Item $line_item,
-        $taxable = true,
-        $code_substring_for_whitelist = null
-    );
-
-
-
-    /**
-     * Adds a simple item ( unrelated to any other model object) to the total line item,
-     * in the correct spot in the line item tree.
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param string       $name
-     * @param float        $unit_price
-     * @param string       $description
-     * @param int          $quantity
-     * @param boolean      $taxable
-     * @param boolean      $code if set to a value, ensures there is only one line item with that code
-     * @return boolean success
-     */
-    public function add_unrelated_item(
-        EE_Line_Item $total_line_item,
-        $name,
-        $unit_price,
-        $description = '',
-        $quantity = 1,
-        $taxable = false,
-        $code = null
-    );
-
-
-
-    /**
-     * Gets the line item for the taxes subtotal
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return \EE_Line_Item
-     */
-    public static function get_taxes_subtotal(EE_Line_Item $total_line_item);
+	/**
+	 * Adds an item to the purchase in the right spot
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $line_item
+	 */
+	public function add_item(EE_Line_Item $total_line_item, EE_Line_Item $line_item);
+
+
+
+	/**
+	 * Overwrites the previous tax by clearing out the old taxes, and creates a new
+	 * tax and updates the total line item accordingly
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $amount
+	 * @param string       $name
+	 * @param string       $description
+	 * @param string       $code
+	 * @param boolean      $add_to_existing_line_item if true and a duplicate line item with
+	 *                                                the same code is found, $amount will be added onto it; otherwise will simply
+	 *                                                set the taxes to match $amount
+	 * @return EE_Line_Item the new tax created
+	 */
+	public function set_total_tax_to(
+		EE_Line_Item $total_line_item,
+		$amount,
+		$name = null,
+		$description = null,
+		$code = null,
+		$add_to_existing_line_item = false
+	);
+
+
+
+	/**
+	 * Makes all the line items which are children of $line_item taxable (or not).
+	 * Does NOT save the line items
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param boolean      $taxable
+	 * @param string       $code_substring_for_whitelist if this string is part of the line item's code
+	 *                                                   it will be whitelisted (ie, except from becoming taxable)
+	 */
+	public static function set_line_items_taxable(
+		EE_Line_Item $line_item,
+		$taxable = true,
+		$code_substring_for_whitelist = null
+	);
+
+
+
+	/**
+	 * Adds a simple item ( unrelated to any other model object) to the total line item,
+	 * in the correct spot in the line item tree.
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param string       $name
+	 * @param float        $unit_price
+	 * @param string       $description
+	 * @param int          $quantity
+	 * @param boolean      $taxable
+	 * @param boolean      $code if set to a value, ensures there is only one line item with that code
+	 * @return boolean success
+	 */
+	public function add_unrelated_item(
+		EE_Line_Item $total_line_item,
+		$name,
+		$unit_price,
+		$description = '',
+		$quantity = 1,
+		$taxable = false,
+		$code = null
+	);
+
+
+
+	/**
+	 * Gets the line item for the taxes subtotal
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return \EE_Line_Item
+	 */
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item);
 }
 // End of file EEHI_Line_Item.interface.php
 // Location: core/interfaces/line_items/EEHI_Line_Item.interface.php
\ No newline at end of file

core/interfaces/line_items/EEI_Line_Item_Display.interface.php

Indentation +6 added lines, -6 removed lines

@@ -9,12 +9,12 @@
 interface EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array());
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array());
 
 }
 

core/interfaces/EEI_Transaction.interface.php

Indentation +41 added lines, -41 removed lines

@@ -9,65 +9,65 @@
 interface EEI_Transaction extends EEI_Base
 {
 
-    /**
-     * @return EEI_Payment
-     */
-    public function last_payment();
+	/**
+	 * @return EEI_Payment
+	 */
+	public function last_payment();
 
 
 
-    /**
-     * Gets the total that should eb paid for this transaction
-     *
-     * @return float
-     */
-    public function total();
+	/**
+	 * Gets the total that should eb paid for this transaction
+	 *
+	 * @return float
+	 */
+	public function total();
 
 
 
-    /**
-     * Get the line item that represents the total for the transaction
-     *
-     * @return EEI_Line_Item
-     */
-    public function total_line_item();
+	/**
+	 * Get the line item that represents the total for the transaction
+	 *
+	 * @return EEI_Line_Item
+	 */
+	public function total_line_item();
 
 
 
-    /**
-     * Gets the primary registration for this transaction
-     *
-     * @return EEI_Registration
-     */
-    public function primary_registration();
+	/**
+	 * Gets the primary registration for this transaction
+	 *
+	 * @return EEI_Registration
+	 */
+	public function primary_registration();
 
 
 
-    /**
-     * Returns the balance due on the transaction
-     *
-     * @return float
-     */
-    public function remaining();
+	/**
+	 * Returns the balance due on the transaction
+	 *
+	 * @return float
+	 */
+	public function remaining();
 
 
 
-    /**
-     *        get Total Amount Paid to Date
-     *
-     * @access        public
-     * @return float
-     */
-    public function paid();
+	/**
+	 *        get Total Amount Paid to Date
+	 *
+	 * @access        public
+	 * @return float
+	 */
+	public function paid();
 
 
 
-    /**
-     * Retrieves all the pending payments on this transaction
-     *
-     * @return EEI_Payment[]
-     */
-    public function pending_payments();
+	/**
+	 * Retrieves all the pending payments on this transaction
+	 *
+	 * @return EEI_Payment[]
+	 */
+	public function pending_payments();