eventespresso / event-espresso-core

core/services/container/CoffeeShop.php

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

Indentation +565 added lines, -565 removed lines

@@ -28,569 +28,569 @@
  */
 class CoffeeShop implements CoffeePotInterface
 {
-    /**
-     * 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;
+	}
 }

core/helpers/EEH_Template_Validator.helper.php

Spacing +13 added lines, -13 removed lines

@@ -40,10 +40,10 @@ 
      */
     public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ('allow_null' == $allow_null && is_null($variable_to_test)) {
             return;
         }
@@ -66,7 +66,7 @@ 
      */
     public static function verify_isnt_null($variable_to_test, $name_of_variable)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
         if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
@@ -86,10 +86,10 @@ 
      */
     public static function verify_is_true($expression_to_test, $expression_string_representation)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!$expression_to_test) {
+        if ( ! $expression_to_test) {
             $error[] = esc_html__('Template error.', 'event_espresso');
             $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
@@ -110,14 +110,14 @@ 
      */
     public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
         if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
             return;
         }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+        if ($variable_to_test == null || ! ($variable_to_test instanceof $class_name)) {
             $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
             $msg[] = esc_html__("It should be of type %s", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
@@ -138,14 +138,14 @@ 
      */
     public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
         if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
             return;
         }
-        if (!is_array($variable_to_test)) {
+        if ( ! is_array($variable_to_test)) {
             $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
             $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
@@ -168,10 +168,10 @@ 
      */
     public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
     {
-        if (!WP_DEBUG) {
+        if ( ! WP_DEBUG) {
             return;
         }
-        if (!in_array($variable_to_test, $string_options)) {
+        if ( ! in_array($variable_to_test, $string_options)) {
             $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
             $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
             throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));

Indentation +148 added lines, -148 removed lines

@@ -24,152 +24,152 @@
  */
 class EEH_Template_Validator
 {
-    /**
-     * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful in throwing intelligent errors
-     * @param string $class_name eg EE_Answer, EE_Transaction, etc.
-     * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
-     * @return void
-     * @throws EE_Error (indirectly)
-     */
-    public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ('allow_null' == $allow_null && is_null($variable_to_test)) {
-            return;
-        }
-        self::verify_is_array($variable_to_test, $name_of_variable);
-        foreach ($variable_to_test as $key => $array_element) {
-            self::verify_instanceof($array_element, $key, $class_name);
-        }
-    }
-
-
-
-
-
-    /**
-     * throws an EE_Error if $variable_to_test is null
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful for throwing intelligent errors
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_isnt_null($variable_to_test, $name_of_variable)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
-            $error[] = esc_html__('Variable named %s is null.', 'event_espresso');
-            $error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
-        }
-    }
-
-    /**
-     * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
-     * @param boolean $expression_to_test
-     * @param string $expression_string_representation a string representation of your expression
-     * for example, if your expression were $var1==23, then this should be '$var1==23'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_true($expression_to_test, $expression_string_representation)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!$expression_to_test) {
-            $error[] = esc_html__('Template error.', 'event_espresso');
-            $error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an object of class $class_name
-     * @param mixed $variable_to_test
-     * @param string $name_of_variable helpful when throwing errors
-     * @param string $class_name eg, EE_Answer,
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-        if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
-            return;
-        }
-        if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
-            $msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
-            $msg[] = esc_html__("It should be of type %s", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
-        }
-    }
-
-
-
-
-
-    /**
-     * For verifying that a variable is indeed an array, else throw an EE_Error
-     * @param type $variable_to_test
-     * @param type $variable_name
-     * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-        if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
-            return;
-        }
-        if (!is_array($variable_to_test)) {
-            $error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
-            $error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
-        }
-    }
-
-
-
-
-
-
-
-    /**
-     * for verifying that a variable is one of the string optiosn supplied
-     * @param mixed $variable_to_test
-     * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-     * @param array $string_options an array of acceptable values
-     * @return void
-     * @throws EE_Error
-     */
-    public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
-    {
-        if (!WP_DEBUG) {
-            return;
-        }
-        if (!in_array($variable_to_test, $string_options)) {
-            $msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
-            $msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
-            throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
-        }
-    }
+	/**
+	 * Throws an EE_Error if $variabel_to_test isn't an array of objects of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful in throwing intelligent errors
+	 * @param string $class_name eg EE_Answer, EE_Transaction, etc.
+	 * @param string $allow_null one of 'allow_null', or 'do_not_allow_null'
+	 * @return void
+	 * @throws EE_Error (indirectly)
+	 */
+	public static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
+			return;
+		}
+		self::verify_is_array($variable_to_test, $name_of_variable);
+		foreach ($variable_to_test as $key => $array_element) {
+			self::verify_instanceof($array_element, $key, $class_name);
+		}
+	}
+
+
+
+
+
+	/**
+	 * throws an EE_Error if $variable_to_test is null
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful for throwing intelligent errors
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_isnt_null($variable_to_test, $name_of_variable)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != false) {
+			$error[] = esc_html__('Variable named %s is null.', 'event_espresso');
+			$error[] = esc_html__("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
+		}
+	}
+
+	/**
+	 * When WP_DEBUG is activted, throws an error if $expression_to_test is false.
+	 * @param boolean $expression_to_test
+	 * @param string $expression_string_representation a string representation of your expression
+	 * for example, if your expression were $var1==23, then this should be '$var1==23'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_true($expression_to_test, $expression_string_representation)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!$expression_to_test) {
+			$error[] = esc_html__('Template error.', 'event_espresso');
+			$error[] = esc_html__("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an object of class $class_name
+	 * @param mixed $variable_to_test
+	 * @param string $name_of_variable helpful when throwing errors
+	 * @param string $class_name eg, EE_Answer,
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
+			return;
+		}
+		if ($variable_to_test == null ||  ! ( $variable_to_test instanceof $class_name )) {
+			$msg[] = esc_html__('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[] = esc_html__("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
+		}
+	}
+
+
+
+
+
+	/**
+	 * For verifying that a variable is indeed an array, else throw an EE_Error
+	 * @param type $variable_to_test
+	 * @param type $variable_name
+	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty')
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
+			return;
+		}
+		if (!is_array($variable_to_test)) {
+			$error[] = esc_html__('Variable %s should be an array, but it is not.', 'event_espresso');
+			$error[] = esc_html__("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
+		}
+	}
+
+
+
+
+
+
+
+	/**
+	 * for verifying that a variable is one of the string optiosn supplied
+	 * @param mixed $variable_to_test
+	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
+	 * @param array $string_options an array of acceptable values
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options)
+	{
+		if (!WP_DEBUG) {
+			return;
+		}
+		if (!in_array($variable_to_test, $string_options)) {
+			$msg[0] = esc_html__('Malconfigured template.', 'event_espresso');
+			$msg[1] = esc_html__("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
+		}
+	}
 }

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -7,26 +7,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

payment_methods/Paypal_Express/templates/paypal_express_intro.template.php

Indentation +6 added lines, -6 removed lines

@@ -1,10 +1,10 @@
 <?php
 
 printf(
-    esc_html__(
-        'PayPal Express (Express Checkout) is an off-site payment method for accepting payments via PayPal and is available to event organizers in many countries. A PayPal premier or business account is needed to accept payments. Need a PayPal account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
-        'event_espresso'
-    ),
-    '<a href="https://eventespresso.com/go/paypalexpress/" target="_blank">',
-    '</a>'
+	esc_html__(
+		'PayPal Express (Express Checkout) is an off-site payment method for accepting payments via PayPal and is available to event organizers in many countries. A PayPal premier or business account is needed to accept payments. Need a PayPal account? Call 1-855-456-1338 or %1$sclick here to sign up for a merchant account%2$s.',
+		'event_espresso'
+	),
+	'<a href="https://eventespresso.com/go/paypalexpress/" target="_blank">',
+	'</a>'
 );

payment_methods/Paypal_Standard/EE_Paypal_Standard_Form.form.php

Spacing +3 added lines, -3 removed lines

@@ -67,7 +67,7 @@ 
         $paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
         $paypal_requests_address_info = $this->get_input_value('shipping_details');
         if (
-            ( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
+            ($paypal_calculates_shipping || $paypal_calculates_taxes) &&
             $paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
         ) {
             // they want paypal to calculate taxes or shipping. They need to ask for
@@ -80,8 +80,8 @@ 
                 sprintf(
                     esc_html__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
                     strip_tags($shipping_details_input->html_label_text()),
-                    isset($shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ])
-                        ? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
+                    isset($shipping_details_input_options[EE_PMT_Paypal_Standard::shipping_info_optional])
+                        ? $shipping_details_input_options[EE_PMT_Paypal_Standard::shipping_info_optional]
                         : esc_html__('Unknown', 'event_espresso')
                 ),
                 __FILE__,

Indentation +71 added lines, -71 removed lines

@@ -13,78 +13,78 @@
  */
 class EE_Paypal_Standard_Form extends EE_Payment_Method_Form
 {
-    /**
-     * @param EE_PMT_Paypal_Standard $payment_method_type
-     */
-    public function __construct($payment_method_type)
-    {
-        parent::__construct(
-            array(
-                'payment_method_type'          => $payment_method_type,
-                'extra_meta_inputs'            => array(
-                    'paypal_id'        => new EE_Text_Input(array(
-                        'html_label_text' => sprintf(esc_html__("Paypal Email %s", 'event_espresso'), $payment_method_type->get_help_tab_link()),
-                        'html_help_text'  => esc_html__("Typically payment@example-domain.com", 'event_espresso'),
-                        'required'        => true
-                    )),
-                    'image_url'        => new EE_Admin_File_Uploader_Input(array(
-                        'html_help_text'  => esc_html__("Used for your business/personal logo on the PayPal page", 'event_espresso'),
-                        'html_label_text' => esc_html__('Image URL', 'event_espresso')
-                    )),
-                    'paypal_taxes'     => new EE_Yes_No_Input(array(
-                        'html_label_text' => sprintf(esc_html__('Paypal Calculates Taxes %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
-                        'html_help_text'  => esc_html__('Whether Paypal should add taxes to the order', 'event_espresso'),
-                        'default'         => false
-                    )),
-                    'paypal_shipping'  => new EE_Yes_No_Input(array(
-                        'html_label_text' => sprintf(esc_html__('Paypal Calculates Shipping %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
-                        'html_help_text'  => esc_html__('Whether Paypal should add shipping surcharges', 'event_espresso'),
-                        'default'         => false
-                    )),
-                    'shipping_details' => new EE_Select_Input(array(
-                        EE_PMT_Paypal_Standard::shipping_info_none     => esc_html__("Do not prompt for an address", 'event_espresso'),
-                        EE_PMT_Paypal_Standard::shipping_info_optional => esc_html__("Prompt for an address, but do not require it", 'event_espresso'),
-                        EE_PMT_Paypal_Standard::shipping_info_required => esc_html__("Prompt for an address, and require it", 'event_espresso')
-                    ))
-                )
-            )
-        );
-    }
+	/**
+	 * @param EE_PMT_Paypal_Standard $payment_method_type
+	 */
+	public function __construct($payment_method_type)
+	{
+		parent::__construct(
+			array(
+				'payment_method_type'          => $payment_method_type,
+				'extra_meta_inputs'            => array(
+					'paypal_id'        => new EE_Text_Input(array(
+						'html_label_text' => sprintf(esc_html__("Paypal Email %s", 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => esc_html__("Typically payment@example-domain.com", 'event_espresso'),
+						'required'        => true
+					)),
+					'image_url'        => new EE_Admin_File_Uploader_Input(array(
+						'html_help_text'  => esc_html__("Used for your business/personal logo on the PayPal page", 'event_espresso'),
+						'html_label_text' => esc_html__('Image URL', 'event_espresso')
+					)),
+					'paypal_taxes'     => new EE_Yes_No_Input(array(
+						'html_label_text' => sprintf(esc_html__('Paypal Calculates Taxes %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => esc_html__('Whether Paypal should add taxes to the order', 'event_espresso'),
+						'default'         => false
+					)),
+					'paypal_shipping'  => new EE_Yes_No_Input(array(
+						'html_label_text' => sprintf(esc_html__('Paypal Calculates Shipping %s', 'event_espresso'), $payment_method_type->get_help_tab_link()),
+						'html_help_text'  => esc_html__('Whether Paypal should add shipping surcharges', 'event_espresso'),
+						'default'         => false
+					)),
+					'shipping_details' => new EE_Select_Input(array(
+						EE_PMT_Paypal_Standard::shipping_info_none     => esc_html__("Do not prompt for an address", 'event_espresso'),
+						EE_PMT_Paypal_Standard::shipping_info_optional => esc_html__("Prompt for an address, but do not require it", 'event_espresso'),
+						EE_PMT_Paypal_Standard::shipping_info_required => esc_html__("Prompt for an address, and require it", 'event_espresso')
+					))
+				)
+			)
+		);
+	}
 
 
 
-    /**
-     * @param array $req_data
-     * @throws EE_Error
-     */
-    public function _normalize($req_data)
-    {
-        parent::_normalize($req_data);
-        $paypal_calculates_shipping = $this->get_input_value('paypal_shipping');
-        $paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
-        $paypal_requests_address_info = $this->get_input_value('shipping_details');
-        if (
-            ( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
-            $paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
-        ) {
-            // they want paypal to calculate taxes or shipping. They need to ask for
-            // address info, otherwise paypal can't calculate taxes or shipping
-            /** @type EE_Select_Input $shipping_details_input */
-            $shipping_details_input = $this->get_input('shipping_details');
-            $shipping_details_input->set_default(EE_PMT_Paypal_Standard::shipping_info_optional);
-            $shipping_details_input_options = $shipping_details_input->options();
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
-                    strip_tags($shipping_details_input->html_label_text()),
-                    isset($shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ])
-                        ? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
-                        : esc_html__('Unknown', 'event_espresso')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * @param array $req_data
+	 * @throws EE_Error
+	 */
+	public function _normalize($req_data)
+	{
+		parent::_normalize($req_data);
+		$paypal_calculates_shipping = $this->get_input_value('paypal_shipping');
+		$paypal_calculates_taxes = $this->get_input_value('paypal_taxes');
+		$paypal_requests_address_info = $this->get_input_value('shipping_details');
+		if (
+			( $paypal_calculates_shipping || $paypal_calculates_taxes ) &&
+			$paypal_requests_address_info == EE_PMT_Paypal_Standard::shipping_info_none
+		) {
+			// they want paypal to calculate taxes or shipping. They need to ask for
+			// address info, otherwise paypal can't calculate taxes or shipping
+			/** @type EE_Select_Input $shipping_details_input */
+			$shipping_details_input = $this->get_input('shipping_details');
+			$shipping_details_input->set_default(EE_PMT_Paypal_Standard::shipping_info_optional);
+			$shipping_details_input_options = $shipping_details_input->options();
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__('Automatically set "%s" to "%s" because Paypal requires address info in order to calculate shipping or taxes.', 'event_espresso'),
+					strip_tags($shipping_details_input->html_label_text()),
+					isset($shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ])
+						? $shipping_details_input_options[ EE_PMT_Paypal_Standard::shipping_info_optional ]
+						: esc_html__('Unknown', 'event_espresso')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 }

admin_pages/registrations/qtips/Registration_List_Table_Tips.lib.php

Spacing +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
                . esc_html__(
                    'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
 

Indentation +37 added lines, -37 removed lines

@@ -15,16 +15,16 @@ 
  */
 class Registration_List_Table_Tips extends EE_Qtip_Config
 {
-    protected function _set_tips_array()
-    {
-        $this->_qtipsa = array(
-            0 => array(
-                'content_id' => 'registration-trash-lock',
-                'target'     => '.ee-lock-icon',
-                'content'    => $this->_registration_trash_message(),
-            ),
-            /** removing status strips for now because they are triggered anywhere on the row. */
-            /**1 => array(
+	protected function _set_tips_array()
+	{
+		$this->_qtipsa = array(
+			0 => array(
+				'content_id' => 'registration-trash-lock',
+				'target'     => '.ee-lock-icon',
+				'content'    => $this->_registration_trash_message(),
+			),
+			/** removing status strips for now because they are triggered anywhere on the row. */
+			/**1 => array(
              * 'content_id' => 'registration-status-' . RegStatus::APPROVED,
              * 'target' => '.reg-status-' . RegStatus::APPROVED,
              * 'content' => $this->_registration_status_legend(RegStatus::APPROVED),
@@ -74,37 +74,37 @@ 
              * )
              * )
              * )/**/
-        );
-    }
+		);
+	}
 
 
-    private function _registration_trash_message()
-    {
-        return '<p>'
-               . esc_html__(
-                   'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	private function _registration_trash_message()
+	{
+		return '<p>'
+			   . esc_html__(
+				   'This lock-icon means that this registration cannot be trashed.  Registrations that belong to a transaction that has payments cannot be trashed.  If you wish to trash this registration then you must delete all payments attached to the related transaction first.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
 
-    /**
-     * output the relevant ee-status-legend with the designated status highlighted.
-     *
-     * @param  EEM_Registration constant $status What status is set (by class)
-     * @return string         The status legend with the related status highlighted
-     */
-    private function _registration_status_legend($status)
-    {
+	/**
+	 * output the relevant ee-status-legend with the designated status highlighted.
+	 *
+	 * @param  EEM_Registration constant $status What status is set (by class)
+	 * @return string         The status legend with the related status highlighted
+	 */
+	private function _registration_status_legend($status)
+	{
 
-        $status_array = array(
-            'approved_status' => RegStatus::APPROVED,
-            'pending_status' => RegStatus::PENDING_PAYMENT,
-            'not_approved' => RegStatus::AWAITING_REVIEW,
-            'declined_status' => RegStatus::DECLINED,
-            'cancelled_status' => RegStatus::CANCELLED,
-        );
+		$status_array = array(
+			'approved_status' => RegStatus::APPROVED,
+			'pending_status' => RegStatus::PENDING_PAYMENT,
+			'not_approved' => RegStatus::AWAITING_REVIEW,
+			'declined_status' => RegStatus::DECLINED,
+			'cancelled_status' => RegStatus::CANCELLED,
+		);
 
-        return EEH_Template::status_legend($status_array, $status);
-    }
+		return EEH_Template::status_legend($status_array, $status);
+	}
 }

admin_pages/events/Events_Admin_Page_Init.core.php

Spacing +5 added lines, -5 removed lines

@@ -21,13 +21,13 @@
          * define some events related constants but only if not defined (need to check because unit tests
          *  may load)
          */
-        if (! defined('EVENTS_PG_SLUG')) {
+        if ( ! defined('EVENTS_PG_SLUG')) {
             define('EVENTS_PG_SLUG', 'espresso_events');
             define('EVENTS_LABEL', esc_html__('Events', 'event_espresso'));
-            define('EVENTS_ADMIN', EE_ADMIN_PAGES . 'events/');
-            define('EVENTS_ADMIN_URL', admin_url('admin.php?page=' . EVENTS_PG_SLUG));
-            define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN . 'templates/');
-            define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'events/assets/');
+            define('EVENTS_ADMIN', EE_ADMIN_PAGES.'events/');
+            define('EVENTS_ADMIN_URL', admin_url('admin.php?page='.EVENTS_PG_SLUG));
+            define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN.'templates/');
+            define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL.'events/assets/');
         }
         parent::__construct();
     }

Indentation +33 added lines, -33 removed lines

@@ -14,41 +14,41 @@
  */
 class Events_Admin_Page_Init extends EE_Admin_Page_CPT_Init
 {
-    public function __construct()
-    {
-        /**
-         * define some events related constants but only if not defined (need to check because unit tests
-         *  may load)
-         */
-        if (! defined('EVENTS_PG_SLUG')) {
-            define('EVENTS_PG_SLUG', 'espresso_events');
-            define('EVENTS_LABEL', esc_html__('Events', 'event_espresso'));
-            define('EVENTS_ADMIN', EE_ADMIN_PAGES . 'events/');
-            define('EVENTS_ADMIN_URL', admin_url('admin.php?page=' . EVENTS_PG_SLUG));
-            define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN . 'templates/');
-            define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'events/assets/');
-        }
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		/**
+		 * define some events related constants but only if not defined (need to check because unit tests
+		 *  may load)
+		 */
+		if (! defined('EVENTS_PG_SLUG')) {
+			define('EVENTS_PG_SLUG', 'espresso_events');
+			define('EVENTS_LABEL', esc_html__('Events', 'event_espresso'));
+			define('EVENTS_ADMIN', EE_ADMIN_PAGES . 'events/');
+			define('EVENTS_ADMIN_URL', admin_url('admin.php?page=' . EVENTS_PG_SLUG));
+			define('EVENTS_TEMPLATE_PATH', EVENTS_ADMIN . 'templates/');
+			define('EVENTS_ASSETS_URL', EE_ADMIN_PAGES_URL . 'events/assets/');
+		}
+		parent::__construct();
+	}
 
 
-    protected function _set_init_properties()
-    {
-        $this->label = esc_html__('Event Espresso - Event Details', 'event_espresso');
-    }
+	protected function _set_init_properties()
+	{
+		$this->label = esc_html__('Event Espresso - Event Details', 'event_espresso');
+	}
 
 
-    public function getMenuProperties(): array
-    {
-        return [
-            'menu_type'       => AdminMenuItem::TYPE_MENU_SUB_ITEM,
-            'menu_group'      => 'main',
-            'menu_order'      => 10,
-            'show_on_menu'    => AdminMenuItem::DISPLAY_BLOG_ONLY,
-            'parent_slug'     => 'espresso_events',
-            'menu_slug'       => 'espresso_events',
-            'menu_label'      => esc_html__('Events', 'event_espresso'),
-            'capability'      => 'ee_read_events',
-        ];
-    }
+	public function getMenuProperties(): array
+	{
+		return [
+			'menu_type'       => AdminMenuItem::TYPE_MENU_SUB_ITEM,
+			'menu_group'      => 'main',
+			'menu_order'      => 10,
+			'show_on_menu'    => AdminMenuItem::DISPLAY_BLOG_ONLY,
+			'parent_slug'     => 'espresso_events',
+			'menu_slug'       => 'espresso_events',
+			'menu_label'      => esc_html__('Events', 'event_espresso'),
+			'capability'      => 'ee_read_events',
+		];
+	}
 }

caffeinated/core/libraries/messages/message_type/newsletter/EE_Messages_Contacts_incoming_data.class.php

Spacing +9 added lines, -9 removed lines

@@ -26,7 +26,7 @@ 
 
         // validate that the first element in the array is an EE_Attendee object.  Note that the array may be indexed by REG_ID so we will just shift off the first element.
         $ctc_chk = reset($data);
-        if (! $ctc_chk instanceof EE_Attendee) {
+        if ( ! $ctc_chk instanceof EE_Attendee) {
             throw new EE_Error(esc_html__('The EE_Message_Contacts_incoming_data class expects an array of EE_Attendee objects.', 'event_espresso'));
         }
 
@@ -43,7 +43,7 @@ 
     {
         $attendee_ids = array_filter(
             array_map(
-                function ($attendee) {
+                function($attendee) {
                     if ($attendee instanceof EE_Attendee) {
                         return $attendee->ID();
                     }
@@ -68,7 +68,7 @@ 
         $attendee_ids = (array) $attendee_ids;
         $attendees = EEM_Attendee::instance()->get_all(
             array(
-              array( 'ATT_ID' => array( 'IN', $attendee_ids ) )
+              array('ATT_ID' => array('IN', $attendee_ids))
             )
         );
         return $attendees;
@@ -98,7 +98,7 @@ 
         $this->payment = null;
         $this->billing = array();
         $this->reg_objs = array();
-        $this->attendees = $this->events = $this->tickets = $this->datetimes = $this->questions = $this->answer =  $this->registrations = array();
+        $this->attendees = $this->events = $this->tickets = $this->datetimes = $this->questions = $this->answer = $this->registrations = array();
         $this->total_ticket_count = 0;
         $this->primary_attendee_data = array(
             'registration_id' => 0,
@@ -111,11 +111,11 @@ 
         foreach ($this->_data as $contact) {
             $id = $contact->ID();
             $reg = $contact->get_first_related('Registration');
-            $this->attendees[ $id ]['att_obj'] = $contact;
-            $this->attendees[ $id ]['reg_objs'][ $reg->ID() ] = $reg;
-            $this->attendees[ $id ]['attendee_email'] = $contact->email();
-            $this->attendees[ $id ]['tkt_objs'] = array();
-            $this->attendees[ $id ]['evt_objs'] = array();
+            $this->attendees[$id]['att_obj'] = $contact;
+            $this->attendees[$id]['reg_objs'][$reg->ID()] = $reg;
+            $this->attendees[$id]['attendee_email'] = $contact->email();
+            $this->attendees[$id]['tkt_objs'] = array();
+            $this->attendees[$id]['evt_objs'] = array();
         }
     }
 }

Indentation +91 added lines, -91 removed lines

@@ -11,109 +11,109 @@
  */
 class EE_Messages_Contacts_incoming_data extends EE_Messages_incoming_data
 {
-    /**
-     * Constructor.
-     *
-     * @since    4.3.0
-     * @param  EE_Attendee[]     $data expecting an array of EE_Attendee objects.
-     * @throws EE_Error
-     * @access protected
-     */
-    public function __construct($data = array())
-    {
+	/**
+	 * Constructor.
+	 *
+	 * @since    4.3.0
+	 * @param  EE_Attendee[]     $data expecting an array of EE_Attendee objects.
+	 * @throws EE_Error
+	 * @access protected
+	 */
+	public function __construct($data = array())
+	{
 
-        // validate that the first element in the array is an EE_Attendee object.  Note that the array may be indexed by REG_ID so we will just shift off the first element.
-        $ctc_chk = reset($data);
-        if (! $ctc_chk instanceof EE_Attendee) {
-            throw new EE_Error(esc_html__('The EE_Message_Contacts_incoming_data class expects an array of EE_Attendee objects.', 'event_espresso'));
-        }
+		// validate that the first element in the array is an EE_Attendee object.  Note that the array may be indexed by REG_ID so we will just shift off the first element.
+		$ctc_chk = reset($data);
+		if (! $ctc_chk instanceof EE_Attendee) {
+			throw new EE_Error(esc_html__('The EE_Message_Contacts_incoming_data class expects an array of EE_Attendee objects.', 'event_espresso'));
+		}
 
-        parent::__construct($data);
-    }
+		parent::__construct($data);
+	}
 
 
-    /**
-     * @see parent class for phpdocs.
-     * @param array $attendees
-     * @return array
-     */
-    public static function convert_data_for_persistent_storage($attendees)
-    {
-        $attendee_ids = array_filter(
-            array_map(
-                function ($attendee) {
-                    if ($attendee instanceof EE_Attendee) {
-                        return $attendee->ID();
-                    }
-                    return false;
-                },
-                $attendees
-            )
-        );
-        return $attendee_ids;
-    }
+	/**
+	 * @see parent class for phpdocs.
+	 * @param array $attendees
+	 * @return array
+	 */
+	public static function convert_data_for_persistent_storage($attendees)
+	{
+		$attendee_ids = array_filter(
+			array_map(
+				function ($attendee) {
+					if ($attendee instanceof EE_Attendee) {
+						return $attendee->ID();
+					}
+					return false;
+				},
+				$attendees
+			)
+		);
+		return $attendee_ids;
+	}
 
 
 
 
-    /**
-     * @see parent class for phpdocs
-     * @param array $attendee_ids
-     * @return EE_Attendee[]
-     */
-    public static function convert_data_from_persistent_storage($attendee_ids)
-    {
-        $attendee_ids = (array) $attendee_ids;
-        $attendees = EEM_Attendee::instance()->get_all(
-            array(
-              array( 'ATT_ID' => array( 'IN', $attendee_ids ) )
-            )
-        );
-        return $attendees;
-    }
+	/**
+	 * @see parent class for phpdocs
+	 * @param array $attendee_ids
+	 * @return EE_Attendee[]
+	 */
+	public static function convert_data_from_persistent_storage($attendee_ids)
+	{
+		$attendee_ids = (array) $attendee_ids;
+		$attendees = EEM_Attendee::instance()->get_all(
+			array(
+			  array( 'ATT_ID' => array( 'IN', $attendee_ids ) )
+			)
+		);
+		return $attendees;
+	}
 
 
 
 
-    /**
-     * setup the data.
-     *
-     * Sets up the expected data object for the messages prep using incoming registration objects.
-     *
-     * @since   4.3.0
-     *
-     * @return void
-     * @access protected
-     */
-    protected function _setup_data()
-    {
+	/**
+	 * setup the data.
+	 *
+	 * Sets up the expected data object for the messages prep using incoming registration objects.
+	 *
+	 * @since   4.3.0
+	 *
+	 * @return void
+	 * @access protected
+	 */
+	protected function _setup_data()
+	{
 
-        // we'll loop through each contact and setup the data needed.  Note that many properties will just be set as empty because the contacts data handler is for a very specific set of data (i.e. just what's related to the contact).
-        $this->txn = null;
-        $this->taxes = null;
-        $this->grand_total_price_object = '';
-        $this->user_id = $this->ip_address = $this->user_agent = $this->init_access = '';
-        $this->payment = null;
-        $this->billing = array();
-        $this->reg_objs = array();
-        $this->attendees = $this->events = $this->tickets = $this->datetimes = $this->questions = $this->answer =  $this->registrations = array();
-        $this->total_ticket_count = 0;
-        $this->primary_attendee_data = array(
-            'registration_id' => 0,
-            'att_obj' => null,
-            'reg_obj' => null,
-            'primary_att_obj' => null,
-            'primary_reg_obj' => null
-            );
+		// we'll loop through each contact and setup the data needed.  Note that many properties will just be set as empty because the contacts data handler is for a very specific set of data (i.e. just what's related to the contact).
+		$this->txn = null;
+		$this->taxes = null;
+		$this->grand_total_price_object = '';
+		$this->user_id = $this->ip_address = $this->user_agent = $this->init_access = '';
+		$this->payment = null;
+		$this->billing = array();
+		$this->reg_objs = array();
+		$this->attendees = $this->events = $this->tickets = $this->datetimes = $this->questions = $this->answer =  $this->registrations = array();
+		$this->total_ticket_count = 0;
+		$this->primary_attendee_data = array(
+			'registration_id' => 0,
+			'att_obj' => null,
+			'reg_obj' => null,
+			'primary_att_obj' => null,
+			'primary_reg_obj' => null
+			);
 
-        foreach ($this->_data as $contact) {
-            $id = $contact->ID();
-            $reg = $contact->get_first_related('Registration');
-            $this->attendees[ $id ]['att_obj'] = $contact;
-            $this->attendees[ $id ]['reg_objs'][ $reg->ID() ] = $reg;
-            $this->attendees[ $id ]['attendee_email'] = $contact->email();
-            $this->attendees[ $id ]['tkt_objs'] = array();
-            $this->attendees[ $id ]['evt_objs'] = array();
-        }
-    }
+		foreach ($this->_data as $contact) {
+			$id = $contact->ID();
+			$reg = $contact->get_first_related('Registration');
+			$this->attendees[ $id ]['att_obj'] = $contact;
+			$this->attendees[ $id ]['reg_objs'][ $reg->ID() ] = $reg;
+			$this->attendees[ $id ]['attendee_email'] = $contact->email();
+			$this->attendees[ $id ]['tkt_objs'] = array();
+			$this->attendees[ $id ]['evt_objs'] = array();
+		}
+	}
 }

caffeinated/core/libraries/messages/message_type/payment_reminder/EE_Payment_Reminder_message_type.class.php

Indentation +45 added lines, -45 removed lines

@@ -15,49 +15,49 @@
 class EE_Payment_Reminder_message_type extends EE_Payment_Base_message_type
 {
 
-    public function __construct()
-    {
-
-        // setup type details for reference
-        $this->name = 'payment_reminder';
-        $this->description = esc_html__('This message type is used for all payment reminder messages.  These are triggered when an offline gateway registration is completed or when manually triggered via event administrators via the transaction admin page(s).', 'event_espresso');
-        $this->label = array(
-            'singular' => esc_html__('payment reminder', 'event_espresso'),
-            'plural' => esc_html__('payment reminders', 'event_espresso')
-            );
-        $this->_master_templates = array(
-            'email' => 'payment'
-            );
-
-        parent::__construct();
-    }
-
-
-
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @access  protected
-     * @return  void
-     */
-    protected function _set_contexts()
-    {
-        $this->_context_label = array(
-            'label' => esc_html__('recipient', 'event_espresso'),
-            'plural' => esc_html__('recipients', 'event_espresso'),
-            'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
-            );
-
-        $this->_contexts = array(
-            'admin' => array(
-                'label' => esc_html__('Event Admin', 'event_espresso'),
-                'description' => esc_html__('This template is what event administrators will receive on a successful payment', 'event_espresso')
-                ),
-            'primary_attendee' => array(
-                'label' => esc_html__('Primary Registrant', 'event_espresso'),
-                'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful payment', 'event_espresso')
-                )
-            );
-    }
+	public function __construct()
+	{
+
+		// setup type details for reference
+		$this->name = 'payment_reminder';
+		$this->description = esc_html__('This message type is used for all payment reminder messages.  These are triggered when an offline gateway registration is completed or when manually triggered via event administrators via the transaction admin page(s).', 'event_espresso');
+		$this->label = array(
+			'singular' => esc_html__('payment reminder', 'event_espresso'),
+			'plural' => esc_html__('payment reminders', 'event_espresso')
+			);
+		$this->_master_templates = array(
+			'email' => 'payment'
+			);
+
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @access  protected
+	 * @return  void
+	 */
+	protected function _set_contexts()
+	{
+		$this->_context_label = array(
+			'label' => esc_html__('recipient', 'event_espresso'),
+			'plural' => esc_html__('recipients', 'event_espresso'),
+			'description' => esc_html__('Recipient\'s are who will receive the template.  You may want different payment details sent out depending on who the recipient is', 'event_espresso')
+			);
+
+		$this->_contexts = array(
+			'admin' => array(
+				'label' => esc_html__('Event Admin', 'event_espresso'),
+				'description' => esc_html__('This template is what event administrators will receive on a successful payment', 'event_espresso')
+				),
+			'primary_attendee' => array(
+				'label' => esc_html__('Primary Registrant', 'event_espresso'),
+				'description' => esc_html__('This template is what the primary registrant (the person who made the main registration) will receive on successful payment', 'event_espresso')
+				)
+			);
+	}
 }