eventespresso / event-espresso-core

core/services/container/CoffeeMaker.php

Doc Comments +2 added lines, -2 removed lines

@@ -69,7 +69,7 @@ 
 
 
     /**
-     * @param $type
+     * @param string $type
      * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
      */
     public static function validateType($type)
@@ -127,7 +127,7 @@ 
      * Examines the constructor to determine which method should be used for instantiation
      *
      * @param \ReflectionClass $reflector
-     * @return mixed
+     * @return string
      * @throws InstantiationException
      */
     protected function resolveInstantiationMethod(\ReflectionClass $reflector)

Indentation +152 added lines, -152 removed lines

@@ -18,156 +18,156 @@
 abstract class CoffeeMaker implements CoffeeMakerInterface
 {
 
-    /**
-     * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
-     */
-    const BREW_NEW = 'new';
-
-    /**
-     * Indicates that CoffeeMaker should always return a SHARED instance
-     */
-    const BREW_SHARED = 'shared';
-
-    /**
-     * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
-     */
-    const BREW_LOAD_ONLY = 'load_only';
-
-
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var DependencyInjector $injector
-     */
-    private $injector;
-
-
-    /**
-     * @return array
-     */
-    public static function getTypes()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
-            array(
-                CoffeeMaker::BREW_NEW,
-                CoffeeMaker::BREW_SHARED,
-                CoffeeMaker::BREW_LOAD_ONLY,
-            )
-        );
-    }
-
-
-    /**
-     * @param $type
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     */
-    public static function validateType($type)
-    {
-        $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
-            throw new InvalidIdentifierException(
-                is_object($type) ? get_class($type) : gettype($type),
-                __(
-                    'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
-                    'event_espresso'
-                )
-            );
-        }
-        return $type;
-    }
-
-
-    /**
-     * CoffeeMaker constructor.
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param InjectorInterface  $injector
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->injector = $injector;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\CoffeePotInterface
-     */
-    protected function coffeePot()
-    {
-        return $this->coffee_pot;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\container\DependencyInjector
-     */
-    protected function injector()
-    {
-        return $this->injector;
-    }
-
-
-    /**
-     * Examines the constructor to determine which method should be used for instantiation
-     *
-     * @param \ReflectionClass $reflector
-     * @return mixed
-     * @throws InstantiationException
-     */
-    protected function resolveInstantiationMethod(\ReflectionClass $reflector)
-    {
-        if ($reflector->getConstructor() === null) {
-            return 'NewInstance';
-        }
-        if ($reflector->isInstantiable()) {
-            return 'NewInstanceArgs';
-        }
-        if (method_exists($reflector->getName(), 'instance')) {
-            return 'instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance')) {
-            return 'new_instance';
-        }
-        if (method_exists($reflector->getName(), 'new_instance_from_db')) {
-            return 'new_instance_from_db';
-        }
-        throw new InstantiationException($reflector->getName());
-    }
-
-
-    /**
-     * Ensures files for classes that are not PSR-4 compatible are loaded
-     * and then verifies that classes exist where applicable
-     *
-     * @param RecipeInterface $recipe
-     * @return bool
-     * @throws InvalidClassException
-     */
-    protected function resolveClassAndFilepath(RecipeInterface $recipe)
-    {
-        $paths = $recipe->paths();
-        if (! empty($paths)) {
-            foreach ($paths as $path) {
-                if (strpos($path, '*') === false && is_readable($path)) {
-                    require_once($path);
-                }
-            }
-        }
-        // re: using "false" for class_exists() second param:
-        // if a class name is not already known to PHP, then class_exists() will run through
-        // all of the registered spl_autoload functions until it either finds the class,
-        // or gets to the end of the registered spl_autoload functions.
-        // When the second parameter is true, it will also attempt to load the class file,
-        // but it will also trigger an error if the class can not be loaded.
-        // We don't want that extra error in the mix, so we have set the second param to "false"
-        if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
-            throw new InvalidClassException($recipe->identifier());
-        }
-        return true;
-    }
+	/**
+	 * Indicates that CoffeeMaker should construct a NEW entity instance from the provided arguments (if given)
+	 */
+	const BREW_NEW = 'new';
+
+	/**
+	 * Indicates that CoffeeMaker should always return a SHARED instance
+	 */
+	const BREW_SHARED = 'shared';
+
+	/**
+	 * Indicates that CoffeeMaker should only load the file/class/interface but NOT instantiate
+	 */
+	const BREW_LOAD_ONLY = 'load_only';
+
+
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var DependencyInjector $injector
+	 */
+	private $injector;
+
+
+	/**
+	 * @return array
+	 */
+	public static function getTypes()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso\core\services\container\CoffeeMaker__getTypes',
+			array(
+				CoffeeMaker::BREW_NEW,
+				CoffeeMaker::BREW_SHARED,
+				CoffeeMaker::BREW_LOAD_ONLY,
+			)
+		);
+	}
+
+
+	/**
+	 * @param $type
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 */
+	public static function validateType($type)
+	{
+		$types = CoffeeMaker::getTypes();
+		if (! in_array($type, $types, true)) {
+			throw new InvalidIdentifierException(
+				is_object($type) ? get_class($type) : gettype($type),
+				__(
+					'recipe type (one of the class constants on \EventEspresso\core\services\container\CoffeeMaker)',
+					'event_espresso'
+				)
+			);
+		}
+		return $type;
+	}
+
+
+	/**
+	 * CoffeeMaker constructor.
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param InjectorInterface  $injector
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, InjectorInterface $injector)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->injector = $injector;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\CoffeePotInterface
+	 */
+	protected function coffeePot()
+	{
+		return $this->coffee_pot;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\container\DependencyInjector
+	 */
+	protected function injector()
+	{
+		return $this->injector;
+	}
+
+
+	/**
+	 * Examines the constructor to determine which method should be used for instantiation
+	 *
+	 * @param \ReflectionClass $reflector
+	 * @return mixed
+	 * @throws InstantiationException
+	 */
+	protected function resolveInstantiationMethod(\ReflectionClass $reflector)
+	{
+		if ($reflector->getConstructor() === null) {
+			return 'NewInstance';
+		}
+		if ($reflector->isInstantiable()) {
+			return 'NewInstanceArgs';
+		}
+		if (method_exists($reflector->getName(), 'instance')) {
+			return 'instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance')) {
+			return 'new_instance';
+		}
+		if (method_exists($reflector->getName(), 'new_instance_from_db')) {
+			return 'new_instance_from_db';
+		}
+		throw new InstantiationException($reflector->getName());
+	}
+
+
+	/**
+	 * Ensures files for classes that are not PSR-4 compatible are loaded
+	 * and then verifies that classes exist where applicable
+	 *
+	 * @param RecipeInterface $recipe
+	 * @return bool
+	 * @throws InvalidClassException
+	 */
+	protected function resolveClassAndFilepath(RecipeInterface $recipe)
+	{
+		$paths = $recipe->paths();
+		if (! empty($paths)) {
+			foreach ($paths as $path) {
+				if (strpos($path, '*') === false && is_readable($path)) {
+					require_once($path);
+				}
+			}
+		}
+		// re: using "false" for class_exists() second param:
+		// if a class name is not already known to PHP, then class_exists() will run through
+		// all of the registered spl_autoload functions until it either finds the class,
+		// or gets to the end of the registered spl_autoload functions.
+		// When the second parameter is true, it will also attempt to load the class file,
+		// but it will also trigger an error if the class can not be loaded.
+		// We don't want that extra error in the mix, so we have set the second param to "false"
+		if ($recipe->type() !== CoffeeMaker::BREW_LOAD_ONLY && ! class_exists($recipe->fqcn(), false)) {
+			throw new InvalidClassException($recipe->identifier());
+		}
+		return true;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
     public static function validateType($type)
     {
         $types = CoffeeMaker::getTypes();
-        if (! in_array($type, $types, true)) {
+        if ( ! in_array($type, $types, true)) {
             throw new InvalidIdentifierException(
                 is_object($type) ? get_class($type) : gettype($type),
                 __(
@@ -151,7 +151,7 @@ 
     protected function resolveClassAndFilepath(RecipeInterface $recipe)
     {
         $paths = $recipe->paths();
-        if (! empty($paths)) {
+        if ( ! empty($paths)) {
             foreach ($paths as $path) {
                 if (strpos($path, '*') === false && is_readable($path)) {
                     require_once($path);

core/services/container/CoffeeShop.php

Doc Comments +2 added lines, -2 removed lines

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

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

Indentation +6 added lines, -6 removed lines

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

core/libraries/form_sections/strategies/normalization/EE_Int_Normalization.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
     /**
      * @param string $value_to_normalize
-     * @return int|mixed|string
+     * @return null|integer
      * @throws \EE_Validation_Error
      */
     public function normalize($value_to_normalize)

Indentation +74 added lines, -74 removed lines

@@ -10,88 +10,88 @@
 class EE_Int_Normalization extends EE_Normalization_Strategy_Base
 {
 
-    /*
+	/*
      * regex pattern that matches for the following:
      *      * optional negative sign
      *      * one or more digits
      */
-    const REGEX = '/^(-?)(\d+)(?:\.0+)?$/';
+	const REGEX = '/^(-?)(\d+)(?:\.0+)?$/';
 
 
 
-    /**
-     * @param string $value_to_normalize
-     * @return int|mixed|string
-     * @throws \EE_Validation_Error
-     */
-    public function normalize($value_to_normalize)
-    {
-        if ($value_to_normalize === null) {
-            return null;
-        }
-        if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
-            return (int) $value_to_normalize;
-        }
-        if (! is_string($value_to_normalize)) {
-            throw new EE_Validation_Error(
-                sprintf(
-                    __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
-                    print_r($value_to_normalize, true),
-                    gettype($value_to_normalize)
-                )
-            );
-        }
-        $value_to_normalize = filter_var(
-            $value_to_normalize,
-            FILTER_SANITIZE_NUMBER_FLOAT,
-            FILTER_FLAG_ALLOW_FRACTION
-        );
-        if ($value_to_normalize === '') {
-            return null;
-        }
-        $matches = array();
-        if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) {
-            if (count($matches) === 3) {
-                // if first match is the negative sign,
-                // then the number needs to be multiplied by -1 to remain negative
-                return $matches[1] === '-'
-                    ? (int) $matches[2] * -1
-                    : (int) $matches[2];
-            }
-        }
-        // find if this input has a int validation strategy
-        // in which case, use its message
-        $validation_error_message = null;
-        foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
-                $validation_error_message = $validation_strategy->get_validation_error_message();
-            }
-        }
-        // this really shouldn't ever happen because fields with a int normalization strategy
-        // should also have a int validation strategy, but in case it doesn't use the default
-        if (! $validation_error_message) {
-            $default_validation_strategy = new EE_Int_Validation_Strategy();
-            $validation_error_message = $default_validation_strategy->get_validation_error_message();
-        }
-        throw new EE_Validation_Error($validation_error_message, 'numeric_only');
-    }
+	/**
+	 * @param string $value_to_normalize
+	 * @return int|mixed|string
+	 * @throws \EE_Validation_Error
+	 */
+	public function normalize($value_to_normalize)
+	{
+		if ($value_to_normalize === null) {
+			return null;
+		}
+		if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
+			return (int) $value_to_normalize;
+		}
+		if (! is_string($value_to_normalize)) {
+			throw new EE_Validation_Error(
+				sprintf(
+					__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
+					print_r($value_to_normalize, true),
+					gettype($value_to_normalize)
+				)
+			);
+		}
+		$value_to_normalize = filter_var(
+			$value_to_normalize,
+			FILTER_SANITIZE_NUMBER_FLOAT,
+			FILTER_FLAG_ALLOW_FRACTION
+		);
+		if ($value_to_normalize === '') {
+			return null;
+		}
+		$matches = array();
+		if (preg_match(EE_Int_Normalization::REGEX, $value_to_normalize, $matches)) {
+			if (count($matches) === 3) {
+				// if first match is the negative sign,
+				// then the number needs to be multiplied by -1 to remain negative
+				return $matches[1] === '-'
+					? (int) $matches[2] * -1
+					: (int) $matches[2];
+			}
+		}
+		// find if this input has a int validation strategy
+		// in which case, use its message
+		$validation_error_message = null;
+		foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
+				$validation_error_message = $validation_strategy->get_validation_error_message();
+			}
+		}
+		// this really shouldn't ever happen because fields with a int normalization strategy
+		// should also have a int validation strategy, but in case it doesn't use the default
+		if (! $validation_error_message) {
+			$default_validation_strategy = new EE_Int_Validation_Strategy();
+			$validation_error_message = $default_validation_strategy->get_validation_error_message();
+		}
+		throw new EE_Validation_Error($validation_error_message, 'numeric_only');
+	}
 
 
 
-    /**
-     * Converts the int into a string for use in teh html form
-     *
-     * @param int $normalized_value
-     * @return string
-     */
-    public function unnormalize($normalized_value)
-    {
-        if ($normalized_value === null || $normalized_value === '') {
-            return '';
-        }
-        if (empty($normalized_value)) {
-            return '0';
-        }
-        return "$normalized_value";
-    }
+	/**
+	 * Converts the int into a string for use in teh html form
+	 *
+	 * @param int $normalized_value
+	 * @return string
+	 */
+	public function unnormalize($normalized_value)
+	{
+		if ($normalized_value === null || $normalized_value === '') {
+			return '';
+		}
+		if (empty($normalized_value)) {
+			return '0';
+		}
+		return "$normalized_value";
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
         if (is_int($value_to_normalize) || is_float($value_to_normalize)) {
             return (int) $value_to_normalize;
         }
-        if (! is_string($value_to_normalize)) {
+        if ( ! is_string($value_to_normalize)) {
             throw new EE_Validation_Error(
                 sprintf(
                     __('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'),
@@ -69,7 +69,7 @@ 
         }
         // this really shouldn't ever happen because fields with a int normalization strategy
         // should also have a int validation strategy, but in case it doesn't use the default
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $default_validation_strategy = new EE_Int_Validation_Strategy();
             $validation_error_message = $default_validation_strategy->get_validation_error_message();
         }

core/db_models/EEM_Event.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -217,7 +217,7 @@
 
     /**
      * Used to override the default for the additional limit field.
-     * @param $additional_limit
+     * @param integer $additional_limit
      */
     public static function set_default_additional_limit($additional_limit)
     {

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use EventEspresso\core\services\orm\ModelFieldFactory;
-
 /**
  * EEM_Event Model
  * extends EEM_CPT_Base which extends EEM_Base

Indentation +873 added lines, -873 removed lines

@@ -13,877 +13,877 @@
 class EEM_Event extends EEM_CPT_Base
 {
 
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string $timezone
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone = null)
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            array(
-                EEM_Event::cancelled => array(
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ),
-                EEM_Event::postponed => array(
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ),
-                EEM_Event::sold_out  => array(
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ),
-            )
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables = array(
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        );
-        $this->_fields = array(
-            'Event_CPT'  => array(
-                'EVT_ID'         => new EE_Primary_Key_Int_Field(
-                    'ID',
-                    esc_html__('Post ID for Event', 'event_espresso')
-                ),
-                'EVT_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_slug'       => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__('Event Slug', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_short_desc' => new EE_Simple_HTML_Field(
-                    'post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'EVT_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field(
-                    'post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false,
-                    'draft',
-                    $this->_custom_stati
-                ),
-            ),
-            'Event_Meta' => array(
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field(
-                    'EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
-                    false
-                ),
-                'EVT_display_desc'                => new EE_Boolean_Field(
-                    'EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field(
-                    'EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'EVT_visible_on'                  => new EE_Datetime_Field(
-                    'EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    true,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                    false,
-                    EEM_Event::$_default_reg_status,
-                    EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field(
-                    'EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_phone'                       => new EE_Plain_Text_Field(
-                    'EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_allow_overflow'              => new EE_Boolean_Field(
-                    'EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field(
-                    'EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_external_URL'                => new EE_Plain_Text_Field(
-                    'EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
-                    true
-                ),
-                'EVT_donations'                   => new EE_Boolean_Field(
-                    'EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * @param string $default_reg_status
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                __('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                true,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws \EE_Error
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                array('QSG_deleted' => false),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_all_event_question_groups($EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array('EVT_ID' => $EVT_ID),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int     $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            array(
-                array(
-                    'EVT_ID'      => $EVT_ID,
-                    'EQG_primary' => $for_primary_attendee,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int             $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $where_params = array(
-            'Event_Question_Group.EVT_ID'      => $EVT_ID,
-            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-            'QSG_deleted'                      => false,
-        );
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            array(
-                $where_params,
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-    }
-
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            array(
-                array(
-                    'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ),
-                'order_by' => 'QST_order',
-            )
-        );
-    }
-
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    public function get_options_for_question($QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            array(
-                array(
-                    'Question.QST_ID' => array('IN', $QST_IDs),
-                    'QSO_deleted'     => false,
-                ),
-                'order_by' => 'QSO_ID',
-            )
-        );
-    }
-
-
-
-
-
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = array();
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        $where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
-        // add where params for DTT_EVT_end
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['Datetime.DTT_EVT_end*****'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        } else {
-            $where_params['Datetime.DTT_EVT_end'] = array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            );
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param  array $query_params An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool   $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        $exclude_query = $query_params;
-        if (isset($exclude_query[0])) {
-            unset($exclude_query[0]);
-        }
-        $exclude_query[0] = array(
-            'Datetime.DTT_EVT_end' => array(
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ),
-        );
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
-        $event_ids = array_keys($event_ids);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = array(
-            'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
-            'EVT_ID'               => array('NOT IN', $event_ids),
-        );
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param  array   $query_params An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param  boolean $count        whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws \EE_Error
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0]) ? $query_params[0] : array();
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = array('!=', 'publish');
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count(array($where_params), 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
-    {
-        if ($relationName === 'Price') {
-            // let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            // if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            // run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        // otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
-     *             EE_Registration_Custom_Questions_Form located in
-     *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     * @param    EE_Registration $registration (so existing answers for registration are included)
-     * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @throws EE_Error
-     * @return    array
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(__(
-                'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                'event_espresso'
-            ));
-        }
-        $questions = array();
-        // get all question groups for event
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer = EEM_Answer::instance()->get_one(array(
-                        array(
-                            'QST_ID' => $qst->ID(),
-                            'REG_ID' => $registration->ID(),
-                        ),
-                    ));
-                    $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
-                    $qst_name = $qstn_id = $qst->ID();
-                    $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
-                    $input_name = '';
-                    $input_id = sanitize_key($qst->display_text());
-                    $input_class = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
-                                                                                           . $input_name
-                                                                                           . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
-                    // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($classInstance instanceof EE_Event) {
-            // events have their timezone defined in the DB, so use it immediately
-            $this->set_timezone($classInstance->get_timezone());
-        }
-        return $classInstance;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string $timezone
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone = null)
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			array(
+				EEM_Event::cancelled => array(
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				),
+				EEM_Event::postponed => array(
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				),
+				EEM_Event::sold_out  => array(
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				),
+			)
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status) ? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables = array(
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		);
+		$this->_fields = array(
+			'Event_CPT'  => array(
+				'EVT_ID'         => new EE_Primary_Key_Int_Field(
+					'ID',
+					esc_html__('Post ID for Event', 'event_espresso')
+				),
+				'EVT_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__('Event Name', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_slug'       => new EE_Slug_Field(
+					'post_name',
+					esc_html__('Event Slug', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_short_desc' => new EE_Simple_HTML_Field(
+					'post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0
+				),
+				'EVT_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field(
+					'post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false,
+					'draft',
+					$this->_custom_stati
+				),
+			),
+			'Event_Meta' => array(
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field(
+					'EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'),
+					false
+				),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
+					'EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
+					false
+				),
+				'EVT_display_desc'                => new EE_Boolean_Field(
+					'EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'),
+					false,
+					1
+				),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field(
+					'EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'),
+					false,
+					1
+				),
+				'EVT_visible_on'                  => new EE_Datetime_Field(
+					'EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					true,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'),
+					false,
+					EEM_Event::$_default_reg_status,
+					EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field(
+					'EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_phone'                       => new EE_Plain_Text_Field(
+					'EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_allow_overflow'              => new EE_Boolean_Field(
+					'EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field(
+					'EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_external_URL'                => new EE_Plain_Text_Field(
+					'EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
+					true
+				),
+				'EVT_donations'                   => new EE_Boolean_Field(
+					'EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Venue'                  => new EE_HABTM_Relation('Event_Venue'),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * @param string $default_reg_status
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				true,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				array('QSG_deleted' => false),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_all_event_question_groups($EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array('EVT_ID' => $EVT_ID),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			array(
+				array(
+					'EVT_ID'      => $EVT_ID,
+					'EQG_primary' => $for_primary_attendee,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int             $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$where_params = array(
+			'Event_Question_Group.EVT_ID'      => $EVT_ID,
+			'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+			'QSG_deleted'                      => false,
+		);
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			array(
+				$where_params,
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			array(
+				array(
+					'Question_Group.QSG_ID' => array('IN', $QSG_IDs),
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				),
+				'order_by' => 'QST_order',
+			)
+		);
+	}
+
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	public function get_options_for_question($QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			array(
+				array(
+					'Question.QST_ID' => array('IN', $QST_IDs),
+					'QSO_deleted'     => false,
+				),
+				'order_by' => 'QSO_ID',
+			)
+		);
+	}
+
+
+
+
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = array();
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		$where_params['status'] = array('IN', array('publish', EEM_Event::sold_out));
+		// add where params for DTT_EVT_end
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['Datetime.DTT_EVT_end*****'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		} else {
+			$where_params['Datetime.DTT_EVT_end'] = array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param  array $query_params An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool   $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		$exclude_query = $query_params;
+		if (isset($exclude_query[0])) {
+			unset($exclude_query[0]);
+		}
+		$exclude_query[0] = array(
+			'Datetime.DTT_EVT_end' => array(
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			),
+		);
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->_get_all_wpdb_results($exclude_query, OBJECT_K, 'Event_CPT.ID');
+		$event_ids = array_keys($event_ids);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = array(
+			'Datetime.DTT_EVT_end' => array('<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')),
+			'EVT_ID'               => array('NOT IN', $event_ids),
+		);
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param  array   $query_params An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param  boolean $count        whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws \EE_Error
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0]) ? $query_params[0] : array();
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = array('!=', 'publish');
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count(array($where_params), 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = array())
+	{
+		if ($relationName === 'Price') {
+			// let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			// if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				// let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			// run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		// otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
+	 *             EE_Registration_Custom_Questions_Form located in
+	 *             admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 * @param    EE_Registration $registration (so existing answers for registration are included)
+	 * @param    int             $EVT_ID       so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @throws EE_Error
+	 * @return    array
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(__(
+				'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+				'event_espresso'
+			));
+		}
+		$questions = array();
+		// get all question groups for event
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts = $qg->questions();
+				$questions[ $qg->ID() ] = $qg->model_field_array();
+				$questions[ $qg->ID() ]['QSG_questions'] = array();
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer = EEM_Answer::instance()->get_one(array(
+						array(
+							'QST_ID' => $qst->ID(),
+							'REG_ID' => $registration->ID(),
+						),
+					));
+					$answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
+					$qst_name = $qstn_id = $qst->ID();
+					$ans_id = $answer->ID();
+					$qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+					$input_name = '';
+					$input_id = sanitize_key($qst->display_text());
+					$input_class = '';
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
+																						   . $input_name
+																						   . $qst_name;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
+					// leave responses as-is, don't convert stuff into html entities please!
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($classInstance instanceof EE_Event) {
+			// events have their timezone defined in the DB, so use it immediately
+			$this->set_timezone($classInstance->get_timezone());
+		}
+		return $classInstance;
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -254,7 +254,7 @@ 
             'WP_User'                => new EE_Belongs_To_Relation(),
         );
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         parent::__construct($timezone);
     }
 
@@ -346,7 +346,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -377,7 +377,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -411,7 +411,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID = 0, EE_Registration $registration)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -823,11 +823,11 @@ 
         $questions = array();
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts = $qg->questions();
-                $questions[ $qg->ID() ] = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = array();
+                $questions[$qg->ID()] = $qg->model_field_array();
+                $questions[$qg->ID()]['QSG_questions'] = array();
                 foreach ($qsts as $qst) {
                     if ($qst->is_system_question()) {
                         continue;
@@ -841,26 +841,26 @@ 
                     $answer = $answer instanceof EE_Answer ? $answer : EEM_Answer::instance()->create_default_object();
                     $qst_name = $qstn_id = $qst->ID();
                     $ans_id = $answer->ID();
-                    $qst_name = ! empty($ans_id) ? '[' . $qst_name . '][' . $ans_id . ']' : '[' . $qst_name . ']';
+                    $qst_name = ! empty($ans_id) ? '['.$qst_name.']['.$ans_id.']' : '['.$qst_name.']';
                     $input_name = '';
                     $input_id = sanitize_key($qst->display_text());
                     $input_class = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ] = $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name'] = 'qstn'
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()] = $qst->model_field_array();
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name'] = 'qstn'
                                                                                            . $input_name
                                                                                            . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id'] = $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'] = array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj'] = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj'] = $answer;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id'] = $input_id.'-'.$qstn_id;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'] = array();
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj'] = $qst;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj'] = $answer;
                     // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
                     if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
                         $QSOs = $qst->options(true, $answer->value());
                         if (is_array($QSOs)) {
                             foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] = $QSO->model_field_array();
+                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] = $QSO->model_field_array();
                             }
                         }
                     }

admin_pages/events/help_tabs/events_default_settings_max_tickets.help_tab.php

Indentation +3 added lines, -3 removed lines

@@ -1,6 +1,6 @@
 <p>
     <?php esc_html_e(
-        'Use this to control what the default will be for maximum tickets on an order when creating a new event.',
-        'event_espresso'
-    ); ?>
+		'Use this to control what the default will be for maximum tickets on an order when creating a new event.',
+		'event_espresso'
+	); ?>
 </p>
\ No newline at end of file

core/services/notices/ConvertNoticesToEeErrors.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
             $error_string = esc_html__('The following errors occurred:', 'event_espresso');
             foreach ($notices->getError() as $notice) {
                 if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
+                    $error_string .= '<br />'.$notice->message();
                 } else {
                     EE_Error::add_error(
                         $notice->message(),

Indentation +50 added lines, -50 removed lines

@@ -19,56 +19,56 @@
 class ConvertNoticesToEeErrors extends NoticeConverter
 {
 
-    /**
-     * Converts Notice objects into EE_Error notifications
-     *
-     * @param NoticesContainerInterface $notices
-     * @throws EE_Error
-     */
-    public function process(NoticesContainerInterface $notices)
-    {
-        $this->setNotices($notices);
-        $notices = $this->getNotices();
-        if ($notices->hasAttention()) {
-            foreach ($notices->getAttention() as $notice) {
-                EE_Error::add_attention(
-                    $notice->message(),
-                    $notice->file(),
-                    $notice->func(),
-                    $notice->line()
-                );
-            }
-        }
-        if ($notices->hasError()) {
-            $error_string = esc_html__('The following errors occurred:', 'event_espresso');
-            foreach ($notices->getError() as $notice) {
-                if ($this->getThrowExceptions()) {
-                    $error_string .= '<br />' . $notice->message();
-                } else {
-                    EE_Error::add_error(
-                        $notice->message(),
-                        $notice->file(),
-                        $notice->func(),
-                        $notice->line()
-                    );
-                }
-            }
-            if ($this->getThrowExceptions()) {
-                throw new EE_Error($error_string);
-            }
-        }
-        if ($notices->hasSuccess()) {
-            foreach ($notices->getSuccess() as $notice) {
-                EE_Error::add_success(
-                    $notice->message(),
-                    $notice->file(),
-                    $notice->func(),
-                    $notice->line()
-                );
-            }
-        }
-        $this->clearNotices();
-    }
+	/**
+	 * Converts Notice objects into EE_Error notifications
+	 *
+	 * @param NoticesContainerInterface $notices
+	 * @throws EE_Error
+	 */
+	public function process(NoticesContainerInterface $notices)
+	{
+		$this->setNotices($notices);
+		$notices = $this->getNotices();
+		if ($notices->hasAttention()) {
+			foreach ($notices->getAttention() as $notice) {
+				EE_Error::add_attention(
+					$notice->message(),
+					$notice->file(),
+					$notice->func(),
+					$notice->line()
+				);
+			}
+		}
+		if ($notices->hasError()) {
+			$error_string = esc_html__('The following errors occurred:', 'event_espresso');
+			foreach ($notices->getError() as $notice) {
+				if ($this->getThrowExceptions()) {
+					$error_string .= '<br />' . $notice->message();
+				} else {
+					EE_Error::add_error(
+						$notice->message(),
+						$notice->file(),
+						$notice->func(),
+						$notice->line()
+					);
+				}
+			}
+			if ($this->getThrowExceptions()) {
+				throw new EE_Error($error_string);
+			}
+		}
+		if ($notices->hasSuccess()) {
+			foreach ($notices->getSuccess() as $notice) {
+				EE_Error::add_success(
+					$notice->message(),
+					$notice->file(),
+					$notice->func(),
+					$notice->line()
+				);
+			}
+		}
+		$this->clearNotices();
+	}
 
 
 }

public/Espresso_Arabica_2014/loop-espresso_events.php

Indentation +34 added lines, -34 removed lines

@@ -11,48 +11,48 @@
  * @version     4+
  */
 if (have_posts()) :
-    if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?>
+	if (apply_filters('FHEE__archive_espresso_events_template__show_header', true)) : ?>
         <header class="page-header">
             <h1 class="page-title">
                 <?php
-                if (is_day()) :
-                    printf(__('Today\'s Events: %s', 'event_espresso'), get_the_date());
-                elseif (is_month()) :
-                    printf(
-                        __('Events This Month: %s', 'event_espresso'),
-                        get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso'))
-                    );
-                elseif (is_year()) :
-                    printf(
-                        __('Events This Year: %s', 'event_espresso'),
-                        get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
-                    );
-                else :
-                    echo apply_filters(
-                        'FHEE__archive_espresso_events_template__upcoming_events_h1',
-                        __('Upcoming Events', 'event_espresso')
-                    );
-                endif;
-                ?>
+				if (is_day()) :
+					printf(__('Today\'s Events: %s', 'event_espresso'), get_the_date());
+				elseif (is_month()) :
+					printf(
+						__('Events This Month: %s', 'event_espresso'),
+						get_the_date(_x('F Y', 'monthly archives date format', 'event_espresso'))
+					);
+				elseif (is_year()) :
+					printf(
+						__('Events This Year: %s', 'event_espresso'),
+						get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
+					);
+				else :
+					echo apply_filters(
+						'FHEE__archive_espresso_events_template__upcoming_events_h1',
+						__('Upcoming Events', 'event_espresso')
+					);
+				endif;
+				?>
             </h1>
 
         </header><!-- .page-header -->
 
         <?php
-    endif;
-    // allow other stuff
-    do_action('AHEE__archive_espresso_events_template__before_loop');
-    // Start the Loop.
-    while (have_posts()) : the_post();
-        // Include the post TYPE-specific template for the content.
-        espresso_get_template_part('content', 'espresso_events-shortcode');
-    endwhile;
-    // Previous/next page navigation.
-    espresso_pagination();
-    // allow moar other stuff
-    do_action('AHEE__archive_espresso_events_template__after_loop');
+	endif;
+	// allow other stuff
+	do_action('AHEE__archive_espresso_events_template__before_loop');
+	// Start the Loop.
+	while (have_posts()) : the_post();
+		// Include the post TYPE-specific template for the content.
+		espresso_get_template_part('content', 'espresso_events-shortcode');
+	endwhile;
+	// Previous/next page navigation.
+	espresso_pagination();
+	// allow moar other stuff
+	do_action('AHEE__archive_espresso_events_template__after_loop');
 else :
-    // If no content, include the "No posts found" template.
-    espresso_get_template_part('content', 'none');
+	// If no content, include the "No posts found" template.
+	espresso_get_template_part('content', 'none');
 endif;
 

Braces +6 added lines, -2 removed lines

@@ -27,11 +27,13 @@ 
                         __('Events This Year: %s', 'event_espresso'),
                         get_the_date(_x('Y', 'yearly archives date format', 'event_espresso'))
                     );
-                else :
+                else {
+                	:
                     echo apply_filters(
                         'FHEE__archive_espresso_events_template__upcoming_events_h1',
                         __('Upcoming Events', 'event_espresso')
                     );
+                }
                 endif;
                 ?>
             </h1>
@@ -51,8 +53,10 @@ 
     espresso_pagination();
     // allow moar other stuff
     do_action('AHEE__archive_espresso_events_template__after_loop');
-else :
+else {
+	:
     // If no content, include the "No posts found" template.
     espresso_get_template_part('content', 'none');
+}
 endif;
 

caffeinated/payment_methods/Paypal_Pro/EEG_Paypal_Pro.gateway.php

Doc Comments +1 added lines, -1 removed lines

@@ -450,7 +450,7 @@
 
 
     /**
-     * @param $Request
+     * @param string $Request
      * @return mixed
      */
     private function _CURLRequest($Request)

Indentation +587 added lines, -587 removed lines

@@ -11,591 +11,591 @@
 class EEG_Paypal_Pro extends EE_Onsite_Gateway
 {
 
-    /**
-     * @var $_paypal_api_username string
-     */
-    protected $_username = null;
-
-    /**
-     * @var $_password string
-     */
-    protected $_password = null;
-
-    /**
-     * @var $_signature string
-     */
-    protected $_signature = null;
-
-    /**
-     * @var $_credit_card_types array with the keys for credit card types accepted on this account
-     */
-    protected $_credit_card_types    = null;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB',
-    );
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info {
-     * @type string $credit_card
-     * @type string $credit_card_type
-     * @type string $exp_month always 2 characters
-     * @type string $exp_year always 4 characters
-     * @type string $cvv
-     * }
-     * @see      parent::do_direct_payment for more info
-     * @return EE_Payment|EEI_Payment
-     * @throws EE_Error
-     */
-    public function do_direct_payment($payment, $billing_info = null)
-    {
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            throw new EE_Error(
-                esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
-            );
-        }
-        $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
-            throw new EE_Error(
-                esc_html__(
-                    'No primary registration on transaction while paying with PayPal Pro.',
-                    'event_espresso'
-                )
-            );
-        }
-        $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
-            throw new EE_Error(
-                esc_html__(
-                    'No attendee on primary registration while paying with PayPal Pro.',
-                    'event_espresso'
-                )
-            );
-        }
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127);
-        // charge for the full amount. Show itemized list
-        if ($this->_can_easily_itemize_transaction_for($payment)) {
-            $item_num = 1;
-            $total_line_item = $transaction->total_line_item();
-            $order_items = array();
-            foreach ($total_line_item->get_items() as $line_item) {
-                // ignore line items with a quantity of 0
-                if ($line_item->quantity() == 0) {
-                    continue;
-                }
-                $item = array(
-                    // Item Name.  127 char max.
-                    'l_name'                 => substr(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    ),
-                    // Item description.  127 char max.
-                    'l_desc'                 => substr(
-                        $gateway_formatter->formatLineItemDesc($line_item, $payment),
-                        0,
-                        127
-                    ),
-                    // Cost of individual item.
-                    'l_amt'                  => $line_item->unit_price(),
-                    // Item Number.  127 char max.
-                    'l_number'               => $item_num++,
-                    // Item quantity.  Must be any positive integer.
-                    'l_qty'                  => $line_item->quantity(),
-                    // Item's sales tax amount.
-                    'l_taxamt'               => '',
-                    // eBay auction number of item.
-                    'l_ebayitemnumber'       => '',
-                    // eBay transaction ID of purchased item.
-                    'l_ebayitemauctiontxnid' => '',
-                    // eBay order ID for the item.
-                    'l_ebayitemorderid'      => '',
-                );
-                // add to array of all items
-                array_push($order_items, $item);
-            }
-            $item_amount = $total_line_item->get_items_total();
-            $tax_amount = $total_line_item->get_total_tax();
-        } else {
-            $order_items = array();
-            $item_amount = $payment->amount();
-            $tax_amount = 0;
-            array_push($order_items, array(
-                // Item Name.  127 char max.
-                'l_name'   => substr(
-                    $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                    0,
-                    127
-                ),
-                // Item description.  127 char max.
-                'l_desc'   => substr(
-                    $gateway_formatter->formatPartialPaymentLineItemDesc($payment),
-                    0,
-                    127
-                ),
-                // Cost of individual item.
-                'l_amt'    => $payment->amount(),
-                // Item Number.  127 char max.
-                'l_number' => 1,
-                // Item quantity.  Must be any positive integer.
-                'l_qty'    => 1,
-            ));
-        }
-        // Populate data arrays with order data.
-        $DPFields = array(
-            // How you want to obtain payment ?
-            // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture.
-            // Sale indicates that this is a final sale for which you are requesting payment.  Default is Sale.
-            'paymentaction'    => 'Sale',
-            // Required.  IP address of the payer's browser.
-            'ipaddress'        => $_SERVER['REMOTE_ADDR'],
-            // Flag to determine whether you want the results returned by FMF.  1 or 0.  Default is 0.
-            'returnfmfdetails' => '1',
-        );
-        $CCDetails = array(
-            // Required. Type of credit card.  Visa, MasterCard, Discover, Amex, Maestro, Solo.
-            // If Maestro or Solo, the currency code must be GBP.
-            //  In addition, either start date or issue number must be specified.
-            'creditcardtype' => $billing_info['credit_card_type'],
-            // Required.  Credit card number.  No spaces or punctuation.
-            'acct'           => $billing_info['credit_card'],
-            // Required.  Credit card expiration date.  Format is MMYYYY
-            'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
-            // Requirements determined by your PayPal account settings.  Security digits for credit card.
-            'cvv2'           => $billing_info['cvv'],
-        );
-        $PayerInfo = array(
-            // Email address of payer.
-            'email'       => $billing_info['email'],
-            // Unique PayPal customer ID for payer.
-            'payerid'     => '',
-            // Status of payer.  Values are verified or unverified
-            'payerstatus' => '',
-            // Payer's business name.
-            'business'    => '',
-        );
-        $PayerName = array(
-            // Payer's salutation.  20 char max.
-            'salutation' => '',
-            // Payer's first name.  25 char max.
-            'firstname'  => substr($billing_info['first_name'], 0, 25),
-            // Payer's middle name.  25 char max.
-            'middlename' => '',
-            // Payer's last name.  25 char max.
-            'lastname'   => substr($billing_info['last_name'], 0, 25),
-            // Payer's suffix.  12 char max.
-            'suffix'     => '',
-        );
-        $BillingAddress = array(
-            // Required.  First street address.
-            'street'      => $billing_info['address'],
-            // Second street address.
-            'street2'     => $billing_info['address2'],
-            // Required.  Name of City.
-            'city'        => $billing_info['city'],
-            // Required. Name of State or Province.
-            'state'       => substr($billing_info['state'], 0, 40),
-            // Required.  Country code.
-            'countrycode' => $billing_info['country'],
-            // Required.  Postal code of payer.
-            'zip'         => $billing_info['zip'],
-        );
-        // check if the registration info contains the needed fields for paypal pro
-        // (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
-        if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
-            $use_registration_address_info = true;
-        } else {
-            $use_registration_address_info = false;
-        }
-        // so if the attendee has enough data to fill out PayPal Pro's shipping info, use it.
-        // If not, use the billing info again
-        $ShippingAddress = array(
-            'shiptoname'     => substr($use_registration_address_info
-                ? $attendee->full_name()
-                : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
-            'shiptostreet'   => substr($use_registration_address_info
-                ? $attendee->address()
-                : $billing_info['address'], 0, 100),
-            'shiptostreet2'  => substr($use_registration_address_info
-                ? $attendee->address2() : $billing_info['address2'], 0, 100),
-            'shiptocity'     => substr($use_registration_address_info
-                ? $attendee->city()
-                : $billing_info['city'], 0, 40),
-            'state'          => substr($use_registration_address_info
-                ? $attendee->state_name()
-                : $billing_info['state'], 0, 40),
-            'shiptocountry'  => $use_registration_address_info
-                ? $attendee->country_ID()
-                : $billing_info['country'],
-            'shiptozip'      => substr($use_registration_address_info
-                ? $attendee->zip()
-                : $billing_info['zip'], 0, 20),
-            'shiptophonenum' => substr($use_registration_address_info
-                ? $attendee->phone()
-                : $billing_info['phone'], 0, 20),
-        );
-        $PaymentDetails = array(
-            // Required.  Total amount of order, including shipping, handling, and tax.
-            'amt'          => $gateway_formatter->formatCurrency($payment->amount()),
-            // Required.  Three-letter currency code.  Default is USD.
-            'currencycode' => $payment->currency_code(),
-            // Required if you include itemized cart details. (L_AMTn, etc.)
-            // Subtotal of items not including S&H, or tax.
-            'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
-            // Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
-            'shippingamt'  => '',
-            // Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
-            'handlingamt'  => '',
-            // Required if you specify itemized cart tax details.
-            // Sum of tax for all items on the order.  Total sales tax.
-            'taxamt'       => $gateway_formatter->formatCurrency($tax_amount),
-            // Description of the order the customer is purchasing.  127 char max.
-            'desc'         => $order_description,
-            // Free-form field for your own use.  256 char max.
-            'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
-            // Your own invoice or tracking number
-            'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
-            // URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
-            'notifyurl'    => '',
-            'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
-        );
-        // Wrap all data arrays into a single, "master" array which will be passed into the class function.
-        $PayPalRequestData = array(
-            'DPFields'        => $DPFields,
-            'CCDetails'       => $CCDetails,
-            'PayerInfo'       => $PayerInfo,
-            'PayerName'       => $PayerName,
-            'BillingAddress'  => $BillingAddress,
-            'ShippingAddress' => $ShippingAddress,
-            'PaymentDetails'  => $PaymentDetails,
-            'OrderItems'      => $order_items,
-        );
-        $this->_log_clean_request($PayPalRequestData, $payment);
-        try {
-            $PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
-            // remove PCI-sensitive data so it doesn't get stored
-            $PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
-            $message = isset($PayPalResult['L_LONGMESSAGE0']) ? $PayPalResult['L_LONGMESSAGE0'] : $PayPalResult['ACK'];
-            if (empty($PayPalResult['RAWRESPONSE'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                $payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
-                $payment->set_details($PayPalResult);
-            } else {
-                if ($this->_APICallSuccessful($PayPalResult)) {
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-                // make sure we interpret the AMT as a float, not an international string
-                // (where periods are thousand separators)
-                $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
-                $payment->set_gateway_response($message);
-                $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID'])
-                    ? $PayPalResult['TRANSACTIONID']
-                    : null);
-                $primary_registration_code = $primary_registrant instanceof EE_Registration
-                    ? $primary_registrant->reg_code()
-                    : '';
-                $payment->set_extra_accntng($primary_registration_code);
-                $payment->set_details($PayPalResult);
-            }
-        } catch (Exception $e) {
-            $payment->set_status($this->_pay_model->failed_status());
-            $payment->set_gateway_response($e->getMessage());
-        }
-        // $payment->set_status( $this->_pay_model->declined_status() );
-        // $payment->set_gateway_response( '' );
-        return $payment;
-    }
-
-
-
-    /**
-     * CLeans out sensitive CC data and then logs it, and returns the cleaned request
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @return void
-     */
-    private function _log_clean_request($request, $payment)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['CCDetails']['acct']);
-        unset($cleaned_request_data['CCDetails']['cvv2']);
-        unset($cleaned_request_data['CCDetails']['expdate']);
-        $this->log(array('Paypal Request' => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     * Cleans the response, logs it, and returns it
-     *
-     * @param array       $response
-     * @param EEI_Payment $payment
-     * @return array cleaned
-     */
-    private function _log_clean_response($response, $payment)
-    {
-        unset($response['REQUESTDATA']['CREDITCARDTYPE']);
-        unset($response['REQUESTDATA']['ACCT']);
-        unset($response['REQUESTDATA']['EXPDATE']);
-        unset($response['REQUESTDATA']['CVV2']);
-        unset($response['RAWREQUEST']);
-        $this->log(array('Paypal Response' => $response), $payment);
-        return $response;
-    }
-
-
-
-    /**
-     * @param $DataArray
-     * @return array
-     */
-    private function prep_and_curl_request($DataArray)
-    {
-        // Create empty holders for each portion of the NVP string
-        $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP';
-        $CCDetailsNVP = '';
-        $PayerInfoNVP = '';
-        $PayerNameNVP = '';
-        $BillingAddressNVP = '';
-        $ShippingAddressNVP = '';
-        $PaymentDetailsNVP = '';
-        $OrderItemsNVP = '';
-        $Secure3DNVP = '';
-        // DP Fields
-        $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
-        foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
-            $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
-        }
-        // CC Details Fields
-        $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
-        foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
-            $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
-        }
-        // PayerInfo Type Fields
-        $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
-        foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
-            $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
-        }
-        // Payer Name Fields
-        $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
-        foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
-            $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
-        }
-        // Address Fields (Billing)
-        $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
-        foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
-            $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
-        }
-        // Payment Details Type Fields
-        $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
-        foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
-            $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
-        }
-        // Payment Details Item Type Fields
-        $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
-        $n = 0;
-        foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
-            $CurrentItem = $OrderItems[ $OrderItemsVar ];
-            foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
-                $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
-            }
-            $n++;
-        }
-        // Ship To Address Fields
-        $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
-        foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
-            $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
-        }
-        // 3D Secure Fields
-        $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
-        foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
-            $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
-        }
-        // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
-        $NVPRequest = 'USER='
-                      . $this->_username
-                      . '&PWD='
-                      . $this->_password
-                      . '&VERSION=64.0'
-                      . '&SIGNATURE='
-                      . $this->_signature
-                      . $DPFieldsNVP
-                      . $CCDetailsNVP
-                      . $PayerInfoNVP
-                      . $PayerNameNVP
-                      . $BillingAddressNVP
-                      . $PaymentDetailsNVP
-                      . $OrderItemsNVP
-                      . $ShippingAddressNVP
-                      . $Secure3DNVP;
-        $NVPResponse = $this->_CURLRequest($NVPRequest);
-        $NVPRequestArray = $this->_NVPToArray($NVPRequest);
-        $NVPResponseArray = $this->_NVPToArray($NVPResponse);
-        $Errors = $this->_GetErrors($NVPResponseArray);
-        $NVPResponseArray['ERRORS'] = $Errors;
-        $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray;
-        $NVPResponseArray['RAWREQUEST'] = $NVPRequest;
-        $NVPResponseArray['RAWRESPONSE'] = $NVPResponse;
-        return $NVPResponseArray;
-    }
-
-
-
-    /**
-     * @param $Request
-     * @return mixed
-     */
-    private function _CURLRequest($Request)
-    {
-        $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
-        $curl = curl_init();
-        curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true));
-        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
-        curl_setopt($curl, CURLOPT_TIMEOUT, 60);
-        curl_setopt($curl, CURLOPT_URL, $EndPointURL);
-        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);
-        curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
-        // execute the curl POST
-        $Response = curl_exec($curl);
-        curl_close($curl);
-        return $Response;
-    }
-
-
-
-    /**
-     * @param $NVPString
-     * @return array
-     */
-    private function _NVPToArray($NVPString)
-    {
-        // prepare responses into array
-        $proArray = array();
-        while (strlen($NVPString)) {
-            // name
-            $keypos = strpos($NVPString, '=');
-            $keyval = substr($NVPString, 0, $keypos);
-            // value
-            $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
-            $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
-            // decoding the response
-            $proArray[ $keyval ] = urldecode($valval);
-            $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
-        }
-        return $proArray;
-    }
-
-
-
-    /**
-     * @param array $PayPalResult
-     * @return bool
-     */
-    private function _APICallSuccessful($PayPalResult)
-    {
-        $approved = false;
-        // check main response message from PayPal
-        if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
-            $ack = strtoupper($PayPalResult['ACK']);
-            $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
-        }
-        return $approved;
-    }
-
-
-
-    /**
-     * @param $DataArray
-     * @return array
-     */
-    private function _GetErrors($DataArray)
-    {
-        $Errors = array();
-        $n = 0;
-        while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
-            $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
-            $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
-                : '';
-            $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
-                : '';
-            $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
-                ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
-                : '';
-            $CurrentItem = array(
-                'L_ERRORCODE'    => $LErrorCode,
-                'L_SHORTMESSAGE' => $LShortMessage,
-                'L_LONGMESSAGE'  => $LLongMessage,
-                'L_SEVERITYCODE' => $LSeverityCode,
-            );
-            array_push($Errors, $CurrentItem);
-            $n++;
-        }
-        return $Errors;
-    }
-
-
-
-    /**
-     *        nothing to see here...  move along....
-     *
-     * @access protected
-     * @param $Errors
-     * @return string
-     */
-    private function _DisplayErrors($Errors)
-    {
-        $error = '';
-        foreach ($Errors as $ErrorVar => $ErrorVal) {
-            $CurrentError = $Errors[ $ErrorVar ];
-            foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
-                $CurrentVarName = '';
-                if ($CurrentErrorVar == 'L_ERRORCODE') {
-                    $CurrentVarName = 'Error Code';
-                } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
-                    $CurrentVarName = 'Short Message';
-                } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
-                    $CurrentVarName = 'Long Message';
-                } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
-                    $CurrentVarName = 'Severity Code';
-                }
-                $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
-            }
-        }
-        return $error;
-    }
+	/**
+	 * @var $_paypal_api_username string
+	 */
+	protected $_username = null;
+
+	/**
+	 * @var $_password string
+	 */
+	protected $_password = null;
+
+	/**
+	 * @var $_signature string
+	 */
+	protected $_signature = null;
+
+	/**
+	 * @var $_credit_card_types array with the keys for credit card types accepted on this account
+	 */
+	protected $_credit_card_types    = null;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB',
+	);
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info {
+	 * @type string $credit_card
+	 * @type string $credit_card_type
+	 * @type string $exp_month always 2 characters
+	 * @type string $exp_year always 4 characters
+	 * @type string $cvv
+	 * }
+	 * @see      parent::do_direct_payment for more info
+	 * @return EE_Payment|EEI_Payment
+	 * @throws EE_Error
+	 */
+	public function do_direct_payment($payment, $billing_info = null)
+	{
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			throw new EE_Error(
+				esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
+			);
+		}
+		$primary_registrant = $transaction->primary_registration();
+		if (! $primary_registrant instanceof EEI_Registration) {
+			throw new EE_Error(
+				esc_html__(
+					'No primary registration on transaction while paying with PayPal Pro.',
+					'event_espresso'
+				)
+			);
+		}
+		$attendee = $primary_registrant->attendee();
+		if (! $attendee instanceof EEI_Attendee) {
+			throw new EE_Error(
+				esc_html__(
+					'No attendee on primary registration while paying with PayPal Pro.',
+					'event_espresso'
+				)
+			);
+		}
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127);
+		// charge for the full amount. Show itemized list
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
+			$item_num = 1;
+			$total_line_item = $transaction->total_line_item();
+			$order_items = array();
+			foreach ($total_line_item->get_items() as $line_item) {
+				// ignore line items with a quantity of 0
+				if ($line_item->quantity() == 0) {
+					continue;
+				}
+				$item = array(
+					// Item Name.  127 char max.
+					'l_name'                 => substr(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					),
+					// Item description.  127 char max.
+					'l_desc'                 => substr(
+						$gateway_formatter->formatLineItemDesc($line_item, $payment),
+						0,
+						127
+					),
+					// Cost of individual item.
+					'l_amt'                  => $line_item->unit_price(),
+					// Item Number.  127 char max.
+					'l_number'               => $item_num++,
+					// Item quantity.  Must be any positive integer.
+					'l_qty'                  => $line_item->quantity(),
+					// Item's sales tax amount.
+					'l_taxamt'               => '',
+					// eBay auction number of item.
+					'l_ebayitemnumber'       => '',
+					// eBay transaction ID of purchased item.
+					'l_ebayitemauctiontxnid' => '',
+					// eBay order ID for the item.
+					'l_ebayitemorderid'      => '',
+				);
+				// add to array of all items
+				array_push($order_items, $item);
+			}
+			$item_amount = $total_line_item->get_items_total();
+			$tax_amount = $total_line_item->get_total_tax();
+		} else {
+			$order_items = array();
+			$item_amount = $payment->amount();
+			$tax_amount = 0;
+			array_push($order_items, array(
+				// Item Name.  127 char max.
+				'l_name'   => substr(
+					$gateway_formatter->formatPartialPaymentLineItemName($payment),
+					0,
+					127
+				),
+				// Item description.  127 char max.
+				'l_desc'   => substr(
+					$gateway_formatter->formatPartialPaymentLineItemDesc($payment),
+					0,
+					127
+				),
+				// Cost of individual item.
+				'l_amt'    => $payment->amount(),
+				// Item Number.  127 char max.
+				'l_number' => 1,
+				// Item quantity.  Must be any positive integer.
+				'l_qty'    => 1,
+			));
+		}
+		// Populate data arrays with order data.
+		$DPFields = array(
+			// How you want to obtain payment ?
+			// Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture.
+			// Sale indicates that this is a final sale for which you are requesting payment.  Default is Sale.
+			'paymentaction'    => 'Sale',
+			// Required.  IP address of the payer's browser.
+			'ipaddress'        => $_SERVER['REMOTE_ADDR'],
+			// Flag to determine whether you want the results returned by FMF.  1 or 0.  Default is 0.
+			'returnfmfdetails' => '1',
+		);
+		$CCDetails = array(
+			// Required. Type of credit card.  Visa, MasterCard, Discover, Amex, Maestro, Solo.
+			// If Maestro or Solo, the currency code must be GBP.
+			//  In addition, either start date or issue number must be specified.
+			'creditcardtype' => $billing_info['credit_card_type'],
+			// Required.  Credit card number.  No spaces or punctuation.
+			'acct'           => $billing_info['credit_card'],
+			// Required.  Credit card expiration date.  Format is MMYYYY
+			'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
+			// Requirements determined by your PayPal account settings.  Security digits for credit card.
+			'cvv2'           => $billing_info['cvv'],
+		);
+		$PayerInfo = array(
+			// Email address of payer.
+			'email'       => $billing_info['email'],
+			// Unique PayPal customer ID for payer.
+			'payerid'     => '',
+			// Status of payer.  Values are verified or unverified
+			'payerstatus' => '',
+			// Payer's business name.
+			'business'    => '',
+		);
+		$PayerName = array(
+			// Payer's salutation.  20 char max.
+			'salutation' => '',
+			// Payer's first name.  25 char max.
+			'firstname'  => substr($billing_info['first_name'], 0, 25),
+			// Payer's middle name.  25 char max.
+			'middlename' => '',
+			// Payer's last name.  25 char max.
+			'lastname'   => substr($billing_info['last_name'], 0, 25),
+			// Payer's suffix.  12 char max.
+			'suffix'     => '',
+		);
+		$BillingAddress = array(
+			// Required.  First street address.
+			'street'      => $billing_info['address'],
+			// Second street address.
+			'street2'     => $billing_info['address2'],
+			// Required.  Name of City.
+			'city'        => $billing_info['city'],
+			// Required. Name of State or Province.
+			'state'       => substr($billing_info['state'], 0, 40),
+			// Required.  Country code.
+			'countrycode' => $billing_info['country'],
+			// Required.  Postal code of payer.
+			'zip'         => $billing_info['zip'],
+		);
+		// check if the registration info contains the needed fields for paypal pro
+		// (see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/)
+		if ($attendee->address() && $attendee->city() && $attendee->country_ID()) {
+			$use_registration_address_info = true;
+		} else {
+			$use_registration_address_info = false;
+		}
+		// so if the attendee has enough data to fill out PayPal Pro's shipping info, use it.
+		// If not, use the billing info again
+		$ShippingAddress = array(
+			'shiptoname'     => substr($use_registration_address_info
+				? $attendee->full_name()
+				: $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+			'shiptostreet'   => substr($use_registration_address_info
+				? $attendee->address()
+				: $billing_info['address'], 0, 100),
+			'shiptostreet2'  => substr($use_registration_address_info
+				? $attendee->address2() : $billing_info['address2'], 0, 100),
+			'shiptocity'     => substr($use_registration_address_info
+				? $attendee->city()
+				: $billing_info['city'], 0, 40),
+			'state'          => substr($use_registration_address_info
+				? $attendee->state_name()
+				: $billing_info['state'], 0, 40),
+			'shiptocountry'  => $use_registration_address_info
+				? $attendee->country_ID()
+				: $billing_info['country'],
+			'shiptozip'      => substr($use_registration_address_info
+				? $attendee->zip()
+				: $billing_info['zip'], 0, 20),
+			'shiptophonenum' => substr($use_registration_address_info
+				? $attendee->phone()
+				: $billing_info['phone'], 0, 20),
+		);
+		$PaymentDetails = array(
+			// Required.  Total amount of order, including shipping, handling, and tax.
+			'amt'          => $gateway_formatter->formatCurrency($payment->amount()),
+			// Required.  Three-letter currency code.  Default is USD.
+			'currencycode' => $payment->currency_code(),
+			// Required if you include itemized cart details. (L_AMTn, etc.)
+			// Subtotal of items not including S&H, or tax.
+			'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
+			// Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
+			'shippingamt'  => '',
+			// Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
+			'handlingamt'  => '',
+			// Required if you specify itemized cart tax details.
+			// Sum of tax for all items on the order.  Total sales tax.
+			'taxamt'       => $gateway_formatter->formatCurrency($tax_amount),
+			// Description of the order the customer is purchasing.  127 char max.
+			'desc'         => $order_description,
+			// Free-form field for your own use.  256 char max.
+			'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
+			// Your own invoice or tracking number
+			'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
+			// URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
+			'notifyurl'    => '',
+			'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
+		);
+		// Wrap all data arrays into a single, "master" array which will be passed into the class function.
+		$PayPalRequestData = array(
+			'DPFields'        => $DPFields,
+			'CCDetails'       => $CCDetails,
+			'PayerInfo'       => $PayerInfo,
+			'PayerName'       => $PayerName,
+			'BillingAddress'  => $BillingAddress,
+			'ShippingAddress' => $ShippingAddress,
+			'PaymentDetails'  => $PaymentDetails,
+			'OrderItems'      => $order_items,
+		);
+		$this->_log_clean_request($PayPalRequestData, $payment);
+		try {
+			$PayPalResult = $this->prep_and_curl_request($PayPalRequestData);
+			// remove PCI-sensitive data so it doesn't get stored
+			$PayPalResult = $this->_log_clean_response($PayPalResult, $payment);
+			$message = isset($PayPalResult['L_LONGMESSAGE0']) ? $PayPalResult['L_LONGMESSAGE0'] : $PayPalResult['ACK'];
+			if (empty($PayPalResult['RAWRESPONSE'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				$payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso'));
+				$payment->set_details($PayPalResult);
+			} else {
+				if ($this->_APICallSuccessful($PayPalResult)) {
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+				// make sure we interpret the AMT as a float, not an international string
+				// (where periods are thousand separators)
+				$payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0);
+				$payment->set_gateway_response($message);
+				$payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID'])
+					? $PayPalResult['TRANSACTIONID']
+					: null);
+				$primary_registration_code = $primary_registrant instanceof EE_Registration
+					? $primary_registrant->reg_code()
+					: '';
+				$payment->set_extra_accntng($primary_registration_code);
+				$payment->set_details($PayPalResult);
+			}
+		} catch (Exception $e) {
+			$payment->set_status($this->_pay_model->failed_status());
+			$payment->set_gateway_response($e->getMessage());
+		}
+		// $payment->set_status( $this->_pay_model->declined_status() );
+		// $payment->set_gateway_response( '' );
+		return $payment;
+	}
+
+
+
+	/**
+	 * CLeans out sensitive CC data and then logs it, and returns the cleaned request
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['CCDetails']['acct']);
+		unset($cleaned_request_data['CCDetails']['cvv2']);
+		unset($cleaned_request_data['CCDetails']['expdate']);
+		$this->log(array('Paypal Request' => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 * Cleans the response, logs it, and returns it
+	 *
+	 * @param array       $response
+	 * @param EEI_Payment $payment
+	 * @return array cleaned
+	 */
+	private function _log_clean_response($response, $payment)
+	{
+		unset($response['REQUESTDATA']['CREDITCARDTYPE']);
+		unset($response['REQUESTDATA']['ACCT']);
+		unset($response['REQUESTDATA']['EXPDATE']);
+		unset($response['REQUESTDATA']['CVV2']);
+		unset($response['RAWREQUEST']);
+		$this->log(array('Paypal Response' => $response), $payment);
+		return $response;
+	}
+
+
+
+	/**
+	 * @param $DataArray
+	 * @return array
+	 */
+	private function prep_and_curl_request($DataArray)
+	{
+		// Create empty holders for each portion of the NVP string
+		$DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP';
+		$CCDetailsNVP = '';
+		$PayerInfoNVP = '';
+		$PayerNameNVP = '';
+		$BillingAddressNVP = '';
+		$ShippingAddressNVP = '';
+		$PaymentDetailsNVP = '';
+		$OrderItemsNVP = '';
+		$Secure3DNVP = '';
+		// DP Fields
+		$DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
+		foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
+			$DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+		}
+		// CC Details Fields
+		$CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
+		foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
+			$CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+		}
+		// PayerInfo Type Fields
+		$PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
+		foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
+			$PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+		}
+		// Payer Name Fields
+		$PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
+		foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
+			$PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+		}
+		// Address Fields (Billing)
+		$BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
+		foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
+			$BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+		}
+		// Payment Details Type Fields
+		$PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
+		foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
+			$PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+		}
+		// Payment Details Item Type Fields
+		$OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
+		$n = 0;
+		foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
+			$CurrentItem = $OrderItems[ $OrderItemsVar ];
+			foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
+				$OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+			}
+			$n++;
+		}
+		// Ship To Address Fields
+		$ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
+		foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
+			$ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+		}
+		// 3D Secure Fields
+		$Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
+		foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
+			$Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+		}
+		// Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
+		$NVPRequest = 'USER='
+					  . $this->_username
+					  . '&PWD='
+					  . $this->_password
+					  . '&VERSION=64.0'
+					  . '&SIGNATURE='
+					  . $this->_signature
+					  . $DPFieldsNVP
+					  . $CCDetailsNVP
+					  . $PayerInfoNVP
+					  . $PayerNameNVP
+					  . $BillingAddressNVP
+					  . $PaymentDetailsNVP
+					  . $OrderItemsNVP
+					  . $ShippingAddressNVP
+					  . $Secure3DNVP;
+		$NVPResponse = $this->_CURLRequest($NVPRequest);
+		$NVPRequestArray = $this->_NVPToArray($NVPRequest);
+		$NVPResponseArray = $this->_NVPToArray($NVPResponse);
+		$Errors = $this->_GetErrors($NVPResponseArray);
+		$NVPResponseArray['ERRORS'] = $Errors;
+		$NVPResponseArray['REQUESTDATA'] = $NVPRequestArray;
+		$NVPResponseArray['RAWREQUEST'] = $NVPRequest;
+		$NVPResponseArray['RAWRESPONSE'] = $NVPResponse;
+		return $NVPResponseArray;
+	}
+
+
+
+	/**
+	 * @param $Request
+	 * @return mixed
+	 */
+	private function _CURLRequest($Request)
+	{
+		$EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp';
+		$curl = curl_init();
+		curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true));
+		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
+		curl_setopt($curl, CURLOPT_TIMEOUT, 60);
+		curl_setopt($curl, CURLOPT_URL, $EndPointURL);
+		curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+		curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);
+		curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
+		// execute the curl POST
+		$Response = curl_exec($curl);
+		curl_close($curl);
+		return $Response;
+	}
+
+
+
+	/**
+	 * @param $NVPString
+	 * @return array
+	 */
+	private function _NVPToArray($NVPString)
+	{
+		// prepare responses into array
+		$proArray = array();
+		while (strlen($NVPString)) {
+			// name
+			$keypos = strpos($NVPString, '=');
+			$keyval = substr($NVPString, 0, $keypos);
+			// value
+			$valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
+			$valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
+			// decoding the response
+			$proArray[ $keyval ] = urldecode($valval);
+			$NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
+		}
+		return $proArray;
+	}
+
+
+
+	/**
+	 * @param array $PayPalResult
+	 * @return bool
+	 */
+	private function _APICallSuccessful($PayPalResult)
+	{
+		$approved = false;
+		// check main response message from PayPal
+		if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) {
+			$ack = strtoupper($PayPalResult['ACK']);
+			$approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false;
+		}
+		return $approved;
+	}
+
+
+
+	/**
+	 * @param $DataArray
+	 * @return array
+	 */
+	private function _GetErrors($DataArray)
+	{
+		$Errors = array();
+		$n = 0;
+		while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
+			$LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
+			$LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
+				? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
+				: '';
+			$LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
+				? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
+				: '';
+			$LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
+				? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
+				: '';
+			$CurrentItem = array(
+				'L_ERRORCODE'    => $LErrorCode,
+				'L_SHORTMESSAGE' => $LShortMessage,
+				'L_LONGMESSAGE'  => $LLongMessage,
+				'L_SEVERITYCODE' => $LSeverityCode,
+			);
+			array_push($Errors, $CurrentItem);
+			$n++;
+		}
+		return $Errors;
+	}
+
+
+
+	/**
+	 *        nothing to see here...  move along....
+	 *
+	 * @access protected
+	 * @param $Errors
+	 * @return string
+	 */
+	private function _DisplayErrors($Errors)
+	{
+		$error = '';
+		foreach ($Errors as $ErrorVar => $ErrorVal) {
+			$CurrentError = $Errors[ $ErrorVar ];
+			foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
+				$CurrentVarName = '';
+				if ($CurrentErrorVar == 'L_ERRORCODE') {
+					$CurrentVarName = 'Error Code';
+				} elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') {
+					$CurrentVarName = 'Short Message';
+				} elseif ($CurrentErrorVar == 'L_LONGMESSAGE') {
+					$CurrentVarName = 'Long Message';
+				} elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
+					$CurrentVarName = 'Severity Code';
+				}
+				$error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+			}
+		}
+		return $error;
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -77,13 +77,13 @@ 
     public function do_direct_payment($payment, $billing_info = null)
     {
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             throw new EE_Error(
                 esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso')
             );
         }
         $primary_registrant = $transaction->primary_registration();
-        if (! $primary_registrant instanceof EEI_Registration) {
+        if ( ! $primary_registrant instanceof EEI_Registration) {
             throw new EE_Error(
                 esc_html__(
                     'No primary registration on transaction while paying with PayPal Pro.',
@@ -92,7 +92,7 @@ 
             );
         }
         $attendee = $primary_registrant->attendee();
-        if (! $attendee instanceof EEI_Attendee) {
+        if ( ! $attendee instanceof EEI_Attendee) {
             throw new EE_Error(
                 esc_html__(
                     'No attendee on primary registration while paying with PayPal Pro.',
@@ -189,7 +189,7 @@ 
             // Required.  Credit card number.  No spaces or punctuation.
             'acct'           => $billing_info['credit_card'],
             // Required.  Credit card expiration date.  Format is MMYYYY
-            'expdate'        => $billing_info['exp_month'] . $billing_info['exp_year'],
+            'expdate'        => $billing_info['exp_month'].$billing_info['exp_year'],
             // Requirements determined by your PayPal account settings.  Security digits for credit card.
             'cvv2'           => $billing_info['cvv'],
         );
@@ -241,7 +241,7 @@ 
         $ShippingAddress = array(
             'shiptoname'     => substr($use_registration_address_info
                 ? $attendee->full_name()
-                : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32),
+                : $billing_info['first_name'].' '.$billing_info['last_name'], 0, 32),
             'shiptostreet'   => substr($use_registration_address_info
                 ? $attendee->address()
                 : $billing_info['address'], 0, 100),
@@ -270,7 +270,7 @@ 
             'currencycode' => $payment->currency_code(),
             // Required if you include itemized cart details. (L_AMTn, etc.)
             // Subtotal of items not including S&H, or tax.
-            'itemamt'      => $gateway_formatter->formatCurrency($item_amount),//
+            'itemamt'      => $gateway_formatter->formatCurrency($item_amount), //
             // Total shipping costs for the order.  If you specify shippingamt, you must also specify itemamt.
             'shippingamt'  => '',
             // Total handling costs for the order.  If you specify handlingamt, you must also specify itemamt.
@@ -283,10 +283,10 @@ 
             // Free-form field for your own use.  256 char max.
             'custom'       => $primary_registrant ? $primary_registrant->ID() : '',
             // Your own invoice or tracking number
-            'invnum'       => wp_generate_password(12, false),// $transaction->ID(),
+            'invnum'       => wp_generate_password(12, false), // $transaction->ID(),
             // URL for receiving Instant Payment Notifications.  This overrides what your profile is set to use.
             'notifyurl'    => '',
-            'buttonsource' => 'EventEspresso_SP',// EE will blow up if you change this
+            'buttonsource' => 'EventEspresso_SP', // EE will blow up if you change this
         );
         // Wrap all data arrays into a single, "master" array which will be passed into the class function.
         $PayPalRequestData = array(
@@ -396,52 +396,52 @@ 
         // DP Fields
         $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array();
         foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) {
-            $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal);
+            $DPFieldsNVP .= '&'.strtoupper($DPFieldsVar).'='.urlencode($DPFieldsVal);
         }
         // CC Details Fields
         $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array();
         foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) {
-            $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal);
+            $CCDetailsNVP .= '&'.strtoupper($CCDetailsVar).'='.urlencode($CCDetailsVal);
         }
         // PayerInfo Type Fields
         $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array();
         foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) {
-            $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal);
+            $PayerInfoNVP .= '&'.strtoupper($PayerInfoVar).'='.urlencode($PayerInfoVal);
         }
         // Payer Name Fields
         $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array();
         foreach ($PayerName as $PayerNameVar => $PayerNameVal) {
-            $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal);
+            $PayerNameNVP .= '&'.strtoupper($PayerNameVar).'='.urlencode($PayerNameVal);
         }
         // Address Fields (Billing)
         $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array();
         foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) {
-            $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal);
+            $BillingAddressNVP .= '&'.strtoupper($BillingAddressVar).'='.urlencode($BillingAddressVal);
         }
         // Payment Details Type Fields
         $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array();
         foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) {
-            $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal);
+            $PaymentDetailsNVP .= '&'.strtoupper($PaymentDetailsVar).'='.urlencode($PaymentDetailsVal);
         }
         // Payment Details Item Type Fields
         $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array();
         $n = 0;
         foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) {
-            $CurrentItem = $OrderItems[ $OrderItemsVar ];
+            $CurrentItem = $OrderItems[$OrderItemsVar];
             foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) {
-                $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal);
+                $OrderItemsNVP .= '&'.strtoupper($CurrentItemVar).$n.'='.urlencode($CurrentItemVal);
             }
             $n++;
         }
         // Ship To Address Fields
         $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array();
         foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) {
-            $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal);
+            $ShippingAddressNVP .= '&'.strtoupper($ShippingAddressVar).'='.urlencode($ShippingAddressVal);
         }
         // 3D Secure Fields
         $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array();
         foreach ($Secure3D as $Secure3DVar => $Secure3DVal) {
-            $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal);
+            $Secure3DNVP .= '&'.strtoupper($Secure3DVar).'='.urlencode($Secure3DVal);
         }
         // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string
         $NVPRequest = 'USER='
@@ -512,7 +512,7 @@ 
             $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString);
             $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1);
             // decoding the response
-            $proArray[ $keyval ] = urldecode($valval);
+            $proArray[$keyval] = urldecode($valval);
             $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString));
         }
         return $proArray;
@@ -545,16 +545,16 @@ 
     {
         $Errors = array();
         $n = 0;
-        while (isset($DataArray[ 'L_ERRORCODE' . $n . '' ])) {
-            $LErrorCode = isset($DataArray[ 'L_ERRORCODE' . $n . '' ]) ? $DataArray[ 'L_ERRORCODE' . $n . '' ] : '';
-            $LShortMessage = isset($DataArray[ 'L_SHORTMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_SHORTMESSAGE' . $n . '' ]
+        while (isset($DataArray['L_ERRORCODE'.$n.''])) {
+            $LErrorCode = isset($DataArray['L_ERRORCODE'.$n.'']) ? $DataArray['L_ERRORCODE'.$n.''] : '';
+            $LShortMessage = isset($DataArray['L_SHORTMESSAGE'.$n.''])
+                ? $DataArray['L_SHORTMESSAGE'.$n.'']
                 : '';
-            $LLongMessage = isset($DataArray[ 'L_LONGMESSAGE' . $n . '' ])
-                ? $DataArray[ 'L_LONGMESSAGE' . $n . '' ]
+            $LLongMessage = isset($DataArray['L_LONGMESSAGE'.$n.''])
+                ? $DataArray['L_LONGMESSAGE'.$n.'']
                 : '';
-            $LSeverityCode = isset($DataArray[ 'L_SEVERITYCODE' . $n . '' ])
-                ? $DataArray[ 'L_SEVERITYCODE' . $n . '' ]
+            $LSeverityCode = isset($DataArray['L_SEVERITYCODE'.$n.''])
+                ? $DataArray['L_SEVERITYCODE'.$n.'']
                 : '';
             $CurrentItem = array(
                 'L_ERRORCODE'    => $LErrorCode,
@@ -581,7 +581,7 @@ 
     {
         $error = '';
         foreach ($Errors as $ErrorVar => $ErrorVal) {
-            $CurrentError = $Errors[ $ErrorVar ];
+            $CurrentError = $Errors[$ErrorVar];
             foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) {
                 $CurrentVarName = '';
                 if ($CurrentErrorVar == 'L_ERRORCODE') {
@@ -593,7 +593,7 @@ 
                 } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') {
                     $CurrentVarName = 'Severity Code';
                 }
-                $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal;
+                $error .= '<br />'.$CurrentVarName.': '.$CurrentErrorVal;
             }
         }
         return $error;