intraxia / jaxion

src/Assets/ServiceProvider.php

Indentation +32 added lines, -32 removed lines

@@ -11,40 +11,40 @@
  * @subpackage Assets
  */
 class ServiceProvider implements ServiceProviderContract {
-	/**
-	 * Container to register with.
-	 *
-	 * @var Container
-	 */
-	protected $container;
+    /**
+     * Container to register with.
+     *
+     * @var Container
+     */
+    protected $container;
 
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param Container $container
-	 */
-	public function register( Container $container ) {
-		$this->container = $container;
+    /**
+     * {@inheritDoc}
+     *
+     * @param Container $container
+     */
+    public function register( Container $container ) {
+        $this->container = $container;
 
-		$container->define(
-			array( 'assets' => 'Intraxia\Jaxion\Contract\Assets\Register' ),
-			$register = new Register( $container->fetch( 'url' ), $container->fetch( 'version' ) )
-		);
+        $container->define(
+            array( 'assets' => 'Intraxia\Jaxion\Contract\Assets\Register' ),
+            $register = new Register( $container->fetch( 'url' ), $container->fetch( 'version' ) )
+        );
 
-		$this->add_assets( $register );
-	}
+        $this->add_assets( $register );
+    }
 
-	/**
-	 * Registers the assets on the generated Register.
-	 *
-	 * This is a no-op by default by can be overwritten by the implementing developer
-	 * to provide a single, clean location to register their assets.
-	 *
-	 * @param Register $register
-	 *
-	 * @codeCoverageIgnore
-	 */
-	protected function add_assets( Register $register ) {
-		// no-op
-	}
+    /**
+     * Registers the assets on the generated Register.
+     *
+     * This is a no-op by default by can be overwritten by the implementing developer
+     * to provide a single, clean location to register their assets.
+     *
+     * @param Register $register
+     *
+     * @codeCoverageIgnore
+     */
+    protected function add_assets( Register $register ) {
+        // no-op
+    }
 }

src/Core/Loader.php

Indentation +97 added lines, -97 removed lines

@@ -15,109 +15,109 @@
  * @subpackage Core
  */
 class Loader implements LoaderContract {
-	/**
-	 * Array of action hooks to attach.
-	 *
-	 * @var array[]
-	 */
-	protected $actions = array();
+    /**
+     * Array of action hooks to attach.
+     *
+     * @var array[]
+     */
+    protected $actions = array();
 
-	/**
-	 * Array of filter hooks to attach.
-	 *
-	 * @var array[]
-	 */
-	protected $filters = array();
+    /**
+     * Array of filter hooks to attach.
+     *
+     * @var array[]
+     */
+    protected $filters = array();
 
-	/**
-	 * {@inheritDoc}
-	 */
-	public function run() {
-		foreach ( $this->actions as $action ) {
-			add_action(
-				$action['hook'],
-				array( $action['service'], $action['method'] ),
-				$action['priority'],
-				$action['args']
-			);
-		}
+    /**
+     * {@inheritDoc}
+     */
+    public function run() {
+        foreach ( $this->actions as $action ) {
+            add_action(
+                $action['hook'],
+                array( $action['service'], $action['method'] ),
+                $action['priority'],
+                $action['args']
+            );
+        }
 
-		foreach ( $this->filters as $filter ) {
-			add_filter(
-				$filter['hook'],
-				array( $filter['service'], $filter['method'] ),
-				$filter['priority'],
-				$filter['args']
-			);
-		}
-	}
+        foreach ( $this->filters as $filter ) {
+            add_filter(
+                $filter['hook'],
+                array( $filter['service'], $filter['method'] ),
+                $filter['priority'],
+                $filter['args']
+            );
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param HasActions $service
-	 */
-	public function register_actions( HasActions $service ) {
-		foreach ( $service->action_hooks() as $action ) {
-			$this->actions = $this->add(
-				$this->actions,
-				$action['hook'],
-				$service,
-				$action['method'],
-				isset( $action['priority'] ) ? $action['priority'] : 10,
-				isset( $action['args'] ) ? $action['args'] : 1
-			);
-		}
-	}
+    /**
+     * {@inheritDoc}
+     *
+     * @param HasActions $service
+     */
+    public function register_actions( HasActions $service ) {
+        foreach ( $service->action_hooks() as $action ) {
+            $this->actions = $this->add(
+                $this->actions,
+                $action['hook'],
+                $service,
+                $action['method'],
+                isset( $action['priority'] ) ? $action['priority'] : 10,
+                isset( $action['args'] ) ? $action['args'] : 1
+            );
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param HasFilters $service
-	 */
-	public function register_filters( HasFilters $service ) {
-		foreach ( $service->filter_hooks() as $filter ) {
-			$this->filters = $this->add(
-				$this->filters,
-				$filter['hook'],
-				$service,
-				$filter['method'],
-				isset( $filter['priority'] ) ? $filter['priority'] : 10,
-				isset( $filter['args'] ) ? $filter['args'] : 1
-			);
-		}
-	}
+    /**
+     * {@inheritDoc}
+     *
+     * @param HasFilters $service
+     */
+    public function register_filters( HasFilters $service ) {
+        foreach ( $service->filter_hooks() as $filter ) {
+            $this->filters = $this->add(
+                $this->filters,
+                $filter['hook'],
+                $service,
+                $filter['method'],
+                isset( $filter['priority'] ) ? $filter['priority'] : 10,
+                isset( $filter['args'] ) ? $filter['args'] : 1
+            );
+        }
+    }
 
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param HasShortcode $service
-	 */
-	public function register_shortcode( HasShortcode $service ) {
-		add_shortcode( $service->shortcode_name(), array( $service, 'do_shortcode' ) );
-	}
+    /**
+     * {@inheritDoc}
+     *
+     * @param HasShortcode $service
+     */
+    public function register_shortcode( HasShortcode $service ) {
+        add_shortcode( $service->shortcode_name(), array( $service, 'do_shortcode' ) );
+    }
 
-	/**
-	 * Utility to register the actions and hooks into a single collection.
-	 *
-	 * @param array  $hooks
-	 * @param string $hook
-	 * @param object $service
-	 * @param string $method
-	 * @param int    $priority
-	 * @param int    $accepted_args
-	 *
-	 * @return array
-	 */
-	protected function add( $hooks, $hook, $service, $method, $priority, $accepted_args ) {
-		$hooks[] = array(
-			'hook'     => $hook,
-			'service'  => $service,
-			'method'   => $method,
-			'priority' => $priority,
-			'args'     => $accepted_args,
-		);
+    /**
+     * Utility to register the actions and hooks into a single collection.
+     *
+     * @param array  $hooks
+     * @param string $hook
+     * @param object $service
+     * @param string $method
+     * @param int    $priority
+     * @param int    $accepted_args
+     *
+     * @return array
+     */
+    protected function add( $hooks, $hook, $service, $method, $priority, $accepted_args ) {
+        $hooks[] = array(
+            'hook'     => $hook,
+            'service'  => $service,
+            'method'   => $method,
+            'priority' => $priority,
+            'args'     => $accepted_args,
+        );
 
-		return $hooks;
-	}
+        return $hooks;
+    }
 }

src/Core/Container.php

Indentation +318 added lines, -318 removed lines

@@ -13,322 +13,322 @@
  * @subpackage Core
  */
 class Container implements ContainerContract {
-	/**
-	 * ServiceProvider names to register with the container.
-	 *
-	 * Can be overwritten to include predefined providers.
-	 *
-	 * @var string[]
-	 */
-	protected $providers = array();
-
-	/**
-	 * Registered definitions.
-	 *
-	 * @var mixed[]
-	 */
-	private $definitions = array();
-
-	/**
-	 * Aliases to share between fetches.
-	 *
-	 * @var <string, true>[]
-	 */
-	private $shared = array();
-
-	/**
-	 * Aliases of all the registered services.
-	 *
-	 * @var <string, true>[]
-	 */
-	private $aliases = array();
-
-	/**
-	 * Array of classes registered on the container.
-	 *
-	 * @var <string, true>[]
-	 */
-	private $classes = array();
-
-	/**
-	 * Current position in the loop.
-	 *
-	 * @var int
-	 */
-	private $position;
-
-	/**
-	 * 0-indexed array of aliases for looping.
-	 *
-	 * @var string[]
-	 */
-	private $keys = array();
-
-	/**
-	 * Create a new container with the given providers.
-	 *
-	 * Providers can be instances or the class of the provider as a string.
-	 *
-	 * @param ServiceProvider[]|string[] $providers
-	 */
-	public function __construct( array $providers = array() ) {
-		// array_unique ensures we only register each provider once.
-		$providers = array_unique( array_merge( $this->providers, $providers ) );
-
-		foreach ( $providers as $provider ) {
-			if ( is_string( $provider ) && class_exists( $provider ) ) {
-				$provider = new $provider;
-			}
-
-			if ( $provider instanceof ServiceProvider ) {
-				$this->register( $provider );
-			}
-		}
-	}
-
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param string|array $alias
-	 * @param mixed        $definition
-	 *
-	 * @throws DefinedAliasException
-	 *
-	 * @return $this
-	 */
-	public function define( $alias, $definition ) {
-		if ( is_array( $alias ) ) {
-			$class = current( $alias );
-			$alias = key( $alias );
-		}
-
-		if ( isset( $this->aliases[ $alias ] ) ) {
-			throw new DefinedAliasException( $alias );
-		}
-
-		$this->aliases[ $alias ]     = true;
-		$this->definitions[ $alias ] = $definition;
-
-		// Closures are treated as factories unless
-		// defined via Container::share.
-		if ( ! $definition instanceof \Closure ) {
-			$this->shared[ $alias ] = true;
-		}
-
-		if ( isset( $class ) ) {
-			$this->classes[ $class ] = $alias;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param string|array $alias
-	 * @param mixed        $definition
-	 *
-	 * @throws DefinedAliasException
-	 *
-	 * @return $this
-	 */
-	public function share( $alias, $definition ) {
-		$this->define( $alias, $definition );
-
-		if ( is_array( $alias ) ) {
-			$alias = key( $alias );
-		}
-
-		$this->shared[ $alias ] = true;
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param string $alias
-	 *
-	 * @throws UndefinedAliasException
-	 *
-	 * @return mixed
-	 */
-	public function fetch( $alias ) {
-		if ( isset( $this->classes[ $alias ] ) ) {
-			// If the alias is a class name,
-			// then retrieve its linked alias.
-			// This is only registered when
-			// registering using an array.
-			$alias = $this->classes[ $alias ];
-		}
-
-		if ( ! isset( $this->aliases[ $alias ] ) ) {
-			throw new UndefinedAliasException( $alias );
-		}
-
-		$value = $this->definitions[ $alias ];
-
-		// If the shared value is a closure,
-		// execute it and assign the result
-		// in place of the closure.
-		if ( $value instanceof \Closure ) {
-			$factory = $value;
-			$value   = $factory( $this );
-		}
-
-		// If the value is shared, save the shared value.
-		if ( isset( $this->shared[ $alias ] ) ) {
-			$this->definitions[ $alias ] = $value;
-		}
-
-		// Return the fetched value.
-		return $value;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  string $alias
-	 *
-	 * @return bool
-	 */
-	public function has( $alias ) {
-		return isset( $this->aliases[ $alias ] );
-	}
-
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param string $alias
-	 *
-	 * @return $this
-	 */
-	public function remove( $alias ) {
-		if ( isset( $this->aliases[ $alias ] ) ) {
-			/**
-			 * If there's no reference in the aliases array,
-			 * the service won't be found on fetching and
-			 * can be overwritten on setting.
-			 *
-			 * Pros: Quick setting/unsetting, faster
-			 * performance on those operations when doing
-			 * a lot of these.
-			 *
-			 * Cons: Objects and values set in the container
-			 * can't get garbage collected.
-			 *
-			 * If this is a problem, this may need to be revisited.
-			 */
-			unset( $this->aliases[ $alias ] );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @param ServiceProvider $provider
-	 *
-	 * @return $this
-	 */
-	public function register( ServiceProvider $provider ) {
-		// @todo make sure provider is only registered once
-		$provider->register( $this );
-
-		return $this;
-	}
-
-	/**
-	 * Set a value into the container.
-	 *
-	 * @param  string $id
-	 * @param  mixed  $value
-	 *
-	 * @see    define
-	 */
-	public function offsetSet( $id, $value ) {
-		$this->define( $id, $value );
-	}
-
-	/**
-	 * Get an value from the container.
-	 *
-	 * @param  string $id
-	 *
-	 * @return object
-	 * @throws UndefinedAliasException
-	 *
-	 * @see    fetch
-	 */
-	public function offsetGet( $id ) {
-		return $this->fetch( $id );
-	}
-
-	/**
-	 * Checks if a key is set on the container.
-	 *
-	 * @param  string $id
-	 *
-	 * @return bool
-	 *
-	 * @see    has
-	 */
-	public function offsetExists( $id ) {
-		return $this->has( $id );
-	}
-
-	/**
-	 * Remove a key from the container.
-	 *
-	 * @param string $id
-	 *
-	 * @see   remove
-	 */
-	public function offsetUnset( $id ) {
-		$this->remove( $id );
-	}
-
-	/**
-	 * Sets the object properties to prepare for the loop.
-	 */
-	public function rewind() {
-		$this->position = 0;
-		$this->keys     = array_keys( $this->aliases );
-	}
-
-	/**
-	 * Retrieves the service object for the current step in the loop.
-	 *
-	 * @return object
-	 */
-	public function current() {
-		return $this->fetch( $this->keys[ $this->position ] );
-	}
-
-	/**
-	 * Retrieves the key for the current step in the loop.
-	 *
-	 * @return string
-	 */
-	public function key() {
-		return $this->keys[ $this->position ];
-	}
-
-	/**
-	 * Increments to the next step in the loop.
-	 */
-	public function next() {
-		$this->position ++;
-	}
-
-	/**
-	 * Checks if the next step in the loop in valid.
-	 *
-	 * @return bool
-	 */
-	public function valid() {
-		return isset( $this->keys[ $this->position ] );
-	}
+    /**
+     * ServiceProvider names to register with the container.
+     *
+     * Can be overwritten to include predefined providers.
+     *
+     * @var string[]
+     */
+    protected $providers = array();
+
+    /**
+     * Registered definitions.
+     *
+     * @var mixed[]
+     */
+    private $definitions = array();
+
+    /**
+     * Aliases to share between fetches.
+     *
+     * @var <string, true>[]
+     */
+    private $shared = array();
+
+    /**
+     * Aliases of all the registered services.
+     *
+     * @var <string, true>[]
+     */
+    private $aliases = array();
+
+    /**
+     * Array of classes registered on the container.
+     *
+     * @var <string, true>[]
+     */
+    private $classes = array();
+
+    /**
+     * Current position in the loop.
+     *
+     * @var int
+     */
+    private $position;
+
+    /**
+     * 0-indexed array of aliases for looping.
+     *
+     * @var string[]
+     */
+    private $keys = array();
+
+    /**
+     * Create a new container with the given providers.
+     *
+     * Providers can be instances or the class of the provider as a string.
+     *
+     * @param ServiceProvider[]|string[] $providers
+     */
+    public function __construct( array $providers = array() ) {
+        // array_unique ensures we only register each provider once.
+        $providers = array_unique( array_merge( $this->providers, $providers ) );
+
+        foreach ( $providers as $provider ) {
+            if ( is_string( $provider ) && class_exists( $provider ) ) {
+                $provider = new $provider;
+            }
+
+            if ( $provider instanceof ServiceProvider ) {
+                $this->register( $provider );
+            }
+        }
+    }
+
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param string|array $alias
+     * @param mixed        $definition
+     *
+     * @throws DefinedAliasException
+     *
+     * @return $this
+     */
+    public function define( $alias, $definition ) {
+        if ( is_array( $alias ) ) {
+            $class = current( $alias );
+            $alias = key( $alias );
+        }
+
+        if ( isset( $this->aliases[ $alias ] ) ) {
+            throw new DefinedAliasException( $alias );
+        }
+
+        $this->aliases[ $alias ]     = true;
+        $this->definitions[ $alias ] = $definition;
+
+        // Closures are treated as factories unless
+        // defined via Container::share.
+        if ( ! $definition instanceof \Closure ) {
+            $this->shared[ $alias ] = true;
+        }
+
+        if ( isset( $class ) ) {
+            $this->classes[ $class ] = $alias;
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param string|array $alias
+     * @param mixed        $definition
+     *
+     * @throws DefinedAliasException
+     *
+     * @return $this
+     */
+    public function share( $alias, $definition ) {
+        $this->define( $alias, $definition );
+
+        if ( is_array( $alias ) ) {
+            $alias = key( $alias );
+        }
+
+        $this->shared[ $alias ] = true;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param string $alias
+     *
+     * @throws UndefinedAliasException
+     *
+     * @return mixed
+     */
+    public function fetch( $alias ) {
+        if ( isset( $this->classes[ $alias ] ) ) {
+            // If the alias is a class name,
+            // then retrieve its linked alias.
+            // This is only registered when
+            // registering using an array.
+            $alias = $this->classes[ $alias ];
+        }
+
+        if ( ! isset( $this->aliases[ $alias ] ) ) {
+            throw new UndefinedAliasException( $alias );
+        }
+
+        $value = $this->definitions[ $alias ];
+
+        // If the shared value is a closure,
+        // execute it and assign the result
+        // in place of the closure.
+        if ( $value instanceof \Closure ) {
+            $factory = $value;
+            $value   = $factory( $this );
+        }
+
+        // If the value is shared, save the shared value.
+        if ( isset( $this->shared[ $alias ] ) ) {
+            $this->definitions[ $alias ] = $value;
+        }
+
+        // Return the fetched value.
+        return $value;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  string $alias
+     *
+     * @return bool
+     */
+    public function has( $alias ) {
+        return isset( $this->aliases[ $alias ] );
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param string $alias
+     *
+     * @return $this
+     */
+    public function remove( $alias ) {
+        if ( isset( $this->aliases[ $alias ] ) ) {
+            /**
+             * If there's no reference in the aliases array,
+             * the service won't be found on fetching and
+             * can be overwritten on setting.
+             *
+             * Pros: Quick setting/unsetting, faster
+             * performance on those operations when doing
+             * a lot of these.
+             *
+             * Cons: Objects and values set in the container
+             * can't get garbage collected.
+             *
+             * If this is a problem, this may need to be revisited.
+             */
+            unset( $this->aliases[ $alias ] );
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param ServiceProvider $provider
+     *
+     * @return $this
+     */
+    public function register( ServiceProvider $provider ) {
+        // @todo make sure provider is only registered once
+        $provider->register( $this );
+
+        return $this;
+    }
+
+    /**
+     * Set a value into the container.
+     *
+     * @param  string $id
+     * @param  mixed  $value
+     *
+     * @see    define
+     */
+    public function offsetSet( $id, $value ) {
+        $this->define( $id, $value );
+    }
+
+    /**
+     * Get an value from the container.
+     *
+     * @param  string $id
+     *
+     * @return object
+     * @throws UndefinedAliasException
+     *
+     * @see    fetch
+     */
+    public function offsetGet( $id ) {
+        return $this->fetch( $id );
+    }
+
+    /**
+     * Checks if a key is set on the container.
+     *
+     * @param  string $id
+     *
+     * @return bool
+     *
+     * @see    has
+     */
+    public function offsetExists( $id ) {
+        return $this->has( $id );
+    }
+
+    /**
+     * Remove a key from the container.
+     *
+     * @param string $id
+     *
+     * @see   remove
+     */
+    public function offsetUnset( $id ) {
+        $this->remove( $id );
+    }
+
+    /**
+     * Sets the object properties to prepare for the loop.
+     */
+    public function rewind() {
+        $this->position = 0;
+        $this->keys     = array_keys( $this->aliases );
+    }
+
+    /**
+     * Retrieves the service object for the current step in the loop.
+     *
+     * @return object
+     */
+    public function current() {
+        return $this->fetch( $this->keys[ $this->position ] );
+    }
+
+    /**
+     * Retrieves the key for the current step in the loop.
+     *
+     * @return string
+     */
+    public function key() {
+        return $this->keys[ $this->position ];
+    }
+
+    /**
+     * Increments to the next step in the loop.
+     */
+    public function next() {
+        $this->position ++;
+    }
+
+    /**
+     * Checks if the next step in the loop in valid.
+     *
+     * @return bool
+     */
+    public function valid() {
+        return isset( $this->keys[ $this->position ] );
+    }
 }

src/Core/Application.php

Indentation +142 added lines, -142 removed lines

@@ -13,146 +13,146 @@
  * @package Intraxia\Jaxion
  */
 class Application extends Container implements ApplicationContract {
-	/**
-	 * Define plugin version on Application.
-	 */
-	const VERSION = '';
-
-	/**
-	 * Singleton instance of the Application object
-	 *
-	 * @var Application
-	 */
-	protected static $instance = null;
-
-	/**
-	 * Instantiates a new Application container.
-	 *
-	 * The Application constructor enforces the presence of of a single instance
-	 * of the Application. If an instance already exists, an Exception will be thrown.
-	 *
-	 * @param string $file
-	 * @param array  $providers
-	 *
-	 * @throws ApplicationAlreadyBootedException
-	 */
-	public function __construct( $file, array $providers = array() ) {
-		if ( null !== static::$instance ) {
-			throw new ApplicationAlreadyBootedException;
-		}
-
-		static::$instance = $this;
-
-		$this->register_constants( $file );
-		$this->register_core_services();
-		$this->load_i18n();
-
-		register_activation_hook( $file, array( $this, 'activate' ) );
-		register_deactivation_hook( $file, array( $this, 'deactivate' ) );
-
-		parent::__construct( $providers );
-	}
-
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @throws UnexpectedValueException
-	 */
-	public function boot() {
-		$loader = $this->fetch( 'loader' );
-
-		if ( ! $loader instanceof LoaderContract ) {
-			throw new UnexpectedValueException;
-		}
-
-		foreach ( $this as $alias => $value ) {
-			if ( $value instanceof HasActions ) {
-				$loader->register_actions( $value );
-			}
-
-			if ( $value instanceof HasFilters ) {
-				$loader->register_filters( $value );
-			}
-
-			if ( $value instanceof HasShortcode ) {
-				$loader->register_shortcode( $value );
-			}
-		}
-
-		add_action( 'plugins_loaded', array( $loader, 'run' ) );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function activate() {
-		// no-op
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @codeCoverageIgnore
-	 */
-	public function deactivate() {
-		// no-op
-	}
-
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @return Application
-	 * @throws ApplicationNotBootedException
-	 */
-	public static function instance() {
-		if ( null === static::$instance ) {
-			throw new ApplicationNotBootedException;
-		}
-
-		return static::$instance;
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	public static function shutdown() {
-		if ( null !== static::$instance ) {
-			static::$instance = null;
-		}
-	}
-
-	/**
-	 * Sets the plugin's url, path, and basename.
-	 *
-	 * @param string $file
-	 */
-	private function register_constants( $file ) {
-		$this->share( 'url', plugin_dir_url( $file ) );
-		$this->share( 'path', plugin_dir_path( $file ) );
-		$this->share( 'basename', $basename = plugin_basename( $file ) );
-		$this->share( 'slug', dirname( $basename ) );
-		$this->share( 'version', static::VERSION );
-	}
-
-	/**
-	 * Registers the built-in services with the Application container.
-	 */
-	private function register_core_services() {
-		$this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) {
-			return new Loader( $app );
-		} );
-	}
-
-	/**
-	 * Load's the plugin's translation files.
-	 */
-	private function load_i18n() {
-		load_plugin_textdomain(
-			$this->fetch( 'basename' ),
-			false,
-			basename( $this->fetch( 'path' ) ) . '/languages/'
-		);
-	}
+    /**
+     * Define plugin version on Application.
+     */
+    const VERSION = '';
+
+    /**
+     * Singleton instance of the Application object
+     *
+     * @var Application
+     */
+    protected static $instance = null;
+
+    /**
+     * Instantiates a new Application container.
+     *
+     * The Application constructor enforces the presence of of a single instance
+     * of the Application. If an instance already exists, an Exception will be thrown.
+     *
+     * @param string $file
+     * @param array  $providers
+     *
+     * @throws ApplicationAlreadyBootedException
+     */
+    public function __construct( $file, array $providers = array() ) {
+        if ( null !== static::$instance ) {
+            throw new ApplicationAlreadyBootedException;
+        }
+
+        static::$instance = $this;
+
+        $this->register_constants( $file );
+        $this->register_core_services();
+        $this->load_i18n();
+
+        register_activation_hook( $file, array( $this, 'activate' ) );
+        register_deactivation_hook( $file, array( $this, 'deactivate' ) );
+
+        parent::__construct( $providers );
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @throws UnexpectedValueException
+     */
+    public function boot() {
+        $loader = $this->fetch( 'loader' );
+
+        if ( ! $loader instanceof LoaderContract ) {
+            throw new UnexpectedValueException;
+        }
+
+        foreach ( $this as $alias => $value ) {
+            if ( $value instanceof HasActions ) {
+                $loader->register_actions( $value );
+            }
+
+            if ( $value instanceof HasFilters ) {
+                $loader->register_filters( $value );
+            }
+
+            if ( $value instanceof HasShortcode ) {
+                $loader->register_shortcode( $value );
+            }
+        }
+
+        add_action( 'plugins_loaded', array( $loader, 'run' ) );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @codeCoverageIgnore
+     */
+    public function activate() {
+        // no-op
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @codeCoverageIgnore
+     */
+    public function deactivate() {
+        // no-op
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return Application
+     * @throws ApplicationNotBootedException
+     */
+    public static function instance() {
+        if ( null === static::$instance ) {
+            throw new ApplicationNotBootedException;
+        }
+
+        return static::$instance;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public static function shutdown() {
+        if ( null !== static::$instance ) {
+            static::$instance = null;
+        }
+    }
+
+    /**
+     * Sets the plugin's url, path, and basename.
+     *
+     * @param string $file
+     */
+    private function register_constants( $file ) {
+        $this->share( 'url', plugin_dir_url( $file ) );
+        $this->share( 'path', plugin_dir_path( $file ) );
+        $this->share( 'basename', $basename = plugin_basename( $file ) );
+        $this->share( 'slug', dirname( $basename ) );
+        $this->share( 'version', static::VERSION );
+    }
+
+    /**
+     * Registers the built-in services with the Application container.
+     */
+    private function register_core_services() {
+        $this->share( array( 'loader' => 'Intraxia\Jaxion\Contract\Core\Loader' ), function ( $app ) {
+            return new Loader( $app );
+        } );
+    }
+
+    /**
+     * Load's the plugin's translation files.
+     */
+    private function load_i18n() {
+        load_plugin_textdomain(
+            $this->fetch( 'basename' ),
+            false,
+            basename( $this->fetch( 'path' ) ) . '/languages/'
+        );
+    }
 }

src/Utility/Str.php

Indentation +32 added lines, -32 removed lines

@@ -11,39 +11,39 @@
  * @subpackage Utility
  */
 class Str {
-	/**
-	 * Determine if a given string starts with a given substring.
-	 *
-	 * @param  string       $haystack
-	 * @param  string|array $needles
-	 *
-	 * @return bool
-	 */
-	public static function starts_with( $haystack, $needles ) {
-		foreach ( (array) $needles as $needle ) {
-			if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) {
-				return true;
-			}
-		}
+    /**
+     * Determine if a given string starts with a given substring.
+     *
+     * @param  string       $haystack
+     * @param  string|array $needles
+     *
+     * @return bool
+     */
+    public static function starts_with( $haystack, $needles ) {
+        foreach ( (array) $needles as $needle ) {
+            if ( '' !== $needle && 0 === strpos( $haystack, $needle ) ) {
+                return true;
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Determine if a given string ends with a given substring.
-	 *
-	 * @param  string       $haystack
-	 * @param  string|array $needles
-	 *
-	 * @return bool
-	 */
-	public static function ends_with( $haystack, $needles ) {
-		foreach ( (array) $needles as $needle ) {
-			if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) {
-				return true;
-			}
-		}
+    /**
+     * Determine if a given string ends with a given substring.
+     *
+     * @param  string       $haystack
+     * @param  string|array $needles
+     *
+     * @return bool
+     */
+    public static function ends_with( $haystack, $needles ) {
+        foreach ( (array) $needles as $needle ) {
+            if ( substr( $haystack, - strlen( $needle ) ) === (string) $needle ) {
+                return true;
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 }

src/Contract/Axolotl/EntityManager.php

Indentation +46 added lines, -46 removed lines

@@ -6,54 +6,54 @@
 use WP_Error;
 
 interface EntityManager {
-	/**
-	 * Get a single model of the provided class with the given ID.
-	 *
-	 * @param string $class Fully qualified class name of model.
-	 * @param int    $id    ID of the model.
-	 *
-	 * @return Model|WP_Error
-	 */
-	public function find( $class, $id );
+    /**
+     * Get a single model of the provided class with the given ID.
+     *
+     * @param string $class Fully qualified class name of model.
+     * @param int    $id    ID of the model.
+     *
+     * @return Model|WP_Error
+     */
+    public function find( $class, $id );
 
-	/**
-	 * Finds all the models of the provided class for the given params.
-	 *
-	 * This method will return an empty Collection if the query returns no models.
-	 *
-	 * @param string $class  Fully qualified class name of models to find.
-	 * @param array  $params Params to constrain the find.
-	 *
-	 * @return Collection|WP_Error
-	 */
-	public function find_by( $class, $params = array() );
+    /**
+     * Finds all the models of the provided class for the given params.
+     *
+     * This method will return an empty Collection if the query returns no models.
+     *
+     * @param string $class  Fully qualified class name of models to find.
+     * @param array  $params Params to constrain the find.
+     *
+     * @return Collection|WP_Error
+     */
+    public function find_by( $class, $params = array() );
 
-	/**
-	 * Saves a new model of the provided class with the given data.
-	 *
-	 * @param string $class
-	 * @param array  $data
-	 *
-	 * @return Model|WP_Error
-	 */
-	public function create( $class, $data = array() );
+    /**
+     * Saves a new model of the provided class with the given data.
+     *
+     * @param string $class
+     * @param array  $data
+     *
+     * @return Model|WP_Error
+     */
+    public function create( $class, $data = array() );
 
-	/**
-	 * Updates a model with its latest dataE.
-	 *
-	 * @param Model $model
-	 *
-	 * @return Model|WP_Error
-	 */
-	public function persist( Model $model );
+    /**
+     * Updates a model with its latest dataE.
+     *
+     * @param Model $model
+     *
+     * @return Model|WP_Error
+     */
+    public function persist( Model $model );
 
-	/**
-	 * Delete the provide
-	 *
-	 * @param Model $model
-	 * @param bool  $force
-	 *
-	 * @return mixed
-	 */
-	public function delete( Model $model, $force = false );
+    /**
+     * Delete the provide
+     *
+     * @param Model $model
+     * @param bool  $force
+     *
+     * @return mixed
+     */
+    public function delete( Model $model, $force = false );
 }

src/Axolotl/Model.php

Indentation +673 added lines, -673 removed lines

@@ -20,677 +20,677 @@
  * @since      0.1.0
  */
 abstract class Model implements Serializes {
-	/**
-	 * Table attribute key.
-	 */
-	const TABLE_KEY = '@@table';
-
-	/**
-	 * Object attribute key.
-	 */
-	const OBJECT_KEY = '@@object';
-
-	/**
-	 * Memoized values for class methods.
-	 *
-	 * @var array
-	 */
-	private static $memo = array();
-
-	/**
-	 * Model attributes.
-	 *
-	 * @var array
-	 */
-	private $attributes = array(
-		self::TABLE_KEY  => array(),
-		self::OBJECT_KEY => null,
-	);
-
-	/**
-	 * Model's original attributes.
-	 *
-	 * @var array
-	 */
-	private $original = array(
-		self::TABLE_KEY  => array(),
-		self::OBJECT_KEY => null,
-	);
-
-	/**
-	 * Properties which are allowed to be set on the model.
-	 *
-	 * If this array is empty, any attributes can be set on the model.
-	 *
-	 * @var string[]
-	 */
-	protected $fillable = array();
-
-	/**
-	 * Properties which cannot be automatically filled on the model.
-	 *
-	 * If the model is unguarded, these properties can be filled.
-	 *
-	 * @var array
-	 */
-	protected $guarded = array();
-
-	/**
-	 * Properties which should not be serialized.
-	 *
-	 * @var array
-	 */
-	protected $hidden = array();
-
-	/**
-	 * Properties which should be serialized.
-	 *
-	 * @var array
-	 */
-	protected $visible = array();
-
-	/**
-	 * Whether the model's properties are guarded.
-	 *
-	 * When false, allows guarded properties to be filled.
-	 *
-	 * @var bool
-	 */
-	protected $is_guarded = true;
-
-	/**
-	 * Constructs a new model with provided attributes.
-	 *
-	 * If self::OBJECT_KEY is passed as one of the attributes, the underlying post
-	 * will be overwritten.
-	 *
-	 * @param array <string, mixed> $attributes
-	 */
-	public function __construct( array $attributes = array() ) {
-		$this->maybe_boot();
-		$this->sync_original();
-
-		if ( $this->uses_wp_object() ) {
-			$this->create_wp_object();
-		}
-
-		$this->refresh( $attributes );
-	}
-
-	/**
-	 * Refreshes the model's current attributes with the provided array.
-	 *
-	 * The model's attributes will match what was provided in the array,
-	 * and any attributes not passed
-	 *
-	 * @param array $attributes
-	 *
-	 * @return $this
-	 */
-	public function refresh( array $attributes ) {
-		$this->clear();
-
-		return $this->merge( $attributes );
-	}
-
-	/**
-	 * Merges the provided attributes with the provided array.
-	 *
-	 * @param array $attributes
-	 *
-	 * @return $this
-	 */
-	public function merge( array $attributes ) {
-		foreach ( $attributes as $name => $value ) {
-			$this->set_attribute( $name, $value );
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Get the model's table attributes.
-	 *
-	 * Returns the array of for the model that will either need to be
-	 * saved in postmeta or a separate table.
-	 *
-	 * @return array
-	 */
-	public function get_table_attributes() {
-		return $this->attributes[ self::TABLE_KEY ];
-	}
-
-	/**
-	 * Get the model's original attributes.
-	 *
-	 * @return array
-	 */
-	public function get_original_table_attributes() {
-		return $this->original[ self::TABLE_KEY ];
-	}
-
-	/**
-	 * Retrieve an array of the attributes on the model
-	 * that have changed compared to the model's
-	 * original data.
-	 *
-	 * @return array
-	 */
-	public function get_changed_table_attributes() {
-		$changed = array();
-
-		foreach ( $this->get_table_attributes() as $attribute ) {
-			if ( $this->get_attribute( $attribute ) !==
-			     $this->get_original_attribute( $attribute )
-			) {
-				$changed[ $attribute ] = $this->get_attribute( $attribute );
-			}
-		}
-
-		return $changed;
-	}
-
-	/**
-	 * Get the model's underlying post.
-	 *
-	 * Returns the underlying WP_Post object for the model, representing
-	 * the data that will be save in the wp_posts table.
-	 *
-	 * @return false|WP_Post|WP_Term
-	 */
-	public function get_underlying_wp_object() {
-		if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
-			return $this->attributes[ self::OBJECT_KEY ];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Get the model's original underlying post.
-	 *
-	 * @return WP_Post
-	 */
-	public function get_original_underlying_wp_object() {
-		return $this->original[ self::OBJECT_KEY ];
-	}
-
-	/**
-	 * Get the model attributes on the WordPress object
-	 * that have changed compared to the model's
-	 * original attributes.
-	 *
-	 * @return array
-	 */
-	public function get_changed_wp_object_attributes() {
-		$changed = array();
-
-		foreach ( $this->get_wp_object_keys() as $key ) {
-			if ( $this->get_attribute( $key ) !==
-			     $this->get_original_attribute( $key )
-			) {
-				$changed[ $key ] = $this->get_attribute( $key );
-			}
-		}
-
-		return $changed;
-	}
-
-	/**
-	 * Magic __set method.
-	 *
-	 * Passes the name and value to set_attribute, which is where the magic happens.
-	 *
-	 * @param string $name
-	 * @param mixed  $value
-	 */
-	public function __set( $name, $value ) {
-		$this->set_attribute( $name, $value );
-	}
-
-	/**
-	 * Sets the model attributes.
-	 *
-	 * Checks whether the model attribute can be set, check if it
-	 * maps to the WP_Post property, otherwise, assigns it to the
-	 * table attribute array.
-	 *
-	 * @param string $name
-	 * @param mixed  $value
-	 *
-	 * @return $this
-	 *
-	 * @throws GuardedPropertyException
-	 */
-	public function set_attribute( $name, $value ) {
-		if ( self::OBJECT_KEY === $name ) {
-			return $this->override_wp_object( $value );
-		}
-
-		if ( ! $this->is_fillable( $name ) ) {
-			throw new GuardedPropertyException;
-		}
-
-		if ( $method = $this->has_map_method( $name ) ) {
-			$this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
-		} else {
-			$this->attributes[ self::TABLE_KEY ][ $name ] = $value;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Retrieves all the attribute keys for the model.
-	 *
-	 * @return array
-	 */
-	public function get_attribute_keys() {
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
-		}
-
-		return self::$memo[ get_called_class() ][ __METHOD__ ]
-			= array_merge(
-				$this->fillable,
-				$this->guarded,
-				$this->get_compute_methods()
-			);
-	}
-
-	/**
-	 * Retrieves the attribute keys that aren't mapped to a post.
-	 *
-	 * @return array
-	 */
-	public function get_table_keys() {
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
-		}
-
-		$keys = array();
-
-		foreach ( $this->get_attribute_keys() as $key ) {
-			if ( ! $this->has_map_method( $key ) &&
-			     ! $this->has_compute_method( $key )
-			) {
-				$keys[] = $key;
-			}
-		}
-
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
-	}
-
-	/**
-	 * Retrieves the attribute keys that are mapped to a post.
-	 *
-	 * @return array
-	 */
-	public function get_wp_object_keys() {
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
-		}
-
-		$keys = array();
-
-		foreach ( $this->get_attribute_keys() as $key ) {
-			if ( $this->has_map_method( $key ) ) {
-				$keys[] = $key;
-			}
-		}
-
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
-	}
-
-	/**
-	 * Returns the model's keys that are computed at call time.
-	 *
-	 * @return array
-	 */
-	public function get_computed_keys() {
-		if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
-			return self::$memo[ get_called_class() ][ __METHOD__ ];
-		}
-
-		$keys = array();
-
-		foreach ( $this->get_attribute_keys() as $key ) {
-			if ( $this->has_compute_method( $key ) ) {
-				$keys[] = $key;
-			}
-		}
-
-		return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
-	}
-
-	/**
-	 * Serializes the model's public data into an array.
-	 *
-	 * @return array
-	 */
-	public function serialize() {
-		$attributes = array();
-
-		if ( $this->visible ) {
-			// If visible attributes are set, we'll only reveal those.
-			foreach ( $this->visible as $key ) {
-				$attributes[ $key ] = $this->get_attribute( $key );
-			}
-		} elseif ( $this->hidden ) {
-			// If hidden attributes are set, we'll grab everything and hide those.
-			foreach ( $this->get_attribute_keys() as $key ) {
-				if ( ! in_array( $key, $this->hidden ) ) {
-					$attributes[ $key ] = $this->get_attribute( $key );
-				}
-			}
-		} else {
-			// If nothing is hidden/visible, we'll grab and reveal everything.
-			foreach ( $this->get_attribute_keys() as $key ) {
-				$attributes[ $key ] = $this->get_attribute( $key );
-			}
-		}
-
-		return array_map( function ( $attribute ) {
-			if ( $attribute instanceof Serializes ) {
-				return $attribute->serialize();
-			}
-
-			return $attribute;
-		}, $attributes );
-	}
-
-	/**
-	 * Syncs the current attributes to the model's original.
-	 *
-	 * @return $this
-	 */
-	public function sync_original() {
-		$this->original = $this->attributes;
-
-		if ( $this->attributes[ self::OBJECT_KEY ] ) {
-			$this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Checks if a given attribute is mass-fillable.
-	 *
-	 * Returns true if the attribute can be filled, false if it can't.
-	 *
-	 * @param string $name
-	 *
-	 * @return bool
-	 */
-	private function is_fillable( $name ) {
-		// If this model isn't guarded, everything is fillable.
-		if ( ! $this->is_guarded ) {
-			return true;
-		}
-
-		// If it's in the fillable array, then it's fillable.
-		if ( in_array( $name, $this->fillable ) ) {
-			return true;
-		}
-
-		// If it's explicitly guarded, then it's not fillable.
-		if ( in_array( $name, $this->guarded ) ) {
-			return false;
-		}
-
-		// If fillable hasn't been defined, then everything else fillable.
-		return ! $this->fillable;
-	}
-
-	/**
-	 * Overrides the current WP_Post with a provided one.
-	 *
-	 * Resets the post's default values and stores it in the attributes.
-	 *
-	 * @param WP_Post $value
-	 *
-	 * @return $this
-	 */
-	private function override_wp_object( $value ) {
-		$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
-
-		return $this;
-	}
-
-	/**
-	 * Create and set with a new blank post.
-	 *
-	 * Creates a new WP_Post object, assigns it the default attributes,
-	 * and stores it in the attributes.
-	 *
-	 * @throws LogicException
-	 */
-	private function create_wp_object() {
-		switch ( true ) {
-			case $this instanceof UsesWordPressPost:
-				$object = new WP_Post( (object) array() );
-				break;
-			case $this instanceof UsesWordPressTerm:
-				$object = new WP_Term( (object) array() );
-				break;
-			default:
-				throw new LogicException;
-				break;
-		}
-
-		$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
-	}
-
-	/**
-	 * Enforces values on the post that can't change.
-	 *
-	 * Primarily, this is used to make sure the post_type always maps
-	 * to the model's "$type" property, but this can all be overridden
-	 * by the developer to enforce other values in the model.
-	 *
-	 * @param object $object
-	 *
-	 * @return object
-	 */
-	protected function set_wp_object_constants( $object ) {
-		if ( $this instanceof UsesWordPressPost ) {
-			$object->post_type = $this::get_post_type();
-		}
-
-		if ( $this instanceof UsesWordPressTerm ) {
-			$object->taxonomy = $this::get_taxonomy();
-		}
-
-		return $object;
-	}
-
-	/**
-	 * Magic __get method.
-	 *
-	 * Passes the name and value to get_attribute, which is where the magic happens.
-	 *
-	 * @param string $name
-	 *
-	 * @return mixed
-	 */
-	public function __get( $name ) {
-		return $this->get_attribute( $name );
-	}
-
-	/**
-	 * Retrieves the model attribute.
-	 *
-	 * @param string $name
-	 *
-	 * @return mixed
-	 *
-	 * @throws PropertyDoesNotExistException If property isn't found.
-	 */
-	public function get_attribute( $name ) {
-		if ( $method = $this->has_map_method( $name ) ) {
-			$value = $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
-		} elseif ( $method = $this->has_compute_method( $name ) ) {
-			$value = $this->{$method}();
-		} else {
-			if ( ! isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
-				throw new PropertyDoesNotExistException;
-			}
-
-			$value = $this->attributes[ self::TABLE_KEY ][ $name ];
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Retrieve the model's original attribute value.
-	 *
-	 * @param string $name
-	 *
-	 * @return mixed
-	 *
-	 * @throws PropertyDoesNotExistException If property isn't found.
-	 */
-	public function get_original_attribute( $name ) {
-		$original = new static( $this->original );
-
-		return $original->get_attribute( $name );
-	}
-
-	/**
-	 * Fetches the Model's primary ID, depending on the model
-	 * implementation.
-	 *
-	 * @return int
-	 *
-	 * @throws LogicException
-	 */
-	public function get_primary_id() {
-		if ( $this instanceof UsesWordPressPost ) {
-			return $this->get_underlying_wp_object()->ID;
-		}
-
-		if ( $this instanceof UsesWordPressTerm ) {
-			return $this->get_underlying_wp_object()->term_id;
-		}
-
-		// Model w/o wp_object not yet supported.
-		throw new LogicException;
-	}
-
-	/**
-	 * Checks whether the attribute has a map method.
-	 *
-	 * This is used to determine whether the attribute maps to a
-	 * property on the underlying WP_Post object. Returns the
-	 * method if one exists, returns false if it doesn't.
-	 *
-	 * @param string $name
-	 *
-	 * @return false|string
-	 */
-	protected function has_map_method( $name ) {
-		if ( method_exists( $this, $method = "map_{$name}" ) ) {
-			return $method;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Checks whether the attribute has a compute method.
-	 *
-	 * This is used to determine if the attribute should be computed
-	 * from other attributes.
-	 *
-	 * @param string $name
-	 *
-	 * @return false|string
-	 */
-	protected function has_compute_method( $name ) {
-		if ( method_exists( $this, $method = "compute_{$name}" ) ) {
-			return $method;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Clears all the current attributes from the model.
-	 *
-	 * This does not touch the model's original attributes, and will
-	 * only clear fillable attributes, unless the model is unguarded.
-	 *
-	 * @return $this
-	 */
-	public function clear() {
-		$keys = $this->get_attribute_keys();
-
-		foreach ( $keys as $key ) {
-			try {
-				$this->set_attribute( $key, null );
-			} catch ( GuardedPropertyException $e ) {
-				// We won't clear out guarded attributes.
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Unguards the model.
-	 *
-	 * Sets the model to be unguarded, allowing the filling of
-	 * guarded attributes.
-	 */
-	public function unguard() {
-		$this->is_guarded = false;
-	}
-
-	/**
-	 * Reguards the model.
-	 *
-	 * Sets the model to be guarded, preventing filling of
-	 * guarded attributes.
-	 */
-	public function reguard() {
-		$this->is_guarded = true;
-	}
-
-	/**
-	 * Retrieves all the compute methods on the model.
-	 *
-	 * @return array
-	 */
-	protected function get_compute_methods() {
-		$methods = get_class_methods( get_called_class() );
-		$methods = array_filter( $methods, function ( $method ) {
-			return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
-		} );
-		$methods = array_map( function ( $method ) {
-			return substr( $method, strlen( 'compute_' ) );
-		}, $methods );
-
-		return $methods;
-	}
-
-	/**
-	 * Sets up the memo array for the creating model.
-	 */
-	private function maybe_boot() {
-		if ( ! isset( self::$memo[ get_called_class() ] ) ) {
-			self::$memo[ get_called_class() ] = array();
-		}
-	}
-
-	/**
-	 * Whether this Model uses an underlying WordPress object.
-	 *
-	 * @return bool
-	 */
-	protected function uses_wp_object() {
-		return $this instanceof UsesWordPressPost ||
-			$this instanceof UsesWordPressTerm;
-	}
+    /**
+     * Table attribute key.
+     */
+    const TABLE_KEY = '@@table';
+
+    /**
+     * Object attribute key.
+     */
+    const OBJECT_KEY = '@@object';
+
+    /**
+     * Memoized values for class methods.
+     *
+     * @var array
+     */
+    private static $memo = array();
+
+    /**
+     * Model attributes.
+     *
+     * @var array
+     */
+    private $attributes = array(
+        self::TABLE_KEY  => array(),
+        self::OBJECT_KEY => null,
+    );
+
+    /**
+     * Model's original attributes.
+     *
+     * @var array
+     */
+    private $original = array(
+        self::TABLE_KEY  => array(),
+        self::OBJECT_KEY => null,
+    );
+
+    /**
+     * Properties which are allowed to be set on the model.
+     *
+     * If this array is empty, any attributes can be set on the model.
+     *
+     * @var string[]
+     */
+    protected $fillable = array();
+
+    /**
+     * Properties which cannot be automatically filled on the model.
+     *
+     * If the model is unguarded, these properties can be filled.
+     *
+     * @var array
+     */
+    protected $guarded = array();
+
+    /**
+     * Properties which should not be serialized.
+     *
+     * @var array
+     */
+    protected $hidden = array();
+
+    /**
+     * Properties which should be serialized.
+     *
+     * @var array
+     */
+    protected $visible = array();
+
+    /**
+     * Whether the model's properties are guarded.
+     *
+     * When false, allows guarded properties to be filled.
+     *
+     * @var bool
+     */
+    protected $is_guarded = true;
+
+    /**
+     * Constructs a new model with provided attributes.
+     *
+     * If self::OBJECT_KEY is passed as one of the attributes, the underlying post
+     * will be overwritten.
+     *
+     * @param array <string, mixed> $attributes
+     */
+    public function __construct( array $attributes = array() ) {
+        $this->maybe_boot();
+        $this->sync_original();
+
+        if ( $this->uses_wp_object() ) {
+            $this->create_wp_object();
+        }
+
+        $this->refresh( $attributes );
+    }
+
+    /**
+     * Refreshes the model's current attributes with the provided array.
+     *
+     * The model's attributes will match what was provided in the array,
+     * and any attributes not passed
+     *
+     * @param array $attributes
+     *
+     * @return $this
+     */
+    public function refresh( array $attributes ) {
+        $this->clear();
+
+        return $this->merge( $attributes );
+    }
+
+    /**
+     * Merges the provided attributes with the provided array.
+     *
+     * @param array $attributes
+     *
+     * @return $this
+     */
+    public function merge( array $attributes ) {
+        foreach ( $attributes as $name => $value ) {
+            $this->set_attribute( $name, $value );
+        }
+
+        return $this;
+    }
+
+    /**
+     * Get the model's table attributes.
+     *
+     * Returns the array of for the model that will either need to be
+     * saved in postmeta or a separate table.
+     *
+     * @return array
+     */
+    public function get_table_attributes() {
+        return $this->attributes[ self::TABLE_KEY ];
+    }
+
+    /**
+     * Get the model's original attributes.
+     *
+     * @return array
+     */
+    public function get_original_table_attributes() {
+        return $this->original[ self::TABLE_KEY ];
+    }
+
+    /**
+     * Retrieve an array of the attributes on the model
+     * that have changed compared to the model's
+     * original data.
+     *
+     * @return array
+     */
+    public function get_changed_table_attributes() {
+        $changed = array();
+
+        foreach ( $this->get_table_attributes() as $attribute ) {
+            if ( $this->get_attribute( $attribute ) !==
+                    $this->get_original_attribute( $attribute )
+            ) {
+                $changed[ $attribute ] = $this->get_attribute( $attribute );
+            }
+        }
+
+        return $changed;
+    }
+
+    /**
+     * Get the model's underlying post.
+     *
+     * Returns the underlying WP_Post object for the model, representing
+     * the data that will be save in the wp_posts table.
+     *
+     * @return false|WP_Post|WP_Term
+     */
+    public function get_underlying_wp_object() {
+        if ( isset( $this->attributes[ self::OBJECT_KEY ] ) ) {
+            return $this->attributes[ self::OBJECT_KEY ];
+        }
+
+        return false;
+    }
+
+    /**
+     * Get the model's original underlying post.
+     *
+     * @return WP_Post
+     */
+    public function get_original_underlying_wp_object() {
+        return $this->original[ self::OBJECT_KEY ];
+    }
+
+    /**
+     * Get the model attributes on the WordPress object
+     * that have changed compared to the model's
+     * original attributes.
+     *
+     * @return array
+     */
+    public function get_changed_wp_object_attributes() {
+        $changed = array();
+
+        foreach ( $this->get_wp_object_keys() as $key ) {
+            if ( $this->get_attribute( $key ) !==
+                    $this->get_original_attribute( $key )
+            ) {
+                $changed[ $key ] = $this->get_attribute( $key );
+            }
+        }
+
+        return $changed;
+    }
+
+    /**
+     * Magic __set method.
+     *
+     * Passes the name and value to set_attribute, which is where the magic happens.
+     *
+     * @param string $name
+     * @param mixed  $value
+     */
+    public function __set( $name, $value ) {
+        $this->set_attribute( $name, $value );
+    }
+
+    /**
+     * Sets the model attributes.
+     *
+     * Checks whether the model attribute can be set, check if it
+     * maps to the WP_Post property, otherwise, assigns it to the
+     * table attribute array.
+     *
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return $this
+     *
+     * @throws GuardedPropertyException
+     */
+    public function set_attribute( $name, $value ) {
+        if ( self::OBJECT_KEY === $name ) {
+            return $this->override_wp_object( $value );
+        }
+
+        if ( ! $this->is_fillable( $name ) ) {
+            throw new GuardedPropertyException;
+        }
+
+        if ( $method = $this->has_map_method( $name ) ) {
+            $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()} = $value;
+        } else {
+            $this->attributes[ self::TABLE_KEY ][ $name ] = $value;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Retrieves all the attribute keys for the model.
+     *
+     * @return array
+     */
+    public function get_attribute_keys() {
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
+        }
+
+        return self::$memo[ get_called_class() ][ __METHOD__ ]
+            = array_merge(
+                $this->fillable,
+                $this->guarded,
+                $this->get_compute_methods()
+            );
+    }
+
+    /**
+     * Retrieves the attribute keys that aren't mapped to a post.
+     *
+     * @return array
+     */
+    public function get_table_keys() {
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
+        }
+
+        $keys = array();
+
+        foreach ( $this->get_attribute_keys() as $key ) {
+            if ( ! $this->has_map_method( $key ) &&
+                 ! $this->has_compute_method( $key )
+            ) {
+                $keys[] = $key;
+            }
+        }
+
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
+    }
+
+    /**
+     * Retrieves the attribute keys that are mapped to a post.
+     *
+     * @return array
+     */
+    public function get_wp_object_keys() {
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
+        }
+
+        $keys = array();
+
+        foreach ( $this->get_attribute_keys() as $key ) {
+            if ( $this->has_map_method( $key ) ) {
+                $keys[] = $key;
+            }
+        }
+
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
+    }
+
+    /**
+     * Returns the model's keys that are computed at call time.
+     *
+     * @return array
+     */
+    public function get_computed_keys() {
+        if ( isset( self::$memo[ get_called_class() ][ __METHOD__ ] ) ) {
+            return self::$memo[ get_called_class() ][ __METHOD__ ];
+        }
+
+        $keys = array();
+
+        foreach ( $this->get_attribute_keys() as $key ) {
+            if ( $this->has_compute_method( $key ) ) {
+                $keys[] = $key;
+            }
+        }
+
+        return self::$memo[ get_called_class() ][ __METHOD__ ] = $keys;
+    }
+
+    /**
+     * Serializes the model's public data into an array.
+     *
+     * @return array
+     */
+    public function serialize() {
+        $attributes = array();
+
+        if ( $this->visible ) {
+            // If visible attributes are set, we'll only reveal those.
+            foreach ( $this->visible as $key ) {
+                $attributes[ $key ] = $this->get_attribute( $key );
+            }
+        } elseif ( $this->hidden ) {
+            // If hidden attributes are set, we'll grab everything and hide those.
+            foreach ( $this->get_attribute_keys() as $key ) {
+                if ( ! in_array( $key, $this->hidden ) ) {
+                    $attributes[ $key ] = $this->get_attribute( $key );
+                }
+            }
+        } else {
+            // If nothing is hidden/visible, we'll grab and reveal everything.
+            foreach ( $this->get_attribute_keys() as $key ) {
+                $attributes[ $key ] = $this->get_attribute( $key );
+            }
+        }
+
+        return array_map( function ( $attribute ) {
+            if ( $attribute instanceof Serializes ) {
+                return $attribute->serialize();
+            }
+
+            return $attribute;
+        }, $attributes );
+    }
+
+    /**
+     * Syncs the current attributes to the model's original.
+     *
+     * @return $this
+     */
+    public function sync_original() {
+        $this->original = $this->attributes;
+
+        if ( $this->attributes[ self::OBJECT_KEY ] ) {
+            $this->original[ self::OBJECT_KEY ] = clone $this->attributes[ self::OBJECT_KEY ];
+        }
+
+        return $this;
+    }
+
+    /**
+     * Checks if a given attribute is mass-fillable.
+     *
+     * Returns true if the attribute can be filled, false if it can't.
+     *
+     * @param string $name
+     *
+     * @return bool
+     */
+    private function is_fillable( $name ) {
+        // If this model isn't guarded, everything is fillable.
+        if ( ! $this->is_guarded ) {
+            return true;
+        }
+
+        // If it's in the fillable array, then it's fillable.
+        if ( in_array( $name, $this->fillable ) ) {
+            return true;
+        }
+
+        // If it's explicitly guarded, then it's not fillable.
+        if ( in_array( $name, $this->guarded ) ) {
+            return false;
+        }
+
+        // If fillable hasn't been defined, then everything else fillable.
+        return ! $this->fillable;
+    }
+
+    /**
+     * Overrides the current WP_Post with a provided one.
+     *
+     * Resets the post's default values and stores it in the attributes.
+     *
+     * @param WP_Post $value
+     *
+     * @return $this
+     */
+    private function override_wp_object( $value ) {
+        $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
+
+        return $this;
+    }
+
+    /**
+     * Create and set with a new blank post.
+     *
+     * Creates a new WP_Post object, assigns it the default attributes,
+     * and stores it in the attributes.
+     *
+     * @throws LogicException
+     */
+    private function create_wp_object() {
+        switch ( true ) {
+            case $this instanceof UsesWordPressPost:
+                $object = new WP_Post( (object) array() );
+                break;
+            case $this instanceof UsesWordPressTerm:
+                $object = new WP_Term( (object) array() );
+                break;
+            default:
+                throw new LogicException;
+                break;
+        }
+
+        $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $object );
+    }
+
+    /**
+     * Enforces values on the post that can't change.
+     *
+     * Primarily, this is used to make sure the post_type always maps
+     * to the model's "$type" property, but this can all be overridden
+     * by the developer to enforce other values in the model.
+     *
+     * @param object $object
+     *
+     * @return object
+     */
+    protected function set_wp_object_constants( $object ) {
+        if ( $this instanceof UsesWordPressPost ) {
+            $object->post_type = $this::get_post_type();
+        }
+
+        if ( $this instanceof UsesWordPressTerm ) {
+            $object->taxonomy = $this::get_taxonomy();
+        }
+
+        return $object;
+    }
+
+    /**
+     * Magic __get method.
+     *
+     * Passes the name and value to get_attribute, which is where the magic happens.
+     *
+     * @param string $name
+     *
+     * @return mixed
+     */
+    public function __get( $name ) {
+        return $this->get_attribute( $name );
+    }
+
+    /**
+     * Retrieves the model attribute.
+     *
+     * @param string $name
+     *
+     * @return mixed
+     *
+     * @throws PropertyDoesNotExistException If property isn't found.
+     */
+    public function get_attribute( $name ) {
+        if ( $method = $this->has_map_method( $name ) ) {
+            $value = $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
+        } elseif ( $method = $this->has_compute_method( $name ) ) {
+            $value = $this->{$method}();
+        } else {
+            if ( ! isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
+                throw new PropertyDoesNotExistException;
+            }
+
+            $value = $this->attributes[ self::TABLE_KEY ][ $name ];
+        }
+
+        return $value;
+    }
+
+    /**
+     * Retrieve the model's original attribute value.
+     *
+     * @param string $name
+     *
+     * @return mixed
+     *
+     * @throws PropertyDoesNotExistException If property isn't found.
+     */
+    public function get_original_attribute( $name ) {
+        $original = new static( $this->original );
+
+        return $original->get_attribute( $name );
+    }
+
+    /**
+     * Fetches the Model's primary ID, depending on the model
+     * implementation.
+     *
+     * @return int
+     *
+     * @throws LogicException
+     */
+    public function get_primary_id() {
+        if ( $this instanceof UsesWordPressPost ) {
+            return $this->get_underlying_wp_object()->ID;
+        }
+
+        if ( $this instanceof UsesWordPressTerm ) {
+            return $this->get_underlying_wp_object()->term_id;
+        }
+
+        // Model w/o wp_object not yet supported.
+        throw new LogicException;
+    }
+
+    /**
+     * Checks whether the attribute has a map method.
+     *
+     * This is used to determine whether the attribute maps to a
+     * property on the underlying WP_Post object. Returns the
+     * method if one exists, returns false if it doesn't.
+     *
+     * @param string $name
+     *
+     * @return false|string
+     */
+    protected function has_map_method( $name ) {
+        if ( method_exists( $this, $method = "map_{$name}" ) ) {
+            return $method;
+        }
+
+        return false;
+    }
+
+    /**
+     * Checks whether the attribute has a compute method.
+     *
+     * This is used to determine if the attribute should be computed
+     * from other attributes.
+     *
+     * @param string $name
+     *
+     * @return false|string
+     */
+    protected function has_compute_method( $name ) {
+        if ( method_exists( $this, $method = "compute_{$name}" ) ) {
+            return $method;
+        }
+
+        return false;
+    }
+
+    /**
+     * Clears all the current attributes from the model.
+     *
+     * This does not touch the model's original attributes, and will
+     * only clear fillable attributes, unless the model is unguarded.
+     *
+     * @return $this
+     */
+    public function clear() {
+        $keys = $this->get_attribute_keys();
+
+        foreach ( $keys as $key ) {
+            try {
+                $this->set_attribute( $key, null );
+            } catch ( GuardedPropertyException $e ) {
+                // We won't clear out guarded attributes.
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Unguards the model.
+     *
+     * Sets the model to be unguarded, allowing the filling of
+     * guarded attributes.
+     */
+    public function unguard() {
+        $this->is_guarded = false;
+    }
+
+    /**
+     * Reguards the model.
+     *
+     * Sets the model to be guarded, preventing filling of
+     * guarded attributes.
+     */
+    public function reguard() {
+        $this->is_guarded = true;
+    }
+
+    /**
+     * Retrieves all the compute methods on the model.
+     *
+     * @return array
+     */
+    protected function get_compute_methods() {
+        $methods = get_class_methods( get_called_class() );
+        $methods = array_filter( $methods, function ( $method ) {
+            return strrpos( $method, 'compute_', - strlen( $method ) ) !== false;
+        } );
+        $methods = array_map( function ( $method ) {
+            return substr( $method, strlen( 'compute_' ) );
+        }, $methods );
+
+        return $methods;
+    }
+
+    /**
+     * Sets up the memo array for the creating model.
+     */
+    private function maybe_boot() {
+        if ( ! isset( self::$memo[ get_called_class() ] ) ) {
+            self::$memo[ get_called_class() ] = array();
+        }
+    }
+
+    /**
+     * Whether this Model uses an underlying WordPress object.
+     *
+     * @return bool
+     */
+    protected function uses_wp_object() {
+        return $this instanceof UsesWordPressPost ||
+            $this instanceof UsesWordPressTerm;
+    }
 }

src/Axolotl/Collection.php

Indentation +148 added lines, -148 removed lines

@@ -14,152 +14,152 @@
  * @subpackage Axolotl
  */
 class Collection implements Countable, Iterator, Serializes {
-	/**
-	 * Collection elements.
-	 *
-	 * @var array
-	 */
-	protected $elements = array();
-
-	/**
-	 * Models registered to the collection.
-	 *
-	 * @var string
-	 */
-	protected $model;
-
-	/**
-	 * Where Collection is in loop.
-	 *
-	 * @var int
-	 */
-	protected $position = 0;
-
-	/**
-	 * Collection constructor.
-	 *
-	 * @param array $elements
-	 * @param array $config
-	 */
-	public function __construct( array $elements = array(), array $config = array() ) {
-		$this->parse_config( $config );
-
-		foreach ( $elements as $element ) {
-			$this->add( $element );
-		}
-	}
-
-	/**
-	 * Adds a new element to the Collection.
-	 *
-	 * @param mixed $element
-	 *
-	 * @throws RuntimeException
-	 */
-	public function add( $element ) {
-		if ( $this->model && is_array( $element ) ) {
-			$element = new $this->model( $element );
-		}
-
-		if ( $this->model && ! ( $element instanceof $this->model ) ) {
-			throw new RuntimeException;
-		}
-
-		$this->elements[] = $element;
-	}
-
-	/**
-	 * Fetches the element at the provided index.
-	 *
-	 * @param int $index
-	 *
-	 * @return mixed
-	 */
-	public function at( $index ) {
-		return isset( $this->elements[ $index ] ) ? $this->elements[ $index ] : null;
-	}
-
-	/**
-	 * Return the current element.
-	 *
-	 * @return mixed
-	 */
-	public function current() {
-		return $this->at( $this->position );
-	}
-
-	/**
-	 * Move forward to next element.
-	 */
-	public function next() {
-		$this->position ++;
-	}
-
-	/**
-	 * Return the key of the current element.
-	 *
-	 * @return mixed
-	 */
-	public function key() {
-		return $this->position;
-	}
-
-	/**
-	 * Checks if current position is valid.
-	 *
-	 * @return bool
-	 */
-	public function valid() {
-		return isset( $this->elements[ $this->position ] );
-	}
-
-	/**
-	 * Rewind the Iterator to the first element.
-	 */
-	public function rewind() {
-		$this->position = 0;
-	}
-
-	/**
-	 * Count elements of an object.
-	 *
-	 * @return int
-	 */
-	public function count() {
-		return count( $this->elements );
-	}
-
-	/**
-	 * Parses the Collection config to set its properties.
-	 *
-	 * @param array $config
-	 *
-	 * @throws LogicException
-	 */
-	protected function parse_config( array $config ) {
-		if ( isset( $config['model'] ) ) {
-			$model = $config['model'];
-
-			if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) {
-				throw new LogicException;
-			}
-
-			$this->model = $model;
-		}
-	}
-
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @return array
-	 */
-	public function serialize() {
-		return array_map(function( $element ) {
-			if ( $element instanceof Serializes ) {
-				return $element->serialize();
-			}
-
-			return $element;
-		}, $this->elements);
-	}
+    /**
+     * Collection elements.
+     *
+     * @var array
+     */
+    protected $elements = array();
+
+    /**
+     * Models registered to the collection.
+     *
+     * @var string
+     */
+    protected $model;
+
+    /**
+     * Where Collection is in loop.
+     *
+     * @var int
+     */
+    protected $position = 0;
+
+    /**
+     * Collection constructor.
+     *
+     * @param array $elements
+     * @param array $config
+     */
+    public function __construct( array $elements = array(), array $config = array() ) {
+        $this->parse_config( $config );
+
+        foreach ( $elements as $element ) {
+            $this->add( $element );
+        }
+    }
+
+    /**
+     * Adds a new element to the Collection.
+     *
+     * @param mixed $element
+     *
+     * @throws RuntimeException
+     */
+    public function add( $element ) {
+        if ( $this->model && is_array( $element ) ) {
+            $element = new $this->model( $element );
+        }
+
+        if ( $this->model && ! ( $element instanceof $this->model ) ) {
+            throw new RuntimeException;
+        }
+
+        $this->elements[] = $element;
+    }
+
+    /**
+     * Fetches the element at the provided index.
+     *
+     * @param int $index
+     *
+     * @return mixed
+     */
+    public function at( $index ) {
+        return isset( $this->elements[ $index ] ) ? $this->elements[ $index ] : null;
+    }
+
+    /**
+     * Return the current element.
+     *
+     * @return mixed
+     */
+    public function current() {
+        return $this->at( $this->position );
+    }
+
+    /**
+     * Move forward to next element.
+     */
+    public function next() {
+        $this->position ++;
+    }
+
+    /**
+     * Return the key of the current element.
+     *
+     * @return mixed
+     */
+    public function key() {
+        return $this->position;
+    }
+
+    /**
+     * Checks if current position is valid.
+     *
+     * @return bool
+     */
+    public function valid() {
+        return isset( $this->elements[ $this->position ] );
+    }
+
+    /**
+     * Rewind the Iterator to the first element.
+     */
+    public function rewind() {
+        $this->position = 0;
+    }
+
+    /**
+     * Count elements of an object.
+     *
+     * @return int
+     */
+    public function count() {
+        return count( $this->elements );
+    }
+
+    /**
+     * Parses the Collection config to set its properties.
+     *
+     * @param array $config
+     *
+     * @throws LogicException
+     */
+    protected function parse_config( array $config ) {
+        if ( isset( $config['model'] ) ) {
+            $model = $config['model'];
+
+            if ( ! is_subclass_of( $model, 'Intraxia\Jaxion\Axolotl\Model' ) ) {
+                throw new LogicException;
+            }
+
+            $this->model = $model;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return array
+     */
+    public function serialize() {
+        return array_map(function( $element ) {
+            if ( $element instanceof Serializes ) {
+                return $element->serialize();
+            }
+
+            return $element;
+        }, $this->elements);
+    }
 }