eventespresso / event-espresso-core

core/services/collections/Collection.php

Doc Comments +3 added lines, -3 removed lines

@@ -194,7 +194,7 @@ 
      * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
      *
      * @param mixed $identifier
-     * @return mixed
+     * @return boolean
      */
     public function get($identifier)
     {
@@ -309,7 +309,7 @@ 
      * setCurrentUsingObject
      * advances pointer to the provided object
      *
-     * @param $object
+     * @param \EventEspresso\core\libraries\form_sections\form_handlers\SequentialStepForm $object
      * @return boolean
      */
     public function setCurrentUsingObject($object)
@@ -347,7 +347,7 @@ 
      *
      * @see http://stackoverflow.com/a/8736013
      * @param $object
-     * @return boolean|int|string
+     * @return integer
      */
     public function indexOf($object)
     {

Indentation +498 added lines, -498 removed lines

@@ -19,502 +19,502 @@
 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;
-
-    /**
-     * a short dash separated string describing the contents of this collection
-     *
-     * @type string $collection_identifier
-     */
-    protected $collection_name;
-
-
-    /**
-     * Collection constructor
-     *
-     * @param string $collection_interface
-     * @param string $collection_name
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($collection_interface, $collection_name = '')
-    {
-        $this->setCollectionInterface($collection_interface);
-        $this->setCollectionName($collection_name);
-        $this->setCollectionIdentifier();
-    }
-
-
-    /**
-     * 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;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * @param string $collection_name
-     */
-    protected function setCollectionName($collection_name)
-    {
-        $this->collection_name = ! empty($collection_name)
-            ? sanitize_key($collection_name)
-            : basename(str_replace('\\', '/', get_class($this)));
-    }
-
-
-    /**
-     * @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);
-        }
-        $this->collection_identifier = $this->collection_name . '-' . strtoupper(implode('-', $id));
-    }
-
-
-    /**
-     * 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);
-    }
-
-
-    /**
-     * getIdentifier
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function getIdentifier($object, $identifier = null)
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : spl_object_hash($object);
-    }
-
-
-    /**
-     * setIdentifier
-     * Sets the data associated with an object in the Collection
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function setIdentifier($object, $identifier = null)
-    {
-        $identifier = $this->getIdentifier($object, $identifier);
-        $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
-     *
-     * @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
-     *
-     * @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
-     *
-     * @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
-     *
-     * @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
-     *
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        return $this->count() === 0;
-    }
-
-
-    /**
-     * remove
-     * detaches an object from the Collection
-     *
-     * @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
-     *
-     * @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
-     *
-     * @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;
+
+	/**
+	 * a short dash separated string describing the contents of this collection
+	 *
+	 * @type string $collection_identifier
+	 */
+	protected $collection_name;
+
+
+	/**
+	 * Collection constructor
+	 *
+	 * @param string $collection_interface
+	 * @param string $collection_name
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($collection_interface, $collection_name = '')
+	{
+		$this->setCollectionInterface($collection_interface);
+		$this->setCollectionName($collection_name);
+		$this->setCollectionIdentifier();
+	}
+
+
+	/**
+	 * 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;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * @param string $collection_name
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		$this->collection_name = ! empty($collection_name)
+			? sanitize_key($collection_name)
+			: basename(str_replace('\\', '/', get_class($this)));
+	}
+
+
+	/**
+	 * @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);
+		}
+		$this->collection_identifier = $this->collection_name . '-' . strtoupper(implode('-', $id));
+	}
+
+
+	/**
+	 * 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);
+	}
+
+
+	/**
+	 * getIdentifier
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function getIdentifier($object, $identifier = null)
+	{
+		return ! empty($identifier)
+			? $identifier
+			: spl_object_hash($object);
+	}
+
+
+	/**
+	 * setIdentifier
+	 * Sets the data associated with an object in the Collection
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function setIdentifier($object, $identifier = null)
+	{
+		$identifier = $this->getIdentifier($object, $identifier);
+		$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
+	 *
+	 * @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
+	 *
+	 * @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
+	 *
+	 * @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
+	 *
+	 * @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
+	 *
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		return $this->count() === 0;
+	}
+
+
+	/**
+	 * remove
+	 * detaches an object from the Collection
+	 *
+	 * @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
+	 *
+	 * @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
+	 *
+	 * @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);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -66,7 +66,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,13 +111,13 @@ 
     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);
         }
-        $this->collection_identifier = $this->collection_name . '-' . strtoupper(implode('-', $id));
+        $this->collection_identifier = $this->collection_name.'-'.strtoupper(implode('-', $id));
     }
 
 
@@ -135,7 +135,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)) {
@@ -351,7 +351,7 @@ 
      */
     public function indexOf($object)
     {
-        if (! $this->contains($object)) {
+        if ( ! $this->contains($object)) {
             return false;
         }
         foreach ($this as $index => $obj) {
@@ -420,9 +420,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);
             }
@@ -446,17 +446,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

core/services/collections/CollectionLoader.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +267 added lines, -267 removed lines

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

Spacing +8 added lines, -8 removed lines

@@ -87,7 +87,7 @@ 
     ) {
         try {
             $this->collection_details = $collection_details;
-            if (! $collection instanceof CollectionInterface) {
+            if ( ! $collection instanceof CollectionInterface) {
                 $collection = new Collection($this->collection_details->getCollectionInterface());
             }
             $this->collection = $collection;
@@ -119,7 +119,7 @@ 
      */
     protected function loadAllFromFilepaths()
     {
-        if (! $this->file_locator instanceof FileLocator) {
+        if ( ! $this->file_locator instanceof FileLocator) {
             $this->file_locator = new FileLocator();
         }
         $this->file_locator->setFileMask($this->collection_details->getFileMask());
@@ -152,10 +152,10 @@ 
      */
     protected function loadClassFromFilepath($filepath)
     {
-        if (! is_string($filepath)) {
+        if ( ! is_string($filepath)) {
             throw new InvalidDataTypeException('$filepath', $filepath, 'string');
         }
-        if (! is_readable($filepath)) {
+        if ( ! is_readable($filepath)) {
             throw new InvalidFilePathException($filepath);
         }
         require_once $filepath;
@@ -163,7 +163,7 @@ 
         $file_name = basename($filepath);
         // now remove any file extensions
         $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new InvalidClassException($class_name);
         }
         $entity = $this->entity_factory instanceof FactoryInterface
@@ -237,7 +237,7 @@ 
             // objects added to the collection based on entity callback, so the entity itself decides
             case CollectionDetails::ID_CALLBACK_METHOD:
                 $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
+                if ( ! method_exists($entity, $identifier_callback)) {
                     throw new InvalidEntityException(
                         $entity,
                         $this->collection_details->getCollectionInterface(),
@@ -303,10 +303,10 @@ 
      */
     protected function loadClassFromFQCN($FQCN)
     {
-        if (! is_string($FQCN)) {
+        if ( ! is_string($FQCN)) {
             throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
         }
-        if (! class_exists($FQCN)) {
+        if ( ! class_exists($FQCN)) {
             throw new InvalidClassException($FQCN);
         }
         do_action(

core/domain/entities/editor/BlockInterface.php

Indentation +66 added lines, -66 removed lines

@@ -22,70 +22,70 @@
 interface BlockInterface
 {
 
-    const NAME_SPACE = 'eventespresso';
-
-    /**
-     * Perform any early setup required by the block
-     * including setting the block type and supported post types
-     *
-     * @return void
-     */
-    public function initialize();
-
-
-    /**
-     * @return string
-     */
-    public function blockType();
-
-
-    /**
-     * AssetRegister that this editor block uses for asset registration
-     *
-     * @return BlockAssetManagerInterface
-     */
-    public function assetManager();
-
-
-    /**
-     * Registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function registerBlock();
-
-
-    /**
-     * Un-registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function unRegisterBlock();
-
-
-    /**
-     * returns an array of fully qualified class names
-     * for RouteMatchSpecificationInterface objects
-     * that specify routes that the block should be loaded for.
-     *
-     * @return array
-     */
-    public function supportedRoutes();
-
-
-    /**
-     * @return array
-     */
-    public function getEditorContainer();
-
-
-    /**
-     * returns the rendered HTML for the block
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function renderBlock(array $attributes = array());
+	const NAME_SPACE = 'eventespresso';
+
+	/**
+	 * Perform any early setup required by the block
+	 * including setting the block type and supported post types
+	 *
+	 * @return void
+	 */
+	public function initialize();
+
+
+	/**
+	 * @return string
+	 */
+	public function blockType();
+
+
+	/**
+	 * AssetRegister that this editor block uses for asset registration
+	 *
+	 * @return BlockAssetManagerInterface
+	 */
+	public function assetManager();
+
+
+	/**
+	 * Registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function registerBlock();
+
+
+	/**
+	 * Un-registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function unRegisterBlock();
+
+
+	/**
+	 * returns an array of fully qualified class names
+	 * for RouteMatchSpecificationInterface objects
+	 * that specify routes that the block should be loaded for.
+	 *
+	 * @return array
+	 */
+	public function supportedRoutes();
+
+
+	/**
+	 * @return array
+	 */
+	public function getEditorContainer();
+
+
+	/**
+	 * returns the rendered HTML for the block
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function renderBlock(array $attributes = array());
 }

core/domain/entities/route_match/RouteMatchSpecification.php

Indentation +12 added lines, -12 removed lines

@@ -24,17 +24,17 @@
 abstract class RouteMatchSpecification implements RouteMatchSpecificationInterface
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * RouteMatch constructor.
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * RouteMatch constructor.
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 }

core/domain/entities/route_match/DoesNotMatchRouteSpecification.php

Indentation +10 added lines, -10 removed lines

@@ -14,14 +14,14 @@
  */
 class DoesNotMatchRouteSpecification extends RouteMatchSpecificationDecorator
 {
-    /**
-     * returns true if current request matches specification
-     *
-     * @since $VID:$
-     * @return boolean
-     */
-    public function routeMatches()
-    {
-        return ! $this->specification->routeMatches();
-    }
+	/**
+	 * returns true if current request matches specification
+	 *
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function routeMatches()
+	{
+		return ! $this->specification->routeMatches();
+	}
 }

core/domain/entities/route_match/RouteMatchSpecificationInterface.php

Indentation +7 added lines, -7 removed lines

@@ -12,11 +12,11 @@
  */
 interface RouteMatchSpecificationInterface
 {
-    /**
-     * returns true if current request matches specification
-     *
-     * @since $VID:$
-     * @return boolean
-     */
-    public function routeMatches();
+	/**
+	 * returns true if current request matches specification
+	 *
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function routeMatches();
 }

core/domain/entities/route_match/MultiRouteSpecification.php

Indentation +15 added lines, -15 removed lines

@@ -15,20 +15,20 @@
 abstract class MultiRouteSpecification extends RouteMatchSpecification
 {
 
-    /**
-     * @var RouteMatchSpecificationInterface[] $specifications
-     */
-    protected $specifications;
+	/**
+	 * @var RouteMatchSpecificationInterface[] $specifications
+	 */
+	protected $specifications;
 
-    /**
-     * MultiRouteSpecification constructor.
-     *
-     * @param RouteMatchSpecificationInterface[] $specifications
-     * @param RequestInterface                   $request
-     */
-    public function __construct(array $specifications, RequestInterface $request)
-    {
-        $this->specifications = $specifications;
-        parent::__construct($request);
-    }
+	/**
+	 * MultiRouteSpecification constructor.
+	 *
+	 * @param RouteMatchSpecificationInterface[] $specifications
+	 * @param RequestInterface                   $request
+	 */
+	public function __construct(array $specifications, RequestInterface $request)
+	{
+		$this->specifications = $specifications;
+		parent::__construct($request);
+	}
 }

core/domain/entities/route_match/MatchAnyRouteSpecification.php

Indentation +15 added lines, -15 removed lines

@@ -14,19 +14,19 @@
 class MatchAnyRouteSpecification extends MultiRouteSpecification
 {
 
-    /**
-     * returns true if current request matches specification
-     *
-     * @since $VID:$
-     * @return boolean
-     */
-    public function routeMatches()
-    {
-        foreach ($this->specifications as $specification) {
-            if ($specification->routeMatches()) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * returns true if current request matches specification
+	 *
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function routeMatches()
+	{
+		foreach ($this->specifications as $specification) {
+			if ($specification->routeMatches()) {
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/domain/entities/route_match/specifications/admin/WordPressPostsEditorAddNew.php

Indentation +14 added lines, -14 removed lines

@@ -14,18 +14,18 @@
  */
 class WordPressPostsEditorAddNew extends RouteMatchSpecification
 {
-    /**
-     * returns true if current request matches specification
-     *
-     * @since $VID:$
-     * @return boolean
-     */
-    public function routeMatches()
-    {
-        return strpos($this->request->requestUri(),'wp-admin/post-new.php' ) !== false
-            && (
-                $this->request->getRequestParam('post_type') === 'post'
-                || $this->request->requestParamIsSet('post_type') === false
-            );
-    }
+	/**
+	 * returns true if current request matches specification
+	 *
+	 * @since $VID:$
+	 * @return boolean
+	 */
+	public function routeMatches()
+	{
+		return strpos($this->request->requestUri(),'wp-admin/post-new.php' ) !== false
+			&& (
+				$this->request->getRequestParam('post_type') === 'post'
+				|| $this->request->requestParamIsSet('post_type') === false
+			);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      */
     public function routeMatches()
     {
-        return strpos($this->request->requestUri(),'wp-admin/post-new.php' ) !== false
+        return strpos($this->request->requestUri(), 'wp-admin/post-new.php') !== false
             && (
                 $this->request->getRequestParam('post_type') === 'post'
                 || $this->request->requestParamIsSet('post_type') === false