eventespresso / event-espresso-core

core/services/loaders/CachingLoader.php

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
         $identifier = ''
     ) {
         parent::__construct($loader);
-        $this->cache       = $cache;
+        $this->cache = $cache;
         $this->object_identifier = $object_identifier;
         $this->setIdentifier($identifier);
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@ 
      */
     private function setIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;

Indentation +182 added lines, -182 removed lines

@@ -17,186 +17,186 @@
 class CachingLoader extends CachingLoaderDecorator
 {
 
-    /**
-     * @var bool
-     */
-    protected $bypass;
-
-    /**
-     * @var CollectionInterface
-     */
-    protected $cache;
-
-    /**
-     * @var string
-     */
-    protected $identifier;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param ObjectIdentifier         $object_identifier
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        LoaderDecoratorInterface $loader,
-        CollectionInterface $cache,
-        ObjectIdentifier $object_identifier,
-        $identifier = ''
-    ) {
-        parent::__construct($loader);
-        $this->cache       = $cache;
-        $this->object_identifier = $object_identifier;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        $this->bypass = filter_var(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-                false,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = array())
-    {
-        if ($object instanceof $fqcn) {
-            return $this->cache->add(
-                $object,
-                $this->object_identifier->getIdentifier($fqcn, $arguments)
-            );
-        }
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
-                    'event_espresso'
-                ),
-                $fqcn
-            )
-        );
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @param array                     $interfaces
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if ($this->bypass) {
-            // even though $shared might be true, caching could be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        if ($this->cache->has($object_identifier)) {
-            return $this->cache->get($object_identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if ($object instanceof $fqcn) {
-            $this->cache->add($object, $object_identifier);
-        }
-        return $object;
-    }
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->clearCache();
-        $this->loader->reset();
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the cache
-     *
-     * @since 4.9.62.p
-     */
-    public function clearCache()
-    {
-        $this->cache->trashAndDetachAll();
-    }
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn, array $arguments = [])
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        $object = $this->cache->has($object_identifier)
-            ? $this->cache->get($object_identifier)
-            : $this->loader->load($fqcn, $arguments);
-        return $this->cache->remove($object);
-    }
+	/**
+	 * @var bool
+	 */
+	protected $bypass;
+
+	/**
+	 * @var CollectionInterface
+	 */
+	protected $cache;
+
+	/**
+	 * @var string
+	 */
+	protected $identifier;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param ObjectIdentifier         $object_identifier
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $loader,
+		CollectionInterface $cache,
+		ObjectIdentifier $object_identifier,
+		$identifier = ''
+	) {
+		parent::__construct($loader);
+		$this->cache       = $cache;
+		$this->object_identifier = $object_identifier;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		$this->bypass = filter_var(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+				false,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = array())
+	{
+		if ($object instanceof $fqcn) {
+			return $this->cache->add(
+				$object,
+				$this->object_identifier->getIdentifier($fqcn, $arguments)
+			);
+		}
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The supplied class name "%1$s" must match the class of the supplied object.',
+					'event_espresso'
+				),
+				$fqcn
+			)
+		);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @param array                     $interfaces
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if ($this->bypass) {
+			// even though $shared might be true, caching could be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		if ($this->cache->has($object_identifier)) {
+			return $this->cache->get($object_identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if ($object instanceof $fqcn) {
+			$this->cache->add($object, $object_identifier);
+		}
+		return $object;
+	}
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->clearCache();
+		$this->loader->reset();
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the cache
+	 *
+	 * @since 4.9.62.p
+	 */
+	public function clearCache()
+	{
+		$this->cache->trashAndDetachAll();
+	}
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn, array $arguments = [])
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		$object = $this->cache->has($object_identifier)
+			? $this->cache->get($object_identifier)
+			: $this->loader->load($fqcn, $arguments);
+		return $this->cache->remove($object);
+	}
 }

core/services/loaders/LoaderFactory.php

Indentation +39 added lines, -39 removed lines

@@ -80,47 +80,47 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
-    /**
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
-     *                                              otherwise can be left null
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getLoader(
-        $generator = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        if (
-            ! LoaderFactory::$loader instanceof LoaderInterface
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection(''),
-                    $object_identifier
-                ),
-                $class_cache
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
+	 *                                              otherwise can be left null
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getLoader(
+		$generator = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		if (
+			! LoaderFactory::$loader instanceof LoaderInterface
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection(''),
+					$object_identifier
+				),
+				$class_cache
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 
 
 }

core/services/loaders/ObjectIdentifier.php

Spacing +3 added lines, -3 removed lines

@@ -73,7 +73,7 @@ 
     public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
     {
         return $fqcn === $object_identifier
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+               || strpos($object_identifier, $fqcn.ObjectIdentifier::DELIMITER) === 0;
     }
 
 
@@ -93,8 +93,8 @@ 
         )
             ? $this->getIdentifierForArguments($arguments)
             : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+        if ( ! empty($identifier)) {
+            $fqcn .= ObjectIdentifier::DELIMITER.md5($identifier);
         }
         return $fqcn;
     }

Indentation +102 added lines, -102 removed lines

@@ -16,117 +16,117 @@
 class ObjectIdentifier
 {
 
-    /**
-     * used to separate the FQCN from the class's arguments identifier
-     */
-    const DELIMITER = '____';
+	/**
+	 * used to separate the FQCN from the class's arguments identifier
+	 */
+	const DELIMITER = '____';
 
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
 
 
-    /**
-     * ObjectIdentifier constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    public function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-    }
+	/**
+	 * ObjectIdentifier constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	public function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+	}
 
 
-    /**
-     * Returns true if the supplied $object_identifier contains
-     * the delimiter used to separate an fqcn from the arguments hash
-     *
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function hasArguments($object_identifier)
-    {
-        // type casting to bool instead of using strpos() !== false
-        // because an object identifier should never begin with the delimiter
-        // therefore the delimiter should NOT be found at position 0
-        return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
-    }
+	/**
+	 * Returns true if the supplied $object_identifier contains
+	 * the delimiter used to separate an fqcn from the arguments hash
+	 *
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function hasArguments($object_identifier)
+	{
+		// type casting to bool instead of using strpos() !== false
+		// because an object identifier should never begin with the delimiter
+		// therefore the delimiter should NOT be found at position 0
+		return (bool) strpos($object_identifier, ObjectIdentifier::DELIMITER);
+	}
 
 
-    /**
-     * Returns true if the supplied FQCN equals the supplied $object_identifier
-     * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
-     * AND that $object_identifier is for an object with arguments.
-     * This allows a request for an object using a FQCN to match
-     * a previously instantiated object with arguments
-     * without having to know those arguments.
-     *
-     * @param string $fqcn
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
-    {
-        return $fqcn === $object_identifier
-               || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
-    }
+	/**
+	 * Returns true if the supplied FQCN equals the supplied $object_identifier
+	 * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
+	 * AND that $object_identifier is for an object with arguments.
+	 * This allows a request for an object using a FQCN to match
+	 * a previously instantiated object with arguments
+	 * without having to know those arguments.
+	 *
+	 * @param string $fqcn
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function fqcnMatchesObjectIdentifier($fqcn, $object_identifier)
+	{
+		return $fqcn === $object_identifier
+			   || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+	}
 
 
-    /**
-     * build a string representation of an object's FQCN and arguments
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return string
-     */
-    public function getIdentifier($fqcn, array $arguments = array())
-    {
-        // only build identifier from arguments if class is not ReservedInstanceInterface
-        $identifier = ! $this->class_cache->hasInterface(
-            $fqcn,
-            'EventEspresso\core\interfaces\ReservedInstanceInterface'
-        )
-            ? $this->getIdentifierForArguments($arguments)
-            : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
-        }
-        return $fqcn;
-    }
+	/**
+	 * build a string representation of an object's FQCN and arguments
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return string
+	 */
+	public function getIdentifier($fqcn, array $arguments = array())
+	{
+		// only build identifier from arguments if class is not ReservedInstanceInterface
+		$identifier = ! $this->class_cache->hasInterface(
+			$fqcn,
+			'EventEspresso\core\interfaces\ReservedInstanceInterface'
+		)
+			? $this->getIdentifierForArguments($arguments)
+			: '';
+		if (! empty($identifier)) {
+			$fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+		}
+		return $fqcn;
+	}
 
 
-    /**
-     * build a string representation of a object's arguments
-     * (mostly because Closures can't be serialized)
-     *
-     * @param array $arguments
-     * @return string
-     */
-    protected function getIdentifierForArguments(array $arguments)
-    {
-        if (empty($arguments)) {
-            return '';
-        }
-        $identifier = '';
-        foreach ($arguments as $key => $argument) {
-            // don't include arguments used to assist with loading legacy classes
-            if (is_string($key) && strpos($key, 'EE_Registry::create') === 0) {
-                continue;
-            }
-            switch (true) {
-                case is_object($argument):
-                case $argument instanceof Closure:
-                    $identifier .= spl_object_hash($argument);
-                    break;
-                case is_array($argument):
-                    $identifier .= $this->getIdentifierForArguments($argument);
-                    break;
-                default:
-                    $identifier .= $argument;
-                    break;
-            }
-        }
-        return $identifier;
-    }
+	/**
+	 * build a string representation of a object's arguments
+	 * (mostly because Closures can't be serialized)
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	protected function getIdentifierForArguments(array $arguments)
+	{
+		if (empty($arguments)) {
+			return '';
+		}
+		$identifier = '';
+		foreach ($arguments as $key => $argument) {
+			// don't include arguments used to assist with loading legacy classes
+			if (is_string($key) && strpos($key, 'EE_Registry::create') === 0) {
+				continue;
+			}
+			switch (true) {
+				case is_object($argument):
+				case $argument instanceof Closure:
+					$identifier .= spl_object_hash($argument);
+					break;
+				case is_array($argument):
+					$identifier .= $this->getIdentifierForArguments($argument);
+					break;
+				default:
+					$identifier .= $argument;
+					break;
+			}
+		}
+		return $identifier;
+	}
 }

core/domain/DomainInterface.php

Indentation +36 added lines, -36 removed lines

@@ -16,55 +16,55 @@
 interface DomainInterface extends InterminableInterface
 {
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginFile();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginFile();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginBasename();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginBasename();
 
 
-    /**
-     * @return string
-     */
-    public function pluginPath();
+	/**
+	 * @return string
+	 */
+	public function pluginPath();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginUrl();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginUrl();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function version();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function version();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl();
 
 
-    /**
-     * @return string
-     */
-    public function assetNamespace();
+	/**
+	 * @return string
+	 */
+	public function assetNamespace();
 
 }

core/domain/entities/editor/BlockCollection.php

Indentation +47 added lines, -47 removed lines

@@ -20,55 +20,55 @@
 class BlockCollection extends Collection
 {
 
-    /**
-     * Collection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface');
-    }
+	/**
+	 * Collection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct('EventEspresso\core\domain\entities\editor\BlockInterface');
+	}
 
 
-    /**
-     * unRegisterBlock
-     * finds block in the Collection based on the identifier that was set using addObject()
-     * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found.
-     * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
-     *
-     * @param mixed $identifier
-     * @return boolean
-     */
-    public function unRegisterBlock($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object->unRegisterBlock();
-            }
-            $this->next();
-        }
-        return false;
-    }
+	/**
+	 * unRegisterBlock
+	 * finds block in the Collection based on the identifier that was set using addObject()
+	 * and calls unRegisterBlock() on it. Returns block if successful and false if block was not found.
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
+	 *
+	 * @param mixed $identifier
+	 * @return boolean
+	 */
+	public function unRegisterBlock($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object->unRegisterBlock();
+			}
+			$this->next();
+		}
+		return false;
+	}
 
 
-    /**
-     * unRegisterAllBlocks
-     * calls unRegisterBlock() on all blocks in Collection.
-     * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
-     *
-     * @return void
-     */
-    public function unRegisterAllBlocks()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $this->current()->unRegisterBlock();
-            $this->next();
-        }
-        $this->rewind();
-    }
+	/**
+	 * unRegisterAllBlocks
+	 * calls unRegisterBlock() on all blocks in Collection.
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection afterwards
+	 *
+	 * @return void
+	 */
+	public function unRegisterAllBlocks()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$this->current()->unRegisterBlock();
+			$this->next();
+		}
+		$this->rewind();
+	}
 }

core/domain/services/custom_post_types/RegisterCustomPostTypes.php

Spacing +1 added lines, -1 removed lines

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

Indentation +295 added lines, -295 removed lines

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

core/domain/DomainBase.php

Spacing +2 added lines, -2 removed lines

@@ -136,7 +136,7 @@ 
      */
     public function distributionAssetsPath()
     {
-        return $this->pluginPath() . 'assets/dist/';
+        return $this->pluginPath().'assets/dist/';
     }
 
 
@@ -145,7 +145,7 @@ 
      */
     public function distributionAssetsUrl()
     {
-        return $this->pluginUrl() . 'assets/dist/';
+        return $this->pluginUrl().'assets/dist/';
     }
 
 

Indentation +149 added lines, -149 removed lines

@@ -16,153 +16,153 @@
 abstract class DomainBase implements DomainInterface
 {
 
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var FilePath
-     */
-    private $plugin_file;
-
-    /**
-     * String indicating version for plugin
-     *
-     * @var string
-     */
-    private $version;
-
-    /**
-     * @var string $plugin_basename
-     */
-    private $plugin_basename;
-
-    /**
-     * @var string $plugin_path
-     */
-    private $plugin_path;
-
-    /**
-     * @var string $plugin_url
-     */
-    private $plugin_url;
-
-    /**
-     * @var string $asset_namespace
-     */
-    private $asset_namespace;
-
-
-
-    /**
-     * Initializes internal properties.
-     *
-     * @param FilePath $plugin_file
-     * @param Version  $version
-     */
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        $this->plugin_file = $plugin_file;
-        $this->version = $version;
-        $this->plugin_basename = plugin_basename($this->pluginFile());
-        $this->plugin_path = plugin_dir_path($this->pluginFile());
-        $this->plugin_url = plugin_dir_url($this->pluginFile());
-        $this->setAssetNamespace();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginFile()
-    {
-        return (string) $this->plugin_file;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginBasename()
-    {
-        return $this->plugin_basename;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginPath()
-    {
-        return $this->plugin_path;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginUrl()
-    {
-        return $this->plugin_url;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function version()
-    {
-        return (string) $this->version;
-    }
-
-
-
-    /**
-     * @return Version
-     */
-    public function versionValueObject()
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath()
-    {
-        return $this->pluginPath() . 'assets/dist/';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl()
-    {
-        return $this->pluginUrl() . 'assets/dist/';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function assetNamespace()
-    {
-        return $this->asset_namespace;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function setAssetNamespace()
-    {
-        $this->asset_namespace = sanitize_key(
-            // convert directory separators to dashes and remove file extension
-            str_replace(array('/', '.php'), array('-', ''), $this->plugin_basename)
-        );
-    }
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var FilePath
+	 */
+	private $plugin_file;
+
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var string
+	 */
+	private $version;
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private $plugin_basename;
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private $plugin_path;
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private $plugin_url;
+
+	/**
+	 * @var string $asset_namespace
+	 */
+	private $asset_namespace;
+
+
+
+	/**
+	 * Initializes internal properties.
+	 *
+	 * @param FilePath $plugin_file
+	 * @param Version  $version
+	 */
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		$this->plugin_file = $plugin_file;
+		$this->version = $version;
+		$this->plugin_basename = plugin_basename($this->pluginFile());
+		$this->plugin_path = plugin_dir_path($this->pluginFile());
+		$this->plugin_url = plugin_dir_url($this->pluginFile());
+		$this->setAssetNamespace();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginFile()
+	{
+		return (string) $this->plugin_file;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginBasename()
+	{
+		return $this->plugin_basename;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginPath()
+	{
+		return $this->plugin_path;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginUrl()
+	{
+		return $this->plugin_url;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function version()
+	{
+		return (string) $this->version;
+	}
+
+
+
+	/**
+	 * @return Version
+	 */
+	public function versionValueObject()
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath()
+	{
+		return $this->pluginPath() . 'assets/dist/';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl()
+	{
+		return $this->pluginUrl() . 'assets/dist/';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function assetNamespace()
+	{
+		return $this->asset_namespace;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function setAssetNamespace()
+	{
+		$this->asset_namespace = sanitize_key(
+			// convert directory separators to dashes and remove file extension
+			str_replace(array('/', '.php'), array('-', ''), $this->plugin_basename)
+		);
+	}
 }

core/domain/values/assets/ManifestFile.php

Indentation +22 added lines, -22 removed lines

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

core/domain/values/assets/Asset.php

Spacing +2 added lines, -2 removed lines

@@ -82,7 +82,7 @@ 
      */
     private function setType($type)
     {
-        if (! in_array($type, $this->validAssetTypes(), true)) {
+        if ( ! in_array($type, $this->validAssetTypes(), true)) {
             throw new InvalidDataTypeException(
                 'Asset::$type',
                 $type,
@@ -99,7 +99,7 @@ 
      */
     private function setHandle($handle)
     {
-        if (! is_string($handle)) {
+        if ( ! is_string($handle)) {
             throw new InvalidDataTypeException(
                 '$handle',
                 $handle,

Indentation +164 added lines, -164 removed lines

@@ -16,168 +16,168 @@
 abstract class Asset
 {
 
-    /**
-     * indicates the file extension for a build distribution CSS file
-     */
-    const FILE_EXTENSION_DISTRIBUTION_CSS = '.dist.css';
-
-    /**
-     * indicates the file extension for a build distribution JS file
-     */
-    const FILE_EXTENSION_DISTRIBUTION_JS = '.dist.js';
-
-    /**
-     * Indicates the file extension for a build distribution dependencies json file.
-     */
-    const FILE_EXTENSION_DISTRIBUTION_DEPS = '.dist.deps.php';
-
-    /**
-     * indicates a Cascading Style Sheet asset
-     */
-    const TYPE_CSS = 'css';
-
-    /**
-     * indicates a Javascript asset
-     */
-    const TYPE_JS = 'js';
-
-    /**
-     * indicates a JSON asset
-     */
-    CONST TYPE_JSON = 'json';
-    /**
-     * indicates a PHP asset
-     */
-    CONST TYPE_PHP = 'php';
-
-    /**
-     * indicates a Javascript manifest file
-     */
-    const TYPE_MANIFEST = 'manifest';
-
-    /**
-     * @var DomainInterface $domain
-     */
-    protected $domain;
-
-    /**
-     * @var string $type
-     */
-    private $type;
-
-    /**
-     * @var string $handle
-     */
-    private $handle;
-
-    /**
-     * @var bool $registered
-     */
-    private $registered = false;
-
-
-    /**
-     * Asset constructor.
-     *
-     * @param                 $type
-     * @param string          $handle
-     * @param DomainInterface $domain
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($type, $handle, DomainInterface $domain)
-    {
-        $this->domain = $domain;
-        $this->setType($type);
-        $this->setHandle($handle);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validAssetTypes()
-    {
-        return array(
-            Asset::TYPE_CSS,
-            Asset::TYPE_JS,
-            Asset::TYPE_MANIFEST,
-        );
-    }
-
-
-    /**
-     * @param string $type
-     * @throws InvalidDataTypeException
-     */
-    private function setType($type)
-    {
-        if (! in_array($type, $this->validAssetTypes(), true)) {
-            throw new InvalidDataTypeException(
-                'Asset::$type',
-                $type,
-                'one of the TYPE_* class constants on \EventEspresso\core\domain\values\Asset is required'
-            );
-        }
-        $this->type = $type;
-    }
-
-
-    /**
-     * @param string $handle
-     * @throws InvalidDataTypeException
-     */
-    private function setHandle($handle)
-    {
-        if (! is_string($handle)) {
-            throw new InvalidDataTypeException(
-                '$handle',
-                $handle,
-                'string'
-            );
-        }
-        $this->handle = $handle;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function assetNamespace()
-    {
-        return $this->domain->assetNamespace();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function handle()
-    {
-        return $this->handle;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isRegistered()
-    {
-        return $this->registered;
-    }
-
-    /**
-     * @param bool $registered
-     */
-    public function setRegistered($registered = true)
-    {
-        $this->registered = filter_var($registered, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates the file extension for a build distribution CSS file
+	 */
+	const FILE_EXTENSION_DISTRIBUTION_CSS = '.dist.css';
+
+	/**
+	 * indicates the file extension for a build distribution JS file
+	 */
+	const FILE_EXTENSION_DISTRIBUTION_JS = '.dist.js';
+
+	/**
+	 * Indicates the file extension for a build distribution dependencies json file.
+	 */
+	const FILE_EXTENSION_DISTRIBUTION_DEPS = '.dist.deps.php';
+
+	/**
+	 * indicates a Cascading Style Sheet asset
+	 */
+	const TYPE_CSS = 'css';
+
+	/**
+	 * indicates a Javascript asset
+	 */
+	const TYPE_JS = 'js';
+
+	/**
+	 * indicates a JSON asset
+	 */
+	CONST TYPE_JSON = 'json';
+	/**
+	 * indicates a PHP asset
+	 */
+	CONST TYPE_PHP = 'php';
+
+	/**
+	 * indicates a Javascript manifest file
+	 */
+	const TYPE_MANIFEST = 'manifest';
+
+	/**
+	 * @var DomainInterface $domain
+	 */
+	protected $domain;
+
+	/**
+	 * @var string $type
+	 */
+	private $type;
+
+	/**
+	 * @var string $handle
+	 */
+	private $handle;
+
+	/**
+	 * @var bool $registered
+	 */
+	private $registered = false;
+
+
+	/**
+	 * Asset constructor.
+	 *
+	 * @param                 $type
+	 * @param string          $handle
+	 * @param DomainInterface $domain
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($type, $handle, DomainInterface $domain)
+	{
+		$this->domain = $domain;
+		$this->setType($type);
+		$this->setHandle($handle);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validAssetTypes()
+	{
+		return array(
+			Asset::TYPE_CSS,
+			Asset::TYPE_JS,
+			Asset::TYPE_MANIFEST,
+		);
+	}
+
+
+	/**
+	 * @param string $type
+	 * @throws InvalidDataTypeException
+	 */
+	private function setType($type)
+	{
+		if (! in_array($type, $this->validAssetTypes(), true)) {
+			throw new InvalidDataTypeException(
+				'Asset::$type',
+				$type,
+				'one of the TYPE_* class constants on \EventEspresso\core\domain\values\Asset is required'
+			);
+		}
+		$this->type = $type;
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @throws InvalidDataTypeException
+	 */
+	private function setHandle($handle)
+	{
+		if (! is_string($handle)) {
+			throw new InvalidDataTypeException(
+				'$handle',
+				$handle,
+				'string'
+			);
+		}
+		$this->handle = $handle;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function assetNamespace()
+	{
+		return $this->domain->assetNamespace();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function handle()
+	{
+		return $this->handle;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isRegistered()
+	{
+		return $this->registered;
+	}
+
+	/**
+	 * @param bool $registered
+	 */
+	public function setRegistered($registered = true)
+	{
+		$this->registered = filter_var($registered, FILTER_VALIDATE_BOOLEAN);
+	}
 }