eventespresso / event-espresso-core

core/services/assets/AssetCollection.php

Spacing +2 added lines, -2 removed lines

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

Indentation +188 added lines, -188 removed lines

@@ -21,192 +21,192 @@
 {
 
 
-    /**
-     * AssetCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\values\assets\Asset');
-    }
-
-
-    /**
-     * @return StylesheetAsset[]
-     * @since 4.9.62.p
-     */
-    public function getStylesheetAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * @return JavascriptAsset[]
-     * @since 4.9.62.p
-     */
-    public function getJavascriptAssets()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_JS);
-    }
-
-
-    /**
-     * @return ManifestFile[]
-     * @since 4.9.62.p
-     */
-    public function getManifestFiles()
-    {
-        return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
-    }
-
-
-    /**
-     * @param $type
-     * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[]
-     * @since 4.9.62.p
-     */
-    protected function getAssetsOfType($type)
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var Asset $asset */
-            $asset = $this->current();
-            if ($asset->type() === $type) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
-
-
-    /**
-     * @return JavascriptAsset[]
-     * @since 4.9.62.p
-     */
-    public function getJavascriptAssetsWithData()
-    {
-        $files = array();
-        $this->rewind();
-        while ($this->valid()) {
-            /** @var JavascriptAsset $asset */
-            $asset = $this->current();
-            if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
-                $files[ $asset->handle() ] = $asset;
-            }
-            $this->next();
-        }
-        $this->rewind();
-        return $files;
-    }
-
-
-    /**
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier and type
-     *
-     * @param  mixed $identifier
-     * @param string $type
-     * @return bool
-     * @since 4.9.63.p
-     */
-    public function hasAssetOfType($identifier, $type = Asset::TYPE_JS)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * returns TRUE or FALSE
-     * depending on whether the Javascript Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     * @since 4.9.63.p
-     */
-    public function hasJavascriptAsset($identifier)
-    {
-        return $this->hasAssetOfType($identifier, Asset::TYPE_JS);
-    }
-
-
-    /**
-     * returns TRUE or FALSE
-     * depending on whether the Stylesheet Asset is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     * @since 4.9.63.p
-     */
-    public function hasStylesheetAsset($identifier)
-    {
-        return $this->hasAssetOfType($identifier, Asset::TYPE_CSS);
-    }
-
-    /**
-     * returns the object from the Collection
-     * based on the supplied $identifier and type
-     *
-     * @param  mixed $identifier
-     * @param string $type
-     * @return JavascriptAsset|StylesheetAsset
-     * @since 4.9.63.p
-     */
-    public function getAssetOfType($identifier, $type = Asset::TYPE_JS)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
-                /** @var JavascriptAsset|StylesheetAsset $object */
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * returns the Stylesheet Asset from the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return StylesheetAsset
-     * @since 4.9.63.p
-     */
-    public function getStylesheetAsset($identifier)
-    {
-        return $this->getAssetOfType($identifier, Asset::TYPE_CSS);
-    }
-
-
-    /**
-     * returns the Javascript Asset from the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return JavascriptAsset
-     * @since 4.9.63.p
-     */
-    public function getJavascriptAsset($identifier)
-    {
-        return $this->getAssetOfType($identifier, Asset::TYPE_JS);
-    }
+	/**
+	 * AssetCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\values\assets\Asset');
+	}
+
+
+	/**
+	 * @return StylesheetAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getStylesheetAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * @return JavascriptAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getJavascriptAssets()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * @return ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	public function getManifestFiles()
+	{
+		return $this->getAssetsOfType(Asset::TYPE_MANIFEST);
+	}
+
+
+	/**
+	 * @param $type
+	 * @return JavascriptAsset[]|StylesheetAsset[]|ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	protected function getAssetsOfType($type)
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var Asset $asset */
+			$asset = $this->current();
+			if ($asset->type() === $type) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
+
+
+	/**
+	 * @return JavascriptAsset[]
+	 * @since 4.9.62.p
+	 */
+	public function getJavascriptAssetsWithData()
+	{
+		$files = array();
+		$this->rewind();
+		while ($this->valid()) {
+			/** @var JavascriptAsset $asset */
+			$asset = $this->current();
+			if ($asset->type() === Asset::TYPE_JS && $asset->hasInlineData()) {
+				$files[ $asset->handle() ] = $asset;
+			}
+			$this->next();
+		}
+		$this->rewind();
+		return $files;
+	}
+
+
+	/**
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier and type
+	 *
+	 * @param  mixed $identifier
+	 * @param string $type
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	public function hasAssetOfType($identifier, $type = Asset::TYPE_JS)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * returns TRUE or FALSE
+	 * depending on whether the Javascript Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	public function hasJavascriptAsset($identifier)
+	{
+		return $this->hasAssetOfType($identifier, Asset::TYPE_JS);
+	}
+
+
+	/**
+	 * returns TRUE or FALSE
+	 * depending on whether the Stylesheet Asset is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @since 4.9.63.p
+	 */
+	public function hasStylesheetAsset($identifier)
+	{
+		return $this->hasAssetOfType($identifier, Asset::TYPE_CSS);
+	}
+
+	/**
+	 * returns the object from the Collection
+	 * based on the supplied $identifier and type
+	 *
+	 * @param  mixed $identifier
+	 * @param string $type
+	 * @return JavascriptAsset|StylesheetAsset
+	 * @since 4.9.63.p
+	 */
+	public function getAssetOfType($identifier, $type = Asset::TYPE_JS)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->getInfo() === $identifier && $this->current()->type() === $type) {
+				/** @var JavascriptAsset|StylesheetAsset $object */
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * returns the Stylesheet Asset from the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return StylesheetAsset
+	 * @since 4.9.63.p
+	 */
+	public function getStylesheetAsset($identifier)
+	{
+		return $this->getAssetOfType($identifier, Asset::TYPE_CSS);
+	}
+
+
+	/**
+	 * returns the Javascript Asset from the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return JavascriptAsset
+	 * @since 4.9.63.p
+	 */
+	public function getJavascriptAsset($identifier)
+	{
+		return $this->getAssetOfType($identifier, Asset::TYPE_JS);
+	}
 }

core/services/collections/Collection.php

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

Indentation +510 added lines, -510 removed lines

@@ -18,514 +18,514 @@
  */
 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
-     * used as the base for the $collection_identifier
-     * defaults to the class short name if not set
-     *
-     * @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();
-    }
-
-
-    /**
-     * @return string
-     * @since 4.10.33.p
-     */
-    public function collectionInterface(): string
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * 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 string
-     */
-    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 https://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 https://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 https://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 https://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 https://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 https://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
+	 * used as the base for the $collection_identifier
+	 * defaults to the class short name if not set
+	 *
+	 * @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();
+	}
+
+
+	/**
+	 * @return string
+	 * @since 4.10.33.p
+	 */
+	public function collectionInterface(): string
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * 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 string
+	 */
+	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 https://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 https://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 https://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 https://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 https://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 https://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/dependencies/ClassAlias.php

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      */
     public function __construct($alias, $fqcn)
     {
-        if (! is_subclass_of($fqcn, $alias)) {
+        if ( ! is_subclass_of($fqcn, $alias)) {
             throw new InvalidAliasException($fqcn, $alias);
         }
         $this->alias = $alias;

Indentation +38 added lines, -38 removed lines

@@ -16,46 +16,46 @@
  */
 class ClassAlias
 {
-    /**
-     * @var string $alias   an interface or base class representing what object
-     *                      can be utilized by another object and/or function
-     */
-    private $alias;
+	/**
+	 * @var string $alias   an interface or base class representing what object
+	 *                      can be utilized by another object and/or function
+	 */
+	private $alias;
 
-    /**
-     * @var string $fqcn the actual class that should be substituted for the alias above
-     */
-    private $fqcn;
+	/**
+	 * @var string $fqcn the actual class that should be substituted for the alias above
+	 */
+	private $fqcn;
 
-    /**
-     * ClassAlias constructor.
-     *
-     * @param string $alias Interface specified by implementing class
-     * @param string $fqcn  Concrete class that satisfies interface
-     * @throws InvalidAliasException
-     */
-    public function __construct($alias, $fqcn)
-    {
-        if (! is_subclass_of($fqcn, $alias)) {
-            throw new InvalidAliasException($fqcn, $alias);
-        }
-        $this->alias = $alias;
-        $this->fqcn = $fqcn;
-    }
+	/**
+	 * ClassAlias constructor.
+	 *
+	 * @param string $alias Interface specified by implementing class
+	 * @param string $fqcn  Concrete class that satisfies interface
+	 * @throws InvalidAliasException
+	 */
+	public function __construct($alias, $fqcn)
+	{
+		if (! is_subclass_of($fqcn, $alias)) {
+			throw new InvalidAliasException($fqcn, $alias);
+		}
+		$this->alias = $alias;
+		$this->fqcn = $fqcn;
+	}
 
-    /**
-     * @return string
-     */
-    public function alias()
-    {
-        return $this->alias;
-    }
+	/**
+	 * @return string
+	 */
+	public function alias()
+	{
+		return $this->alias;
+	}
 
-    /**
-     * @return string
-     */
-    public function fqcn()
-    {
-        return $this->fqcn;
-    }
+	/**
+	 * @return string
+	 */
+	public function fqcn()
+	{
+		return $this->fqcn;
+	}
 }

core/services/factory/FactoryWithDependencyResolver.php

Indentation +33 added lines, -33 removed lines

@@ -18,41 +18,41 @@
  */
 abstract class FactoryWithDependencyResolver implements FactoryInterface
 {
-    /**
-     * @var DependencyResolverInterface $dependency_resolver
-     */
-    private $dependency_resolver;
+	/**
+	 * @var DependencyResolverInterface $dependency_resolver
+	 */
+	private $dependency_resolver;
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
 
-    /**
-     * FactoryWithDependencyResolver constructor.
-     *
-     * @param DependencyResolverInterface $dependency_resolver
-     * @param LoaderInterface             $loader
-     */
-    public function __construct(DependencyResolverInterface $dependency_resolver, LoaderInterface $loader)
-    {
-        $this->dependency_resolver = $dependency_resolver;
-        $this->loader = $loader;
-    }
+	/**
+	 * FactoryWithDependencyResolver constructor.
+	 *
+	 * @param DependencyResolverInterface $dependency_resolver
+	 * @param LoaderInterface             $loader
+	 */
+	public function __construct(DependencyResolverInterface $dependency_resolver, LoaderInterface $loader)
+	{
+		$this->dependency_resolver = $dependency_resolver;
+		$this->loader = $loader;
+	}
 
-    /**
-     * @return DependencyResolverInterface
-     */
-    public function dependencyResolver()
-    {
-        return $this->dependency_resolver;
-    }
+	/**
+	 * @return DependencyResolverInterface
+	 */
+	public function dependencyResolver()
+	{
+		return $this->dependency_resolver;
+	}
 
-    /**
-     * @return LoaderInterface
-     */
-    public function loader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @return LoaderInterface
+	 */
+	public function loader()
+	{
+		return $this->loader;
+	}
 }

core/domain/entities/route_match/MatchAllRouteSpecifications.php

Spacing +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
     public function isMatchingRoute()
     {
         foreach ($this->specifications as $specification) {
-            if (! $specification->isMatchingRoute()) {
+            if ( ! $specification->isMatchingRoute()) {
                 return false;
             }
         }

Indentation +15 added lines, -15 removed lines

@@ -13,19 +13,19 @@
  */
 class MatchAllRouteSpecifications extends MultiRouteSpecification
 {
-    /**
-     * returns true if current request matches specification
-     *
-     * @since 4.9.71.p
-     * @return boolean
-     */
-    public function isMatchingRoute()
-    {
-        foreach ($this->specifications as $specification) {
-            if (! $specification->isMatchingRoute()) {
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * returns true if current request matches specification
+	 *
+	 * @since 4.9.71.p
+	 * @return boolean
+	 */
+	public function isMatchingRoute()
+	{
+		foreach ($this->specifications as $specification) {
+			if (! $specification->isMatchingRoute()) {
+				return false;
+			}
+		}
+		return true;
+	}
 }

core/services/route_match/RouteMatchSpecificationManager.php

Spacing +1 added lines, -1 removed lines

@@ -115,7 +115,7 @@
     {
         /** @var RouteMatchSpecificationInterface $specification */
         $specification = $this->specifications->get($routeMatchSpecificationFqcn);
-        if (! $specification instanceof $routeMatchSpecificationFqcn) {
+        if ( ! $specification instanceof $routeMatchSpecificationFqcn) {
             throw new InvalidClassException($routeMatchSpecificationFqcn);
         }
         return $specification->isMatchingRoute();

Indentation +107 added lines, -107 removed lines

@@ -25,122 +25,122 @@
  */
 class RouteMatchSpecificationManager
 {
-    /**
-     * @var CollectionInterface[]|RouteMatchSpecificationInterface[] $specifications
-     */
-    private $specifications;
+	/**
+	 * @var CollectionInterface[]|RouteMatchSpecificationInterface[] $specifications
+	 */
+	private $specifications;
 
-    /**
-     * @var RouteMatchSpecificationFactory $specifications_factory
-     */
-    private $specifications_factory;
+	/**
+	 * @var RouteMatchSpecificationFactory $specifications_factory
+	 */
+	private $specifications_factory;
 
 
-    /**
-     * RouteMatchSpecificationManager constructor.
-     *
-     * @param RouteMatchSpecificationCollection $specifications
-     * @param RouteMatchSpecificationFactory    $specifications_factory
-     */
-    public function __construct(
-        RouteMatchSpecificationCollection $specifications,
-        RouteMatchSpecificationFactory $specifications_factory
-    ) {
-        $this->specifications = $specifications;
-        $this->specifications_factory = $specifications_factory;
-        add_action('AHEE__EE_System__loadRouteMatchSpecifications', array($this, 'initialize'));
-    }
+	/**
+	 * RouteMatchSpecificationManager constructor.
+	 *
+	 * @param RouteMatchSpecificationCollection $specifications
+	 * @param RouteMatchSpecificationFactory    $specifications_factory
+	 */
+	public function __construct(
+		RouteMatchSpecificationCollection $specifications,
+		RouteMatchSpecificationFactory $specifications_factory
+	) {
+		$this->specifications = $specifications;
+		$this->specifications_factory = $specifications_factory;
+		add_action('AHEE__EE_System__loadRouteMatchSpecifications', array($this, 'initialize'));
+	}
 
 
-    /**
-     * Perform any early setup required for block editors to functions
-     *
-     * @return void
-     * @throws CollectionLoaderException
-     * @throws CollectionDetailsException
-     */
-    public function initialize()
-    {
-        $this->populateSpecificationCollection();
-    }
+	/**
+	 * Perform any early setup required for block editors to functions
+	 *
+	 * @return void
+	 * @throws CollectionLoaderException
+	 * @throws CollectionDetailsException
+	 */
+	public function initialize()
+	{
+		$this->populateSpecificationCollection();
+	}
 
 
-    /**
-     * @return CollectionInterface|RouteMatchSpecificationInterface[]
-     * @throws CollectionLoaderException
-     * @throws CollectionDetailsException
-     * @since 4.9.71.p
-     */
-    private function populateSpecificationCollection()
-    {
-        $loader = new CollectionLoader(
-            new CollectionDetails(
-                // collection name
-                RouteMatchSpecificationCollection::COLLECTION_NAME,
-                // collection interface
-                'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface',
-                // FQCNs for classes to add (all classes within each namespace will be loaded)
-                apply_filters(
-                    'FHEE__EventEspresso_core_services_route_match_RouteMatchSpecificationManager__populateSpecificationCollection__collection_FQCNs',
-                    array(
-                        'EventEspresso\core\domain\entities\route_match\specifications\admin',
-                        'EventEspresso\core\domain\entities\route_match\specifications\frontend',
-                    )
-                ),
-                // filepaths to classes to add
-                array(),
-                // file mask to use if parsing folder for files to add
-                '',
-                // what to use as identifier for collection entities
-                // using CLASS NAME prevents duplicates (works like a singleton)
-                CollectionDetails::ID_CLASS_NAME
-            ),
-            $this->specifications,
-            null,
-            $this->specifications_factory
-        );
-        return $loader->getCollection();
-    }
+	/**
+	 * @return CollectionInterface|RouteMatchSpecificationInterface[]
+	 * @throws CollectionLoaderException
+	 * @throws CollectionDetailsException
+	 * @since 4.9.71.p
+	 */
+	private function populateSpecificationCollection()
+	{
+		$loader = new CollectionLoader(
+			new CollectionDetails(
+				// collection name
+				RouteMatchSpecificationCollection::COLLECTION_NAME,
+				// collection interface
+				'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface',
+				// FQCNs for classes to add (all classes within each namespace will be loaded)
+				apply_filters(
+					'FHEE__EventEspresso_core_services_route_match_RouteMatchSpecificationManager__populateSpecificationCollection__collection_FQCNs',
+					array(
+						'EventEspresso\core\domain\entities\route_match\specifications\admin',
+						'EventEspresso\core\domain\entities\route_match\specifications\frontend',
+					)
+				),
+				// filepaths to classes to add
+				array(),
+				// file mask to use if parsing folder for files to add
+				'',
+				// what to use as identifier for collection entities
+				// using CLASS NAME prevents duplicates (works like a singleton)
+				CollectionDetails::ID_CLASS_NAME
+			),
+			$this->specifications,
+			null,
+			$this->specifications_factory
+		);
+		return $loader->getCollection();
+	}
 
 
-    /**
-     * Given the FQCN for a RouteMatchSpecification, will return true if the current request matches
-     *
-     * @param string $routeMatchSpecificationFqcn fully qualified class name
-     * @return bool
-     * @throws InvalidClassException
-     * @since 4.9.71.p
-     */
-    public function routeMatchesCurrentRequest($routeMatchSpecificationFqcn)
-    {
-        /** @var RouteMatchSpecificationInterface $specification */
-        $specification = $this->specifications->get($routeMatchSpecificationFqcn);
-        if (! $specification instanceof $routeMatchSpecificationFqcn) {
-            throw new InvalidClassException($routeMatchSpecificationFqcn);
-        }
-        return $specification->isMatchingRoute();
-    }
+	/**
+	 * Given the FQCN for a RouteMatchSpecification, will return true if the current request matches
+	 *
+	 * @param string $routeMatchSpecificationFqcn fully qualified class name
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @since 4.9.71.p
+	 */
+	public function routeMatchesCurrentRequest($routeMatchSpecificationFqcn)
+	{
+		/** @var RouteMatchSpecificationInterface $specification */
+		$specification = $this->specifications->get($routeMatchSpecificationFqcn);
+		if (! $specification instanceof $routeMatchSpecificationFqcn) {
+			throw new InvalidClassException($routeMatchSpecificationFqcn);
+		}
+		return $specification->isMatchingRoute();
+	}
 
 
-    /**
-     * Handy method for development that returns
-     * a list of existing RouteMatchSpecification classes
-     * matching the current request that can be used to identify it.
-     * If no matches are returned (or nothing acceptable)
-     * then create a new one that better matches your requirements.
-     *
-     * @return array
-     * @since 4.9.71.p
-     */
-    public function findRouteMatchSpecificationsMatchingCurrentRequest()
-    {
-        $matches = array();
-        foreach ($this->specifications as $specification) {
-            /** @var RouteMatchSpecificationInterface $specification */
-            if ($specification->isMatchingRoute()) {
-                $matches[] = get_class($specification);
-            }
-        }
-        return $matches;
-    }
+	/**
+	 * Handy method for development that returns
+	 * a list of existing RouteMatchSpecification classes
+	 * matching the current request that can be used to identify it.
+	 * If no matches are returned (or nothing acceptable)
+	 * then create a new one that better matches your requirements.
+	 *
+	 * @return array
+	 * @since 4.9.71.p
+	 */
+	public function findRouteMatchSpecificationsMatchingCurrentRequest()
+	{
+		$matches = array();
+		foreach ($this->specifications as $specification) {
+			/** @var RouteMatchSpecificationInterface $specification */
+			if ($specification->isMatchingRoute()) {
+				$matches[] = get_class($specification);
+			}
+		}
+		return $matches;
+	}
 }

core/domain/entities/route_match/MultiRouteSpecification.php

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     public function __construct(array $specifications, RequestInterface $request)
     {
         foreach ($specifications as $specification) {
-            if (! $specification instanceof RouteMatchSpecificationInterface) {
+            if ( ! $specification instanceof RouteMatchSpecificationInterface) {
                 throw new InvalidEntityException(
                     $specification,
                     'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface'

Indentation +24 added lines, -24 removed lines

@@ -15,29 +15,29 @@
  */
 abstract class MultiRouteSpecification extends RouteMatchSpecification
 {
-    /**
-     * @var RouteMatchSpecificationInterface[] $specifications
-     */
-    protected $specifications;
+	/**
+	 * @var RouteMatchSpecificationInterface[] $specifications
+	 */
+	protected $specifications;
 
-    /**
-     * MultiRouteSpecification constructor.
-     *
-     * @param RouteMatchSpecificationInterface[] $specifications
-     * @param RequestInterface                   $request
-     * @throws InvalidEntityException
-     */
-    public function __construct(array $specifications, RequestInterface $request)
-    {
-        foreach ($specifications as $specification) {
-            if (! $specification instanceof RouteMatchSpecificationInterface) {
-                throw new InvalidEntityException(
-                    $specification,
-                    'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface'
-                );
-            }
-        }
-        $this->specifications = $specifications;
-        parent::__construct($request);
-    }
+	/**
+	 * MultiRouteSpecification constructor.
+	 *
+	 * @param RouteMatchSpecificationInterface[] $specifications
+	 * @param RequestInterface                   $request
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(array $specifications, RequestInterface $request)
+	{
+		foreach ($specifications as $specification) {
+			if (! $specification instanceof RouteMatchSpecificationInterface) {
+				throw new InvalidEntityException(
+					$specification,
+					'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface'
+				);
+			}
+		}
+		$this->specifications = $specifications;
+		parent::__construct($request);
+	}
 }

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

Indentation +18 added lines, -18 removed lines

@@ -18,22 +18,22 @@
  */
 class WordPressPostsEditor extends MatchAnyRouteSpecification
 {
-    /**
-     * WordPressPostsEditor constructor.
-     *
-     * @param WordPressPostsEditorEdit $edit_post_route_match
-     * @param WordPressPostsEditorAddNew $create_post_route_match
-     * @param RequestInterface           $request
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    public function __construct(
-        WordPressPostsEditorEdit $edit_post_route_match,
-        WordPressPostsEditorAddNew $create_post_route_match,
-        RequestInterface $request
-    ) {
-        parent::__construct(
-            array($edit_post_route_match, $create_post_route_match),
-            $request
-        );
-    }
+	/**
+	 * WordPressPostsEditor constructor.
+	 *
+	 * @param WordPressPostsEditorEdit $edit_post_route_match
+	 * @param WordPressPostsEditorAddNew $create_post_route_match
+	 * @param RequestInterface           $request
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	public function __construct(
+		WordPressPostsEditorEdit $edit_post_route_match,
+		WordPressPostsEditorAddNew $create_post_route_match,
+		RequestInterface $request
+	) {
+		parent::__construct(
+			array($edit_post_route_match, $create_post_route_match),
+			$request
+		);
+	}
 }

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

Indentation +18 added lines, -18 removed lines

@@ -19,22 +19,22 @@
  */
 class EspressoEventEditor extends MatchAnyRouteSpecification
 {
-    /**
-     * EspressoEventEditor constructor.
-     *
-     * @param EspressoEventEditorEdit   $edit_event_route_match
-     * @param EspressoEventEditorAddNew $create_event_route_match
-     * @param RequestInterface          $request
-     * @throws InvalidEntityException
-     */
-    public function __construct(
-        EspressoEventEditorEdit $edit_event_route_match,
-        EspressoEventEditorAddNew $create_event_route_match,
-        RequestInterface $request
-    ) {
-        parent::__construct(
-            array($edit_event_route_match, $create_event_route_match),
-            $request
-        );
-    }
+	/**
+	 * EspressoEventEditor constructor.
+	 *
+	 * @param EspressoEventEditorEdit   $edit_event_route_match
+	 * @param EspressoEventEditorAddNew $create_event_route_match
+	 * @param RequestInterface          $request
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(
+		EspressoEventEditorEdit $edit_event_route_match,
+		EspressoEventEditorAddNew $create_event_route_match,
+		RequestInterface $request
+	) {
+		parent::__construct(
+			array($edit_event_route_match, $create_event_route_match),
+			$request
+		);
+	}
 }