eventespresso / event-espresso-core

core/services/loaders/LoaderFactory.php

Indentation +38 added lines, -38 removed lines

@@ -70,44 +70,44 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
-    /**
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
-     *                                              otherwise can be left null
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getLoader(
-        $generator = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        if (! LoaderFactory::$loader instanceof LoaderInterface
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection(''),
-                    $object_identifier
-                ),
-                $class_cache
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
+	 *                                              otherwise can be left null
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getLoader(
+		$generator = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		if (! LoaderFactory::$loader instanceof LoaderInterface
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection(''),
+					$object_identifier
+				),
+				$class_cache
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
         ClassInterfaceCache $class_cache = null,
         ObjectIdentifier $object_identifier = null
     ) {
-        if (! LoaderFactory::$loader instanceof LoaderInterface
+        if ( ! LoaderFactory::$loader instanceof LoaderInterface
             && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
             && $class_cache instanceof ClassInterfaceCache
             && $object_identifier instanceof ObjectIdentifier

core/services/collections/CollectionLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 
     /**
      * @param        $entity
-     * @param  mixed $identifier
+     * @param  string $identifier
      * @return string
      * @throws InvalidEntityException
      */

Spacing +8 added lines, -8 removed lines

@@ -84,7 +84,7 @@ 
         LocatorInterface $file_locator = null
     ) {
         $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
+        if ( ! $collection instanceof CollectionInterface) {
             $collection = new Collection($this->collection_details->getCollectionInterface());
         }
         $this->collection = $collection;
@@ -111,7 +111,7 @@ 
      */
     protected function loadAllFromFilepaths()
     {
-        if (! $this->file_locator instanceof FileLocator) {
+        if ( ! $this->file_locator instanceof FileLocator) {
             $this->file_locator = new FileLocator();
         }
         $this->file_locator->setFileMask($this->collection_details->getFileMask());
@@ -143,10 +143,10 @@ 
      */
     protected function loadClassFromFilepath($filepath)
     {
-        if (! is_string($filepath)) {
+        if ( ! is_string($filepath)) {
             throw new InvalidDataTypeException('$filepath', $filepath, 'string');
         }
-        if (! is_readable($filepath)) {
+        if ( ! is_readable($filepath)) {
             throw new InvalidFilePathException($filepath);
         }
         require_once $filepath;
@@ -154,7 +154,7 @@ 
         $file_name = basename($filepath);
         // now remove any file extensions
         $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new InvalidClassException($class_name);
         }
         return $this->addEntityToCollection(new $class_name(), $file_name);
@@ -224,7 +224,7 @@ 
             // objects added to the collection based on entity callback, so the entity itself decides
             case CollectionDetails::ID_CALLBACK_METHOD:
                 $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
+                if ( ! method_exists($entity, $identifier_callback)) {
                     throw new InvalidEntityException(
                         $entity,
                         $this->collection_details->getCollectionInterface(),
@@ -288,10 +288,10 @@ 
      */
     protected function loadClassFromFQCN($FQCN)
     {
-        if (! is_string($FQCN)) {
+        if ( ! is_string($FQCN)) {
             throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
         }
-        if (! class_exists($FQCN)) {
+        if ( ! class_exists($FQCN)) {
             throw new InvalidClassException($FQCN);
         }
         return $this->addEntityToCollection(

Indentation +249 added lines, -249 removed lines

@@ -27,276 +27,276 @@
 class CollectionLoader
 {
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was NOT ADDED to the collection
-     */
-    const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was NOT ADDED to the collection
+	 */
+	const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was SUCCESSFULLY ADDED to the collection
-     */
-    const ENTITY_ADDED = 'entity-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was SUCCESSFULLY ADDED to the collection
+	 */
+	const ENTITY_ADDED = 'entity-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was ALREADY ADDED to the collection,
-     * and therefore could not be added again.
-     */
-    const ENTITY_EXISTS = 'entity-already-in-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was ALREADY ADDED to the collection,
+	 * and therefore could not be added again.
+	 */
+	const ENTITY_EXISTS = 'entity-already-in-collection';
 
 
-    /**
-     * @var CollectionDetailsInterface $collection_details
-     */
-    protected $collection_details;
+	/**
+	 * @var CollectionDetailsInterface $collection_details
+	 */
+	protected $collection_details;
 
-    /**
-     * @var CollectionInterface $collection
-     */
-    protected $collection;
+	/**
+	 * @var CollectionInterface $collection
+	 */
+	protected $collection;
 
-    /**
-     * @var FileLocator $file_locator
-     */
-    protected $file_locator;
+	/**
+	 * @var FileLocator $file_locator
+	 */
+	protected $file_locator;
 
 
-    /**
-     * CollectionLoader constructor.
-     *
-     * @param CollectionDetailsInterface $collection_details
-     * @param CollectionInterface        $collection
-     * @param LocatorInterface           $file_locator
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     */
-    public function __construct(
-        CollectionDetailsInterface $collection_details,
-        CollectionInterface $collection = null,
-        LocatorInterface $file_locator = null
-    ) {
-        $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
-            $collection = new Collection($this->collection_details->getCollectionInterface());
-        }
-        $this->collection = $collection;
-        $this->file_locator = $file_locator;
-        $this->loadAllFromFilepaths();
-        $this->loadFromFQCNs();
-    }
+	/**
+	 * CollectionLoader constructor.
+	 *
+	 * @param CollectionDetailsInterface $collection_details
+	 * @param CollectionInterface        $collection
+	 * @param LocatorInterface           $file_locator
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(
+		CollectionDetailsInterface $collection_details,
+		CollectionInterface $collection = null,
+		LocatorInterface $file_locator = null
+	) {
+		$this->collection_details = $collection_details;
+		if (! $collection instanceof CollectionInterface) {
+			$collection = new Collection($this->collection_details->getCollectionInterface());
+		}
+		$this->collection = $collection;
+		$this->file_locator = $file_locator;
+		$this->loadAllFromFilepaths();
+		$this->loadFromFQCNs();
+	}
 
 
-    /**
-     * @return CollectionInterface
-     */
-    public function getCollection()
-    {
-        return $this->collection;
-    }
+	/**
+	 * @return CollectionInterface
+	 */
+	public function getCollection()
+	{
+		return $this->collection;
+	}
 
 
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    protected function loadAllFromFilepaths()
-    {
-        if (! $this->file_locator instanceof FileLocator) {
-            $this->file_locator = new FileLocator();
-        }
-        $this->file_locator->setFileMask($this->collection_details->getFileMask());
-        // find all of the files that match the file mask in the specified folder
-        $this->file_locator->locate($this->collection_details->getCollectionPaths());
-        // filter the results
-        $filepaths = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
-            $this->file_locator->getFilePaths(),
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ($filepaths as $filepath) {
-            $this->loadClassFromFilepath($filepath);
-        }
-    }
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	protected function loadAllFromFilepaths()
+	{
+		if (! $this->file_locator instanceof FileLocator) {
+			$this->file_locator = new FileLocator();
+		}
+		$this->file_locator->setFileMask($this->collection_details->getFileMask());
+		// find all of the files that match the file mask in the specified folder
+		$this->file_locator->locate($this->collection_details->getCollectionPaths());
+		// filter the results
+		$filepaths = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
+			$this->file_locator->getFilePaths(),
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ($filepaths as $filepath) {
+			$this->loadClassFromFilepath($filepath);
+		}
+	}
 
 
-    /**
-     * @param  string $filepath
-     * @return string
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidClassException
-     */
-    protected function loadClassFromFilepath($filepath)
-    {
-        if (! is_string($filepath)) {
-            throw new InvalidDataTypeException('$filepath', $filepath, 'string');
-        }
-        if (! is_readable($filepath)) {
-            throw new InvalidFilePathException($filepath);
-        }
-        require_once $filepath;
-        // extract filename from path
-        $file_name = basename($filepath);
-        // now remove any file extensions
-        $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
-            throw new InvalidClassException($class_name);
-        }
-        return $this->addEntityToCollection(new $class_name(), $file_name);
-    }
+	/**
+	 * @param  string $filepath
+	 * @return string
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidClassException
+	 */
+	protected function loadClassFromFilepath($filepath)
+	{
+		if (! is_string($filepath)) {
+			throw new InvalidDataTypeException('$filepath', $filepath, 'string');
+		}
+		if (! is_readable($filepath)) {
+			throw new InvalidFilePathException($filepath);
+		}
+		require_once $filepath;
+		// extract filename from path
+		$file_name = basename($filepath);
+		// now remove any file extensions
+		$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
+		if (! class_exists($class_name)) {
+			throw new InvalidClassException($class_name);
+		}
+		return $this->addEntityToCollection(new $class_name(), $file_name);
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function addEntityToCollection($entity, $identifier)
-    {
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity',
-            $entity,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        $identifier = $this->setIdentifier($entity, $identifier);
-        if ($this->collection->has($identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_EXISTS;
-        }
-        if ($this->collection->add($entity, $identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_ADDED;
-        }
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
-    }
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function addEntityToCollection($entity, $identifier)
+	{
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity',
+			$entity,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		$identifier = $this->setIdentifier($entity, $identifier);
+		if ($this->collection->has($identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_EXISTS;
+		}
+		if ($this->collection->add($entity, $identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_ADDED;
+		}
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function setIdentifier($entity, $identifier)
-    {
-        switch ($this->collection_details->identifierType()) {
-            // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH:
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME:
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD:
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function setIdentifier($entity, $identifier)
+	{
+		switch ($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH:
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME:
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD:
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if (! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-        }
-        return apply_filters(
-            'FHEE__CollectionLoader__addEntityToCollection__identifier',
-            $identifier,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-    }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+		}
+		return apply_filters(
+			'FHEE__CollectionLoader__addEntityToCollection__identifier',
+			$identifier,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    protected function loadFromFQCNs()
-    {
-        $FQCNs = $this->collection_details->getCollectionFQCNs();
-        $FQCNs = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
-            $FQCNs,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        foreach ($FQCNs as $FQCN) {
-            $this->loadClassFromFQCN($FQCN);
-        }
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	protected function loadFromFQCNs()
+	{
+		$FQCNs = $this->collection_details->getCollectionFQCNs();
+		$FQCNs = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
+			$FQCNs,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		foreach ($FQCNs as $FQCN) {
+			$this->loadClassFromFQCN($FQCN);
+		}
+	}
 
 
-    /**
-     * @param  string $FQCN Fully Qualified Class Name
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function loadClassFromFQCN($FQCN)
-    {
-        if (! is_string($FQCN)) {
-            throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
-        }
-        if (! class_exists($FQCN)) {
-            throw new InvalidClassException($FQCN);
-        }
-        return $this->addEntityToCollection(
-            EE_Registry::instance()->create($FQCN),
-            $FQCN
-        );
-    }
+	/**
+	 * @param  string $FQCN Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function loadClassFromFQCN($FQCN)
+	{
+		if (! is_string($FQCN)) {
+			throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
+		}
+		if (! class_exists($FQCN)) {
+			throw new InvalidClassException($FQCN);
+		}
+		return $this->addEntityToCollection(
+			EE_Registry::instance()->create($FQCN),
+			$FQCN
+		);
+	}
 }

core/exceptions/InvalidEntityException.php

Indentation +26 added lines, -26 removed lines

@@ -16,30 +16,30 @@
 class InvalidEntityException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidEntityException constructor.
-     *
-     * @param mixed     $actual   the actual object (or thing) we got
-     * @param string    $expected classname of the entity we wanted
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
-                    'event_espresso'
-                ),
-                is_object($actual)
-                    ? get_class($actual)
-                    : gettype($actual),
-                $expected,
-                var_export($actual, true)
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidEntityException constructor.
+	 *
+	 * @param mixed     $actual   the actual object (or thing) we got
+	 * @param string    $expected classname of the entity we wanted
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
+					'event_espresso'
+				),
+				is_object($actual)
+					? get_class($actual)
+					: gettype($actual),
+				$expected,
+				var_export($actual, true)
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

acceptance_tests/Helpers/MessagesAdmin.php

Indentation +290 added lines, -290 removed lines

@@ -10,294 +10,294 @@
  */
 trait MessagesAdmin
 {
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnMessagesActivityListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
-    }
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     */
-    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Directs to message settings page
-     */
-    public function amOnMessageSettingsPage()
-    {
-        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
-    }
-
-
-    public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
-    {
-        $this->actor()->dragAndDrop(
-            MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
-            MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
-        );
-    }
-
-
-    /**
-     * Assumes you are already on the list table page that has the ui for editing the template.
-     * @param string $message_type_slug
-     * @param string $context [optional] if you want to click directly to the given context in the editor
-     */
-    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
-    {
-        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
-    }
-
-
-    /**
-     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
-     * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
-     *
-     * @param int    $expected_occurence_count
-     * @param string $text_to_check_for
-     * @param string $field
-     * @param string $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     */
-    public function verifyMatchingCountofTextInMessageActivityListTableFor(
-        $expected_occurence_count,
-        $text_to_check_for,
-        $field,
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin'
-    ) {
-        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
-            $field,
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $text_to_check_for,
-            0
-        ));
-        $actual_count = count($elements);
-        $this->actor()->assertEquals(
-            $expected_occurence_count,
-            $actual_count,
-            sprintf(
-                'Expected %s of the %s text for the %s field but there were actually %s counted.',
-                $expected_occurence_count,
-                $text_to_check_for,
-                $field,
-                $actual_count
-            )
-        );
-    }
-
-
-    /**
-     * This will create a custom message template for the given messenger and message type from the context of the
-     * default (global) message template list table.
-     * Also takes care of verifying the template was created.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     */
-    public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
-    {
-        $this->amOnDefaultMessageTemplateListTablePage();
-        $this->actor()->click(
-            MessagesPage::createCustomButtonForMessageTypeAndMessenger(
-                $message_type_label,
-                $messenger_label
-            )
-        );
-        $this->actor()->seeInField('#title', 'New Custom Template');
-    }
-
-
-    /**
-     * This switches the context of the current messages template to the given reference.
-     * @param string $context_reference  This should be the visible label for the option.
-     */
-    public function switchContextTo($context_reference)
-    {
-        $this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
-        $this->actor()->waitForText($context_reference, 10, 'h1');
-    }
-
-
-    /**
-     * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
-     * toggling.
-     *
-     * @param string $context_string           What context is being switched (used for the expected state text)
-     * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
-     *                                         (false)
-     */
-    public function toggleContextState($context_string, $expected_state_is_active = true)
-    {
-        $this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
-        $this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
-        if ($expected_state_is_active) {
-            $this->actor()->waitForText("The template for $context_string is currently active.");
-        } else {
-            $this->actor()->waitForText("The template for $context_string is currently inactive");
-        }
-    }
-
-
-    /**
-     * Triggers saving the message template.
-     * @param bool $and_close   Use to indicate to click the Save and Close button.
-     */
-    public function saveMessageTemplate($and_close = false)
-    {
-        $this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
-        if ($and_close) {
-            $this->actor()->click('Save and Close');
-        } else {
-            $this->actor()->click('Save');
-        }
-        $this->actor()->waitForText('successfully updated');
-    }
-
-
-    /**
-     * This takes care of clicking the View Message icon for the given parameters.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function viewMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        ));
-    }
-
-
-    /**
-     * Takes care of deleting a message matching the given parameters via the message activity list table.
-     * Assumes you are already viewing the messages activity list table.
-     * @param        $message_type_label
-     * @param        $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     */
-    public function deleteMessageInMessagesListTableFor(
-        $message_type_label,
-        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            $number_in_set
-        );
-        $cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $this->actor()->scrollTo($cell_selector, 0, -30);
-        $this->actor()->moveMouseOver(
-            $cell_selector,
-            5,
-            5
-        );
-        $this->actor()->waitForElementVisible(
-            $delete_action_selector
-        );
-        $this->actor()->click(
-            $delete_action_selector
-        );
-        $this->actor()->waitForText('successfully deleted', 20);
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is in that window.
-     * @param string $text_to_view
-     */
-    public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
-        $this->actor()->switchToIframe();
-    }
-
-
-    /**
-     * This returns the value for the link at the given selector in the message modal.
-     * @param string $selector (any selector string accepted by WebDriver)
-     */
-    public function observeLinkAtSelectorInMessageModal($selector)
-    {
-        $this->actor()->wait(2);
-        $this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
-        $this->actor()->switchToIframe('message-view-window');
-        $link = $this->actor()->observeLinkUrlAt($selector);
-        $this->actor()->switchToIframe();
-        return $link;
-    }
-
-
-    /**
-     * Assuming you have already triggered the view modal for a single message from the context of the message activity
-     * list table, this will take care of validating the given text is NOT that window.
-     * @param string $text_to_view
-     */
-    public function dontSeeTextInViewMessageModal($text_to_view)
-    {
-        $this->seeTextInViewMessageModal($text_to_view, true);
-    }
-
-
-    public function dismissMessageModal()
-    {
-        $this->actor()->executeJs('window.dialogHelper.closeModal()');
-    }
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnMessagesActivityListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
+	}
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 */
+	public function amOnCustomMessageTemplateListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Directs to message settings page
+	 */
+	public function amOnMessageSettingsPage()
+	{
+		$this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
+	}
+
+
+	public function activateMessageTypeForMessenger($message_type_slug, $messenger_slug = 'email')
+	{
+		$this->actor()->dragAndDrop(
+			MessagesPage::draggableSettingsBoxSelectorForMessageTypeAndMessenger($message_type_slug, $messenger_slug),
+			MessagesPage::MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR
+		);
+	}
+
+
+	/**
+	 * Assumes you are already on the list table page that has the ui for editing the template.
+	 * @param string $message_type_slug
+	 * @param string $context [optional] if you want to click directly to the given context in the editor
+	 */
+	public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
+	{
+		$this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
+	}
+
+
+	/**
+	 * Use this action to verify that the count for the given text in the specified field is as expected.  For example
+	 * filling the condition of, "There should only be 1 instance of `someaddress@email.com` in all the 'to' column.
+	 *
+	 * @param int    $expected_occurence_count
+	 * @param string $text_to_check_for
+	 * @param string $field
+	 * @param string $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 */
+	public function verifyMatchingCountofTextInMessageActivityListTableFor(
+		$expected_occurence_count,
+		$text_to_check_for,
+		$field,
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin'
+	) {
+		$elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
+			$field,
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$text_to_check_for,
+			0
+		));
+		$actual_count = count($elements);
+		$this->actor()->assertEquals(
+			$expected_occurence_count,
+			$actual_count,
+			sprintf(
+				'Expected %s of the %s text for the %s field but there were actually %s counted.',
+				$expected_occurence_count,
+				$text_to_check_for,
+				$field,
+				$actual_count
+			)
+		);
+	}
+
+
+	/**
+	 * This will create a custom message template for the given messenger and message type from the context of the
+	 * default (global) message template list table.
+	 * Also takes care of verifying the template was created.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 */
+	public function createCustomMessageTemplateFromDefaultFor($message_type_label, $messenger_label)
+	{
+		$this->amOnDefaultMessageTemplateListTablePage();
+		$this->actor()->click(
+			MessagesPage::createCustomButtonForMessageTypeAndMessenger(
+				$message_type_label,
+				$messenger_label
+			)
+		);
+		$this->actor()->seeInField('#title', 'New Custom Template');
+	}
+
+
+	/**
+	 * This switches the context of the current messages template to the given reference.
+	 * @param string $context_reference  This should be the visible label for the option.
+	 */
+	public function switchContextTo($context_reference)
+	{
+		$this->actor()->selectOption(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR, $context_reference);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR);
+		$this->actor()->waitForText($context_reference, 10, 'h1');
+	}
+
+
+	/**
+	 * Toggles Context so its turned off or on (depending on where it started) and verifies the expected state after
+	 * toggling.
+	 *
+	 * @param string $context_string           What context is being switched (used for the expected state text)
+	 * @param bool   $expected_state_is_active Used to indicate whether the expected state is active (true) or inactive
+	 *                                         (false)
+	 */
+	public function toggleContextState($context_string, $expected_state_is_active = true)
+	{
+		$this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
+		$this->actor()->click(MessagesPage::MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE);
+		if ($expected_state_is_active) {
+			$this->actor()->waitForText("The template for $context_string is currently active.");
+		} else {
+			$this->actor()->waitForText("The template for $context_string is currently inactive");
+		}
+	}
+
+
+	/**
+	 * Triggers saving the message template.
+	 * @param bool $and_close   Use to indicate to click the Save and Close button.
+	 */
+	public function saveMessageTemplate($and_close = false)
+	{
+		$this->actor()->scrollTo(MessagesPage::MESSAGES_CONTEXT_SWITCHER_SELECTOR);
+		if ($and_close) {
+			$this->actor()->click('Save and Close');
+		} else {
+			$this->actor()->click('Save');
+		}
+		$this->actor()->waitForText('successfully updated');
+	}
+
+
+	/**
+	 * This takes care of clicking the View Message icon for the given parameters.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function viewMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$this->actor()->click(MessagesPage::messagesActivityListTableViewButtonSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		));
+	}
+
+
+	/**
+	 * Takes care of deleting a message matching the given parameters via the message activity list table.
+	 * Assumes you are already viewing the messages activity list table.
+	 * @param        $message_type_label
+	 * @param        $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 */
+	public function deleteMessageInMessagesListTableFor(
+		$message_type_label,
+		$message_status = MessagesPage::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$delete_action_selector = MessagesPage::messagesActivityListTableDeleteActionSelectorFor(
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			$number_in_set
+		);
+		$cell_selector = MessagesPage::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$this->actor()->scrollTo($cell_selector, 0, -30);
+		$this->actor()->moveMouseOver(
+			$cell_selector,
+			5,
+			5
+		);
+		$this->actor()->waitForElementVisible(
+			$delete_action_selector
+		);
+		$this->actor()->click(
+			$delete_action_selector
+		);
+		$this->actor()->waitForText('successfully deleted', 20);
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is in that window.
+	 * @param string $text_to_view
+	 */
+	public function seeTextInViewMessageModal($text_to_view, $should_not_see = false)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$should_not_see ? $this->actor()->dontSee($text_to_view) : $this->actor()->see($text_to_view);
+		$this->actor()->switchToIframe();
+	}
+
+
+	/**
+	 * This returns the value for the link at the given selector in the message modal.
+	 * @param string $selector (any selector string accepted by WebDriver)
+	 */
+	public function observeLinkAtSelectorInMessageModal($selector)
+	{
+		$this->actor()->wait(2);
+		$this->actor()->waitForElementVisible('.ee-admin-dialog-container-inner-content');
+		$this->actor()->switchToIframe('message-view-window');
+		$link = $this->actor()->observeLinkUrlAt($selector);
+		$this->actor()->switchToIframe();
+		return $link;
+	}
+
+
+	/**
+	 * Assuming you have already triggered the view modal for a single message from the context of the message activity
+	 * list table, this will take care of validating the given text is NOT that window.
+	 * @param string $text_to_view
+	 */
+	public function dontSeeTextInViewMessageModal($text_to_view)
+	{
+		$this->seeTextInViewMessageModal($text_to_view, true);
+	}
+
+
+	public function dismissMessageModal()
+	{
+		$this->actor()->executeJs('window.dialogHelper.closeModal()');
+	}
 }

core/services/assets/AssetRegistrationException.php

Indentation +20 added lines, -20 removed lines

@@ -16,24 +16,24 @@
  */
 class AssetRegistrationException extends RuntimeException
 {
-    /**
-     * @param                $script_handle
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html_x(
-                    'The "%1$s" script could not be registered with WordPress core.',
-                    'The "script-handle" script could not be registered with WordPress core.',
-                    'event_espresso'
-                ),
-                $script_handle
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * @param                $script_handle
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($script_handle, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html_x(
+					'The "%1$s" script could not be registered with WordPress core.',
+					'The "script-handle" script could not be registered with WordPress core.',
+					'event_espresso'
+				),
+				$script_handle
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }
\ No newline at end of file

core/services/privacy/policy/PrivacyPolicyInterface.php

Indentation +12 added lines, -12 removed lines

@@ -16,20 +16,20 @@
 interface PrivacyPolicyInterface
 {
 
-    /**
-     * Returns the translated name to display in this privacy policy's section's title
-     *
-     * @return string
-     */
-    public function getName();
+	/**
+	 * Returns the translated name to display in this privacy policy's section's title
+	 *
+	 * @return string
+	 */
+	public function getName();
 
 
-    /**
-     * Returns the suggested privacy policy content for this plugin. May contain HTML
-     *
-     * @return string
-     */
-    public function getContent();
+	/**
+	 * Returns the suggested privacy policy content for this plugin. May contain HTML
+	 *
+	 * @return string
+	 */
+	public function getContent();
 }
 // End of file PrivacyPolicyInterface.php
 // Location: EventEspresso\core\domain\services\admin/PrivacyPolicyInterface.php

core/domain/services/admin/privacy/export/ExportRegistration.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use EE_Registration;
 use EE_Ticket;
-use EEM_Answer;
 use EEM_Registration;
 use EventEspresso\core\services\privacy\export\PersonalDataExporterInterface;
 

Indentation +122 added lines, -122 removed lines

@@ -18,133 +18,133 @@
  */
 class ExportRegistration implements PersonalDataExporterInterface
 {
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
 
-    /**
-     * ExportRegistration constructor.
-     *
-     * @param EEM_Registration $registration_model
-     */
-    public function __construct(EEM_Registration $registration_model)
-    {
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * ExportRegistration constructor.
+	 *
+	 * @param EEM_Registration $registration_model
+	 */
+	public function __construct(EEM_Registration $registration_model)
+	{
+		$this->registration_model = $registration_model;
+	}
 
 
-    /**
-     * Returns data for export.
-     *
-     * @param string    $email_address ,
-     * @param int       $page          starts at 1, not 0
-     * @return array {
-     * @type array      $data          {
-     * @type array {
-     * @type string     $group_id      (not translated, same for all exports)
-     * @type string     $group_label   (translated string)
-     * @type string|int $item_id
-     * @type array      $data          {
-     * @type array {
-     * @type string     $name          what's shown in the left-column of the export row
-     * @type string     $value         what's showin the right-column of the export row
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     */
-    public function export($email_address, $page = 1)
-    {
-        $page_size = 10;
-        $registrations = $this->registration_model->get_all(
-            array(
-                array(
-                    'Attendee.ATT_email' => $email_address,
-                ),
-                'limit' => array(
-                    ($page - 1) * $page_size,
-                    $page_size,
-                ),
-            )
-        );
-        $export_fields = array_intersect_key(
-            $this->registration_model->field_settings(),
-            array_flip(
-                array(
-                    'REG_code',
-                    'REG_date',
-                    'REG_final_price',
-                    'REG_paid',
-                    'REG_url_link',
-                    'REG_count',
-                    'REG_group_size',
-                    'REG_att_is_going',
-                )
-            )
-        );
-        $export_items = array();
-        $found_something = false;
-        foreach ($registrations as $registration) {
-            /**
-             * @var $registration EE_Registration
-             */
-            $found_something = true;
-            $data = array();
-            foreach ($export_fields as $field_name => $field_obj) {
-                $data[] = array(
-                    'name'  => $field_obj->get_nicename(),
-                    'value' => $registration->get_pretty($field_name),
-                );
-            }
-            $answers = $registration->answers(
-                array(
-                    'force_join' => array(
-                        'Question',
-                    ),
-                )
-            );
-            foreach ($answers as $answer) {
-                $data[] = array(
-                    'name'  => $answer->question()->display_text(),
-                    'value' => $answer->pretty_value(),
-                );
-            }
-            $ticket = $registration->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                $data[] = array(
-                    'name'  => esc_html__('Ticket', 'event_espresso'),
-                    'value' => $ticket->name_and_info(),
-                );
-                $data[] = array(
-                    'name'  => esc_html__('Event', 'event_espresso'),
-                    'value' => $ticket->get_event_name(),
-                );
-            }
+	/**
+	 * Returns data for export.
+	 *
+	 * @param string    $email_address ,
+	 * @param int       $page          starts at 1, not 0
+	 * @return array {
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $group_id      (not translated, same for all exports)
+	 * @type string     $group_label   (translated string)
+	 * @type string|int $item_id
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $name          what's shown in the left-column of the export row
+	 * @type string     $value         what's showin the right-column of the export row
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 */
+	public function export($email_address, $page = 1)
+	{
+		$page_size = 10;
+		$registrations = $this->registration_model->get_all(
+			array(
+				array(
+					'Attendee.ATT_email' => $email_address,
+				),
+				'limit' => array(
+					($page - 1) * $page_size,
+					$page_size,
+				),
+			)
+		);
+		$export_fields = array_intersect_key(
+			$this->registration_model->field_settings(),
+			array_flip(
+				array(
+					'REG_code',
+					'REG_date',
+					'REG_final_price',
+					'REG_paid',
+					'REG_url_link',
+					'REG_count',
+					'REG_group_size',
+					'REG_att_is_going',
+				)
+			)
+		);
+		$export_items = array();
+		$found_something = false;
+		foreach ($registrations as $registration) {
+			/**
+			 * @var $registration EE_Registration
+			 */
+			$found_something = true;
+			$data = array();
+			foreach ($export_fields as $field_name => $field_obj) {
+				$data[] = array(
+					'name'  => $field_obj->get_nicename(),
+					'value' => $registration->get_pretty($field_name),
+				);
+			}
+			$answers = $registration->answers(
+				array(
+					'force_join' => array(
+						'Question',
+					),
+				)
+			);
+			foreach ($answers as $answer) {
+				$data[] = array(
+					'name'  => $answer->question()->display_text(),
+					'value' => $answer->pretty_value(),
+				);
+			}
+			$ticket = $registration->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				$data[] = array(
+					'name'  => esc_html__('Ticket', 'event_espresso'),
+					'value' => $ticket->name_and_info(),
+				);
+				$data[] = array(
+					'name'  => esc_html__('Event', 'event_espresso'),
+					'value' => $ticket->get_event_name(),
+				);
+			}
 
-            $export_items[] = array(
-                'group_id'    => 'registration',
-                'group_label' => esc_html__('Event Registrations', 'event_espresso'),
-                'item_id'     => $registration->ID(),
-                'data'        => $data,
-            );
-        }
-        return array(
-            'data' => $export_items,
-            'done' => ! $found_something,
-        );
-    }
+			$export_items[] = array(
+				'group_id'    => 'registration',
+				'group_label' => esc_html__('Event Registrations', 'event_espresso'),
+				'item_id'     => $registration->ID(),
+				'data'        => $data,
+			);
+		}
+		return array(
+			'data' => $export_items,
+			'done' => ! $found_something,
+		);
+	}
 
-    /**
-     * Gets the Translated name of this exporter
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Registration Data Exporter', 'event_espresso');
-    }
+	/**
+	 * Gets the Translated name of this exporter
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Registration Data Exporter', 'event_espresso');
+	}
 }
 // End of file ExportRegistration.php
 // Location: EventEspresso\core\domain\services\admin\privacy\export/ExportRegistration.php

core/domain/services/admin/privacy/export/ExportTransaction.php

Indentation +96 added lines, -96 removed lines

@@ -15,106 +15,106 @@
  */
 class ExportTransaction implements PersonalDataExporterInterface
 {
-    /**
-     * @var EEM_Transaction $transaction_model
-     */
-    protected $transaction_model;
+	/**
+	 * @var EEM_Transaction $transaction_model
+	 */
+	protected $transaction_model;
 
-    /**
-     * ExportTransaction constructor.
-     *
-     * @param $transaction_model
-     */
-    public function __construct(EEM_Transaction $transaction_model)
-    {
-        $this->transaction_model = $transaction_model;
-    }
+	/**
+	 * ExportTransaction constructor.
+	 *
+	 * @param $transaction_model
+	 */
+	public function __construct(EEM_Transaction $transaction_model)
+	{
+		$this->transaction_model = $transaction_model;
+	}
 
 
-    /**
-     * Returns data for export.
-     *
-     * @param string    $email_address ,
-     * @param int       $page          starts at 1, not 0
-     * @return array {
-     * @type array      $data          {
-     * @type array {
-     * @type string     $group_id      (not translated, same for all exports)
-     * @type string     $group_label   (translated string)
-     * @type string|int $item_id
-     * @type array      $data          {
-     * @type array {
-     * @type string     $name          what's shown in the left-column of the export row
-     * @type string     $value         what's showin the right-column of the export row
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     */
-    public function export($email_address, $page = 1)
-    {
-        $page_size = 10;
-        $transactions = $this->transaction_model->get_all(
-            array(
-                array(
-                    'Registration.Attendee.ATT_email' => $email_address,
-                ),
-                'limit' => array(
-                    ($page - 1) * $page_size,
-                    $page_size,
-                ),
-            )
-        );
-        $export_fields = array_intersect_key(
-            EEM_Transaction::instance()->field_settings(),
-            array_flip(
-                array(
-                    'TXN_timestamp',
-                    'TXN_total',
-                    'TXN_paid',
-                    'TXN_session_data',
-                )
-            )
-        );
-        $export_items = array();
-        $found_something = false;
-        foreach ($transactions as $transaction) {
-            $found_something = true;
-            $data = array();
-            foreach ($export_fields as $field_name => $field_obj) {
-                if ($field_name === 'TXN_session_data') {
-                    $value = $transaction->get_pretty($field_name, 'print_r');
-                } else {
-                    $value = $transaction->get_pretty($field_name);
-                }
-                $data[] = array(
-                    'name'  => $field_obj->get_nicename(),
-                    'value' => $value,
-                );
-            }
-            $export_items[] = array(
-                'group_id'    => 'transactions',
-                'group_label' => esc_html__('Transactions', 'event_espresso'),
-                'item_id'     => $transaction->ID(),
-                'data'        => $data,
-            );
-        }
-        return array(
-            'data' => $export_items,
-            'done' => ! $found_something,
-        );
-    }
+	/**
+	 * Returns data for export.
+	 *
+	 * @param string    $email_address ,
+	 * @param int       $page          starts at 1, not 0
+	 * @return array {
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $group_id      (not translated, same for all exports)
+	 * @type string     $group_label   (translated string)
+	 * @type string|int $item_id
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $name          what's shown in the left-column of the export row
+	 * @type string     $value         what's showin the right-column of the export row
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 */
+	public function export($email_address, $page = 1)
+	{
+		$page_size = 10;
+		$transactions = $this->transaction_model->get_all(
+			array(
+				array(
+					'Registration.Attendee.ATT_email' => $email_address,
+				),
+				'limit' => array(
+					($page - 1) * $page_size,
+					$page_size,
+				),
+			)
+		);
+		$export_fields = array_intersect_key(
+			EEM_Transaction::instance()->field_settings(),
+			array_flip(
+				array(
+					'TXN_timestamp',
+					'TXN_total',
+					'TXN_paid',
+					'TXN_session_data',
+				)
+			)
+		);
+		$export_items = array();
+		$found_something = false;
+		foreach ($transactions as $transaction) {
+			$found_something = true;
+			$data = array();
+			foreach ($export_fields as $field_name => $field_obj) {
+				if ($field_name === 'TXN_session_data') {
+					$value = $transaction->get_pretty($field_name, 'print_r');
+				} else {
+					$value = $transaction->get_pretty($field_name);
+				}
+				$data[] = array(
+					'name'  => $field_obj->get_nicename(),
+					'value' => $value,
+				);
+			}
+			$export_items[] = array(
+				'group_id'    => 'transactions',
+				'group_label' => esc_html__('Transactions', 'event_espresso'),
+				'item_id'     => $transaction->ID(),
+				'data'        => $data,
+			);
+		}
+		return array(
+			'data' => $export_items,
+			'done' => ! $found_something,
+		);
+	}
 
-    /**
-     * Gets the Translated name of this exporter
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Transaction Exporter', 'event_espresso');
-    }
+	/**
+	 * Gets the Translated name of this exporter
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Transaction Exporter', 'event_espresso');
+	}
 }
 // End of file ExportTransaction.php
 // Location: EventEspresso\core\domain\services\admin\privacy\export/ExportTransaction.php

core/domain/services/admin/privacy/export/ExportCheckins.php

Indentation +100 added lines, -100 removed lines

@@ -16,112 +16,112 @@
  */
 class ExportCheckins implements PersonalDataExporterInterface
 {
-    /**
-     * @var EEM_Checkin
-     */
-    protected $checkin_model;
+	/**
+	 * @var EEM_Checkin
+	 */
+	protected $checkin_model;
 
-    /**
-     * ExportCheckins constructor.
-     *
-     * @param EEM_Checkin $checkin_model
-     */
-    public function __construct(EEM_Checkin $checkin_model)
-    {
-        $this->checkin_model = $checkin_model;
-    }
+	/**
+	 * ExportCheckins constructor.
+	 *
+	 * @param EEM_Checkin $checkin_model
+	 */
+	public function __construct(EEM_Checkin $checkin_model)
+	{
+		$this->checkin_model = $checkin_model;
+	}
 
 
-    /**
-     * Returns data for export.
-     *
-     * @param string    $email_address ,
-     * @param int       $page          starts at 1, not 0
-     * @return array {
-     * @type array      $data          {
-     * @type array {
-     * @type string     $group_id      (not translated, same for all exports)
-     * @type string     $group_label   (translated string)
-     * @type string|int $item_id
-     * @type array      $data          {
-     * @type array {
-     * @type string     $name          what's shown in the left-column of the export row
-     * @type string     $value         what's showin the right-column of the export row
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     *                                 }
-     */
-    public function export($email_address, $page = 1)
-    {
-        $page_size = 10;
-        $checkins = $this->checkin_model->get_all(
-            array(
-                array(
-                    'Registration.Attendee.ATT_email' => $email_address,
-                ),
-                'limit'      => array(
-                    ($page - 1) * $page_size,
-                    $page_size,
-                ),
-                'force_join' => array('Registration.Event'),
-            )
-        );
+	/**
+	 * Returns data for export.
+	 *
+	 * @param string    $email_address ,
+	 * @param int       $page          starts at 1, not 0
+	 * @return array {
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $group_id      (not translated, same for all exports)
+	 * @type string     $group_label   (translated string)
+	 * @type string|int $item_id
+	 * @type array      $data          {
+	 * @type array {
+	 * @type string     $name          what's shown in the left-column of the export row
+	 * @type string     $value         what's showin the right-column of the export row
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 *                                 }
+	 */
+	public function export($email_address, $page = 1)
+	{
+		$page_size = 10;
+		$checkins = $this->checkin_model->get_all(
+			array(
+				array(
+					'Registration.Attendee.ATT_email' => $email_address,
+				),
+				'limit'      => array(
+					($page - 1) * $page_size,
+					$page_size,
+				),
+				'force_join' => array('Registration.Event'),
+			)
+		);
 
-        if (empty($checkins)) {
-            return array(
-                'data' => array(),
-                'done' => true,
-            );
-        }
+		if (empty($checkins)) {
+			return array(
+				'data' => array(),
+				'done' => true,
+			);
+		}
 
-        $export_items = array();
-        foreach ($checkins as $checkin) {
-            $reg = $checkin->get_first_related('Registration');
-            if ($reg instanceof EE_Registration) {
-                $event_name = $reg->event_name();
-            } else {
-                $event_name = esc_html__('Unknown', 'event_espresso');
-            }
-            $export_items[] =
-                array(
-                    'group_id'    => 'check-ins',
-                    'group_label' => esc_html__('Event Check-Ins', 'event_espresso'),
-                    'item_id'     => $checkin->ID(),
-                    'data'        => array(
-                        array(
-                            'name'  => esc_html__('Time', 'event_espresso'),
-                            'value' => $checkin->get_pretty('CHK_timestamp'),
-                        ),
-                        array(
-                            'name'  => esc_html__('Check in/out', 'event_espresso'),
-                            'value' => $checkin->get('CHK_in')
-                                ? esc_html__('In', 'event_espresso')
-                                : esc_html__('Out', 'event_espresso'),
-                        ),
-                        array(
-                            'name'  => esc_html__('Event', 'event_espresso'),
-                            'value' => $event_name,
-                        ),
-                    ),
-                );
-        }
-        return array(
-            'data' => $export_items,
-            'done' => true,
-        );
-    }
+		$export_items = array();
+		foreach ($checkins as $checkin) {
+			$reg = $checkin->get_first_related('Registration');
+			if ($reg instanceof EE_Registration) {
+				$event_name = $reg->event_name();
+			} else {
+				$event_name = esc_html__('Unknown', 'event_espresso');
+			}
+			$export_items[] =
+				array(
+					'group_id'    => 'check-ins',
+					'group_label' => esc_html__('Event Check-Ins', 'event_espresso'),
+					'item_id'     => $checkin->ID(),
+					'data'        => array(
+						array(
+							'name'  => esc_html__('Time', 'event_espresso'),
+							'value' => $checkin->get_pretty('CHK_timestamp'),
+						),
+						array(
+							'name'  => esc_html__('Check in/out', 'event_espresso'),
+							'value' => $checkin->get('CHK_in')
+								? esc_html__('In', 'event_espresso')
+								: esc_html__('Out', 'event_espresso'),
+						),
+						array(
+							'name'  => esc_html__('Event', 'event_espresso'),
+							'value' => $event_name,
+						),
+					),
+				);
+		}
+		return array(
+			'data' => $export_items,
+			'done' => true,
+		);
+	}
 
-    /**
-     * Gets the Translated name of this exporter
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Checkins Exporter', 'event_espresso');
-    }
+	/**
+	 * Gets the Translated name of this exporter
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Checkins Exporter', 'event_espresso');
+	}
 }
 // End of file ExportCheckins.php
 // Location: EventEspresso\core\domain\services\admin\privacy\export/ExportCheckins.php