eventespresso / event-espresso-core

core/services/assets/AssetManagerInterface.php

Indentation +62 added lines, -62 removed lines

@@ -19,78 +19,78 @@
  */
 interface AssetManagerInterface
 {
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function assetNamespace();
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function assetNamespace();
 
-    /**
-     * @since 4.9.62.p
-     */
-    public function addAssets();
+	/**
+	 * @since 4.9.62.p
+	 */
+	public function addAssets();
 
 
-    /**
-     * @return ManifestFile
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addManifestFile();
+	/**
+	 * @return ManifestFile
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addManifestFile();
 
 
-    /**
-     * @return ManifestFile[]
-     * @since 4.9.62.p
-     */
-    public function getManifestFile();
+	/**
+	 * @return ManifestFile[]
+	 * @since 4.9.62.p
+	 */
+	public function getManifestFile();
 
 
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addJavascript(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $load_in_footer = true
-    );
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascript(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$load_in_footer = true
+	);
 
 
 
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param string $media
-     * @return StylesheetAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addStylesheet(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $media = 'all'
-    );
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param string $media
+	 * @return StylesheetAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheet(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$media = 'all'
+	);
 
 
-    /**
-     * @param string $handle
-     * @return bool
-     * @since 4.9.62.p
-     */
-    public function enqueueAsset($handle);
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @since 4.9.62.p
+	 */
+	public function enqueueAsset($handle);
 }

core/services/assets/BlockAssetManagerInterface.php

Indentation +38 added lines, -38 removed lines

@@ -12,42 +12,42 @@
  */
 interface BlockAssetManagerInterface
 {
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function assetNamespace();
-
-    /**
-     * @since $VID:$
-     * @return void
-     */
-    public function setAssetHandles();
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function getEditorScriptHandle();
-
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function getEditorStyleHandle();
-
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function getScriptHandle();
-
-
-    /**
-     * @since $VID:$
-     * @return string
-     */
-    public function getStyleHandle();
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function assetNamespace();
+
+	/**
+	 * @since $VID:$
+	 * @return void
+	 */
+	public function setAssetHandles();
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getEditorScriptHandle();
+
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getEditorStyleHandle();
+
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getScriptHandle();
+
+
+	/**
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function getStyleHandle();
 }
\ No newline at end of file

core/services/collections/CollectionDetails.php

Indentation +347 added lines, -347 removed lines

@@ -43,351 +43,351 @@
 class CollectionDetails implements CollectionDetailsInterface
 {
 
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's spl_object_hash() as it's identifier
-     */
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's class name as it's identifier
-     */
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use the return value from a specified callback method on each object
-     */
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
-
-    /**
-     * The interface used for controlling what gets added to the collection
-     *
-     * @var string $collection_interface
-     */
-    protected $collection_interface = '';
-
-    /**
-     * a unique name used to identify the collection in filter names
-     * supplied value is run through sanitize_title_with_dashes(),
-     * but then also converts dashes to underscores
-     *
-     * @var string $collection_name
-     */
-    protected $collection_name = '';
-
-    /**
-     * what the collection uses for the object identifier.
-     * corresponds to one of the class constants above.
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
-     *
-     * @var string $identifier_type
-     */
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
-
-    /**
-     * the pattern applied to paths when searching for class files to add to the collection
-     * ie: "My_Awesome_*.class.php"
-     * defaults to "*.php"
-     *
-     * @var string $file_mask
-     */
-    protected $file_mask = '';
-
-    /**
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
-     * then this specifies the method to use on each entity.
-     * If the callback method does not exist, then an exception will be thrown
-     *
-     * @var string $identifier_callback
-     */
-    protected $identifier_callback = '';
-
-    /**
-     * an array of Fully Qualified Class Names
-     *  for example:
-     *  $FQCNs = array(
-     *      '/Fully/Qualified/ClassNameA'
-     *      '/Fully/Qualified/Other/ClassNameB'
-     *  );
-     *
-     * @var array $collection_FQCNs
-     */
-    protected $collection_FQCNs = array();
-
-    /**
-     * an array of full server paths to folders containing files to be loaded into collection
-     *  for example:
-     *  $paths = array(
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
-     *  );
-     *
-     * @var array $collection_paths
-     */
-    protected $collection_paths = array();
-
-    /**
-     * @var LocatorInterface $file_locator
-     */
-    protected $file_locator;
-
-
-    /**
-     * CollectionDetails constructor.
-     *
-     * @access public
-     * @param string           $collection_name
-     * @param string           $collection_interface
-     * @param array            $collection_FQCNs
-     * @param array            $collection_paths
-     * @param string           $file_mask
-     * @param string           $identifier_type
-     * @param string           $identifier_callback
-     * @param LocatorInterface $file_locator
-     * @throws CollectionDetailsException
-     */
-    public function __construct(
-        $collection_name,
-        $collection_interface,
-        array $collection_FQCNs = array(),
-        array $collection_paths = array(),
-        $file_mask = '',
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
-        $identifier_callback = '',
-        LocatorInterface $file_locator = null
-    ) {
-        try {
-            $this->setCollectionName($collection_name);
-            $this->setCollectionInterface($collection_interface);
-            $this->setCollectionFQCNs($collection_FQCNs);
-            $this->setCollectionPaths($collection_paths);
-            $this->setFileMasks($file_mask);
-            $this->setIdentifierType($identifier_type);
-            $this->setIdentifierCallback($identifier_callback);
-            $this->file_locator = $file_locator;
-        } catch (Exception $exception) {
-            throw new CollectionDetailsException($exception);
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return mixed
-     */
-    public function getCollectionInterface()
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\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;
-    }
-
-
-    /**
-     * the collection name will be used for creating dynamic filters
-     *
-     * @access public
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * sanitizes collection name and converts spaces and dashes to underscores
-     *
-     * @access protected
-     * @param string $collection_name
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setCollectionName($collection_name)
-    {
-        if (! is_string($collection_name)) {
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
-        }
-        $this->collection_name = str_replace(
-            '-',
-            '_',
-            sanitize_title_with_dashes($collection_name, '', 'save')
-        );
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType()
-    {
-        return $this->identifier_type;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_type
-     * @throws InvalidIdentifierException
-     */
-    protected function setIdentifierType($identifier_type)
-    {
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
-        )) {
-            throw new InvalidIdentifierException(
-                $identifier_type,
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
-            );
-        }
-        $this->identifier_type = $identifier_type;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback()
-    {
-        return $this->identifier_callback;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_callback
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
-    {
-        if (! is_string($identifier_callback)) {
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
-        }
-        $this->identifier_callback = $identifier_callback;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask()
-    {
-        return $this->file_mask;
-    }
-
-
-    /**
-     * sets the file mask which is then used to filter what files get loaded
-     * when searching for classes to add to the collection. Defaults to '*.php'
-     *
-     * @access protected
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setFileMasks($file_mask)
-    {
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
-        // we know our default is a string, so if it's not a string now,
-        // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionFQCNs()
-    {
-        return $this->collection_FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_FQCNs
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setCollectionFQCNs($collection_FQCNs)
-    {
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
-                if (class_exists($collection_FQCN)) {
-                    $this->collection_FQCNs[] = $collection_FQCN;
-                } else {
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
-                        $this->collection_FQCNs[] = $FQCN;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $partial_FQCN
-     * @return array
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
-    {
-        if (! $this->file_locator instanceof FqcnLocator) {
-            $this->file_locator = new FqcnLocator();
-        }
-        $this->file_locator->locate($partial_FQCN);
-        return $this->file_locator->getFQCNs();
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getCollectionPaths()
-    {
-        return $this->collection_paths;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_paths
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     */
-    public function setCollectionPaths($collection_paths)
-    {
-        foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
-                    throw new InvalidFilePathException($collection_path);
-                }
-                $this->collection_paths[] = $collection_path;
-            }
-        }
-    }
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's spl_object_hash() as it's identifier
+	 */
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's class name as it's identifier
+	 */
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use the return value from a specified callback method on each object
+	 */
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
+
+	/**
+	 * The interface used for controlling what gets added to the collection
+	 *
+	 * @var string $collection_interface
+	 */
+	protected $collection_interface = '';
+
+	/**
+	 * a unique name used to identify the collection in filter names
+	 * supplied value is run through sanitize_title_with_dashes(),
+	 * but then also converts dashes to underscores
+	 *
+	 * @var string $collection_name
+	 */
+	protected $collection_name = '';
+
+	/**
+	 * what the collection uses for the object identifier.
+	 * corresponds to one of the class constants above.
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
+	 *
+	 * @var string $identifier_type
+	 */
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
+
+	/**
+	 * the pattern applied to paths when searching for class files to add to the collection
+	 * ie: "My_Awesome_*.class.php"
+	 * defaults to "*.php"
+	 *
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '';
+
+	/**
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
+	 * then this specifies the method to use on each entity.
+	 * If the callback method does not exist, then an exception will be thrown
+	 *
+	 * @var string $identifier_callback
+	 */
+	protected $identifier_callback = '';
+
+	/**
+	 * an array of Fully Qualified Class Names
+	 *  for example:
+	 *  $FQCNs = array(
+	 *      '/Fully/Qualified/ClassNameA'
+	 *      '/Fully/Qualified/Other/ClassNameB'
+	 *  );
+	 *
+	 * @var array $collection_FQCNs
+	 */
+	protected $collection_FQCNs = array();
+
+	/**
+	 * an array of full server paths to folders containing files to be loaded into collection
+	 *  for example:
+	 *  $paths = array(
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
+	 *  );
+	 *
+	 * @var array $collection_paths
+	 */
+	protected $collection_paths = array();
+
+	/**
+	 * @var LocatorInterface $file_locator
+	 */
+	protected $file_locator;
+
+
+	/**
+	 * CollectionDetails constructor.
+	 *
+	 * @access public
+	 * @param string           $collection_name
+	 * @param string           $collection_interface
+	 * @param array            $collection_FQCNs
+	 * @param array            $collection_paths
+	 * @param string           $file_mask
+	 * @param string           $identifier_type
+	 * @param string           $identifier_callback
+	 * @param LocatorInterface $file_locator
+	 * @throws CollectionDetailsException
+	 */
+	public function __construct(
+		$collection_name,
+		$collection_interface,
+		array $collection_FQCNs = array(),
+		array $collection_paths = array(),
+		$file_mask = '',
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
+		$identifier_callback = '',
+		LocatorInterface $file_locator = null
+	) {
+		try {
+			$this->setCollectionName($collection_name);
+			$this->setCollectionInterface($collection_interface);
+			$this->setCollectionFQCNs($collection_FQCNs);
+			$this->setCollectionPaths($collection_paths);
+			$this->setFileMasks($file_mask);
+			$this->setIdentifierType($identifier_type);
+			$this->setIdentifierCallback($identifier_callback);
+			$this->file_locator = $file_locator;
+		} catch (Exception $exception) {
+			throw new CollectionDetailsException($exception);
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return mixed
+	 */
+	public function getCollectionInterface()
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\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;
+	}
+
+
+	/**
+	 * the collection name will be used for creating dynamic filters
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * sanitizes collection name and converts spaces and dashes to underscores
+	 *
+	 * @access protected
+	 * @param string $collection_name
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		if (! is_string($collection_name)) {
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
+		}
+		$this->collection_name = str_replace(
+			'-',
+			'_',
+			sanitize_title_with_dashes($collection_name, '', 'save')
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType()
+	{
+		return $this->identifier_type;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_type
+	 * @throws InvalidIdentifierException
+	 */
+	protected function setIdentifierType($identifier_type)
+	{
+		if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
+		)) {
+			throw new InvalidIdentifierException(
+				$identifier_type,
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
+			);
+		}
+		$this->identifier_type = $identifier_type;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback()
+	{
+		return $this->identifier_callback;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_callback
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
+	{
+		if (! is_string($identifier_callback)) {
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
+		}
+		$this->identifier_callback = $identifier_callback;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask()
+	{
+		return $this->file_mask;
+	}
+
+
+	/**
+	 * sets the file mask which is then used to filter what files get loaded
+	 * when searching for classes to add to the collection. Defaults to '*.php'
+	 *
+	 * @access protected
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setFileMasks($file_mask)
+	{
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
+		// we know our default is a string, so if it's not a string now,
+		// then that means the incoming parameter was something else
+		if (! is_string($this->file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionFQCNs()
+	{
+		return $this->collection_FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_FQCNs
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setCollectionFQCNs($collection_FQCNs)
+	{
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
+			if (! empty($collection_FQCN)) {
+				if (class_exists($collection_FQCN)) {
+					$this->collection_FQCNs[] = $collection_FQCN;
+				} else {
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
+						$this->collection_FQCNs[] = $FQCN;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $partial_FQCN
+	 * @return array
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
+	{
+		if (! $this->file_locator instanceof FqcnLocator) {
+			$this->file_locator = new FqcnLocator();
+		}
+		$this->file_locator->locate($partial_FQCN);
+		return $this->file_locator->getFQCNs();
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getCollectionPaths()
+	{
+		return $this->collection_paths;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_paths
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 */
+	public function setCollectionPaths($collection_paths)
+	{
+		foreach ((array) $collection_paths as $collection_path) {
+			if (! empty($collection_path)) {
+				if (! is_readable($collection_path)) {
+					throw new InvalidFilePathException($collection_path);
+				}
+				$this->collection_paths[] = $collection_path;
+			}
+		}
+	}
 }

core/services/collections/CollectionLoaderException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class CollectionLoaderException extends RuntimeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param Exception $previous
-     * @param string    $message
-     * @param int       $code
-     */
-    public function __construct(Exception $previous, $message = '', $code = 0)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The following error occurred during the creation and/or loading of this collection: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                $previous->getMessage()
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param Exception $previous
+	 * @param string    $message
+	 * @param int       $code
+	 */
+	public function __construct(Exception $previous, $message = '', $code = 0)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The following error occurred during the creation and/or loading of this collection: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				$previous->getMessage()
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/collections/CollectionDetailsException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class CollectionDetailsException extends RuntimeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param Exception $previous
-     * @param string    $message
-     * @param int       $code
-     */
-    public function __construct(Exception $previous, $message = '', $code = 0)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The following error occurred during the collection details generation: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                $previous->getMessage()
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param Exception $previous
+	 * @param string    $message
+	 * @param int       $code
+	 */
+	public function __construct(Exception $previous, $message = '', $code = 0)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The following error occurred during the collection details generation: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				$previous->getMessage()
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/domain/entities/editor/Block.php

Indentation +212 added lines, -212 removed lines

@@ -20,216 +20,216 @@
 abstract class Block implements BlockInterface
 {
 
-    /**
-     * BlockAssetManager that this editor block uses for asset registration
-     *
-     * @var BlockAssetManagerInterface $block_asset_manager
-     */
-    protected $block_asset_manager;
-
-    /**
-     * @var array $attributes
-     */
-    private $attributes;
-
-    /**
-     * If set to true, then the block will render its content client side
-     * If false, then the block will render its content server side using the renderBlock() method
-     *
-     * @var bool $dynamic
-     */
-    private $dynamic = false;
-
-    /**
-     * @var string $block_type
-     */
-    private $block_type;
-
-    /**
-     * @var array $supported_routes
-     */
-    private $supported_routes;
-
-    /**
-     * @var WP_Block_Type $wp_block_type
-     */
-    private $wp_block_type;
-
-
-    /**
-     * BlockLoader constructor.
-     *
-     * @param BlockAssetManagerInterface $block_asset_manager
-     */
-    public function __construct(BlockAssetManagerInterface $block_asset_manager)
-    {
-        $this->block_asset_manager = $block_asset_manager;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function blockType()
-    {
-        return $this->block_type;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function namespacedBlockType()
-    {
-        return self::NAME_SPACE . '/' . $this->block_type;
-    }
-
-
-    /**
-     * @param string $block_type
-     */
-    protected function setBlockType($block_type)
-    {
-        $this->block_type = $block_type;
-    }
-
-
-    /**
-     * BlockAssetManager that this editor block uses for asset registration
-     *
-     * @return BlockAssetManagerInterface
-     */
-    public function assetManager()
-    {
-        return $this->block_asset_manager;
-    }
-
-
-    /**
-     * @param WP_Block_Type $wp_block_type
-     */
-    protected function setWpBlockType($wp_block_type)
-    {
-        $this->wp_block_type = $wp_block_type;
-    }
-
-    /**
-     * 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 $this->supported_routes;
-    }
-
-
-    /**
-     * @param array $supported_routes
-     */
-    protected function setSupportedRoutes(array $supported_routes)
-    {
-        $this->supported_routes = $supported_routes;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function attributes()
-    {
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param array $attributes
-     */
-    public function setAttributes(array $attributes)
-    {
-        $this->attributes = $attributes;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isDynamic()
-    {
-        return $this->dynamic;
-    }
-
-
-    /**
-     * @param bool $dynamic
-     */
-    public function setDynamic($dynamic = true)
-    {
-        $this->dynamic = filter_var($dynamic, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * 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()
-    {
-        $args = array(
-            'attributes'    => $this->attributes(),
-            'editor_script' => $this->block_asset_manager->getEditorScriptHandle(),
-            'editor_style'  => $this->block_asset_manager->getEditorStyleHandle(),
-            'script'        => $this->block_asset_manager->getScriptHandle(),
-            'style'         => $this->block_asset_manager->getStyleHandle(),
-        );
-        if ($this->isDynamic()) {
-            $args['render_callback'] = array($this, 'renderBlock');
-        }
-        $wp_block_type = register_block_type(
-            new WP_Block_Type(
-                $this->namespacedBlockType(),
-                $args
-            )
-        );
-        $this->setWpBlockType($wp_block_type);
-        return $wp_block_type;
-    }
-
-
-    /**
-     * @return WP_Block_Type|false The registered block type on success, or false on failure.
-     */
-    public function unRegisterBlock()
-    {
-        return unregister_block_type($this->namespacedBlockType());
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function getEditorContainer()
-    {
-        return array(
-            $this->namespacedBlockType(),
-            array(),
-        );
-    }
-
-
-    /**
-     * returns the rendered HTML for the block
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function renderBlock(array $attributes = array())
-    {
-        return '';
-    }
+	/**
+	 * BlockAssetManager that this editor block uses for asset registration
+	 *
+	 * @var BlockAssetManagerInterface $block_asset_manager
+	 */
+	protected $block_asset_manager;
+
+	/**
+	 * @var array $attributes
+	 */
+	private $attributes;
+
+	/**
+	 * If set to true, then the block will render its content client side
+	 * If false, then the block will render its content server side using the renderBlock() method
+	 *
+	 * @var bool $dynamic
+	 */
+	private $dynamic = false;
+
+	/**
+	 * @var string $block_type
+	 */
+	private $block_type;
+
+	/**
+	 * @var array $supported_routes
+	 */
+	private $supported_routes;
+
+	/**
+	 * @var WP_Block_Type $wp_block_type
+	 */
+	private $wp_block_type;
+
+
+	/**
+	 * BlockLoader constructor.
+	 *
+	 * @param BlockAssetManagerInterface $block_asset_manager
+	 */
+	public function __construct(BlockAssetManagerInterface $block_asset_manager)
+	{
+		$this->block_asset_manager = $block_asset_manager;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function blockType()
+	{
+		return $this->block_type;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function namespacedBlockType()
+	{
+		return self::NAME_SPACE . '/' . $this->block_type;
+	}
+
+
+	/**
+	 * @param string $block_type
+	 */
+	protected function setBlockType($block_type)
+	{
+		$this->block_type = $block_type;
+	}
+
+
+	/**
+	 * BlockAssetManager that this editor block uses for asset registration
+	 *
+	 * @return BlockAssetManagerInterface
+	 */
+	public function assetManager()
+	{
+		return $this->block_asset_manager;
+	}
+
+
+	/**
+	 * @param WP_Block_Type $wp_block_type
+	 */
+	protected function setWpBlockType($wp_block_type)
+	{
+		$this->wp_block_type = $wp_block_type;
+	}
+
+	/**
+	 * 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 $this->supported_routes;
+	}
+
+
+	/**
+	 * @param array $supported_routes
+	 */
+	protected function setSupportedRoutes(array $supported_routes)
+	{
+		$this->supported_routes = $supported_routes;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function attributes()
+	{
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param array $attributes
+	 */
+	public function setAttributes(array $attributes)
+	{
+		$this->attributes = $attributes;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isDynamic()
+	{
+		return $this->dynamic;
+	}
+
+
+	/**
+	 * @param bool $dynamic
+	 */
+	public function setDynamic($dynamic = true)
+	{
+		$this->dynamic = filter_var($dynamic, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * 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()
+	{
+		$args = array(
+			'attributes'    => $this->attributes(),
+			'editor_script' => $this->block_asset_manager->getEditorScriptHandle(),
+			'editor_style'  => $this->block_asset_manager->getEditorStyleHandle(),
+			'script'        => $this->block_asset_manager->getScriptHandle(),
+			'style'         => $this->block_asset_manager->getStyleHandle(),
+		);
+		if ($this->isDynamic()) {
+			$args['render_callback'] = array($this, 'renderBlock');
+		}
+		$wp_block_type = register_block_type(
+			new WP_Block_Type(
+				$this->namespacedBlockType(),
+				$args
+			)
+		);
+		$this->setWpBlockType($wp_block_type);
+		return $wp_block_type;
+	}
+
+
+	/**
+	 * @return WP_Block_Type|false The registered block type on success, or false on failure.
+	 */
+	public function unRegisterBlock()
+	{
+		return unregister_block_type($this->namespacedBlockType());
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function getEditorContainer()
+	{
+		return array(
+			$this->namespacedBlockType(),
+			array(),
+		);
+	}
+
+
+	/**
+	 * returns the rendered HTML for the block
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function renderBlock(array $attributes = array())
+	{
+		return '';
+	}
 }

core/exceptions/InvalidAliasException.php

Indentation +23 added lines, -23 removed lines

@@ -16,27 +16,27 @@
 class InvalidAliasException extends DomainException
 {
 
-    /**
-     * InvalidClassException constructor.
-     *
-     * @param string    $fqcn
-     * @param string    $alias
-     * @param string    $message
-     * @param int       $code
-     * @param Exception $previous
-     */
-    public function __construct($fqcn, $alias, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    '"%1$s" can not be used as an alias because the "%2$s"  class does not extend or implement it.',
-                    'event_espresso'
-                ),
-                $alias,
-                $fqcn
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidClassException constructor.
+	 *
+	 * @param string    $fqcn
+	 * @param string    $alias
+	 * @param string    $message
+	 * @param int       $code
+	 * @param Exception $previous
+	 */
+	public function __construct($fqcn, $alias, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'"%1$s" can not be used as an alias because the "%2$s"  class does not extend or implement it.',
+					'event_espresso'
+				),
+				$alias,
+				$fqcn
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/route_match/RouteMatchSpecificationDependencyResolver.php

Indentation +16 added lines, -16 removed lines

@@ -23,20 +23,20 @@
 class RouteMatchSpecificationDependencyResolver extends DependencyResolver
 {
 
-    /**
-     * Used to configure and/or setup any aliases or recursions required by the DependencyResolver
-     *
-     * @since $VID:$
-     * @throws InvalidAliasException
-     */
-    public function initialize()
-    {
-        $this->addAlias(
-            new ClassAlias(
-                'EventEspresso\core\services\request\RequestInterface',
-                'EventEspresso\core\services\request\Request'
-            )
-        );
-        $this->addRecursion('EventEspresso\core\domain\entities\route_match\specifications');
-    }
+	/**
+	 * Used to configure and/or setup any aliases or recursions required by the DependencyResolver
+	 *
+	 * @since $VID:$
+	 * @throws InvalidAliasException
+	 */
+	public function initialize()
+	{
+		$this->addAlias(
+			new ClassAlias(
+				'EventEspresso\core\services\request\RequestInterface',
+				'EventEspresso\core\services\request\Request'
+			)
+		);
+		$this->addRecursion('EventEspresso\core\domain\entities\route_match\specifications');
+	}
 }

core/services/route_match/RouteMatchSpecificationFactory.php

Indentation +39 added lines, -39 removed lines

@@ -24,46 +24,46 @@
 class RouteMatchSpecificationFactory extends FactoryWithDependencyResolver
 {
 
-    /**
-     * RouteMatchSpecificationFactory constructor
-     *
-     * @param RouteMatchSpecificationDependencyResolver $dependency_resolver
-     * @param LoaderInterface                           $loader
-     */
-    public function __construct(RouteMatchSpecificationDependencyResolver $dependency_resolver, LoaderInterface $loader)
-    {
-        parent::__construct($dependency_resolver, $loader);
-    }
+	/**
+	 * RouteMatchSpecificationFactory constructor
+	 *
+	 * @param RouteMatchSpecificationDependencyResolver $dependency_resolver
+	 * @param LoaderInterface                           $loader
+	 */
+	public function __construct(RouteMatchSpecificationDependencyResolver $dependency_resolver, LoaderInterface $loader)
+	{
+		parent::__construct($dependency_resolver, $loader);
+	}
 
-    /**
-     * @param $fqcn
-     * @return RouteMatchSpecification
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public function createNewRouteMatchSpecification($fqcn)
-    {
-        $this->dependencyResolver()->resolveDependenciesForClass($fqcn);
-        return $this->loader()->getShared($fqcn);
-    }
+	/**
+	 * @param $fqcn
+	 * @return RouteMatchSpecification
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public function createNewRouteMatchSpecification($fqcn)
+	{
+		$this->dependencyResolver()->resolveDependenciesForClass($fqcn);
+		return $this->loader()->getShared($fqcn);
+	}
 
 
-    /**
-     * @param $fqcn
-     * @return RouteMatchSpecification
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public static function create($fqcn)
-    {
-        /** @var RouteMatchSpecificationFactory $specification_factory */
-        $specification_factory = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory'
-        );
-        return $specification_factory->createNewRouteMatchSpecification($fqcn);
-    }
+	/**
+	 * @param $fqcn
+	 * @return RouteMatchSpecification
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public static function create($fqcn)
+	{
+		/** @var RouteMatchSpecificationFactory $specification_factory */
+		$specification_factory = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\route_match\RouteMatchSpecificationFactory'
+		);
+		return $specification_factory->createNewRouteMatchSpecification($fqcn);
+	}
 }