eventespresso / event-espresso-core

core/domain/services/custom_post_types/RegisterCustomPostTypes.php

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
     {
         $custom_post_types = $this->custom_post_types->getDefinitions();
         foreach ($custom_post_types as $custom_post_type => $CPT) {
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
+            $this->wp_post_types[$custom_post_type] = $this->registerCustomPostType(
                 $custom_post_type,
                 $CPT['singular_name'],
                 $CPT['plural_name'],

Indentation +221 added lines, -221 removed lines

@@ -18,240 +18,240 @@
 class RegisterCustomPostTypes
 {
 
-    /**
-     * @var CustomPostTypeDefinitions $custom_post_types
-     */
-    public $custom_post_types;
+	/**
+	 * @var CustomPostTypeDefinitions $custom_post_types
+	 */
+	public $custom_post_types;
 
-    /**
-     * @var WP_Post_Type[] $wp_post_types
-     */
-    public $wp_post_types = array();
+	/**
+	 * @var WP_Post_Type[] $wp_post_types
+	 */
+	public $wp_post_types = array();
 
 
-    /**
-     * RegisterCustomPostTypes constructor.
-     *
-     * @param CustomPostTypeDefinitions $custom_post_types
-     */
-    public function __construct(CustomPostTypeDefinitions $custom_post_types)
-    {
-        $this->custom_post_types = $custom_post_types;
-    }
+	/**
+	 * RegisterCustomPostTypes constructor.
+	 *
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 */
+	public function __construct(CustomPostTypeDefinitions $custom_post_types)
+	{
+		$this->custom_post_types = $custom_post_types;
+	}
 
 
-    /**
-     * @return WP_Post_Type[]
-     */
-    public function getRegisteredCustomPostTypes()
-    {
-        return $this->wp_post_types;
-    }
+	/**
+	 * @return WP_Post_Type[]
+	 */
+	public function getRegisteredCustomPostTypes()
+	{
+		return $this->wp_post_types;
+	}
 
 
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function registerCustomPostTypes()
-    {
-        $custom_post_types = $this->custom_post_types->getDefinitions();
-        foreach ($custom_post_types as $custom_post_type => $CPT) {
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
-                $custom_post_type,
-                $CPT['singular_name'],
-                $CPT['plural_name'],
-                $CPT['singular_slug'],
-                $CPT['plural_slug'],
-                $CPT['args']
-            );
-        }
-    }
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function registerCustomPostTypes()
+	{
+		$custom_post_types = $this->custom_post_types->getDefinitions();
+		foreach ($custom_post_types as $custom_post_type => $CPT) {
+			$this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
+				$custom_post_type,
+				$CPT['singular_name'],
+				$CPT['plural_name'],
+				$CPT['singular_slug'],
+				$CPT['plural_slug'],
+				$CPT['args']
+			);
+		}
+	}
 
 
-    /**
-     * Registers a new custom post type. Sets default settings given only the following params.
-     * Returns the registered post type object, or an error object.
-     *
-     * @param string $post_type          the actual post type name
-     *                                   IMPORTANT:
-     *                                   this must match what the slug is for admin pages related to this CPT
-     *                                   Also any models must use this slug as well
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @param array  $override_arguments exactly like $args as described in
-     *                                   http://codex.wordpress.org/Function_Reference/register_post_type
-     * @return WP_Post_Type|WP_Error
-     * @throws DomainException
-     */
-    public function registerCustomPostType(
-        $post_type,
-        $singular_name,
-        $plural_name,
-        $singular_slug = '',
-        $plural_slug = '',
-        array $override_arguments = array()
-    ) {
-        $wp_post_type = register_post_type(
-            $post_type,
-            $this->prepareArguments(
-                $post_type,
-                $singular_name,
-                $plural_name,
-                $singular_slug,
-                $plural_slug,
-                $override_arguments
-            )
-        );
-        if ($wp_post_type instanceof WP_Error) {
-            throw new DomainException($wp_post_type->get_error_message());
-        }
-        return $wp_post_type;
-    }
+	/**
+	 * Registers a new custom post type. Sets default settings given only the following params.
+	 * Returns the registered post type object, or an error object.
+	 *
+	 * @param string $post_type          the actual post type name
+	 *                                   IMPORTANT:
+	 *                                   this must match what the slug is for admin pages related to this CPT
+	 *                                   Also any models must use this slug as well
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @param array  $override_arguments exactly like $args as described in
+	 *                                   http://codex.wordpress.org/Function_Reference/register_post_type
+	 * @return WP_Post_Type|WP_Error
+	 * @throws DomainException
+	 */
+	public function registerCustomPostType(
+		$post_type,
+		$singular_name,
+		$plural_name,
+		$singular_slug = '',
+		$plural_slug = '',
+		array $override_arguments = array()
+	) {
+		$wp_post_type = register_post_type(
+			$post_type,
+			$this->prepareArguments(
+				$post_type,
+				$singular_name,
+				$plural_name,
+				$singular_slug,
+				$plural_slug,
+				$override_arguments
+			)
+		);
+		if ($wp_post_type instanceof WP_Error) {
+			throw new DomainException($wp_post_type->get_error_message());
+		}
+		return $wp_post_type;
+	}
 
 
-    /**
-     * @param string $post_type          the actual post type name
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @param array  $override_arguments The default values set in this function will be overridden
-     *                                   by whatever you set in $override_arguments
-     * @return array
-     */
-    protected function prepareArguments(
-        $post_type,
-        $singular_name,
-        $plural_name,
-        $singular_slug,
-        $plural_slug,
-        array $override_arguments = array()
-    ) {
-        // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
-        $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
-        $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
-        $labels = $this->getLabels(
-            $singular_name,
-            $plural_name,
-            $singular_slug,
-            $plural_slug
-        );
-        // note the page_templates arg in the supports index is something specific to EE.
-        // WordPress doesn't actually have that in their register_post_type api.
-        $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
-        if ($override_arguments) {
-            if (isset($override_arguments['labels'])) {
-                $labels = array_merge($arguments['labels'], $override_arguments['labels']);
-            }
-            $arguments = array_merge($arguments, $override_arguments);
-            $arguments['labels'] = $labels;
-        }
-        return $arguments;
-    }
+	/**
+	 * @param string $post_type          the actual post type name
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @param array  $override_arguments The default values set in this function will be overridden
+	 *                                   by whatever you set in $override_arguments
+	 * @return array
+	 */
+	protected function prepareArguments(
+		$post_type,
+		$singular_name,
+		$plural_name,
+		$singular_slug,
+		$plural_slug,
+		array $override_arguments = array()
+	) {
+		// verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
+		$singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
+		$plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
+		$labels = $this->getLabels(
+			$singular_name,
+			$plural_name,
+			$singular_slug,
+			$plural_slug
+		);
+		// note the page_templates arg in the supports index is something specific to EE.
+		// WordPress doesn't actually have that in their register_post_type api.
+		$arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
+		if ($override_arguments) {
+			if (isset($override_arguments['labels'])) {
+				$labels = array_merge($arguments['labels'], $override_arguments['labels']);
+			}
+			$arguments = array_merge($arguments, $override_arguments);
+			$arguments['labels'] = $labels;
+		}
+		return $arguments;
+	}
 
 
-    /**
-     * @param string $singular_name
-     * @param string $plural_name
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @return array
-     */
-    private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
-    {
-        return array(
-            'name'               => $plural_name,
-            'singular_name'      => $singular_name,
-            'singular_slug'      => $singular_slug,
-            'plural_slug'        => $plural_slug,
-            'add_new'            => sprintf(
-                esc_html_x('Add %s', 'Add Event', 'event_espresso'),
-                $singular_name
-            ),
-            'add_new_item'       => sprintf(
-                esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
-                $singular_name
-            ),
-            'edit_item'          => sprintf(
-                esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
-                $singular_name
-            ),
-            'new_item'           => sprintf(
-                esc_html_x('New %s', 'New Event', 'event_espresso'),
-                $singular_name
-            ),
-            'all_items'          => sprintf(
-                esc_html_x('All %s', 'All Events', 'event_espresso'),
-                $plural_name
-            ),
-            'view_item'          => sprintf(
-                esc_html_x('View %s', 'View Event', 'event_espresso'),
-                $singular_name
-            ),
-            'search_items'       => sprintf(
-                esc_html_x('Search %s', 'Search Events', 'event_espresso'),
-                $plural_name
-            ),
-            'not_found'          => sprintf(
-                esc_html_x('No %s found', 'No Events found', 'event_espresso'),
-                $plural_name
-            ),
-            'not_found_in_trash' => sprintf(
-                esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
-                $plural_name
-            ),
-            'parent_item_colon'  => '',
-            'menu_name'          => $plural_name,
-        );
-    }
+	/**
+	 * @param string $singular_name
+	 * @param string $plural_name
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @return array
+	 */
+	private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
+	{
+		return array(
+			'name'               => $plural_name,
+			'singular_name'      => $singular_name,
+			'singular_slug'      => $singular_slug,
+			'plural_slug'        => $plural_slug,
+			'add_new'            => sprintf(
+				esc_html_x('Add %s', 'Add Event', 'event_espresso'),
+				$singular_name
+			),
+			'add_new_item'       => sprintf(
+				esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
+				$singular_name
+			),
+			'edit_item'          => sprintf(
+				esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
+				$singular_name
+			),
+			'new_item'           => sprintf(
+				esc_html_x('New %s', 'New Event', 'event_espresso'),
+				$singular_name
+			),
+			'all_items'          => sprintf(
+				esc_html_x('All %s', 'All Events', 'event_espresso'),
+				$plural_name
+			),
+			'view_item'          => sprintf(
+				esc_html_x('View %s', 'View Event', 'event_espresso'),
+				$singular_name
+			),
+			'search_items'       => sprintf(
+				esc_html_x('Search %s', 'Search Events', 'event_espresso'),
+				$plural_name
+			),
+			'not_found'          => sprintf(
+				esc_html_x('No %s found', 'No Events found', 'event_espresso'),
+				$plural_name
+			),
+			'not_found_in_trash' => sprintf(
+				esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
+				$plural_name
+			),
+			'parent_item_colon'  => '',
+			'menu_name'          => $plural_name,
+		);
+	}
 
 
-    /**
-     * @param array  $labels
-     * @param string $post_type
-     * @param string $plural_slug
-     * @return array
-     */
-    private function getDefaultArguments(array $labels, $post_type, $plural_slug)
-    {
-        return array(
-            'labels'             => $labels,
-            'public'             => true,
-            'publicly_queryable' => true,
-            'show_ui'            => false,
-            'show_ee_ui'         => true,
-            'show_in_menu'       => false,
-            'show_in_nav_menus'  => false,
-            'query_var'          => true,
-            'rewrite'            => apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
-                // legacy filter applied for now,
-                // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-                apply_filters(
-                    'FHEE__EE_Register_CPTs__register_CPT__rewrite',
-                    array('slug' => $plural_slug),
-                    $post_type
-                ),
-                $post_type,
-                $plural_slug
-            ),
-            'capability_type'    => 'post',
-            'map_meta_cap'       => true,
-            'has_archive'        => true,
-            'hierarchical'       => false,
-            'menu_position'      => null,
-            'supports'           => array(
-                'title',
-                'editor',
-                'author',
-                'thumbnail',
-                'excerpt',
-                'custom-fields',
-                'comments',
-            ),
-        );
-    }
+	/**
+	 * @param array  $labels
+	 * @param string $post_type
+	 * @param string $plural_slug
+	 * @return array
+	 */
+	private function getDefaultArguments(array $labels, $post_type, $plural_slug)
+	{
+		return array(
+			'labels'             => $labels,
+			'public'             => true,
+			'publicly_queryable' => true,
+			'show_ui'            => false,
+			'show_ee_ui'         => true,
+			'show_in_menu'       => false,
+			'show_in_nav_menus'  => false,
+			'query_var'          => true,
+			'rewrite'            => apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
+				// legacy filter applied for now,
+				// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+				apply_filters(
+					'FHEE__EE_Register_CPTs__register_CPT__rewrite',
+					array('slug' => $plural_slug),
+					$post_type
+				),
+				$post_type,
+				$plural_slug
+			),
+			'capability_type'    => 'post',
+			'map_meta_cap'       => true,
+			'has_archive'        => true,
+			'hierarchical'       => false,
+			'menu_position'      => null,
+			'supports'           => array(
+				'title',
+				'editor',
+				'author',
+				'thumbnail',
+				'excerpt',
+				'custom-fields',
+				'comments',
+			),
+		);
+	}
 }

core/services/collections/Collection.php

Doc Comments +3 added lines, -3 removed lines

@@ -156,7 +156,7 @@ 
      *
      * @access public
      * @param mixed $identifier
-     * @return mixed
+     * @return boolean
      */
     public function get($identifier)
     {
@@ -278,7 +278,7 @@ 
      * advances pointer to the provided object
      *
      * @access public
-     * @param $object
+     * @param \EventEspresso\core\libraries\form_sections\form_handlers\SequentialStepForm $object
      * @return boolean
      */
     public function setCurrentUsingObject($object)
@@ -316,7 +316,7 @@ 
      *
      * @see http://stackoverflow.com/a/8736013
      * @param $object
-     * @return boolean|int|string
+     * @return integer
      */
     public function indexOf($object)
     {

Spacing +10 added lines, -10 removed lines

@@ -68,14 +68,14 @@ 
     protected function setCollectionIdentifier()
     {
         // hash a few collection details
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
+        $identifier = md5(spl_object_hash($this).$this->collection_interface.time());
         // grab a few characters from the start, middle, and end of the hash
         $id = array();
         for ($x = 0; $x < 19; $x += 9) {
             $id[] = substr($identifier, $x, 3);
         }
         $identifier = basename(str_replace('\\', '/', get_class($this)));
-        $identifier .= '-' . strtoupper(implode('-', $id));
+        $identifier .= '-'.strtoupper(implode('-', $id));
         $this->collection_identifier = $identifier;
     }
 
@@ -89,7 +89,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -111,7 +111,7 @@ 
      */
     public function add($object, $identifier = null)
     {
-        if (! $object instanceof $this->collection_interface) {
+        if ( ! $object instanceof $this->collection_interface) {
             throw new InvalidEntityException($object, $this->collection_interface);
         }
         if ($this->contains($object)) {
@@ -322,7 +322,7 @@ 
      */
     public function indexOf($object)
     {
-        if (! $this->contains($object)) {
+        if ( ! $this->contains($object)) {
             return false;
         }
         foreach ($this as $index => $obj) {
@@ -391,9 +391,9 @@ 
             $remaining_objects = $this->slice($index, $this->count() - $index);
             foreach ($remaining_objects as $key => $remaining_object) {
                 // we need to grab the identifiers for each object and use them as keys
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
+                $remaining_objects[$remaining_object->getInfo()] = $remaining_object;
                 // and then remove the object from the current tracking array
-                unset($remaining_objects[ $key ]);
+                unset($remaining_objects[$key]);
                 // and then remove it from the Collection
                 $this->detach($remaining_object);
             }
@@ -417,17 +417,17 @@ 
      */
     public function insertAt($objects, $index)
     {
-        if (! is_array($objects)) {
+        if ( ! is_array($objects)) {
             $objects = array($objects);
         }
         // check to ensure that objects don't already exist in the collection
         foreach ($objects as $key => $object) {
             if ($this->contains($object)) {
-                unset($objects[ $key ]);
+                unset($objects[$key]);
             }
         }
         // do we have any objects left?
-        if (! $objects) {
+        if ( ! $objects) {
             return;
         }
         // detach any objects at or past this index

Indentation +466 added lines, -466 removed lines

@@ -19,470 +19,470 @@
 class Collection extends SplObjectStorage implements CollectionInterface
 {
 
-    /**
-     * a unique string for identifying this collection
-     *
-     * @type string $collection_identifier
-     */
-    protected $collection_identifier;
-
-
-    /**
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
-     * this should be set from within the child class constructor
-     *
-     * @type string $interface
-     */
-    protected $collection_interface;
-
-
-    /**
-     * Collection constructor
-     *
-     * @param string $collection_interface
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($collection_interface)
-    {
-        $this->setCollectionInterface($collection_interface);
-        $this->setCollectionIdentifier();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function collectionIdentifier()
-    {
-        return $this->collection_identifier;
-    }
-
-
-    /**
-     * creates a very readable unique 9 character identifier like:  CF2-532-DAC
-     * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
-     *
-     * @return void
-     */
-    protected function setCollectionIdentifier()
-    {
-        // hash a few collection details
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
-        // grab a few characters from the start, middle, and end of the hash
-        $id = array();
-        for ($x = 0; $x < 19; $x += 9) {
-            $id[] = substr($identifier, $x, 3);
-        }
-        $identifier = basename(str_replace('\\', '/', get_class($this)));
-        $identifier .= '-' . strtoupper(implode('-', $id));
-        $this->collection_identifier = $identifier;
-    }
-
-
-    /**
-     * setCollectionInterface
-     *
-     * @param  string $collection_interface
-     * @throws InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * add
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_identifier()
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function add($object, $identifier = null)
-    {
-        if (! $object instanceof $this->collection_interface) {
-            throw new InvalidEntityException($object, $this->collection_interface);
-        }
-        if ($this->contains($object)) {
-            throw new DuplicateCollectionIdentifierException($identifier);
-        }
-        $this->attach($object);
-        $this->setIdentifier($object, $identifier);
-        return $this->contains($object);
-    }
-
-
-    /**
-     * setIdentifier
-     * Sets the data associated with an object in the Collection
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function setIdentifier($object, $identifier = null)
-    {
-        $identifier = ! empty($identifier)
-            ? $identifier
-            : spl_object_hash($object);
-        $this->rewind();
-        while ($this->valid()) {
-            if ($object === $this->current()) {
-                $this->setInfo($identifier);
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * get
-     * finds and returns an object in the Collection based on the identifier that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed $identifier
-     * @return mixed
-     */
-    public function get($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier
-     *
-     * @access public
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function has($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * hasObject
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function hasObject($object)
-    {
-        return $this->contains($object);
-    }
-
-
-    /**
-     * hasObjects
-     * returns true if there are objects within the Collection, and false if it is empty
-     *
-     * @access public
-     * @return bool
-     */
-    public function hasObjects()
-    {
-        return $this->count() !== 0;
-    }
-
-
-    /**
-     * isEmpty
-     * returns true if there are no objects within the Collection, and false if there are
-     *
-     * @access public
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        return $this->count() === 0;
-    }
-
-
-    /**
-     * remove
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        $this->detach($object);
-        return true;
-    }
-
-
-    /**
-     * setCurrent
-     * advances pointer to the object whose identifier matches that which was provided
-     *
-     * @access public
-     * @param mixed $identifier
-     * @return boolean
-     */
-    public function setCurrent($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * setCurrentUsingObject
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return boolean
-     */
-    public function setCurrentUsingObject($object)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current() === $object) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object occupying the index before the current object,
-     * unless this is already the first object, in which case it just returns the first object
-     *
-     * @return mixed
-     */
-    public function previous()
-    {
-        $index = $this->indexOf($this->current());
-        if ($index === 0) {
-            return $this->current();
-        }
-        $index--;
-        return $this->objectAtIndex($index);
-    }
-
-
-    /**
-     * Returns the index of a given object, or false if not found
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param $object
-     * @return boolean|int|string
-     */
-    public function indexOf($object)
-    {
-        if (! $this->contains($object)) {
-            return false;
-        }
-        foreach ($this as $index => $obj) {
-            if ($obj === $object) {
-                return $index;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     * @return mixed
-     */
-    public function objectAtIndex($index)
-    {
-        $iterator = new LimitIterator($this, $index, 1);
-        $iterator->rewind();
-        return $iterator->current();
-    }
-
-
-    /**
-     * Returns the sequence of objects as specified by the offset and length
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $offset
-     * @param int $length
-     * @return array
-     */
-    public function slice($offset, $length)
-    {
-        $slice = array();
-        $iterator = new LimitIterator($this, $offset, $length);
-        foreach ($iterator as $object) {
-            $slice[] = $object;
-        }
-        return $slice;
-    }
-
-
-    /**
-     * Inserts an object at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $object A single object
-     * @param int   $index
-     * @param mixed $identifier
-     * @return bool
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidEntityException
-     */
-    public function insertObjectAt($object, $index, $identifier = null)
-    {
-        // check to ensure that objects don't already exist in the collection
-        if ($this->has($identifier)) {
-            throw new DuplicateCollectionIdentifierException($identifier);
-        }
-        // detach any objects at or past this index
-        $remaining_objects = array();
-        if ($index < $this->count()) {
-            $remaining_objects = $this->slice($index, $this->count() - $index);
-            foreach ($remaining_objects as $key => $remaining_object) {
-                // we need to grab the identifiers for each object and use them as keys
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
-                // and then remove the object from the current tracking array
-                unset($remaining_objects[ $key ]);
-                // and then remove it from the Collection
-                $this->detach($remaining_object);
-            }
-        }
-        // add the new object we're splicing in
-        $this->add($object, $identifier);
-        // attach the objects we previously detached
-        foreach ($remaining_objects as $key => $remaining_object) {
-            $this->add($remaining_object, $key);
-        }
-        return $this->contains($object);
-    }
-
-
-    /**
-     * Inserts an object (or an array of objects) at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $objects A single object or an array of objects
-     * @param int   $index
-     */
-    public function insertAt($objects, $index)
-    {
-        if (! is_array($objects)) {
-            $objects = array($objects);
-        }
-        // check to ensure that objects don't already exist in the collection
-        foreach ($objects as $key => $object) {
-            if ($this->contains($object)) {
-                unset($objects[ $key ]);
-            }
-        }
-        // do we have any objects left?
-        if (! $objects) {
-            return;
-        }
-        // detach any objects at or past this index
-        $remaining = array();
-        if ($index < $this->count()) {
-            $remaining = $this->slice($index, $this->count() - $index);
-            foreach ($remaining as $object) {
-                $this->detach($object);
-            }
-        }
-        // add the new objects we're splicing in
-        foreach ($objects as $object) {
-            $this->attach($object);
-        }
-        // attach the objects we previously detached
-        foreach ($remaining as $object) {
-            $this->attach($object);
-        }
-    }
-
-
-    /**
-     * Removes the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     */
-    public function removeAt($index)
-    {
-        $this->detach($this->objectAtIndex($index));
-    }
-
-
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-        }
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the Collection
-     */
-    public function trashAndDetachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-            unset($object);
-        }
-    }
+	/**
+	 * a unique string for identifying this collection
+	 *
+	 * @type string $collection_identifier
+	 */
+	protected $collection_identifier;
+
+
+	/**
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
+	 * this should be set from within the child class constructor
+	 *
+	 * @type string $interface
+	 */
+	protected $collection_interface;
+
+
+	/**
+	 * Collection constructor
+	 *
+	 * @param string $collection_interface
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($collection_interface)
+	{
+		$this->setCollectionInterface($collection_interface);
+		$this->setCollectionIdentifier();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function collectionIdentifier()
+	{
+		return $this->collection_identifier;
+	}
+
+
+	/**
+	 * creates a very readable unique 9 character identifier like:  CF2-532-DAC
+	 * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
+	 *
+	 * @return void
+	 */
+	protected function setCollectionIdentifier()
+	{
+		// hash a few collection details
+		$identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
+		// grab a few characters from the start, middle, and end of the hash
+		$id = array();
+		for ($x = 0; $x < 19; $x += 9) {
+			$id[] = substr($identifier, $x, 3);
+		}
+		$identifier = basename(str_replace('\\', '/', get_class($this)));
+		$identifier .= '-' . strtoupper(implode('-', $id));
+		$this->collection_identifier = $identifier;
+	}
+
+
+	/**
+	 * setCollectionInterface
+	 *
+	 * @param  string $collection_interface
+	 * @throws InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * add
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_identifier()
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function add($object, $identifier = null)
+	{
+		if (! $object instanceof $this->collection_interface) {
+			throw new InvalidEntityException($object, $this->collection_interface);
+		}
+		if ($this->contains($object)) {
+			throw new DuplicateCollectionIdentifierException($identifier);
+		}
+		$this->attach($object);
+		$this->setIdentifier($object, $identifier);
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * setIdentifier
+	 * Sets the data associated with an object in the Collection
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function setIdentifier($object, $identifier = null)
+	{
+		$identifier = ! empty($identifier)
+			? $identifier
+			: spl_object_hash($object);
+		$this->rewind();
+		while ($this->valid()) {
+			if ($object === $this->current()) {
+				$this->setInfo($identifier);
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * get
+	 * finds and returns an object in the Collection based on the identifier that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed $identifier
+	 * @return mixed
+	 */
+	public function get($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @access public
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function has($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * hasObject
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function hasObject($object)
+	{
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * hasObjects
+	 * returns true if there are objects within the Collection, and false if it is empty
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function hasObjects()
+	{
+		return $this->count() !== 0;
+	}
+
+
+	/**
+	 * isEmpty
+	 * returns true if there are no objects within the Collection, and false if there are
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		return $this->count() === 0;
+	}
+
+
+	/**
+	 * remove
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		$this->detach($object);
+		return true;
+	}
+
+
+	/**
+	 * setCurrent
+	 * advances pointer to the object whose identifier matches that which was provided
+	 *
+	 * @access public
+	 * @param mixed $identifier
+	 * @return boolean
+	 */
+	public function setCurrent($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * setCurrentUsingObject
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return boolean
+	 */
+	public function setCurrentUsingObject($object)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current() === $object) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object occupying the index before the current object,
+	 * unless this is already the first object, in which case it just returns the first object
+	 *
+	 * @return mixed
+	 */
+	public function previous()
+	{
+		$index = $this->indexOf($this->current());
+		if ($index === 0) {
+			return $this->current();
+		}
+		$index--;
+		return $this->objectAtIndex($index);
+	}
+
+
+	/**
+	 * Returns the index of a given object, or false if not found
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param $object
+	 * @return boolean|int|string
+	 */
+	public function indexOf($object)
+	{
+		if (! $this->contains($object)) {
+			return false;
+		}
+		foreach ($this as $index => $obj) {
+			if ($obj === $object) {
+				return $index;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 * @return mixed
+	 */
+	public function objectAtIndex($index)
+	{
+		$iterator = new LimitIterator($this, $index, 1);
+		$iterator->rewind();
+		return $iterator->current();
+	}
+
+
+	/**
+	 * Returns the sequence of objects as specified by the offset and length
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $offset
+	 * @param int $length
+	 * @return array
+	 */
+	public function slice($offset, $length)
+	{
+		$slice = array();
+		$iterator = new LimitIterator($this, $offset, $length);
+		foreach ($iterator as $object) {
+			$slice[] = $object;
+		}
+		return $slice;
+	}
+
+
+	/**
+	 * Inserts an object at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $object A single object
+	 * @param int   $index
+	 * @param mixed $identifier
+	 * @return bool
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidEntityException
+	 */
+	public function insertObjectAt($object, $index, $identifier = null)
+	{
+		// check to ensure that objects don't already exist in the collection
+		if ($this->has($identifier)) {
+			throw new DuplicateCollectionIdentifierException($identifier);
+		}
+		// detach any objects at or past this index
+		$remaining_objects = array();
+		if ($index < $this->count()) {
+			$remaining_objects = $this->slice($index, $this->count() - $index);
+			foreach ($remaining_objects as $key => $remaining_object) {
+				// we need to grab the identifiers for each object and use them as keys
+				$remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
+				// and then remove the object from the current tracking array
+				unset($remaining_objects[ $key ]);
+				// and then remove it from the Collection
+				$this->detach($remaining_object);
+			}
+		}
+		// add the new object we're splicing in
+		$this->add($object, $identifier);
+		// attach the objects we previously detached
+		foreach ($remaining_objects as $key => $remaining_object) {
+			$this->add($remaining_object, $key);
+		}
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * Inserts an object (or an array of objects) at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $objects A single object or an array of objects
+	 * @param int   $index
+	 */
+	public function insertAt($objects, $index)
+	{
+		if (! is_array($objects)) {
+			$objects = array($objects);
+		}
+		// check to ensure that objects don't already exist in the collection
+		foreach ($objects as $key => $object) {
+			if ($this->contains($object)) {
+				unset($objects[ $key ]);
+			}
+		}
+		// do we have any objects left?
+		if (! $objects) {
+			return;
+		}
+		// detach any objects at or past this index
+		$remaining = array();
+		if ($index < $this->count()) {
+			$remaining = $this->slice($index, $this->count() - $index);
+			foreach ($remaining as $object) {
+				$this->detach($object);
+			}
+		}
+		// add the new objects we're splicing in
+		foreach ($objects as $object) {
+			$this->attach($object);
+		}
+		// attach the objects we previously detached
+		foreach ($remaining as $object) {
+			$this->attach($object);
+		}
+	}
+
+
+	/**
+	 * Removes the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 */
+	public function removeAt($index)
+	{
+		$this->detach($this->objectAtIndex($index));
+	}
+
+
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+		}
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the Collection
+	 */
+	public function trashAndDetachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+			unset($object);
+		}
+	}
 }

core/services/collections/InvalidCollectionIdentifierException.php

Indentation +21 added lines, -21 removed lines

@@ -16,26 +16,26 @@
 class InvalidCollectionIdentifierException extends OutOfBoundsException
 {
 
-    /**
-     * InvalidCollectionIdentifierException constructor.
-     *
-     * @param                $identifier
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied identifier "%1$s" does not exist within this collection. 
+	/**
+	 * InvalidCollectionIdentifierException constructor.
+	 *
+	 * @param                $identifier
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied identifier "%1$s" does not exist within this collection. 
                     You may need to delay adding this asset until the required dependency has been added.',
-                    'event_espresso'
-                ),
-                $identifier
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+					'event_espresso'
+				),
+				$identifier
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/collections/DuplicateCollectionIdentifierException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class DuplicateCollectionIdentifierException extends OutOfRangeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param                $identifier
-     * @param string         $message
-     * @param int            $code
-     * @param Exception|null $previous
-     */
-    public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied identifier "%1$s" already exists within this collection.',
-                    'event_espresso'
-                ),
-                $identifier
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param                $identifier
+	 * @param string         $message
+	 * @param int            $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($identifier, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied identifier "%1$s" already exists within this collection.',
+					'event_espresso'
+				),
+				$identifier
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/assets/AssetCollection.php

Indentation +72 added lines, -72 removed lines

@@ -21,86 +21,86 @@
 {
 
 
-    /**
-     * AssetCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\values\assets\Asset');
-    }
+	/**
+	 * AssetCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\values\assets\Asset');
+	}
 
 
-    /**
-     * @return StylesheetAsset[]
-     * @since $VID:$
-     */
-    public function getStylesheetAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_CSS);
-    }
+	/**
+	 * @return StylesheetAsset[]
+	 * @since $VID:$
+	 */
+	public function getStylesheetAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_CSS);
+	}
 
 
-    /**
-     * @return JavascriptAsset[]
-     * @since $VID:$
-     */
-    public function getJavascriptAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_JS);
-    }
+	/**
+	 * @return JavascriptAsset[]
+	 * @since $VID:$
+	 */
+	public function getJavascriptAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_JS);
+	}
 
 
-    /**
-     * @return ManifestFile[]
-     * @since $VID:$
-     */
-    public function getManifestFiles()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
-    }
+	/**
+	 * @return ManifestFile[]
+	 * @since $VID:$
+	 */
+	public function getManifestFiles()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
+	}
 
 
-    /**
-     * @param $type
-     * @return array
-     * @since $VID:$
-     */
-    protected function getAssetsOfType($type)
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var \EventEspresso\core\domain\values\assets\Asset $asset */
-            $asset = $this->current();
-            if ($asset->type() === $type) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
+	/**
+	 * @param $type
+	 * @return array
+	 * @since $VID:$
+	 */
+	protected function getAssetsOfType($type)
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var \EventEspresso\core\domain\values\assets\Asset $asset */
+			$asset = $this->current();
+			if ($asset->type() === $type) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
 
 
-    /**
-     * @return JavascriptAsset[]
-     * @since $VID:$
-     */
-    public function getJavascriptAssetsWithData()
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var \EventEspresso\core\domain\values\assets\JavascriptAsset $asset */
-            $asset = $this->current();
-            if ($asset->type() === Asset::TYPE_JS && $asset->hasLocalizedData()) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
+	/**
+	 * @return JavascriptAsset[]
+	 * @since $VID:$
+	 */
+	public function getJavascriptAssetsWithData()
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var \EventEspresso\core\domain\values\assets\JavascriptAsset $asset */
+			$asset = $this->current();
+			if ($asset->type() === Asset::TYPE_JS && $asset->hasLocalizedData()) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -75,7 +75,7 @@ 
             /** @var \EventEspresso\core\domain\values\assets\Asset $asset */
             $asset = $this->current();
             if ($asset->type() === $type) {
-                $files[ $asset->handle() ] = $asset;
+                $files[$asset->handle()] = $asset;
             }
             $this->next();
         }
@@ -96,7 +96,7 @@ 
             /** @var \EventEspresso\core\domain\values\assets\JavascriptAsset $asset */
             $asset = $this->current();
             if ($asset->type() === Asset::TYPE_JS && $asset->hasLocalizedData()) {
-                $files[ $asset->handle() ] = $asset;
+                $files[$asset->handle()] = $asset;
             }
             $this->next();
         }

core/services/assets/Registry.php

Spacing +30 added lines, -30 removed lines

@@ -145,7 +145,7 @@ 
         $this->removeAlreadyRegisteredDataForScriptHandles();
         wp_add_inline_script(
             'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+            'var eejsdata='.wp_json_encode(array('data' => $this->jsdata)),
             'before'
         );
         $scripts = $this->assets->getJavascriptAssetsWithData();
@@ -174,7 +174,7 @@ 
     public function addData($key, $value)
     {
         if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $key ] = $value;
+            $this->jsdata[$key] = $value;
         }
     }
 
@@ -195,8 +195,8 @@ 
      */
     public function pushData($key, $value)
     {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
+        if (isset($this->jsdata[$key])
+            && ! is_array($this->jsdata[$key])
         ) {
             throw new InvalidArgumentException(
                 sprintf(
@@ -210,7 +210,7 @@ 
                 )
             );
         }
-        $this->jsdata[ $key ][] = $value;
+        $this->jsdata[$key][] = $value;
     }
 
 
@@ -224,11 +224,11 @@ 
      */
     public function addTemplate($template_reference, $template_content)
     {
-        if (! isset($this->jsdata['templates'])) {
+        if ( ! isset($this->jsdata['templates'])) {
             $this->jsdata['templates'] = array();
         }
         //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
+        if (isset($this->jsdata['templates'][$template_reference])) {
             throw new InvalidArgumentException(
                 sprintf(
                     __(
@@ -239,7 +239,7 @@ 
                 )
             );
         }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
+        $this->jsdata['templates'][$template_reference] = $template_content;
     }
 
 
@@ -251,8 +251,8 @@ 
      */
     public function getTemplate($template_reference)
     {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['templates'][ $template_reference ]
+        return isset($this->jsdata['templates'][$template_reference])
+            ? $this->jsdata['templates'][$template_reference]
             : '';
     }
 
@@ -265,8 +265,8 @@ 
      */
     public function getData($key)
     {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
+        return isset($this->jsdata[$key])
+            ? $this->jsdata[$key]
             : false;
     }
 
@@ -281,8 +281,8 @@ 
      */
     protected function verifyDataNotExisting($key)
     {
-        if (isset($this->jsdata[ $key ])) {
-            if (is_array($this->jsdata[ $key ])) {
+        if (isset($this->jsdata[$key])) {
+            if (is_array($this->jsdata[$key])) {
                 throw new InvalidArgumentException(
                     sprintf(
                         __(
@@ -325,11 +325,11 @@ 
     public function getAssetUrl($namespace, $chunk_name, $asset_type)
     {
         $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name ][ $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
+            $this->manifest_data[$namespace][$chunk_name][$asset_type],
+            $this->manifest_data[$namespace]['url_base']
         )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name ][ $asset_type ]
+            ? $this->manifest_data[$namespace]['url_base']
+              . $this->manifest_data[$namespace][$chunk_name][$asset_type]
             : $chunk_name;
         return apply_filters(
             'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
@@ -379,7 +379,7 @@ 
             $this->registerManifestFile(
                 $manifest_file->assetNamespace(),
                 $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+                $manifest_file->filepath().Registry::FILE_NAME_BUILD_MANIFEST
             );
         }
     }
@@ -397,7 +397,7 @@ 
      */
     public function registerManifestFile($namespace, $url_base, $manifest_file)
     {
-        if (isset($this->manifest_data[ $namespace ])) {
+        if (isset($this->manifest_data[$namespace])) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -428,9 +428,9 @@ 
             }
             return;
         }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+        $this->manifest_data[$namespace] = $this->decodeManifestFile($manifest_file);
+        if ( ! isset($this->manifest_data[$namespace]['url_base'])) {
+            $this->manifest_data[$namespace]['url_base'] = trailingslashit($url_base);
         }
     }
 
@@ -445,7 +445,7 @@ 
      */
     private function decodeManifestFile($manifest_file)
     {
-        if (! file_exists($manifest_file)) {
+        if ( ! file_exists($manifest_file)) {
             throw new InvalidFilePathException($manifest_file);
         }
         return json_decode(file_get_contents($manifest_file), true);
@@ -459,7 +459,7 @@ 
      */
     private function addRegisteredScriptHandlesWithData($script_handle)
     {
-        $this->script_handles_with_data[ $script_handle ] = $script_handle;
+        $this->script_handles_with_data[$script_handle] = $script_handle;
     }
 
 
@@ -485,23 +485,23 @@ 
      */
     private function removeAlreadyRegisteredDataForScriptHandle($script_handle)
     {
-        if (isset($this->script_handles_with_data[ $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($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($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']);
+                unset($wp_scripts->registered[$script_handle]->extra['after']);
             }
             if ($unset_handle) {
-                unset($this->script_handles_with_data[ $script_handle ]);
+                unset($this->script_handles_with_data[$script_handle]);
             }
         }
     }

Indentation +549 added lines, -549 removed lines

@@ -23,560 +23,560 @@
 class Registry
 {
 
-    const FILE_NAME_BUILD_MANIFEST = 'build-manifest.json';
-
-    /**
-     * @var AssetCollection $assets
-     */
-    protected $assets;
-
-    /**
-     * @var I18nRegistry
-     */
-    private $i18n_registry;
-
-    /**
-     * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
-     *
-     * @var array
-     */
-    protected $jsdata = array();
-
-    /**
-     * 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 = array();
-
-
-    /**
-     * Holds the manifest data obtained from registered manifest files.
-     * Manifests are maps of asset chunk name to actual built asset file names.
-     * Shape of this array is:
-     * array(
-     *  'some_namespace_slug' => array(
-     *      'some_chunk_name' => array(
-     *          'js' => 'filename.js'
-     *          'css' => 'filename.js'
-     *      ),
-     *      'url_base' => 'https://baseurl.com/to/assets
-     *  )
-     * )
-     *
-     * @var array
-     */
-    private $manifest_data = array();
-
-
-    /**
-     * Registry constructor.
-     * Hooking into WP actions for script registry.
-     *
-     * @param AssetCollection $assets
-     * @param I18nRegistry    $i18n_registry
-     */
-    public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
-    {
-        $this->assets = $assets;
-        $this->i18n_registry = $i18n_registry;
-        add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
-        add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
-        add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
-        add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
-        add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
-    }
-
-
-    /**
-     * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
-     * translation handling.
-     *
-     * @return I18nRegistry
-     */
-    public function getI18nRegistry()
-    {
-        return $this->i18n_registry;
-    }
-
-
-    /**
-     * Callback for the wp_enqueue_scripts actions used to register assets.
-     *
-     * @since $VID:$
-     * @throws Exception
-     */
-    public function registerScriptsAndStyles()
-    {
-        try {
-            $this->registerScripts($this->assets->getJavascriptAssets());
-            $this->registerStyles($this->assets->getStylesheetAssets());
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
-
-
-    /**
-     * Registers JS assets with WP core
-     *
-     * @since $VID:$
-     * @param JavascriptAsset[] $scripts
-     * @throws AssetRegistrationException
-     * @throws InvalidDataTypeException
-     */
-    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 (defined('EE_DEBUG') && EE_DEBUG && ! $registered) {
-                throw new AssetRegistrationException($script->handle());
-            }
-            $script->setRegistered($registered);
-            if ($script->requiresTranslation()) {
-                $this->registerTranslation($script->handle());
-            }
-            do_action(
-                'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
-                $script
-            );
-        }
-    }
-
-
-    /**
-     * Registers CSS assets with WP core
-     *
-     * @since $VID:$
-     * @param StylesheetAsset[] $styles
-     * @throws InvalidDataTypeException
-     */
-    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_enqueue_style(
-                $style->handle(),
-                $style->source(),
-                $style->dependencies(),
-                $style->version(),
-                $style->media()
-            );
-            $style->setRegistered();
-            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.
-     *
-     * @since 4.9.31.rc.015
-     */
-    public function enqueueData()
-    {
-        $this->removeAlreadyRegisteredDataForScriptHandles();
-        wp_add_inline_script(
-            'eejs-core',
-            'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
-            'before'
-        );
-        $scripts = $this->assets->getJavascriptAssetsWithData();
-        foreach ($scripts as $script) {
-            $this->addRegisteredScriptHandlesWithData($script->handle());
-            if ($script->hasLocalizationCallback()) {
-                $localize = $script->localizationCallback();
-                $localize();
-            }
-        }
-    }
-
-
-    /**
-     * 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($key, $value)
-    {
-        if ($this->verifyDataNotExisting($key)) {
-            $this->jsdata[ $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 appended to the end of an 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, then
-     * this will throw an exception.
-     *
-     * @param string       $key   Key to attach data to.
-     * @param string|array $value Value being registered.
-     * @throws InvalidArgumentException
-     */
-    public function pushData($key, $value)
-    {
-        if (isset($this->jsdata[ $key ])
-            && ! is_array($this->jsdata[ $key ])
-        ) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        '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 I18nRegistry
+	 */
+	private $i18n_registry;
+
+	/**
+	 * This holds the jsdata data object that will be exposed on pages that enqueue the `eejs-core` script.
+	 *
+	 * @var array
+	 */
+	protected $jsdata = array();
+
+	/**
+	 * 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 = array();
+
+
+	/**
+	 * Holds the manifest data obtained from registered manifest files.
+	 * Manifests are maps of asset chunk name to actual built asset file names.
+	 * Shape of this array is:
+	 * array(
+	 *  'some_namespace_slug' => array(
+	 *      'some_chunk_name' => array(
+	 *          'js' => 'filename.js'
+	 *          'css' => 'filename.js'
+	 *      ),
+	 *      'url_base' => 'https://baseurl.com/to/assets
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	private $manifest_data = array();
+
+
+	/**
+	 * Registry constructor.
+	 * Hooking into WP actions for script registry.
+	 *
+	 * @param AssetCollection $assets
+	 * @param I18nRegistry    $i18n_registry
+	 */
+	public function __construct(AssetCollection $assets, I18nRegistry $i18n_registry)
+	{
+		$this->assets = $assets;
+		$this->i18n_registry = $i18n_registry;
+		add_action('wp_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('admin_enqueue_scripts', array($this, 'registerManifestFiles'), 1);
+		add_action('wp_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('admin_enqueue_scripts', array($this, 'registerScriptsAndStyles'), 3);
+		add_action('wp_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('admin_enqueue_scripts', array($this, 'enqueueData'), 4);
+		add_action('wp_print_footer_scripts', array($this, 'enqueueData'), 1);
+		add_action('admin_print_footer_scripts', array($this, 'enqueueData'), 1);
+	}
+
+
+	/**
+	 * For classes that have Registry as a dependency, this provides a handy way to register script handles for i18n
+	 * translation handling.
+	 *
+	 * @return I18nRegistry
+	 */
+	public function getI18nRegistry()
+	{
+		return $this->i18n_registry;
+	}
+
+
+	/**
+	 * Callback for the wp_enqueue_scripts actions used to register assets.
+	 *
+	 * @since $VID:$
+	 * @throws Exception
+	 */
+	public function registerScriptsAndStyles()
+	{
+		try {
+			$this->registerScripts($this->assets->getJavascriptAssets());
+			$this->registerStyles($this->assets->getStylesheetAssets());
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
+
+
+	/**
+	 * Registers JS assets with WP core
+	 *
+	 * @since $VID:$
+	 * @param JavascriptAsset[] $scripts
+	 * @throws AssetRegistrationException
+	 * @throws InvalidDataTypeException
+	 */
+	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 (defined('EE_DEBUG') && EE_DEBUG && ! $registered) {
+				throw new AssetRegistrationException($script->handle());
+			}
+			$script->setRegistered($registered);
+			if ($script->requiresTranslation()) {
+				$this->registerTranslation($script->handle());
+			}
+			do_action(
+				'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__after_script',
+				$script
+			);
+		}
+	}
+
+
+	/**
+	 * Registers CSS assets with WP core
+	 *
+	 * @since $VID:$
+	 * @param StylesheetAsset[] $styles
+	 * @throws InvalidDataTypeException
+	 */
+	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_enqueue_style(
+				$style->handle(),
+				$style->source(),
+				$style->dependencies(),
+				$style->version(),
+				$style->media()
+			);
+			$style->setRegistered();
+			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.
+	 *
+	 * @since 4.9.31.rc.015
+	 */
+	public function enqueueData()
+	{
+		$this->removeAlreadyRegisteredDataForScriptHandles();
+		wp_add_inline_script(
+			'eejs-core',
+			'var eejsdata=' . wp_json_encode(array('data' => $this->jsdata)),
+			'before'
+		);
+		$scripts = $this->assets->getJavascriptAssetsWithData();
+		foreach ($scripts as $script) {
+			$this->addRegisteredScriptHandlesWithData($script->handle());
+			if ($script->hasLocalizationCallback()) {
+				$localize = $script->localizationCallback();
+				$localize();
+			}
+		}
+	}
+
+
+	/**
+	 * 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($key, $value)
+	{
+		if ($this->verifyDataNotExisting($key)) {
+			$this->jsdata[ $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 appended to the end of an 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, then
+	 * this will throw an exception.
+	 *
+	 * @param string       $key   Key to attach data to.
+	 * @param string|array $value Value being registered.
+	 * @throws InvalidArgumentException
+	 */
+	public function pushData($key, $value)
+	{
+		if (isset($this->jsdata[ $key ])
+			&& ! is_array($this->jsdata[ $key ])
+		) {
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'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__
-                )
-            );
-        }
-        $this->jsdata[ $key ][] = $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($template_reference, $template_content)
-    {
-        if (! isset($this->jsdata['templates'])) {
-            $this->jsdata['templates'] = array();
-        }
-        //no overrides allowed.
-        if (isset($this->jsdata['templates'][ $template_reference ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    __(
-                        'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
-                        'event_espresso'
-                    ),
-                    $template_reference
-                )
-            );
-        }
-        $this->jsdata['templates'][ $template_reference ] = $template_content;
-    }
-
-
-    /**
-     * Retrieve the template content already registered for the given reference.
-     *
-     * @param string $template_reference
-     * @return string
-     */
-    public function getTemplate($template_reference)
-    {
-        return isset($this->jsdata['templates'][ $template_reference ])
-            ? $this->jsdata['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($key)
-    {
-        return isset($this->jsdata[ $key ])
-            ? $this->jsdata[ $key ]
-            : false;
-    }
-
-
-    /**
-     * Verifies whether the given data exists already on the jsdata 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($key)
-    {
-        if (isset($this->jsdata[ $key ])) {
-            if (is_array($this->jsdata[ $key ])) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        __(
-                            'The value for %1$s already exists in the Registry::eejs object.
+						'event_espresso'
+					),
+					$key,
+					__METHOD__
+				)
+			);
+		}
+		$this->jsdata[ $key ][] = $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($template_reference, $template_content)
+	{
+		if (! isset($this->jsdata['templates'])) {
+			$this->jsdata['templates'] = array();
+		}
+		//no overrides allowed.
+		if (isset($this->jsdata['templates'][ $template_reference ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'The %1$s key already exists for the templates array in the js data array.  No overrides are allowed.',
+						'event_espresso'
+					),
+					$template_reference
+				)
+			);
+		}
+		$this->jsdata['templates'][ $template_reference ] = $template_content;
+	}
+
+
+	/**
+	 * Retrieve the template content already registered for the given reference.
+	 *
+	 * @param string $template_reference
+	 * @return string
+	 */
+	public function getTemplate($template_reference)
+	{
+		return isset($this->jsdata['templates'][ $template_reference ])
+			? $this->jsdata['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($key)
+	{
+		return isset($this->jsdata[ $key ])
+			? $this->jsdata[ $key ]
+			: false;
+	}
+
+
+	/**
+	 * Verifies whether the given data exists already on the jsdata 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($key)
+	{
+		if (isset($this->jsdata[ $key ])) {
+			if (is_array($this->jsdata[ $key ])) {
+				throw new InvalidArgumentException(
+					sprintf(
+						__(
+							'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(
-                    __(
-                        'The value for %1$s already exists in the Registry::eejs object. Overrides are not
+							'event_espresso'
+						),
+						$key,
+						'pushData()'
+					)
+				);
+			}
+			throw new InvalidArgumentException(
+				sprintf(
+					__(
+						'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($namespace, $chunk_name, $asset_type)
-    {
-        $url = isset(
-            $this->manifest_data[ $namespace ][ $chunk_name ][ $asset_type ],
-            $this->manifest_data[ $namespace ]['url_base']
-        )
-            ? $this->manifest_data[ $namespace ]['url_base']
-              . $this->manifest_data[ $namespace ][ $chunk_name ][ $asset_type ]
-            : $chunk_name;
-        return apply_filters(
-            'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
-            $url,
-            $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($namespace, $chunk_name)
-    {
-        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($namespace, $chunk_name)
-    {
-        return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @since $VID:$
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     */
-    public function registerManifestFiles()
-    {
-        $manifest_files = $this->assets->getManifestFiles();
-        foreach ($manifest_files as $manifest_file) {
-            $this->registerManifestFile(
-                $manifest_file->assetNamespace(),
-                $manifest_file->urlBase(),
-                $manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
-            );
-        }
-    }
-
-
-    /**
-     * Used to register a js/css manifest file with the registered_manifest_files property.
-     *
-     * @param string $namespace     Provided to associate the manifest file with a specific namespace.
-     * @param string $url_base      The url base for the manifest file location.
-     * @param string $manifest_file The absolute path to the manifest file.
-     * @throws InvalidArgumentException
-     * @throws InvalidFilePathException
-     * @since 4.9.59.p
-     */
-    public function registerManifestFile($namespace, $url_base, $manifest_file)
-    {
-        if (isset($this->manifest_data[ $namespace ])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The namespace for this manifest file has already been registered, choose a namespace other than %s',
-                        'event_espresso'
-                    ),
-                    $namespace
-                )
-            );
-        }
-        if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
-            if (is_admin()) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
-                            'event_espresso'
-                        ),
-                        'Event Espresso',
-                        $url_base,
-                        'plugins_url',
-                        'WP_PLUGIN_URL'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return;
-        }
-        $this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
-        if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
-            $this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
-        }
-    }
-
-
-    /**
-     * Decodes json from the provided manifest file.
-     *
-     * @since 4.9.59.p
-     * @param string $manifest_file Path to manifest file.
-     * @return array
-     * @throws InvalidFilePathException
-     */
-    private function decodeManifestFile($manifest_file)
-    {
-        if (! file_exists($manifest_file)) {
-            throw new InvalidFilePathException($manifest_file);
-        }
-        return json_decode(file_get_contents($manifest_file), true);
-    }
-
-
-    /**
-     * This is used to set registered script handles that have data.
-     *
-     * @param string $script_handle
-     */
-    private function addRegisteredScriptHandlesWithData($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($namespace, $chunk_name, $asset_type)
+	{
+		$url = isset(
+			$this->manifest_data[ $namespace ][ $chunk_name ][ $asset_type ],
+			$this->manifest_data[ $namespace ]['url_base']
+		)
+			? $this->manifest_data[ $namespace ]['url_base']
+			  . $this->manifest_data[ $namespace ][ $chunk_name ][ $asset_type ]
+			: $chunk_name;
+		return apply_filters(
+			'FHEE__EventEspresso_core_services_assets_Registry__getAssetUrl',
+			$url,
+			$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($namespace, $chunk_name)
+	{
+		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($namespace, $chunk_name)
+	{
+		return $this->getAssetUrl($namespace, $chunk_name, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @since $VID:$
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 */
+	public function registerManifestFiles()
+	{
+		$manifest_files = $this->assets->getManifestFiles();
+		foreach ($manifest_files as $manifest_file) {
+			$this->registerManifestFile(
+				$manifest_file->assetNamespace(),
+				$manifest_file->urlBase(),
+				$manifest_file->filepath() . Registry::FILE_NAME_BUILD_MANIFEST
+			);
+		}
+	}
+
+
+	/**
+	 * Used to register a js/css manifest file with the registered_manifest_files property.
+	 *
+	 * @param string $namespace     Provided to associate the manifest file with a specific namespace.
+	 * @param string $url_base      The url base for the manifest file location.
+	 * @param string $manifest_file The absolute path to the manifest file.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidFilePathException
+	 * @since 4.9.59.p
+	 */
+	public function registerManifestFile($namespace, $url_base, $manifest_file)
+	{
+		if (isset($this->manifest_data[ $namespace ])) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The namespace for this manifest file has already been registered, choose a namespace other than %s',
+						'event_espresso'
+					),
+					$namespace
+				)
+			);
+		}
+		if (filter_var($url_base, FILTER_VALIDATE_URL) === false) {
+			if (is_admin()) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The url given for %1$s assets is invalid.  The url provided was: "%2$s". This usually happens when another plugin or theme on a site is using the "%3$s" filter or has an invalid url set for the "%4$s" constant',
+							'event_espresso'
+						),
+						'Event Espresso',
+						$url_base,
+						'plugins_url',
+						'WP_PLUGIN_URL'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return;
+		}
+		$this->manifest_data[ $namespace ] = $this->decodeManifestFile($manifest_file);
+		if (! isset($this->manifest_data[ $namespace ]['url_base'])) {
+			$this->manifest_data[ $namespace ]['url_base'] = trailingslashit($url_base);
+		}
+	}
+
+
+	/**
+	 * Decodes json from the provided manifest file.
+	 *
+	 * @since 4.9.59.p
+	 * @param string $manifest_file Path to manifest file.
+	 * @return array
+	 * @throws InvalidFilePathException
+	 */
+	private function decodeManifestFile($manifest_file)
+	{
+		if (! file_exists($manifest_file)) {
+			throw new InvalidFilePathException($manifest_file);
+		}
+		return json_decode(file_get_contents($manifest_file), true);
+	}
+
+
+	/**
+	 * This is used to set registered script handles that have data.
+	 *
+	 * @param string $script_handle
+	 */
+	private function addRegisteredScriptHandlesWithData($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($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 ]);
-            }
-        }
-    }
-
-
-    /**
-     * register translations for a registered script
-     *
-     * @param string $handle
-     */
-    public function registerTranslation($handle)
-    {
-        $this->i18n_registry->registerScriptI18n($handle);
-    }
+	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($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 ]);
+			}
+		}
+	}
+
+
+	/**
+	 * register translations for a registered script
+	 *
+	 * @param string $handle
+	 */
+	public function registerTranslation($handle)
+	{
+		$this->i18n_registry->registerScriptI18n($handle);
+	}
 }

core/exceptions/InvalidIdentifierException.php

Indentation +23 added lines, -23 removed lines

@@ -16,28 +16,28 @@
 class InvalidIdentifierException extends InvalidArgumentException
 {
 
-    /**
-     * InvalidIdentifierException constructor.
-     *
-     * @param string     $actual   the identifier that was supplied
-     * @param string     $expected example of an acceptable identifier
-     * @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 identifier "%1$s" is invalid. A value like "%2$s" was expected.',
-                    'event_espresso'
-                ),
-                $actual,
-                $expected
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidIdentifierException constructor.
+	 *
+	 * @param string     $actual   the identifier that was supplied
+	 * @param string     $expected example of an acceptable identifier
+	 * @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 identifier "%1$s" is invalid. A value like "%2$s" was expected.',
+					'event_espresso'
+				),
+				$actual,
+				$expected
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }
 // Location: core/exceptions/InvalidIdentifierException.php

core/domain/services/assets/CoreAssetManager.php

Spacing +11 added lines, -11 removed lines

@@ -175,7 +175,7 @@ 
             //js.api
             $this->addJavascript(
                 CoreAssetManager::JS_HANDLE_EE_JS_API,
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+                EE_LIBRARIES_URL.'rest_api/assets/js/eejs-api.min.js',
                 array(
                     CoreAssetManager::JS_HANDLE_UNDERSCORE,
                     CoreAssetManager::JS_HANDLE_EE_JS_CORE
@@ -187,11 +187,11 @@ 
 
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_EE_CORE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array(CoreAssetManager::JS_HANDLE_JQUERY)
         )
         ->setLocalizationCallback(
-            function () {
+            function() {
                 wp_localize_script(
                     CoreAssetManager::JS_HANDLE_EE_CORE,
                     CoreAssetManager::JS_HANDLE_EE_I18N,
@@ -213,16 +213,16 @@ 
         if ($this->template_config->enable_default_style && ! is_admin()) {
             $this->addStylesheet(
                 CoreAssetManager::CSS_HANDLE_EE_DEFAULT,
-                is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+                is_readable(EVENT_ESPRESSO_UPLOAD_DIR.'css/style.css')
                     ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
-                    : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+                    : EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
                 array('dashicons')
             );
             //Load custom style sheet if available
             if ($this->template_config->custom_style_sheet !== null) {
                 $this->addStylesheet(
                     CoreAssetManager::CSS_HANDLE_EE_CUSTOM,
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+                    EVENT_ESPRESSO_UPLOAD_URL.'css/'.$this->template_config->custom_style_sheet,
                     array(CoreAssetManager::CSS_HANDLE_EE_DEFAULT)
                 );
             }
@@ -242,14 +242,14 @@ 
     {
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.min.js',
             array(CoreAssetManager::JS_HANDLE_JQUERY)
         )
         ->setVersion('1.15.0');
 
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.validate.additional-methods.min.js',
             array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE)
         )
         ->setVersion('1.15.0');
@@ -270,7 +270,7 @@ 
         // @link http://josscrowcroft.github.io/accounting.js/
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+            EE_THIRD_PARTY_URL.'accounting/accounting.js',
             array(CoreAssetManager::JS_HANDLE_UNDERSCORE)
         )
         ->setVersion('0.3.2');
@@ -278,11 +278,11 @@ 
         $currency_config = $this->currency_config;
         $this->addJavascript(
             CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/ee-accounting-config.js',
             array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
         )
         ->setLocalizationCallback(
-            function () use ($currency_config) {
+            function() use ($currency_config) {
                  wp_localize_script(
                      CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
                      'EE_ACCOUNTING_CFG',

Indentation +333 added lines, -333 removed lines

@@ -28,337 +28,337 @@
 class CoreAssetManager extends AssetManager
 {
 
-    // WordPress core / Third party JS asset handles
-    const JS_HANDLE_JQUERY                = 'jquery';
-
-    const JS_HANDLE_JQUERY_VALIDATE       = 'jquery-validate';
-
-    const JS_HANDLE_JQUERY_VALIDATE_EXTRA = 'jquery-validate-extra-methods';
-
-    const JS_HANDLE_UNDERSCORE            = 'underscore';
-
-    const JS_HANDLE_ACCOUNTING_CORE       = 'ee-accounting-core';
-
-    // EE JS assets handles
-    const JS_HANDLE_EE_MANIFEST        = 'ee-manifest';
-
-    const JS_HANDLE_EE_JS_CORE         = 'eejs-core';
-
-    const JS_HANDLE_EE_VENDOR_REACT    = 'ee-vendor-react';
-
-    const JS_HANDLE_EE_JS_API          = 'eejs-api';
-
-    const JS_HANDLE_EE_CORE            = 'espresso_core';
-
-    const JS_HANDLE_EE_I18N            = 'eei18n';
-
-    const JS_HANDLE_EE_ACCOUNTING      = 'ee-accounting';
-
-    const JS_HANDLE_EE_WP_PLUGINS_PAGE = 'ee-wp-plugins-page';
-
-    // EE CSS assets handles
-    const CSS_HANDLE_EE_DEFAULT = 'espresso_default';
-
-    const CSS_HANDLE_EE_CUSTOM  = 'espresso_custom_css';
-
-    /**
-     * @var EE_Currency_Config $currency_config
-     */
-    protected $currency_config;
-
-    /**
-     * @var EE_Template_Config $template_config
-     */
-    protected $template_config;
-
-
-    /**
-     * CoreAssetRegister constructor.
-     *
-     * @param AssetCollection    $assets
-     * @param EE_Currency_Config $currency_config
-     * @param EE_Template_Config $template_config
-     * @param DomainInterface    $domain
-     * @param Registry           $registry
-     */
-    public function __construct(
-        AssetCollection $assets,
-        EE_Currency_Config $currency_config,
-        EE_Template_Config $template_config,
-        DomainInterface $domain,
-        Registry $registry
-    ) {
-        $this->currency_config = $currency_config;
-        $this->template_config = $template_config;
-        parent::__construct($domain, $assets, $registry);
-    }
-
-
-    /**
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    public function addAssets()
-    {
-        $this->addJavascriptFiles();
-        $this->addStylesheetFiles();
-    }
-
-
-    /**
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    public function addJavascriptFiles()
-    {
-        $this->loadCoreJs();
-        $this->loadJqueryValidate();
-        $this->loadAccountingJs();
-        add_action(
-            'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-            array($this, 'loadQtipJs')
-        );
-        $this->registerAdminAssets();
-    }
-
-
-    /**
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    public function addStylesheetFiles()
-    {
-        $this->loadCoreCss();
-    }
-
-
-    /**
-     * core default javascript
-     *
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadCoreJs()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_MANIFEST,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'manifest')
-        );
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_JS_CORE,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'eejs'),
-            array(CoreAssetManager::JS_HANDLE_EE_MANIFEST)
-        )
-        ->setRequiresTranslation()
-        ->setHasLocalizedData();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_VENDOR_REACT,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'reactVendor'),
-            array(CoreAssetManager::JS_HANDLE_EE_JS_CORE)
-        );
-
-        global $wp_version;
-        if (version_compare($wp_version, '4.4.0', '>')) {
-            //js.api
-            $this->addJavascript(
-                CoreAssetManager::JS_HANDLE_EE_JS_API,
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
-                array(
-                    CoreAssetManager::JS_HANDLE_UNDERSCORE,
-                    CoreAssetManager::JS_HANDLE_EE_JS_CORE
-                )
-            );
-            $this->registry->addData('eejs_api_nonce', wp_create_nonce('wp_rest'));
-            $this->registry->addData(
-                'paths',
-                array(
-                    'rest_route' => rest_url('ee/v4.8.36/'),
-                    'collection_endpoints' => EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName(),
-                    'primary_keys' => EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName()
-                )
-            );
-        }
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_CORE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY)
-        )
-        ->setLocalizationCallback(
-            function () {
-                wp_localize_script(
-                    CoreAssetManager::JS_HANDLE_EE_CORE,
-                    CoreAssetManager::JS_HANDLE_EE_I18N,
-                    EE_Registry::$i18n_js_strings
-                );
-            }
-        );
-    }
-
-
-    /**
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadCoreCss()
-    {
-        if ($this->template_config->enable_default_style && ! is_admin()) {
-            $this->addStylesheet(
-                CoreAssetManager::CSS_HANDLE_EE_DEFAULT,
-                is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                    ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
-                    : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                array('dashicons')
-            );
-            //Load custom style sheet if available
-            if ($this->template_config->custom_style_sheet !== null) {
-                $this->addStylesheet(
-                    CoreAssetManager::CSS_HANDLE_EE_CUSTOM,
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
-                    array(CoreAssetManager::CSS_HANDLE_EE_DEFAULT)
-                );
-            }
-        }
-    }
-
-
-    /**
-     * jQuery Validate for form validation
-     *
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadJqueryValidate()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY)
-        )
-        ->setVersion('1.15.0');
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE)
-        )
-        ->setVersion('1.15.0');
-    }
-
-
-    /**
-     * accounting.js for performing client-side calculations
-     *
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadAccountingJs()
-    {
-        //accounting.js library
-        // @link http://josscrowcroft.github.io/accounting.js/
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
-            array(CoreAssetManager::JS_HANDLE_UNDERSCORE)
-        )
-        ->setVersion('0.3.2');
-
-        $currency_config = $this->currency_config;
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
-            array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
-        )
-        ->setLocalizationCallback(
-            function () use ($currency_config) {
-                 wp_localize_script(
-                     CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
-                     'EE_ACCOUNTING_CFG',
-                     array(
-                         'currency' => array(
-                             'symbol'    => $currency_config->sign,
-                             'format'    => array(
-                                 'pos'  => $currency_config->sign_b4 ? '%s%v' : '%v%s',
-                                 'neg'  => $currency_config->sign_b4 ? '- %s%v' : '- %v%s',
-                                 'zero' => $currency_config->sign_b4 ? '%s--' : '--%s',
-                             ),
-                             'decimal'   => $currency_config->dec_mrk,
-                             'thousand'  => $currency_config->thsnds,
-                             'precision' => $currency_config->dec_plc,
-                         ),
-                         'number'   => array(
-                             'precision' => $currency_config->dec_plc,
-                             'thousand'  => $currency_config->thsnds,
-                             'decimal'   => $currency_config->dec_mrk,
-                         ),
-                     )
-                 );
-            }
-        )
-        ->setVersion();
-    }
-
-
-    /**
-     * registers assets for cleaning your ears
-     *
-     * @param JavascriptAsset $script
-     */
-    public function loadQtipJs(JavascriptAsset $script)
-    {
-        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
-        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (
-            $script->handle() === CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE
-            && apply_filters('FHEE_load_qtip', false)
-        ) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-    }
-
-
-    /**
-     * assets that are used in the WordPress admin
-     *
-     * @since $VID:$
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function registerAdminAssets()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'wp-plugins-page'),
-            array(
-                CoreAssetManager::JS_HANDLE_JQUERY,
-                CoreAssetManager::JS_HANDLE_EE_VENDOR_REACT,
-            )
-        )
-        ->setRequiresTranslation();
-
-        $this->addStylesheet(
-            CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
-            $this->registry->getCssUrl($this->domain->assetNamespace(), 'wp-plugins-page')
-        );
-    }
+	// WordPress core / Third party JS asset handles
+	const JS_HANDLE_JQUERY                = 'jquery';
+
+	const JS_HANDLE_JQUERY_VALIDATE       = 'jquery-validate';
+
+	const JS_HANDLE_JQUERY_VALIDATE_EXTRA = 'jquery-validate-extra-methods';
+
+	const JS_HANDLE_UNDERSCORE            = 'underscore';
+
+	const JS_HANDLE_ACCOUNTING_CORE       = 'ee-accounting-core';
+
+	// EE JS assets handles
+	const JS_HANDLE_EE_MANIFEST        = 'ee-manifest';
+
+	const JS_HANDLE_EE_JS_CORE         = 'eejs-core';
+
+	const JS_HANDLE_EE_VENDOR_REACT    = 'ee-vendor-react';
+
+	const JS_HANDLE_EE_JS_API          = 'eejs-api';
+
+	const JS_HANDLE_EE_CORE            = 'espresso_core';
+
+	const JS_HANDLE_EE_I18N            = 'eei18n';
+
+	const JS_HANDLE_EE_ACCOUNTING      = 'ee-accounting';
+
+	const JS_HANDLE_EE_WP_PLUGINS_PAGE = 'ee-wp-plugins-page';
+
+	// EE CSS assets handles
+	const CSS_HANDLE_EE_DEFAULT = 'espresso_default';
+
+	const CSS_HANDLE_EE_CUSTOM  = 'espresso_custom_css';
+
+	/**
+	 * @var EE_Currency_Config $currency_config
+	 */
+	protected $currency_config;
+
+	/**
+	 * @var EE_Template_Config $template_config
+	 */
+	protected $template_config;
+
+
+	/**
+	 * CoreAssetRegister constructor.
+	 *
+	 * @param AssetCollection    $assets
+	 * @param EE_Currency_Config $currency_config
+	 * @param EE_Template_Config $template_config
+	 * @param DomainInterface    $domain
+	 * @param Registry           $registry
+	 */
+	public function __construct(
+		AssetCollection $assets,
+		EE_Currency_Config $currency_config,
+		EE_Template_Config $template_config,
+		DomainInterface $domain,
+		Registry $registry
+	) {
+		$this->currency_config = $currency_config;
+		$this->template_config = $template_config;
+		parent::__construct($domain, $assets, $registry);
+	}
+
+
+	/**
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	public function addAssets()
+	{
+		$this->addJavascriptFiles();
+		$this->addStylesheetFiles();
+	}
+
+
+	/**
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	public function addJavascriptFiles()
+	{
+		$this->loadCoreJs();
+		$this->loadJqueryValidate();
+		$this->loadAccountingJs();
+		add_action(
+			'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+			array($this, 'loadQtipJs')
+		);
+		$this->registerAdminAssets();
+	}
+
+
+	/**
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	public function addStylesheetFiles()
+	{
+		$this->loadCoreCss();
+	}
+
+
+	/**
+	 * core default javascript
+	 *
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadCoreJs()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_MANIFEST,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'manifest')
+		);
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_JS_CORE,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'eejs'),
+			array(CoreAssetManager::JS_HANDLE_EE_MANIFEST)
+		)
+		->setRequiresTranslation()
+		->setHasLocalizedData();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_VENDOR_REACT,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'reactVendor'),
+			array(CoreAssetManager::JS_HANDLE_EE_JS_CORE)
+		);
+
+		global $wp_version;
+		if (version_compare($wp_version, '4.4.0', '>')) {
+			//js.api
+			$this->addJavascript(
+				CoreAssetManager::JS_HANDLE_EE_JS_API,
+				EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+				array(
+					CoreAssetManager::JS_HANDLE_UNDERSCORE,
+					CoreAssetManager::JS_HANDLE_EE_JS_CORE
+				)
+			);
+			$this->registry->addData('eejs_api_nonce', wp_create_nonce('wp_rest'));
+			$this->registry->addData(
+				'paths',
+				array(
+					'rest_route' => rest_url('ee/v4.8.36/'),
+					'collection_endpoints' => EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName(),
+					'primary_keys' => EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName()
+				)
+			);
+		}
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_CORE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY)
+		)
+		->setLocalizationCallback(
+			function () {
+				wp_localize_script(
+					CoreAssetManager::JS_HANDLE_EE_CORE,
+					CoreAssetManager::JS_HANDLE_EE_I18N,
+					EE_Registry::$i18n_js_strings
+				);
+			}
+		);
+	}
+
+
+	/**
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadCoreCss()
+	{
+		if ($this->template_config->enable_default_style && ! is_admin()) {
+			$this->addStylesheet(
+				CoreAssetManager::CSS_HANDLE_EE_DEFAULT,
+				is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+					? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
+					: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				array('dashicons')
+			);
+			//Load custom style sheet if available
+			if ($this->template_config->custom_style_sheet !== null) {
+				$this->addStylesheet(
+					CoreAssetManager::CSS_HANDLE_EE_CUSTOM,
+					EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+					array(CoreAssetManager::CSS_HANDLE_EE_DEFAULT)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * jQuery Validate for form validation
+	 *
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadJqueryValidate()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY)
+		)
+		->setVersion('1.15.0');
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE)
+		)
+		->setVersion('1.15.0');
+	}
+
+
+	/**
+	 * accounting.js for performing client-side calculations
+	 *
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadAccountingJs()
+	{
+		//accounting.js library
+		// @link http://josscrowcroft.github.io/accounting.js/
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
+			EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+			array(CoreAssetManager::JS_HANDLE_UNDERSCORE)
+		)
+		->setVersion('0.3.2');
+
+		$currency_config = $this->currency_config;
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+			array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
+		)
+		->setLocalizationCallback(
+			function () use ($currency_config) {
+				 wp_localize_script(
+					 CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
+					 'EE_ACCOUNTING_CFG',
+					 array(
+						 'currency' => array(
+							 'symbol'    => $currency_config->sign,
+							 'format'    => array(
+								 'pos'  => $currency_config->sign_b4 ? '%s%v' : '%v%s',
+								 'neg'  => $currency_config->sign_b4 ? '- %s%v' : '- %v%s',
+								 'zero' => $currency_config->sign_b4 ? '%s--' : '--%s',
+							 ),
+							 'decimal'   => $currency_config->dec_mrk,
+							 'thousand'  => $currency_config->thsnds,
+							 'precision' => $currency_config->dec_plc,
+						 ),
+						 'number'   => array(
+							 'precision' => $currency_config->dec_plc,
+							 'thousand'  => $currency_config->thsnds,
+							 'decimal'   => $currency_config->dec_mrk,
+						 ),
+					 )
+				 );
+			}
+		)
+		->setVersion();
+	}
+
+
+	/**
+	 * registers assets for cleaning your ears
+	 *
+	 * @param JavascriptAsset $script
+	 */
+	public function loadQtipJs(JavascriptAsset $script)
+	{
+		// qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
+		// can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (
+			$script->handle() === CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE
+			&& apply_filters('FHEE_load_qtip', false)
+		) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+	}
+
+
+	/**
+	 * assets that are used in the WordPress admin
+	 *
+	 * @since $VID:$
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function registerAdminAssets()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'wp-plugins-page'),
+			array(
+				CoreAssetManager::JS_HANDLE_JQUERY,
+				CoreAssetManager::JS_HANDLE_EE_VENDOR_REACT,
+			)
+		)
+		->setRequiresTranslation();
+
+		$this->addStylesheet(
+			CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
+			$this->registry->getCssUrl($this->domain->assetNamespace(), 'wp-plugins-page')
+		);
+	}
 }

core/domain/values/assets/ManifestFile.php

Indentation +22 added lines, -22 removed lines

@@ -16,26 +16,26 @@
 class ManifestFile extends Asset
 {
 
-    /**
-     * Asset constructor.
-     *
-     * @param DomainInterface $domain
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(DomainInterface $domain)
-    {
-        parent::__construct(Asset::TYPE_MANIFEST, $domain->assetNamespace(), $domain);
-    }
-
-
-    public function urlBase()
-    {
-        return $this->domain->distributionAssetsUrl();
-    }
-
-
-    public function filepath()
-    {
-        return $this->domain->distributionAssetsPath();
-    }
+	/**
+	 * Asset constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(DomainInterface $domain)
+	{
+		parent::__construct(Asset::TYPE_MANIFEST, $domain->assetNamespace(), $domain);
+	}
+
+
+	public function urlBase()
+	{
+		return $this->domain->distributionAssetsUrl();
+	}
+
+
+	public function filepath()
+	{
+		return $this->domain->distributionAssetsPath();
+	}
 }