eventespresso / event-espresso-core

core/services/container/CoffeeShop.php

Indentation +565 added lines, -565 removed lines

@@ -30,569 +30,569 @@
 {
 
 
-    /**
-     * 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(
-                esc_html__('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|string $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(
-                esc_html__('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(
+				esc_html__('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|string $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(
+				esc_html__('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;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -159,7 +159,7 @@ 
         }
         // 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);
         }
@@ -284,7 +284,7 @@ 
      */
     public function addClosure($identifier, $closure)
     {
-        if (! is_callable($closure)) {
+        if ( ! is_callable($closure)) {
             throw new InvalidDataTypeException('$closure', $closure, 'Closure');
         }
         $identifier = $this->processIdentifier($identifier);
@@ -393,7 +393,7 @@ 
             // 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;
+                $matches[strlen($wildcard)] = $default_recipe;
             }
         }
         if (count($matches) > 0) {
@@ -433,7 +433,7 @@ 
         }
         $identifier = $this->processIdentifier($identifier);
         foreach ((array) $aliases as $alias) {
-            $this->filters[ $this->processIdentifier($alias) ] = $identifier;
+            $this->filters[$this->processIdentifier($alias)] = $identifier;
         }
     }
 
@@ -475,8 +475,8 @@ 
     private function filterIdentifier($identifier)
     {
         $identifier = $this->processIdentifier($identifier);
-        return isset($this->filters[ $identifier ]) && ! empty($this->filters[ $identifier ])
-            ? $this->filters[ $identifier ]
+        return isset($this->filters[$identifier]) && ! empty($this->filters[$identifier])
+            ? $this->filters[$identifier]
             : $identifier;
     }
 
@@ -491,7 +491,7 @@ 
      */
     private function processIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidIdentifierException(
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
                 '\Fully\Qualified\ClassName'
@@ -510,7 +510,7 @@ 
      */
     private function getCoffeeMaker($type)
     {
-        if (! $this->coffee_makers->has($type)) {
+        if ( ! $this->coffee_makers->has($type)) {
             throw new OutOfBoundsException(
                 esc_html__('The requested coffee maker is either missing or invalid.', 'event_espresso')
             );
@@ -537,7 +537,7 @@ 
             // 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();
+                $default_recipes[str_replace('*', '', $identifier)] = $this->recipes->current();
             }
             $this->recipes->next();
         }
@@ -557,7 +557,7 @@ 
     private function copyDefaultRecipe(RecipeInterface $default_recipe, $identifier, $type = '')
     {
         $recipe = clone $default_recipe;
-        if (! empty($type)) {
+        if ( ! empty($type)) {
             $recipe->setType($type);
         }
         // is this the base default recipe ?
@@ -587,7 +587,7 @@ 
      */
     private function validateService($identifier, $service)
     {
-        if (! is_object($service)) {
+        if ( ! is_object($service)) {
             throw new InvalidServiceException(
                 $identifier,
                 $service

core/services/container/exceptions/InstantiationException.php

Indentation +21 added lines, -21 removed lines

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

core/services/container/exceptions/ServiceExistsException.php

Indentation +22 added lines, -22 removed lines

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

core/services/container/exceptions/ServiceNotFoundException.php

Indentation +22 added lines, -22 removed lines

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

core/services/container/exceptions/InvalidServiceException.php

Indentation +23 added lines, -23 removed lines

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

core/services/payment_methods/gateways/GatewayDataFormatter.php

Indentation +101 added lines, -101 removed lines

@@ -14,115 +14,115 @@
 class GatewayDataFormatter implements GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
-            $payment->get_first_event_name(),
-            $this,
-            $payment
-        );
-    }
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
+			$payment->get_first_event_name(),
+			$this,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___partial_payment_desc',
-            sprintf(
-                esc_html__('Payment of %1$s for %2$s', "event_espresso"),
-                $payment->get_pretty('PAY_amount', 'no_currency_code'),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___partial_payment_desc',
+			sprintf(
+				esc_html__('Payment of %1$s for %2$s', "event_espresso"),
+				$payment->get_pretty('PAY_amount', 'no_currency_code'),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_gateway___line_item_name',
-            sprintf(
-                _x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
-                $line_item->name(),
-                $line_item->ticket_event_name()
-            ),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_gateway___line_item_name',
+			sprintf(
+				_x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
+				$line_item->name(),
+				$line_item->ticket_event_name()
+			),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___line_item_desc',
-            $line_item->desc(),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___line_item_desc',
+			$line_item->desc(),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
 
 
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___order_description',
-            sprintf(
-                esc_html__('Event Registrations from %1$s for %2$s', "event_espresso"),
-                wp_specialchars_decode(get_bloginfo(), ENT_QUOTES),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___order_description',
+			sprintf(
+				esc_html__('Event Registrations from %1$s for %2$s', "event_espresso"),
+				wp_specialchars_decode(get_bloginfo(), ENT_QUOTES),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
 
 
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     */
-    public function formatCurrency($amount)
-    {
-        return number_format($amount, 2, '.', '');
-    }
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 */
+	public function formatCurrency($amount)
+	{
+		return number_format($amount, 2, '.', '');
+	}
 }

core/services/orm/ModelFieldFactory.php

Indentation +543 added lines, -543 removed lines

@@ -51,547 +51,547 @@
 class ModelFieldFactory
 {
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-
-    /**
-     * ModelFieldFactory constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_All_Caps_Text_Field
-     */
-    public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_All_Caps_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Any_Foreign_Model_Name_Field
-     */
-    public function createAnyForeignModelNameField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value = null,
-        $model_name
-    ) {
-        return $this->loader->getNew(
-            'EE_Any_Foreign_Model_Name_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $model_name)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Boolean_Field
-     */
-    public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Boolean_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param string $timezone_string
-     * @param bool   $nullable
-     * @param string $default_value
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @return EE_Datetime_Field
-     */
-    public function createDatetimeField(
-        $table_column,
-        $nice_name,
-        $nullable = false,
-        $default_value = EE_Datetime_Field::now
-    ) {
-        return $this->loader->getNew(
-            'EE_Datetime_Field',
-            array(
-                $table_column,
-                $nice_name,
-                $nullable,
-                $default_value,
-            )
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Float_Field
-     */
-    public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_DB_Only_Float_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Int_Field
-     */
-    public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_DB_Only_Int_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Text_Field
-     */
-    public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_DB_Only_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @return EE_Email_Field
-     */
-    public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '')
-    {
-        return $this->loader->getNew(
-            'EE_Email_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param array  $allowed_enum_values keys are values to be used in the DB,
-     *                                    values are how they should be displayed
-     * @return EE_Enum_Integer_Field
-     */
-    public function createEnumIntegerField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value = null,
-        array $allowed_enum_values
-    ) {
-        return $this->loader->getNew(
-            'EE_Enum_Integer_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param array  $allowed_enum_values keys are values to be used in the DB,
-     *                                    values are how they should be displayed
-     * @return EE_Enum_Text_Field
-     */
-    public function createEnumTextField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        array $allowed_enum_values
-    ) {
-        return $this->loader->getNew(
-            'EE_Enum_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Float_Field
-     */
-    public function createFloatField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Float_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Foreign_Key_Int_Field
-     */
-    public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name)
-    {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_Int_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $model_name)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Foreign_Key_String_Field
-     */
-    public function createForeignKeyStringField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value,
-        $model_name
-    ) {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_String_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $model_name)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Full_HTML_Field
-     */
-    public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Full_HTML_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Infinite_Integer_Field
-     */
-    public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Infinite_Integer_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string  $table_column
-     * @param string  $nice_name
-     * @param bool    $nullable
-     * @param integer $default_value
-     * @return EE_Integer_Field
-     */
-    public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0)
-    {
-        return $this->loader->getNew(
-            'EE_Integer_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Maybe_Serialized_Simple_HTML_Field
-     */
-    public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Simple_HTML_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Maybe_Serialized_Text_Field
-     */
-    public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Money_Field
-     */
-    public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Money_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @return EE_Plain_Text_Field
-     */
-    public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '')
-    {
-        return $this->loader->getNew(
-            'EE_Plain_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Post_Content_Field
-     */
-    public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Post_Content_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_Int_Field
-     */
-    public function createPrimaryKeyIntField($table_column, $nice_name)
-    {
-        return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name));
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_String_Field
-     */
-    public function createPrimaryKeyStringField($table_column, $nice_name)
-    {
-        return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name));
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Serialized_Text_Field
-     */
-    public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Serialized_Text_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Simple_HTML_Field
-     */
-    public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Simple_HTML_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Slug_Field
-     */
-    public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Slug_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Trashed_Flag_Field
-     */
-    public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        return $this->loader->getNew(
-            'EE_Trashed_Flag_Field',
-            array($table_column, $nice_name, $nullable, $default_value)
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param mixed  $default_value
-     * @param array  $values                            If additional stati are to be used other than the default WP
-     *                                                  statuses, then they can be registered via this property. The
-     *                                                  format of the array should be as follows: array(
-     *                                                  'status_reference' => array(
-     *                                                  'label' => esc_html__('Status Reference Label', 'event_espresso'),
-     *                                                  'public' => true,                 // whether this status should
-     *                                                  be shown on the frontend of the site
-     *                                                  'exclude_from_search' => false,   // whether this status should
-     *                                                  be excluded from wp searches
-     *                                                  'show_in_admin_all_list' => true, // whether this status is
-     *                                                  included in queries for the admin "all" view in list table
-     *                                                  views.
-     *                                                  'show_in_admin_status_list' => true, // show in the list of
-     *                                                  statuses with post counts at the top of the admin list tables
-     *                                                  (i.e. Status Reference(2) )
-     *                                                  'label_count' => _n_noop(
-     *                                                  'Status Reference <span class="count">(%s)</span>',
-     *                                                  'Status References <span class="count">(%s)</span>'
-     *                                                  ),                                   // the text to display on
-     *                                                  the admin screen
-     *                                                  ( or you won't see your status count ).
-     *                                                  )
-     *                                                  )
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     * @return EE_WP_Post_Status_Field
-     */
-    public function createWpPostStatusField(
-        $table_column,
-        $nice_name,
-        $nullable,
-        $default_value = null,
-        array $values = array()
-    ) {
-        return $this->loader->getNew(
-            'EE_WP_Post_Status_Field',
-            array($table_column, $nice_name, $nullable, $default_value, $values)
-        );
-    }
-
-
-    /**
-     * @param string $post_type
-     * @return EE_WP_Post_Type_Field
-     */
-    public function createWpPostTypeField($post_type)
-    {
-        return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type));
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @return EE_WP_User_Field
-     */
-    public function createWpUserField($table_column, $nice_name, $nullable)
-    {
-        return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable));
-    }
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+
+	/**
+	 * ModelFieldFactory constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_All_Caps_Text_Field
+	 */
+	public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_All_Caps_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Any_Foreign_Model_Name_Field
+	 */
+	public function createAnyForeignModelNameField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value = null,
+		$model_name
+	) {
+		return $this->loader->getNew(
+			'EE_Any_Foreign_Model_Name_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $model_name)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Boolean_Field
+	 */
+	public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Boolean_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param string $timezone_string
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @return EE_Datetime_Field
+	 */
+	public function createDatetimeField(
+		$table_column,
+		$nice_name,
+		$nullable = false,
+		$default_value = EE_Datetime_Field::now
+	) {
+		return $this->loader->getNew(
+			'EE_Datetime_Field',
+			array(
+				$table_column,
+				$nice_name,
+				$nullable,
+				$default_value,
+			)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Float_Field
+	 */
+	public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_DB_Only_Float_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Int_Field
+	 */
+	public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_DB_Only_Int_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Text_Field
+	 */
+	public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_DB_Only_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @return EE_Email_Field
+	 */
+	public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '')
+	{
+		return $this->loader->getNew(
+			'EE_Email_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param array  $allowed_enum_values keys are values to be used in the DB,
+	 *                                    values are how they should be displayed
+	 * @return EE_Enum_Integer_Field
+	 */
+	public function createEnumIntegerField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value = null,
+		array $allowed_enum_values
+	) {
+		return $this->loader->getNew(
+			'EE_Enum_Integer_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param array  $allowed_enum_values keys are values to be used in the DB,
+	 *                                    values are how they should be displayed
+	 * @return EE_Enum_Text_Field
+	 */
+	public function createEnumTextField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		array $allowed_enum_values
+	) {
+		return $this->loader->getNew(
+			'EE_Enum_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Float_Field
+	 */
+	public function createFloatField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Float_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Foreign_Key_Int_Field
+	 */
+	public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name)
+	{
+		return $this->loader->getNew(
+			'EE_Foreign_Key_Int_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $model_name)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Foreign_Key_String_Field
+	 */
+	public function createForeignKeyStringField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value,
+		$model_name
+	) {
+		return $this->loader->getNew(
+			'EE_Foreign_Key_String_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $model_name)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Full_HTML_Field
+	 */
+	public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Full_HTML_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Infinite_Integer_Field
+	 */
+	public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Infinite_Integer_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string  $table_column
+	 * @param string  $nice_name
+	 * @param bool    $nullable
+	 * @param integer $default_value
+	 * @return EE_Integer_Field
+	 */
+	public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0)
+	{
+		return $this->loader->getNew(
+			'EE_Integer_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Maybe_Serialized_Simple_HTML_Field
+	 */
+	public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Simple_HTML_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Maybe_Serialized_Text_Field
+	 */
+	public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Money_Field
+	 */
+	public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Money_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @return EE_Plain_Text_Field
+	 */
+	public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '')
+	{
+		return $this->loader->getNew(
+			'EE_Plain_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Post_Content_Field
+	 */
+	public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Post_Content_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_Int_Field
+	 */
+	public function createPrimaryKeyIntField($table_column, $nice_name)
+	{
+		return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name));
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_String_Field
+	 */
+	public function createPrimaryKeyStringField($table_column, $nice_name)
+	{
+		return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name));
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Serialized_Text_Field
+	 */
+	public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Serialized_Text_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Simple_HTML_Field
+	 */
+	public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Simple_HTML_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Slug_Field
+	 */
+	public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Slug_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Trashed_Flag_Field
+	 */
+	public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		return $this->loader->getNew(
+			'EE_Trashed_Flag_Field',
+			array($table_column, $nice_name, $nullable, $default_value)
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param mixed  $default_value
+	 * @param array  $values                            If additional stati are to be used other than the default WP
+	 *                                                  statuses, then they can be registered via this property. The
+	 *                                                  format of the array should be as follows: array(
+	 *                                                  'status_reference' => array(
+	 *                                                  'label' => esc_html__('Status Reference Label', 'event_espresso'),
+	 *                                                  'public' => true,                 // whether this status should
+	 *                                                  be shown on the frontend of the site
+	 *                                                  'exclude_from_search' => false,   // whether this status should
+	 *                                                  be excluded from wp searches
+	 *                                                  'show_in_admin_all_list' => true, // whether this status is
+	 *                                                  included in queries for the admin "all" view in list table
+	 *                                                  views.
+	 *                                                  'show_in_admin_status_list' => true, // show in the list of
+	 *                                                  statuses with post counts at the top of the admin list tables
+	 *                                                  (i.e. Status Reference(2) )
+	 *                                                  'label_count' => _n_noop(
+	 *                                                  'Status Reference <span class="count">(%s)</span>',
+	 *                                                  'Status References <span class="count">(%s)</span>'
+	 *                                                  ),                                   // the text to display on
+	 *                                                  the admin screen
+	 *                                                  ( or you won't see your status count ).
+	 *                                                  )
+	 *                                                  )
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 * @return EE_WP_Post_Status_Field
+	 */
+	public function createWpPostStatusField(
+		$table_column,
+		$nice_name,
+		$nullable,
+		$default_value = null,
+		array $values = array()
+	) {
+		return $this->loader->getNew(
+			'EE_WP_Post_Status_Field',
+			array($table_column, $nice_name, $nullable, $default_value, $values)
+		);
+	}
+
+
+	/**
+	 * @param string $post_type
+	 * @return EE_WP_Post_Type_Field
+	 */
+	public function createWpPostTypeField($post_type)
+	{
+		return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type));
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @return EE_WP_User_Field
+	 */
+	public function createWpUserField($table_column, $nice_name, $nullable)
+	{
+		return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable));
+	}
 }

core/services/commands/middleware/InvalidCommandBusMiddlewareException.php

Indentation +30 added lines, -30 removed lines

@@ -16,35 +16,35 @@
 {
 
 
-    /**
-     * @access public
-     * @param  mixed     $command_bus_middleware_object
-     * @param  string    $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($command_bus_middleware_object, $message = '', $code = 0, \Exception $previous = null)
-    {
-        $command_bus_middleware = is_object($command_bus_middleware_object)
-            ? get_class($command_bus_middleware_object)
-            : gettype($command_bus_middleware_object);
+	/**
+	 * @access public
+	 * @param  mixed     $command_bus_middleware_object
+	 * @param  string    $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($command_bus_middleware_object, $message = '', $code = 0, \Exception $previous = null)
+	{
+		$command_bus_middleware = is_object($command_bus_middleware_object)
+			? get_class($command_bus_middleware_object)
+			: gettype($command_bus_middleware_object);
 
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The supplied Command Bus Middleware "%1$s" does not have a valid name. It should be in the following format: "{CommandName}Handler" ',
-                    'event_espresso'
-                ),
-                $command_bus_middleware
-            );
-        }
-        parent::__construct(
-            '$command_bus_middleware',
-            $command_bus_middleware,
-            'CommandBusMiddlewareInterface',
-            $message,
-            $code,
-            $previous
-        );
-    }
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The supplied Command Bus Middleware "%1$s" does not have a valid name. It should be in the following format: "{CommandName}Handler" ',
+					'event_espresso'
+				),
+				$command_bus_middleware
+			);
+		}
+		parent::__construct(
+			'$command_bus_middleware',
+			$command_bus_middleware,
+			'CommandBusMiddlewareInterface',
+			$message,
+			$code,
+			$previous
+		);
+	}
 }

core/services/commands/CommandHandlerNotFoundException.php

Indentation +17 added lines, -17 removed lines

@@ -13,21 +13,21 @@
 class CommandHandlerNotFoundException extends \OutOfBoundsException
 {
 
-    /**
-     * @access public
-     * @param  string     $command_handler_name
-     * @param  string     $message
-     * @param  int        $code
-     * @param  \Exception $previous
-     */
-    public function __construct($command_handler_name, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__('The requested Command Handler "%1$s" could not be located or does not exist.', 'event_espresso'),
-                $command_handler_name
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * @access public
+	 * @param  string     $command_handler_name
+	 * @param  string     $message
+	 * @param  int        $code
+	 * @param  \Exception $previous
+	 */
+	public function __construct($command_handler_name, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__('The requested Command Handler "%1$s" could not be located or does not exist.', 'event_espresso'),
+				$command_handler_name
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }