eventespresso / event-espresso-core

core/services/graphql/DataLoaderManager.php

Indentation +23 added lines, -23 removed lines

@@ -17,31 +17,31 @@
  */
 class DataLoaderManager implements GQLManagerInterface
 {
-    /**
-     * @var DataLoaderCollection|GQLDataDomainInterface[] $data_loaders
-     */
-    private $data_loaders;
+	/**
+	 * @var DataLoaderCollection|GQLDataDomainInterface[] $data_loaders
+	 */
+	private $data_loaders;
 
 
-    /**
-     * @param DataLoaderCollection|GQLDataDomainInterface[] $data_loaders
-     */
-    public function __construct(DataLoaderCollection $data_loaders)
-    {
-        $this->data_loaders = $data_loaders;
-    }
+	/**
+	 * @param DataLoaderCollection|GQLDataDomainInterface[] $data_loaders
+	 */
+	public function __construct(DataLoaderCollection $data_loaders)
+	{
+		$this->data_loaders = $data_loaders;
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since 5.0.0.p
-     */
-    public function init()
-    {
-        $data_loaders = $this->data_loaders->getDataLoaders();
-        foreach ($data_loaders as $data_loader) {
-            add_filter('graphql_data_loaders', [$data_loader, 'registerLoaders'], 10, 2);
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since 5.0.0.p
+	 */
+	public function init()
+	{
+		$data_loaders = $this->data_loaders->getDataLoaders();
+		foreach ($data_loaders as $data_loader) {
+			add_filter('graphql_data_loaders', [$data_loader, 'registerLoaders'], 10, 2);
+		}
+	}
 }

core/services/graphql/types/TypeBase.php

Indentation +266 added lines, -266 removed lines

@@ -34,270 +34,270 @@
  */
 abstract class TypeBase implements TypeInterface
 {
-    /**
-     * @var string $namespace The graphql namespace/prefix.
-     */
-    protected $namespace = 'Espresso';
-
-    /**
-     * @var EEM_Base $model
-     */
-    protected $model;
-
-    /**
-     * @var string $name
-     */
-    protected $name = '';
-
-    /**
-     * @var string $description
-     */
-    protected $description = '';
-
-    /**
-     * @var GraphQLFieldInterface[] $fields
-     */
-    protected $fields = [];
-
-    /**
-     * @var array $graphql_to_model_map
-     */
-    protected $graphql_to_model_map = [];
-
-    /**
-     * @var FieldResolver $field_resolver
-     */
-    protected $field_resolver;
-
-    /**
-     * @var bool $is_custom_post_type
-     */
-    protected $is_custom_post_type = false;
-
-
-    /**
-     * TypeBase constructor.
-     *
-     * @param EEM_Base|null $model
-     */
-    public function __construct(EEM_Base $model = null)
-    {
-        $this->model = $model;
-        $this->setFields($this->getFields());
-        $this->field_resolver = new FieldResolver(
-            $this->model,
-            $this->getFieldsForResolver()
-        );
-    }
-
-
-    /**
-     * @return GraphQLFieldInterface[]
-     * @since 5.0.0.p
-     */
-    abstract protected function getFields(): array;
-
-
-    /**
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * @param string $name
-     */
-    protected function setName(string $name)
-    {
-        $this->name = $name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description;
-    }
-
-
-    /**
-     * @param string $description
-     */
-    protected function setDescription(string $description)
-    {
-        $this->description = $description;
-    }
-
-
-    /**
-     * @return GraphQLFieldInterface[]
-     * @since 5.0.0.p
-     */
-    public function fields(): array
-    {
-        return (array) $this->fields;
-    }
-
-
-    /**
-     * @param GraphQLFieldInterface[] $fields
-     */
-    protected function setFields(array $fields)
-    {
-        foreach ($fields as $field) {
-            if ($field instanceof GraphQLField) {
-                $this->fields[] = $field;
-            }
-        }
-    }
-
-
-    /**
-     * Creates a key map for internal resolver.
-     *
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function getFieldsForResolver(): array
-    {
-        $fields = [];
-        foreach ($this->fields() as $field) {
-            if ($field->useForOutput()) {
-                $fields[ $field->name() ] = $field;
-            }
-        }
-        return $fields;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCustomPostType(): bool
-    {
-        return $this->is_custom_post_type;
-    }
-
-
-    /**
-     * @param bool $is_custom_post_type
-     */
-    protected function setIsCustomPostType(bool $is_custom_post_type)
-    {
-        $this->is_custom_post_type = filter_var($is_custom_post_type, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param int|float $value
-     * @return int
-     * @since 5.0.0.p
-     */
-    public function parseInfiniteValue($value): int
-    {
-        $value = trim($value);
-        return $value === null
-               || $value === ''
-               || $value === '∞'
-               || $value === 'INF'
-               || $value === INF
-               || $value === EE_INF
-               || is_infinite((float) $value)
-            ? -1
-            : $value;
-    }
-
-
-    /**
-     * @param mixed $source
-     * @return EE_Base_Class|null
-     * @throws EE_Error
-     */
-    private function getModel($source): ?EE_Base_Class
-    {
-        // If it comes from a custom connection
-        // where the $source is already instantiated.
-        if ($source instanceof EE_Base_Class) {
-            return $source;
-        }
-        return $source instanceof Post ? $this->model->get_one_by_ID($source->ID) : null;
-    }
-
-
-    /**
-     * @param mixed       $source  The source that's passed down the GraphQL queries
-     * @param array       $args    The inputArgs on the field
-     * @param AppContext  $context The AppContext passed down the GraphQL tree
-     * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
-     * @return EE_Base_Class|Deferred|string|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws UserError
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function resolveField($source, array $args, AppContext $context, ResolveInfo $info)
-    {
-        $source = $source instanceof RootQuery ? $source : $this->getModel($source);
-
-        return $this->field_resolver->resolve($source, $args, $context, $info);
-    }
-
-
-    /**
-     * @param mixed      $payload The payload returned after mutation
-     * @param array      $args    The inputArgs on the field
-     * @param AppContext $context The AppContext passed down the GraphQL tree
-     * @return EE_Base_Class|EE_Soft_Delete_Base_Class|null
-     * @throws EE_Error
-     */
-    public function resolveFromPayload($payload, array $args, AppContext $context)
-    {
-        if (empty($payload['id'])) {
-            return null;
-        }
-        return $this->model->get_one_by_ID($payload['id']);
-    }
-
-
-    /**
-     * Prepares a datetime value in ISO8601/RFC3339 format.
-     * It is assumed that the value of $datetime is in the format
-     * returned by EE_Base_Class::get_format().
-     *
-     * @param string        $datetime The datetime value.
-     * @param EE_Base_Class $source   The source object.
-     * @return string ISO8601/RFC3339 formatted datetime.
-     */
-    public function formatDatetime(string $datetime, EE_Base_Class $source): string
-    {
-        $format   = $source->get_format();
-        // create date object based on local timezone
-        $datetime = DateTime::createFromFormat($format, $datetime, new DateTimeZone($source->get_timezone()));
-        // change the timezone to UTC
-        $datetime->setTimezone(new DateTimeZone('UTC'));
-
-        return $datetime->format(DateTime::RFC3339);
-    }
-
-
-    /**
-     * Converts an object to JSON. The object must have a "toJson" method.
-     *
-     * @param string        $object   The object/value.
-     * @param EE_Base_Class $source   The source object.
-     * @return string JSON representation of the object.
-     */
-    public function toJson(JsonableInterface $object, EE_Base_Class $source): string
-    {
-        return $object->toJson();
-    }
+	/**
+	 * @var string $namespace The graphql namespace/prefix.
+	 */
+	protected $namespace = 'Espresso';
+
+	/**
+	 * @var EEM_Base $model
+	 */
+	protected $model;
+
+	/**
+	 * @var string $name
+	 */
+	protected $name = '';
+
+	/**
+	 * @var string $description
+	 */
+	protected $description = '';
+
+	/**
+	 * @var GraphQLFieldInterface[] $fields
+	 */
+	protected $fields = [];
+
+	/**
+	 * @var array $graphql_to_model_map
+	 */
+	protected $graphql_to_model_map = [];
+
+	/**
+	 * @var FieldResolver $field_resolver
+	 */
+	protected $field_resolver;
+
+	/**
+	 * @var bool $is_custom_post_type
+	 */
+	protected $is_custom_post_type = false;
+
+
+	/**
+	 * TypeBase constructor.
+	 *
+	 * @param EEM_Base|null $model
+	 */
+	public function __construct(EEM_Base $model = null)
+	{
+		$this->model = $model;
+		$this->setFields($this->getFields());
+		$this->field_resolver = new FieldResolver(
+			$this->model,
+			$this->getFieldsForResolver()
+		);
+	}
+
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 * @since 5.0.0.p
+	 */
+	abstract protected function getFields(): array;
+
+
+	/**
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	protected function setName(string $name)
+	{
+		$this->name = $name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description;
+	}
+
+
+	/**
+	 * @param string $description
+	 */
+	protected function setDescription(string $description)
+	{
+		$this->description = $description;
+	}
+
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 * @since 5.0.0.p
+	 */
+	public function fields(): array
+	{
+		return (array) $this->fields;
+	}
+
+
+	/**
+	 * @param GraphQLFieldInterface[] $fields
+	 */
+	protected function setFields(array $fields)
+	{
+		foreach ($fields as $field) {
+			if ($field instanceof GraphQLField) {
+				$this->fields[] = $field;
+			}
+		}
+	}
+
+
+	/**
+	 * Creates a key map for internal resolver.
+	 *
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function getFieldsForResolver(): array
+	{
+		$fields = [];
+		foreach ($this->fields() as $field) {
+			if ($field->useForOutput()) {
+				$fields[ $field->name() ] = $field;
+			}
+		}
+		return $fields;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCustomPostType(): bool
+	{
+		return $this->is_custom_post_type;
+	}
+
+
+	/**
+	 * @param bool $is_custom_post_type
+	 */
+	protected function setIsCustomPostType(bool $is_custom_post_type)
+	{
+		$this->is_custom_post_type = filter_var($is_custom_post_type, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param int|float $value
+	 * @return int
+	 * @since 5.0.0.p
+	 */
+	public function parseInfiniteValue($value): int
+	{
+		$value = trim($value);
+		return $value === null
+			   || $value === ''
+			   || $value === '∞'
+			   || $value === 'INF'
+			   || $value === INF
+			   || $value === EE_INF
+			   || is_infinite((float) $value)
+			? -1
+			: $value;
+	}
+
+
+	/**
+	 * @param mixed $source
+	 * @return EE_Base_Class|null
+	 * @throws EE_Error
+	 */
+	private function getModel($source): ?EE_Base_Class
+	{
+		// If it comes from a custom connection
+		// where the $source is already instantiated.
+		if ($source instanceof EE_Base_Class) {
+			return $source;
+		}
+		return $source instanceof Post ? $this->model->get_one_by_ID($source->ID) : null;
+	}
+
+
+	/**
+	 * @param mixed       $source  The source that's passed down the GraphQL queries
+	 * @param array       $args    The inputArgs on the field
+	 * @param AppContext  $context The AppContext passed down the GraphQL tree
+	 * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
+	 * @return EE_Base_Class|Deferred|string|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws UserError
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function resolveField($source, array $args, AppContext $context, ResolveInfo $info)
+	{
+		$source = $source instanceof RootQuery ? $source : $this->getModel($source);
+
+		return $this->field_resolver->resolve($source, $args, $context, $info);
+	}
+
+
+	/**
+	 * @param mixed      $payload The payload returned after mutation
+	 * @param array      $args    The inputArgs on the field
+	 * @param AppContext $context The AppContext passed down the GraphQL tree
+	 * @return EE_Base_Class|EE_Soft_Delete_Base_Class|null
+	 * @throws EE_Error
+	 */
+	public function resolveFromPayload($payload, array $args, AppContext $context)
+	{
+		if (empty($payload['id'])) {
+			return null;
+		}
+		return $this->model->get_one_by_ID($payload['id']);
+	}
+
+
+	/**
+	 * Prepares a datetime value in ISO8601/RFC3339 format.
+	 * It is assumed that the value of $datetime is in the format
+	 * returned by EE_Base_Class::get_format().
+	 *
+	 * @param string        $datetime The datetime value.
+	 * @param EE_Base_Class $source   The source object.
+	 * @return string ISO8601/RFC3339 formatted datetime.
+	 */
+	public function formatDatetime(string $datetime, EE_Base_Class $source): string
+	{
+		$format   = $source->get_format();
+		// create date object based on local timezone
+		$datetime = DateTime::createFromFormat($format, $datetime, new DateTimeZone($source->get_timezone()));
+		// change the timezone to UTC
+		$datetime->setTimezone(new DateTimeZone('UTC'));
+
+		return $datetime->format(DateTime::RFC3339);
+	}
+
+
+	/**
+	 * Converts an object to JSON. The object must have a "toJson" method.
+	 *
+	 * @param string        $object   The object/value.
+	 * @param EE_Base_Class $source   The source object.
+	 * @return string JSON representation of the object.
+	 */
+	public function toJson(JsonableInterface $object, EE_Base_Class $source): string
+	{
+		return $object->toJson();
+	}
 }

core/services/graphql/types/TypeCollection.php

Indentation +75 added lines, -75 removed lines

@@ -20,89 +20,89 @@
  */
 class TypeCollection extends Collection
 {
-    const COLLECTION_NAME = 'espresso_graphql_types';
+	const COLLECTION_NAME = 'espresso_graphql_types';
 
-    const COLLECTION_INTERFACE = 'EventEspresso\core\services\graphql\types\TypeInterface';
+	const COLLECTION_INTERFACE = 'EventEspresso\core\services\graphql\types\TypeInterface';
 
-    /**
-     * @var CollectionLoader $loader
-     */
-    protected $loader;
+	/**
+	 * @var CollectionLoader $loader
+	 */
+	protected $loader;
 
 
-    /**
-     * TypeCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            TypeCollection::COLLECTION_INTERFACE,
-            TypeCollection::COLLECTION_NAME
-        );
-    }
+	/**
+	 * TypeCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			TypeCollection::COLLECTION_INTERFACE,
+			TypeCollection::COLLECTION_NAME
+		);
+	}
 
 
-    /**
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since 5.0.0.p
-     */
-    private function loadCollection()
-    {
-        if (! $this->loader instanceof CollectionLoader) {
-            $this->loader = new CollectionLoader(
-                new CollectionDetails(
-                    // collection name
-                    TypeCollection::COLLECTION_NAME,
-                    // collection interface
-                    TypeCollection::COLLECTION_INTERFACE,
-                    // FQCNs for classes to add (all classes within each namespace will be loaded)
-                    apply_filters(
-                        'FHEE__EventEspresso_core_services_graphql_TypeCollection__loadCollection__collection_FQCNs',
-                        ['EventEspresso\core\domain\services\graphql\types']
-                    ),
-                    // filepaths to classes to add
-                    array(),
-                    // file mask to use if parsing folder for files to add
-                    '',
-                    // what to use as identifier for collection entities
-                    // using CLASS NAME prevents duplicates (works like a singleton)
-                    CollectionDetails::ID_CLASS_NAME
-                ),
-                $this
-            );
-        }
-    }
+	/**
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since 5.0.0.p
+	 */
+	private function loadCollection()
+	{
+		if (! $this->loader instanceof CollectionLoader) {
+			$this->loader = new CollectionLoader(
+				new CollectionDetails(
+					// collection name
+					TypeCollection::COLLECTION_NAME,
+					// collection interface
+					TypeCollection::COLLECTION_INTERFACE,
+					// FQCNs for classes to add (all classes within each namespace will be loaded)
+					apply_filters(
+						'FHEE__EventEspresso_core_services_graphql_TypeCollection__loadCollection__collection_FQCNs',
+						['EventEspresso\core\domain\services\graphql\types']
+					),
+					// filepaths to classes to add
+					array(),
+					// file mask to use if parsing folder for files to add
+					'',
+					// what to use as identifier for collection entities
+					// using CLASS NAME prevents duplicates (works like a singleton)
+					CollectionDetails::ID_CLASS_NAME
+				),
+				$this
+			);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     * @throws CollectionDetailsException
-     * @throws CollectionLoaderException
-     * @since 5.0.0.p
-     */
-    public function loadTypes()
-    {
-        $this->loadCollection();
-        return $this->loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface
+	 * @throws CollectionDetailsException
+	 * @throws CollectionLoaderException
+	 * @since 5.0.0.p
+	 */
+	public function loadTypes()
+	{
+		$this->loadCollection();
+		return $this->loader->getCollection();
+	}
 
 
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param mixed  $identifier
-     * @return bool
-     */
-    public function getIdentifier($object, $identifier = null)
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param mixed  $identifier
+	 * @return bool
+	 */
+	public function getIdentifier($object, $identifier = null)
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

core/services/graphql/types/TypeInterface.php

Indentation +75 added lines, -75 removed lines

@@ -23,79 +23,79 @@
  */
 interface TypeInterface
 {
-    /**
-     * @return string
-     */
-    public function name(): string;
-
-
-    /**
-     * @return string
-     */
-    public function description(): string;
-
-
-    /**
-     * @return GraphQLFieldInterface[]
-     * @since 5.0.0.p
-     */
-    public function fields(): array;
-
-
-    /**
-     * Creates a key map for internal resolver.
-     *
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function getFieldsForResolver(): array;
-
-
-    /**
-     * @return bool
-     */
-    public function isCustomPostType(): bool;
-
-
-    /**
-     * @param int|float $value
-     * @return int
-     * @since 5.0.0.p
-     */
-    public function parseInfiniteValue($value): int;
-
-
-    /**
-     * @param mixed       $source  The source that's passed down the GraphQL queries
-     * @param array       $args    The inputArgs on the field
-     * @param AppContext  $context The AppContext passed down the GraphQL tree
-     * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
-     * @return mixed
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws UserError
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function resolveField($source, array $args, AppContext $context, ResolveInfo $info);
-
-
-    /**
-     * @param mixed      $payload The payload returned after mutation
-     * @param array      $args    The inputArgs on the field
-     * @param AppContext $context The AppContext passed down the GraphQL tree
-     * @return string|null
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws UserError
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function resolveFromPayload($payload, array $args, AppContext $context);
+	/**
+	 * @return string
+	 */
+	public function name(): string;
+
+
+	/**
+	 * @return string
+	 */
+	public function description(): string;
+
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 * @since 5.0.0.p
+	 */
+	public function fields(): array;
+
+
+	/**
+	 * Creates a key map for internal resolver.
+	 *
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function getFieldsForResolver(): array;
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCustomPostType(): bool;
+
+
+	/**
+	 * @param int|float $value
+	 * @return int
+	 * @since 5.0.0.p
+	 */
+	public function parseInfiniteValue($value): int;
+
+
+	/**
+	 * @param mixed       $source  The source that's passed down the GraphQL queries
+	 * @param array       $args    The inputArgs on the field
+	 * @param AppContext  $context The AppContext passed down the GraphQL tree
+	 * @param ResolveInfo $info    The ResolveInfo passed down the GraphQL tree
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws UserError
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function resolveField($source, array $args, AppContext $context, ResolveInfo $info);
+
+
+	/**
+	 * @param mixed      $payload The payload returned after mutation
+	 * @param array      $args    The inputArgs on the field
+	 * @param AppContext $context The AppContext passed down the GraphQL tree
+	 * @return string|null
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws UserError
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function resolveFromPayload($payload, array $args, AppContext $context);
 }

core/services/database/WordPressOption.php

Indentation +177 added lines, -177 removed lines

@@ -17,181 +17,181 @@
  */
 abstract class WordPressOption
 {
-    public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
-
-    /**
-     * WordPress makes it difficult to determine if an option successfully saved or not,
-     * which is sometimes really important to know, especially if the information you are saving is critical.
-     * The following options allow us to have a better chance of knowing when an update actually failed
-     * or when everything is OK but it just didn't update because the value hasn't changed.
-     */
-    public const UPDATE_SUCCESS = 1;
-
-    public const UPDATE_NONE = 0;
-
-    public const UPDATE_ERROR = -1;
-
-    /**
-     * @var bool
-     */
-    private $autoload = false;
-
-    /**
-     * @var mixed
-     */
-    private $default_value = null;
-
-    /**
-     * @var string
-     */
-    private $option_name = '';
-
-    /**
-     * @var mixed
-     */
-    private $value = WordPressOption::NOT_SET_YET;
-
-    /**
-     * @var OptionEngine
-     */
-    private $option_engine;
-
-
-    /**
-     * WordPressOption constructor.
-     *
-     * @param string $option_name
-     * @param mixed  $default_value
-     * @param bool   $autoload              if true, will load the option on EVERY request
-     * @param bool   $is_network_option     if true, will save the option to the network as opposed to the current blog
-     */
-    public function __construct(
-        string $option_name,
-        $default_value,
-        bool $autoload = false,
-        bool $is_network_option = false
-    ) {
-        $this->setAutoload($autoload);
-        $this->setDefaultValue($default_value);
-        $this->setOptionName($option_name);
-        $this->option_engine = new OptionEngine($is_network_option);
-    }
-
-
-    /**
-     * @param bool|string $autoload
-     */
-    public function setAutoload($autoload): void
-    {
-        $this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param mixed $default_value
-     */
-    public function setDefaultValue($default_value): void
-    {
-        $this->default_value = $default_value;
-    }
-
-
-    /**
-     * @param string $option_name
-     */
-    public function setOptionName(string $option_name): void
-    {
-        $this->option_name = sanitize_key($option_name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function optionExists(): string
-    {
-        return $this->option_engine->getOption(
-            $this->getOptionName(),
-            WordPressOption::NOT_SET_YET
-        ) !== WordPressOption::NOT_SET_YET;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getOptionName(): string
-    {
-        return $this->option_name;
-    }
-
-
-    /**
-     * @return false|mixed|void
-     */
-    public function loadOption()
-    {
-        if ($this->value === WordPressOption::NOT_SET_YET) {
-            $this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
-        }
-        return $this->value;
-    }
-
-
-    /**
-     * @param $value
-     * @return int
-     */
-    public function updateOption($value): int
-    {
-        // don't update if value has not changed since last update
-        if ($this->valueIsUnchanged($value)) {
-            return WordPressOption::UPDATE_NONE;
-        }
-        $this->value = $value;
-        // because the options for updating differ when adding an option for the first time
-        // we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
-        $updated = $this->optionExists()
-            ? $this->option_engine->updateOption($this->getOptionName(), $this->value)
-            : $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
-
-        if ($updated) {
-            return WordPressOption::UPDATE_SUCCESS;
-        }
-        return WordPressOption::UPDATE_ERROR;
-    }
-
-
-    private function valueIsUnchanged($value): bool
-    {
-        if (is_array($value) && is_array($this->value)) {
-            $diff = EEH_Array::array_diff_recursive($value, $this->value);
-            // $diff = array_diff($value, $this->value);
-            return empty($diff);
-        }
-        // emulate WP's method for checking equality
-        return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
-    }
-
-
-    /**
-     * @return string
-     */
-    private function autoload(): string
-    {
-        return $this->autoload ? 'yes' : 'no';
-    }
-
-
-    /**
-     * Deletes the option from the database
-     * for the rest of the request
-     *
-     * @return bool
-     * @since  5.0.0.p
-     */
-    public function deleteOption(): bool
-    {
-        return $this->option_engine->deleteOption($this->getOptionName());
-    }
+	public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
+
+	/**
+	 * WordPress makes it difficult to determine if an option successfully saved or not,
+	 * which is sometimes really important to know, especially if the information you are saving is critical.
+	 * The following options allow us to have a better chance of knowing when an update actually failed
+	 * or when everything is OK but it just didn't update because the value hasn't changed.
+	 */
+	public const UPDATE_SUCCESS = 1;
+
+	public const UPDATE_NONE = 0;
+
+	public const UPDATE_ERROR = -1;
+
+	/**
+	 * @var bool
+	 */
+	private $autoload = false;
+
+	/**
+	 * @var mixed
+	 */
+	private $default_value = null;
+
+	/**
+	 * @var string
+	 */
+	private $option_name = '';
+
+	/**
+	 * @var mixed
+	 */
+	private $value = WordPressOption::NOT_SET_YET;
+
+	/**
+	 * @var OptionEngine
+	 */
+	private $option_engine;
+
+
+	/**
+	 * WordPressOption constructor.
+	 *
+	 * @param string $option_name
+	 * @param mixed  $default_value
+	 * @param bool   $autoload              if true, will load the option on EVERY request
+	 * @param bool   $is_network_option     if true, will save the option to the network as opposed to the current blog
+	 */
+	public function __construct(
+		string $option_name,
+		$default_value,
+		bool $autoload = false,
+		bool $is_network_option = false
+	) {
+		$this->setAutoload($autoload);
+		$this->setDefaultValue($default_value);
+		$this->setOptionName($option_name);
+		$this->option_engine = new OptionEngine($is_network_option);
+	}
+
+
+	/**
+	 * @param bool|string $autoload
+	 */
+	public function setAutoload($autoload): void
+	{
+		$this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param mixed $default_value
+	 */
+	public function setDefaultValue($default_value): void
+	{
+		$this->default_value = $default_value;
+	}
+
+
+	/**
+	 * @param string $option_name
+	 */
+	public function setOptionName(string $option_name): void
+	{
+		$this->option_name = sanitize_key($option_name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function optionExists(): string
+	{
+		return $this->option_engine->getOption(
+			$this->getOptionName(),
+			WordPressOption::NOT_SET_YET
+		) !== WordPressOption::NOT_SET_YET;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getOptionName(): string
+	{
+		return $this->option_name;
+	}
+
+
+	/**
+	 * @return false|mixed|void
+	 */
+	public function loadOption()
+	{
+		if ($this->value === WordPressOption::NOT_SET_YET) {
+			$this->value = $this->option_engine->getOption($this->getOptionName(), $this->default_value);
+		}
+		return $this->value;
+	}
+
+
+	/**
+	 * @param $value
+	 * @return int
+	 */
+	public function updateOption($value): int
+	{
+		// don't update if value has not changed since last update
+		if ($this->valueIsUnchanged($value)) {
+			return WordPressOption::UPDATE_NONE;
+		}
+		$this->value = $value;
+		// because the options for updating differ when adding an option for the first time
+		// we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
+		$updated = $this->optionExists()
+			? $this->option_engine->updateOption($this->getOptionName(), $this->value)
+			: $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
+
+		if ($updated) {
+			return WordPressOption::UPDATE_SUCCESS;
+		}
+		return WordPressOption::UPDATE_ERROR;
+	}
+
+
+	private function valueIsUnchanged($value): bool
+	{
+		if (is_array($value) && is_array($this->value)) {
+			$diff = EEH_Array::array_diff_recursive($value, $this->value);
+			// $diff = array_diff($value, $this->value);
+			return empty($diff);
+		}
+		// emulate WP's method for checking equality
+		return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	private function autoload(): string
+	{
+		return $this->autoload ? 'yes' : 'no';
+	}
+
+
+	/**
+	 * Deletes the option from the database
+	 * for the rest of the request
+	 *
+	 * @return bool
+	 * @since  5.0.0.p
+	 */
+	public function deleteOption(): bool
+	{
+		return $this->option_engine->deleteOption($this->getOptionName());
+	}
 }

core/services/i18n/LegacyTextDomainOptions.php

Indentation +45 added lines, -45 removed lines

@@ -14,53 +14,53 @@
  */
 class LegacyTextDomainOptions
 {
-    /**
-     * @var LoadedTextDomains
-     */
-    private $loaded_text_domains;
+	/**
+	 * @var LoadedTextDomains
+	 */
+	private $loaded_text_domains;
 
 
-    /**
-     * @param LoadedTextDomains|null $loaded_text_domains
-     */
-    public function __construct(?LoadedTextDomains $loaded_text_domains = null)
-    {
-        $this->loaded_text_domains = $loaded_text_domains ?? new LoadedTextDomains();
-    }
+	/**
+	 * @param LoadedTextDomains|null $loaded_text_domains
+	 */
+	public function __construct(?LoadedTextDomains $loaded_text_domains = null)
+	{
+		$this->loaded_text_domains = $loaded_text_domains ?? new LoadedTextDomains();
+	}
 
 
-    /**
-     * attempts to collect all of the ee_lang_check_* options stored in the database
-     * and add them to one single option handled by EventEspresso\core\services\i18n\LoadedTextDomains
-     *
-     * @since   5.0.0.p
-     */
-    public function convertToConsolidatedFormat()
-    {
-        $options = wp_load_alloptions();
-        foreach ($options as $slug => $values) {
-            if (strpos($slug, 'ee_lang_check_') === 0) {
-                // convert something like "ee_lang_check_en_CA_4.10.39.rc.018" to 'en_CA_4.10.39.rc.018'
-                $locale_version = str_replace('ee_lang_check_', '', $slug);
-                // split 'en_CA_4.10.39.rc.018' into [ 'en', 'CA', '4.10.39.rc.018' ]
-                $locale_version = explode('_', $locale_version);
-                $locale         = null;
-                $version        = null;
-                switch (count($locale_version)) {
-                    case 3:
-                        $locale  = "$locale_version[0]_$locale_version[1]";
-                        $version = $locale_version[2];
-                        break;
-                    case 2:
-                        $locale  = $locale_version[0];
-                        $version = $locale_version[1];
-                        break;
-                }
-                if ($locale && $version) {
-                    $this->loaded_text_domains->versionLoaded($locale, $version);
-                    delete_option($slug);
-                }
-            }
-        }
-    }
+	/**
+	 * attempts to collect all of the ee_lang_check_* options stored in the database
+	 * and add them to one single option handled by EventEspresso\core\services\i18n\LoadedTextDomains
+	 *
+	 * @since   5.0.0.p
+	 */
+	public function convertToConsolidatedFormat()
+	{
+		$options = wp_load_alloptions();
+		foreach ($options as $slug => $values) {
+			if (strpos($slug, 'ee_lang_check_') === 0) {
+				// convert something like "ee_lang_check_en_CA_4.10.39.rc.018" to 'en_CA_4.10.39.rc.018'
+				$locale_version = str_replace('ee_lang_check_', '', $slug);
+				// split 'en_CA_4.10.39.rc.018' into [ 'en', 'CA', '4.10.39.rc.018' ]
+				$locale_version = explode('_', $locale_version);
+				$locale         = null;
+				$version        = null;
+				switch (count($locale_version)) {
+					case 3:
+						$locale  = "$locale_version[0]_$locale_version[1]";
+						$version = $locale_version[2];
+						break;
+					case 2:
+						$locale  = $locale_version[0];
+						$version = $locale_version[1];
+						break;
+				}
+				if ($locale && $version) {
+					$this->loaded_text_domains->versionLoaded($locale, $version);
+					delete_option($slug);
+				}
+			}
+		}
+	}
 }

core/services/assets/AssetManager.php

Indentation +323 added lines, -323 removed lines

@@ -23,332 +23,332 @@
 abstract class AssetManager implements AssetManagerInterface
 {
 
-    /**
-     * @var AssetCollection|Asset[] $assets
-     */
-    protected $assets;
-
-    /**
-     * @var DomainInterface
-     */
-    protected $domain;
-
-    /**
-     * @var Registry $registry
-     */
-    protected $registry;
-
-
-    /**
-     * AssetRegister constructor.
-     *
-     * @param DomainInterface $domain
-     * @param AssetCollection $assets
-     * @param Registry        $registry
-     */
-    public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
-    {
-        $this->domain = $domain;
-        $this->assets = $assets;
-        $this->registry = $registry;
-        $this->registry->addAssetCollection($assets);
-        add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
-        add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
-    }
-
-
-    /**
-     * @return AssetCollection
-     */
-    public function getAssets()
-    {
-        return $this->assets;
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @return string
-     */
-    public function assetNamespace()
-    {
-        return $this->domain->assetNamespace();
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @param string $version
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function addJavascript(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $load_in_footer = true,
-        $version = ''
-    ) {
-        $asset = new JavascriptAsset(
-            $handle,
-            $source,
-            array_unique($dependencies),
-            $load_in_footer,
-            $this->domain,
-            $version
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * Used to register a javascript asset where everything is dynamically derived from the given handle.
-     *
-     * @param string       $handle
-     * @param string|array $extra_dependencies
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     */
-    public function addJs($handle, $extra_dependencies = [])
-    {
-        $details = $this->getAssetDetails(
-            Asset::TYPE_JS,
-            $handle,
-            $extra_dependencies
-        );
-        $source = $this->registry->getJsUrl($this->domain->assetNamespace(), $handle);
-        return $this->addJavascript(
-            $handle,
-            $source,
-            $details['dependencies'],
-            true,
-            $details['version']
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @param string $version
-     * @return JavascriptAsset
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.71.p
-     */
-    public function addVendorJavascript(
-        $handle,
-        array $dependencies = array(),
-        $load_in_footer = true,
-        $version = ''
-    ) {
-        $dev_suffix = wp_scripts_get_suffix('dev');
-        $vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
-        return $this->addJavascript(
-            $handle,
-            "{$vendor_path}{$handle}{$dev_suffix}". Asset::EXT_JS,
-            $dependencies,
-            $load_in_footer,
-            $version
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param string $media
-     * @param string $version
-     * @return StylesheetAsset
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addStylesheet(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $media = 'all',
-        $version = ''
-    ) {
-        $asset = new StylesheetAsset(
-            $handle,
-            $source,
-            array_unique($dependencies),
-            $this->domain,
-            $media,
-            $version
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * Used to register a css asset where everything is dynamically derived from the given handle.
-     *
-     * @param string       $handle
-     * @param string|array $extra_dependencies
-     * @return StylesheetAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     */
-    public function addCss($handle, $extra_dependencies = [])
-    {
-        $details = $this->getAssetDetails(
-            Asset::TYPE_CSS,
-            $handle,
-            $extra_dependencies
-        );
-        return $this->addStylesheet(
-            $handle,
-            $this->registry->getCssUrl($this->domain->assetNamespace(), $handle),
-            $details['dependencies'],
-            'all',
-            $details['version']
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @since 4.9.62.p
-     */
-    public function enqueueAsset($handle)
-    {
-        if ($this->assets->has($handle)) {
-            /** @var Asset $asset */
-            $asset = $this->assets->get($handle);
-            if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
-                $asset->enqueueAsset();
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @return  void
-     * @since   5.0.0.p
-     */
-    public function enqueueBrowserAssets()
-    {
-        foreach ($this->assets as $asset) {
-            if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
-                $asset->enqueueAsset();
-            }
-        }
-    }
-
-
-    /**
-     * @param string $asset_type
-     * @param string $handle
-     * @param array  $extra_dependencies
-     * @return array
-     * @since 4.10.2.p
-     */
-    private function getAssetDetails($asset_type, $handle, $extra_dependencies = [])
-    {
-        $getAssetDetails = '';
-        switch ($asset_type) {
-            case Asset::TYPE_JS :
-                $getAssetDetails = 'getJsAssetDetails';
-                break;
-            case Asset::TYPE_CSS :
-                $getAssetDetails = 'getCssAssetDetails';
-                break;
-        }
-        if ($getAssetDetails === '') {
-            return ['dependencies' => [], 'version' => ''];
-        }
-        $details = $this->registry->$getAssetDetails(
-            $this->domain->assetNamespace(),
-            $handle
-        );
-        $details['dependencies'] = isset($details['dependencies'])
-            ? $details['dependencies']
-            : [];
-        $details['version'] = isset($details['version'])
-            ? $details['version']
-            : '';
-        $details['dependencies'] = ! empty($extra_dependencies)
-            ? array_merge($details['dependencies'], (array) $extra_dependencies)
-            : $details['dependencies'];
-        return $details;
-
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @throws DomainException
-     */
-    public function verifyAssetIsRegistered($handle)
-    {
-        if (wp_script_is($handle, 'registered')) {
-            return true;
-        }
-        if (WP_DEBUG) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" script is not registered when it should be!%2$s
+	/**
+	 * @var AssetCollection|Asset[] $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var DomainInterface
+	 */
+	protected $domain;
+
+	/**
+	 * @var Registry $registry
+	 */
+	protected $registry;
+
+
+	/**
+	 * AssetRegister constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @param AssetCollection $assets
+	 * @param Registry        $registry
+	 */
+	public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
+	{
+		$this->domain = $domain;
+		$this->assets = $assets;
+		$this->registry = $registry;
+		$this->registry->addAssetCollection($assets);
+		add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
+		add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
+	}
+
+
+	/**
+	 * @return AssetCollection
+	 */
+	public function getAssets()
+	{
+		return $this->assets;
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @return string
+	 */
+	public function assetNamespace()
+	{
+		return $this->domain->assetNamespace();
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @param string $version
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascript(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$load_in_footer = true,
+		$version = ''
+	) {
+		$asset = new JavascriptAsset(
+			$handle,
+			$source,
+			array_unique($dependencies),
+			$load_in_footer,
+			$this->domain,
+			$version
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * Used to register a javascript asset where everything is dynamically derived from the given handle.
+	 *
+	 * @param string       $handle
+	 * @param string|array $extra_dependencies
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 */
+	public function addJs($handle, $extra_dependencies = [])
+	{
+		$details = $this->getAssetDetails(
+			Asset::TYPE_JS,
+			$handle,
+			$extra_dependencies
+		);
+		$source = $this->registry->getJsUrl($this->domain->assetNamespace(), $handle);
+		return $this->addJavascript(
+			$handle,
+			$source,
+			$details['dependencies'],
+			true,
+			$details['version']
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @param string $version
+	 * @return JavascriptAsset
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.71.p
+	 */
+	public function addVendorJavascript(
+		$handle,
+		array $dependencies = array(),
+		$load_in_footer = true,
+		$version = ''
+	) {
+		$dev_suffix = wp_scripts_get_suffix('dev');
+		$vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
+		return $this->addJavascript(
+			$handle,
+			"{$vendor_path}{$handle}{$dev_suffix}". Asset::EXT_JS,
+			$dependencies,
+			$load_in_footer,
+			$version
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param string $media
+	 * @param string $version
+	 * @return StylesheetAsset
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheet(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$media = 'all',
+		$version = ''
+	) {
+		$asset = new StylesheetAsset(
+			$handle,
+			$source,
+			array_unique($dependencies),
+			$this->domain,
+			$media,
+			$version
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * Used to register a css asset where everything is dynamically derived from the given handle.
+	 *
+	 * @param string       $handle
+	 * @param string|array $extra_dependencies
+	 * @return StylesheetAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 */
+	public function addCss($handle, $extra_dependencies = [])
+	{
+		$details = $this->getAssetDetails(
+			Asset::TYPE_CSS,
+			$handle,
+			$extra_dependencies
+		);
+		return $this->addStylesheet(
+			$handle,
+			$this->registry->getCssUrl($this->domain->assetNamespace(), $handle),
+			$details['dependencies'],
+			'all',
+			$details['version']
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @since 4.9.62.p
+	 */
+	public function enqueueAsset($handle)
+	{
+		if ($this->assets->has($handle)) {
+			/** @var Asset $asset */
+			$asset = $this->assets->get($handle);
+			if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
+				$asset->enqueueAsset();
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @return  void
+	 * @since   5.0.0.p
+	 */
+	public function enqueueBrowserAssets()
+	{
+		foreach ($this->assets as $asset) {
+			if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
+				$asset->enqueueAsset();
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $asset_type
+	 * @param string $handle
+	 * @param array  $extra_dependencies
+	 * @return array
+	 * @since 4.10.2.p
+	 */
+	private function getAssetDetails($asset_type, $handle, $extra_dependencies = [])
+	{
+		$getAssetDetails = '';
+		switch ($asset_type) {
+			case Asset::TYPE_JS :
+				$getAssetDetails = 'getJsAssetDetails';
+				break;
+			case Asset::TYPE_CSS :
+				$getAssetDetails = 'getCssAssetDetails';
+				break;
+		}
+		if ($getAssetDetails === '') {
+			return ['dependencies' => [], 'version' => ''];
+		}
+		$details = $this->registry->$getAssetDetails(
+			$this->domain->assetNamespace(),
+			$handle
+		);
+		$details['dependencies'] = isset($details['dependencies'])
+			? $details['dependencies']
+			: [];
+		$details['version'] = isset($details['version'])
+			? $details['version']
+			: '';
+		$details['dependencies'] = ! empty($extra_dependencies)
+			? array_merge($details['dependencies'], (array) $extra_dependencies)
+			: $details['dependencies'];
+		return $details;
+
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function verifyAssetIsRegistered($handle)
+	{
+		if (wp_script_is($handle, 'registered')) {
+			return true;
+		}
+		if (WP_DEBUG) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" script is not registered when it should be!%2$s
                         Are you running the Barista plugin for development purposes? 
                         If so, then you need to build the appropriate assets for this domain.%2$s
                         If you are seeing this error on a live website, then you should not have 
                         the WP_DEBUG constant in your wp-config.php file set to "true". 
                         Please contact Event Espresso support for more information.',
-                        'event_espresso'
-                    ),
-                    $handle,
-                    '<br />'
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**************** deprecated ****************/
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public function addManifestFile()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public function getManifestFile()
-    {
-    }
+						'event_espresso'
+					),
+					$handle,
+					'<br />'
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**************** deprecated ****************/
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public function addManifestFile()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public function getManifestFile()
+	{
+	}
 }

core/services/assets/I18nRegistry.php

Indentation +38 added lines, -38 removed lines

@@ -13,46 +13,46 @@
  */
 class I18nRegistry
 {
-    /**
-     * @var DomainInterface
-     */
-    private $domain;
+	/**
+	 * @var DomainInterface
+	 */
+	private $domain;
 
-    /**
-     * @var JedLocaleData $jed_locale
-     */
-    private $jed_locale;
+	/**
+	 * @var JedLocaleData $jed_locale
+	 */
+	private $jed_locale;
 
-    /**
-     * I18nRegistry constructor.
-     *
-     * @param DomainInterface $domain
-     * @param JedLocaleData $jed_locale
-     * @param array() $i18n_map
-     * @deprecated 5.0.0.p
-     */
-    public function __construct(DomainInterface $domain, JedLocaleData $jed_locale, array $i18n_map = [])
-    {
-        $this->domain = $domain;
-        $this->jed_locale = $jed_locale;
-    }
+	/**
+	 * I18nRegistry constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @param JedLocaleData $jed_locale
+	 * @param array() $i18n_map
+	 * @deprecated 5.0.0.p
+	 */
+	public function __construct(DomainInterface $domain, JedLocaleData $jed_locale, array $i18n_map = [])
+	{
+		$this->domain = $domain;
+		$this->jed_locale = $jed_locale;
+	}
 
-    /**
-     * @param string $handle The script handle reference.
-     * @param string $domain The i18n domain for the strings.
-     * @deprecated 5.0.0.p
-     */
-    public function registerScriptI18n(string $handle, string $domain = Domain::TEXT_DOMAIN)
-    {
-    }
+	/**
+	 * @param string $handle The script handle reference.
+	 * @param string $domain The i18n domain for the strings.
+	 * @deprecated 5.0.0.p
+	 */
+	public function registerScriptI18n(string $handle, string $domain = Domain::TEXT_DOMAIN)
+	{
+	}
 
-    /**
-     * @param array $handles Array of registered script handles.
-     * @return array
-     * @deprecated 5.0.0.p
-     */
-    public function queueI18n(array $handles): array
-    {
-        return $handles;
-    }
+	/**
+	 * @param array $handles Array of registered script handles.
+	 * @return array
+	 * @deprecated 5.0.0.p
+	 */
+	public function queueI18n(array $handles): array
+	{
+		return $handles;
+	}
 }

core/services/assets/Registry.php

Indentation +570 added lines, -570 removed lines

@@ -25,581 +25,581 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection[] $assets
-     */
-    protected $assets = [];
-
-    /**
-     * @var AssetManifestInterface
-     */
-    private $asset_manifest;
-
-    /**
-     * This holds the js_data data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $js_data = [];
-
-    /**
-     * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
-     * page source.
-     *
-     * @var array
-     */
-    private $script_handles_with_data = [];
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection        $assets
-     * @param AssetManifestInterface $asset_manifest
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(AssetCollection $assets, AssetManifestInterface $asset_manifest)
-    {
-        $this->addAssetCollection($assets);
-        $this->asset_manifest = $asset_manifest;
-        $this->asset_manifest->initialize();
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 5);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 5);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * @param AssetCollection $asset_collection
-     */
-    public function addAssetCollection(AssetCollection $asset_collection)
-    {
-        $id = $asset_collection->collectionIdentifier();
-        if (! array_key_exists($id, $this->assets)) {
-            $this->assets[ $id ] = $asset_collection;
-        }
-    }
-
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @throws Exception
-     * @since 4.9.62.p
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            foreach ($this->assets as $asset_collection) {
-                $this->registerScripts($asset_collection->getJavascriptAssets());
-                $this->registerStyles($asset_collection->getStylesheetAssets());
-            }
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function registerScripts(array $scripts)
-    {
-        foreach ($scripts as $script) {
-            // skip to next script if this has already been done
-            if ($script->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-                $script
-            );
-            $registered = wp_register_script(
-                $script->handle(),
-                $script->source(),
-                $script->dependencies(),
-                $script->version(),
-                $script->loadInFooter()
-            );
-            if (! $registered && $this->debug()) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->enqueueImmediately()) {
-                wp_enqueue_script($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function registerStyles(array $styles)
-    {
-        foreach ($styles as $style) {
-            // skip to next style if this has already been done
-            if ($style->isRegistered()) {
-                continue;
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
-                $style
-            );
-            wp_register_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            if ($style->enqueueImmediately()) {
-                wp_enqueue_style($style->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
-                $style
-            );
-        }
-    }
-
-
-    /**
-     * Call back for the script print in frontend and backend.
-     * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
-     *
-     * @throws Exception
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        try {
-            $this->removeAlreadyRegisteredDataForScriptHandles();
-            wp_add_inline_script(
-                CoreAssetManager::JS_HANDLE_JS_CORE,
-                'var eejsdata=' . wp_json_encode(['data' => $this->js_data]),
-                'before'
-            );
-            foreach ($this->assets as $asset_collection) {
-                $scripts = $asset_collection->getJavascriptAssetsWithData();
-                foreach ($scripts as $script) {
-                    $this->addRegisteredScriptHandlesWithData($script->handle());
-                    if ($script->hasInlineDataCallback()) {
-                        $localize = $script->inlineDataCallback();
-                        $localize();
-                    }
-                }
-            }
-        } catch (Exception $exception) {
-            EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Used to add data to eejs.data object.
-     * Note:  Overriding existing data is not allowed.
-     * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
-     * If the data you add is something like this:
-     *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
-     * It will be exposed in the page source as:
-     *  eejs.data.my_plugin_data.foo == gar
-     *
-     * @param string       $key   Key used to access your data
-     * @param string|array $value Value to attach to key
-     * @throws InvalidArgumentException
-     */
-    public function addData(string $key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->js_data[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * Similar to addData except this allows for users to push values to an existing key where the values on key are
-     * elements in an array.
-     *
-     * When you use this method, the value you include will be merged with the array on $key.
-     * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
-     * object like this, eejs.data.test = [ my_data,
-     * ]
-     * If there has already been a scalar value attached to the data object given key (via addData for instance), then
-     * this will throw an exception.
-     *
-     * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
-     * key potentially overriding the existing data on merge (specifically with associative arrays).
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData(string $key, $value)
-    {
-        if (
-            isset($this->js_data[ $key ])
-            && ! is_array($this->js_data[ $key ])
-        ) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
+	const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
+
+	/**
+	 * @var AssetCollection[] $assets
+	 */
+	protected $assets = [];
+
+	/**
+	 * @var AssetManifestInterface
+	 */
+	private $asset_manifest;
+
+	/**
+	 * This holds the js_data data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $js_data = [];
+
+	/**
+	 * This keeps track of all scripts with registered data.  It is used to prevent duplicate data objects setup in the
+	 * page source.
+	 *
+	 * @var array
+	 */
+	private $script_handles_with_data = [];
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection        $assets
+	 * @param AssetManifestInterface $asset_manifest
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(AssetCollection $assets, AssetManifestInterface $asset_manifest)
+	{
+		$this->addAssetCollection($assets);
+		$this->asset_manifest = $asset_manifest;
+		$this->asset_manifest->initialize();
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 4);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 5);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 5);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * @param AssetCollection $asset_collection
+	 */
+	public function addAssetCollection(AssetCollection $asset_collection)
+	{
+		$id = $asset_collection->collectionIdentifier();
+		if (! array_key_exists($id, $this->assets)) {
+			$this->assets[ $id ] = $asset_collection;
+		}
+	}
+
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @throws Exception
+	 * @since 4.9.62.p
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			foreach ($this->assets as $asset_collection) {
+				$this->registerScripts($asset_collection->getJavascriptAssets());
+				$this->registerStyles($asset_collection->getStylesheetAssets());
+			}
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function registerScripts(array $scripts)
+	{
+		foreach ($scripts as $script) {
+			// skip to next script if this has already been done
+			if ($script->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+				$script
+			);
+			$registered = wp_register_script(
+				$script->handle(),
+				$script->source(),
+				$script->dependencies(),
+				$script->version(),
+				$script->loadInFooter()
+			);
+			if (! $registered && $this->debug()) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->enqueueImmediately()) {
+				wp_enqueue_script($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function registerStyles(array $styles)
+	{
+		foreach ($styles as $style) {
+			// skip to next style if this has already been done
+			if ($style->isRegistered()) {
+				continue;
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__before_style',
+				$style
+			);
+			wp_register_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			if ($style->enqueueImmediately()) {
+				wp_enqueue_style($style->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerStyles__after_style',
+				$style
+			);
+		}
+	}
+
+
+	/**
+	 * Call back for the script print in frontend and backend.
+	 * Used to call wp_localize_scripts so that data can be added throughout the runtime until this later hook point.
+	 *
+	 * @throws Exception
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		try {
+			$this->removeAlreadyRegisteredDataForScriptHandles();
+			wp_add_inline_script(
+				CoreAssetManager::JS_HANDLE_JS_CORE,
+				'var eejsdata=' . wp_json_encode(['data' => $this->js_data]),
+				'before'
+			);
+			foreach ($this->assets as $asset_collection) {
+				$scripts = $asset_collection->getJavascriptAssetsWithData();
+				foreach ($scripts as $script) {
+					$this->addRegisteredScriptHandlesWithData($script->handle());
+					if ($script->hasInlineDataCallback()) {
+						$localize = $script->inlineDataCallback();
+						$localize();
+					}
+				}
+			}
+		} catch (Exception $exception) {
+			EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Used to add data to eejs.data object.
+	 * Note:  Overriding existing data is not allowed.
+	 * Data will be accessible as a javascript object when you list `eejs-core` as a dependency for your javascript.
+	 * If the data you add is something like this:
+	 *  $this->addData( 'my_plugin_data', array( 'foo' => 'gar' ) );
+	 * It will be exposed in the page source as:
+	 *  eejs.data.my_plugin_data.foo == gar
+	 *
+	 * @param string       $key   Key used to access your data
+	 * @param string|array $value Value to attach to key
+	 * @throws InvalidArgumentException
+	 */
+	public function addData(string $key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->js_data[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Similar to addData except this allows for users to push values to an existing key where the values on key are
+	 * elements in an array.
+	 *
+	 * When you use this method, the value you include will be merged with the array on $key.
+	 * So if the $key was 'test' and you added a value of ['my_data'] then it would be represented in the javascript
+	 * object like this, eejs.data.test = [ my_data,
+	 * ]
+	 * If there has already been a scalar value attached to the data object given key (via addData for instance), then
+	 * this will throw an exception.
+	 *
+	 * Caution: Only add data using this method if you are okay with the potential for additional data added on the same
+	 * key potentially overriding the existing data on merge (specifically with associative arrays).
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData(string $key, $value)
+	{
+		if (
+			isset($this->js_data[ $key ])
+			&& ! is_array($this->js_data[ $key ])
+		) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The value for %1$s is already set and it is not an array. The %2$s method can only be used to
                          push values to this data element when it is an array.',
-                        'event_espresso'
-                    ),
-                    $key,
-                    __METHOD__
-                )
-            );
-        }
-        if (! isset($this->js_data[ $key ])) {
-            $this->js_data[ $key ] = is_array($value) ? $value : [$value];
-        } else {
-            $this->js_data[ $key ] = array_merge($this->js_data[ $key ], (array) $value);
-        }
-    }
-
-
-    /**
-     * Used to set content used by javascript for a template.
-     * Note: Overrides of existing registered templates are not allowed.
-     *
-     * @param string $template_reference
-     * @param string $template_content
-     * @throws InvalidArgumentException
-     */
-    public function addTemplate(string $template_reference, string $template_content)
-    {
-        if (! isset($this->js_data['templates'])) {
-            $this->js_data['templates'] = [];
-        }
-        //no overrides allowed.
-        if (isset($this->js_data['templates'][ $template_reference ])) {
-            if (! $this->debug()) {
-                return;
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->js_data['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate(string $template_reference): string
-    {
-        return $this->js_data['templates'][ $template_reference ] ?? '';
-    }
-
-
-    /**
-     * Retrieve registered data.
-     *
-     * @param string $key Name of key to attach data to.
-     * @return mixed                If there is no for the given key, then false is returned.
-     */
-    public function getData(string $key)
-    {
-        return array_key_exists($key, $this->js_data) ? $this->js_data[ $key ] : null;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the js_data array.
-     * Overriding data is not allowed.
-     *
-     * @param string $key Index for data.
-     * @return bool        If valid then return true.
-     * @throws InvalidArgumentException if data already exists.
-     */
-    protected function verifyDataNotExisting(string $key): bool
-    {
-        if (isset($this->js_data[ $key ])) {
-            if (! $this->debug()) {
-                return false;
-            }
-            if (is_array($this->js_data[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		if (! isset($this->js_data[ $key ])) {
+			$this->js_data[ $key ] = is_array($value) ? $value : [$value];
+		} else {
+			$this->js_data[ $key ] = array_merge($this->js_data[ $key ], (array) $value);
+		}
+	}
+
+
+	/**
+	 * Used to set content used by javascript for a template.
+	 * Note: Overrides of existing registered templates are not allowed.
+	 *
+	 * @param string $template_reference
+	 * @param string $template_content
+	 * @throws InvalidArgumentException
+	 */
+	public function addTemplate(string $template_reference, string $template_content)
+	{
+		if (! isset($this->js_data['templates'])) {
+			$this->js_data['templates'] = [];
+		}
+		//no overrides allowed.
+		if (isset($this->js_data['templates'][ $template_reference ])) {
+			if (! $this->debug()) {
+				return;
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->js_data['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate(string $template_reference): string
+	{
+		return $this->js_data['templates'][ $template_reference ] ?? '';
+	}
+
+
+	/**
+	 * Retrieve registered data.
+	 *
+	 * @param string $key Name of key to attach data to.
+	 * @return mixed                If there is no for the given key, then false is returned.
+	 */
+	public function getData(string $key)
+	{
+		return array_key_exists($key, $this->js_data) ? $this->js_data[ $key ] : null;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the js_data array.
+	 * Overriding data is not allowed.
+	 *
+	 * @param string $key Index for data.
+	 * @return bool        If valid then return true.
+	 * @throws InvalidArgumentException if data already exists.
+	 */
+	protected function verifyDataNotExisting(string $key): bool
+	{
+		if (isset($this->js_data[ $key ])) {
+			if (! $this->debug()) {
+				return false;
+			}
+			if (is_array($this->js_data[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'The value for %1$s already exists in the Registry::eejs object.
                             Overrides are not allowed. Since the value of this data is an array, you may want to use the
                             %2$s method to push your value to the array.',
-                            'event_espresso'
-                        ),
-                        $key,
-                        'pushData()'
-                    )
-                );
-            }
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The value for %1$s already exists in the Registry::eejs object. Overrides are not
                         allowed.  Consider attaching your value to a different key',
-                        'event_espresso'
-                    ),
-                    $key
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Get the actual asset path for asset manifests.
-     * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
-     *
-     * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
-     *                           asset file location.
-     * @param string $chunk_name
-     * @param string $asset_type
-     * @return string
-     * @since 4.9.59.p
-     */
-    public function getAssetUrl(string $namespace, string $chunk_name, string $asset_type): string
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $this->asset_manifest->getAssetUrl($chunk_name, $asset_type),
-            $namespace,
-            $chunk_name,
-            $asset_type
-        );
-    }
-
-
-    /**
-     * Return the url to a js file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getJsUrl(string $namespace, string $chunk_name): string
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * Return the url to a css file for the given namespace and chunk name.
-     *
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return string
-     */
-    public function getCssUrl(string $namespace, string $chunk_name): string
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData(string $script_handle)
-    {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
-    }
-
-
-    /**i
+						'event_espresso'
+					),
+					$key
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Get the actual asset path for asset manifests.
+	 * If there is no asset path found for the given $chunk_name, then the $chunk_name is returned.
+	 *
+	 * @param string $namespace  The namespace associated with the manifest file hosting the map of chunk_name to actual
+	 *                           asset file location.
+	 * @param string $chunk_name
+	 * @param string $asset_type
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	public function getAssetUrl(string $namespace, string $chunk_name, string $asset_type): string
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$this->asset_manifest->getAssetUrl($chunk_name, $asset_type),
+			$namespace,
+			$chunk_name,
+			$asset_type
+		);
+	}
+
+
+	/**
+	 * Return the url to a js file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getJsUrl(string $namespace, string $chunk_name): string
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * Return the url to a css file for the given namespace and chunk name.
+	 *
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return string
+	 */
+	public function getCssUrl(string $namespace, string $chunk_name): string
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData(string $script_handle)
+	{
+		$this->script_handles_with_data[ $script_handle ] = $script_handle;
+	}
+
+
+	/**i
      * Checks WP_Scripts for all of each script handle registered internally as having data and unsets from the
      * Dependency stored in WP_Scripts if its set.
      */
-    private function removeAlreadyRegisteredDataForScriptHandles()
-    {
-        if (empty($this->script_handles_with_data)) {
-            return;
-        }
-        foreach ($this->script_handles_with_data as $script_handle) {
-            $this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
-        }
-    }
-
-
-    /**
-     * Removes any data dependency registered in WP_Scripts if its set.
-     *
-     * @param string $script_handle
-     */
-    private function removeAlreadyRegisteredDataForScriptHandle(string $script_handle)
-    {
-        if (isset($this->script_handles_with_data[ $script_handle ])) {
-            global $wp_scripts;
-            $unset_handle = false;
-            if ($wp_scripts->get_data($script_handle, 'data')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['data']);
-                $unset_handle = true;
-            }
-            //deal with inline_scripts
-            if ($wp_scripts->get_data($script_handle, 'before')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['before']);
-                $unset_handle = true;
-            }
-            if ($wp_scripts->get_data($script_handle, 'after')) {
-                unset($wp_scripts->registered[ $script_handle ]->extra['after']);
-            }
-            if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
-            }
-        }
-    }
-
-
-    /**
-     * @since 4.9.63.p
-     * @return bool
-     * @since 4.9.63.p
-     */
-    private function debug(): bool
-    {
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__debug',
-            defined('EE_DEBUG') && EE_DEBUG
-        );
-    }
-
-
-    /**************** deprecated ****************/
-
-
-
-    /**
-     * @return null
-     * @deprecated 5.0.0.p
-     */
-    public function getI18nRegistry()
-    {
-        return null;
-    }
-
-
-    /**
-     * @param string $handle
-     * @deprecated 5.0.0.p
-     */
-    public function registerTranslation($handle)
-    {
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated 5.0.0.p
-     */
-    public function getCssAssetDetails($namespace, $chunk_name)
-    {
-        return [
-            AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_CSS),
-            AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_CSS),
-        ];
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated 5.0.0.p
-     */
-    public function getCssDependencies($namespace, $chunk_name)
-    {
-        return $this->asset_manifest->getAssetDependencies($chunk_name, AssetManifest::ASSET_EXT_CSS);
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated 5.0.0.p
-     */
-    public function getJsAssetDetails($namespace, $chunk_name)
-    {
-        return [
-            AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_JS),
-            AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_JS),
-        ];
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $chunk_name
-     * @return array
-     * @deprecated 5.0.0.p
-     */
-    public function getJsDependencies($namespace, $chunk_name)
-    {
-        return $this->asset_manifest->getAssetDependencies($chunk_name);
-    }
-
-
-    /**
-     * @deprecated 5.0.0.p
-     */
-    public function registerManifestFiles()
-    {
-    }
-
-
-    /**
-     * @param string $namespace
-     * @param string $url_base
-     * @param string $manifest_file
-     * @param string $manifest_file_path
-     * @deprecated 5.0.0.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
-    {
-    }
+	private function removeAlreadyRegisteredDataForScriptHandles()
+	{
+		if (empty($this->script_handles_with_data)) {
+			return;
+		}
+		foreach ($this->script_handles_with_data as $script_handle) {
+			$this->removeAlreadyRegisteredDataForScriptHandle($script_handle);
+		}
+	}
+
+
+	/**
+	 * Removes any data dependency registered in WP_Scripts if its set.
+	 *
+	 * @param string $script_handle
+	 */
+	private function removeAlreadyRegisteredDataForScriptHandle(string $script_handle)
+	{
+		if (isset($this->script_handles_with_data[ $script_handle ])) {
+			global $wp_scripts;
+			$unset_handle = false;
+			if ($wp_scripts->get_data($script_handle, 'data')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['data']);
+				$unset_handle = true;
+			}
+			//deal with inline_scripts
+			if ($wp_scripts->get_data($script_handle, 'before')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['before']);
+				$unset_handle = true;
+			}
+			if ($wp_scripts->get_data($script_handle, 'after')) {
+				unset($wp_scripts->registered[ $script_handle ]->extra['after']);
+			}
+			if ($unset_handle) {
+				unset($this->script_handles_with_data[ $script_handle ]);
+			}
+		}
+	}
+
+
+	/**
+	 * @since 4.9.63.p
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	private function debug(): bool
+	{
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__debug',
+			defined('EE_DEBUG') && EE_DEBUG
+		);
+	}
+
+
+	/**************** deprecated ****************/
+
+
+
+	/**
+	 * @return null
+	 * @deprecated 5.0.0.p
+	 */
+	public function getI18nRegistry()
+	{
+		return null;
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @deprecated 5.0.0.p
+	 */
+	public function registerTranslation($handle)
+	{
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated 5.0.0.p
+	 */
+	public function getCssAssetDetails($namespace, $chunk_name)
+	{
+		return [
+			AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_CSS),
+			AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_CSS),
+		];
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated 5.0.0.p
+	 */
+	public function getCssDependencies($namespace, $chunk_name)
+	{
+		return $this->asset_manifest->getAssetDependencies($chunk_name, AssetManifest::ASSET_EXT_CSS);
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated 5.0.0.p
+	 */
+	public function getJsAssetDetails($namespace, $chunk_name)
+	{
+		return [
+			AssetManifest::KEY_DEPENDENCIES => $this->asset_manifest->getAssetDependencies($chunk_name, Asset::TYPE_JS),
+			AssetManifest::KEY_VERSION => $this->asset_manifest->getAssetVersion($chunk_name, Asset::TYPE_JS),
+		];
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $chunk_name
+	 * @return array
+	 * @deprecated 5.0.0.p
+	 */
+	public function getJsDependencies($namespace, $chunk_name)
+	{
+		return $this->asset_manifest->getAssetDependencies($chunk_name);
+	}
+
+
+	/**
+	 * @deprecated 5.0.0.p
+	 */
+	public function registerManifestFiles()
+	{
+	}
+
+
+	/**
+	 * @param string $namespace
+	 * @param string $url_base
+	 * @param string $manifest_file
+	 * @param string $manifest_file_path
+	 * @deprecated 5.0.0.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file, $manifest_file_path = '')
+	{
+	}
 }