intraxia / jaxion

src/Axolotl/Model.php

Indentation +730 added lines, -730 removed lines

@@ -21,734 +21,734 @@
  * @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,
-	);
-
-	/**
-	 * Default attribute values.
-	 *
-	 * @var array
-	 */
-	protected $defaults = array();
-
-	/**
-	 * 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->unguard();
-		$this->refresh( $attributes );
-		$this->reguard();
-	}
-
-	/**
-	 * 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 $key => $value ) {
-			if ( $value !==
-				 $this->get_original_attribute( $key )
-			) {
-				$changed[ $key ] = $value;
-			}
-		}
-
-		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 ( self::TABLE_KEY === $name ) {
-			return $this->override_table( $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 ];
-		}
-
-		foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
-			if ( is_object( $item ) ) {
-				$this->original[ $key ] = clone $item;
-			}
-		}
-
-		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 WordPress object with a provided one.
-	 *
-	 * Resets the post's default values and stores it in the attributes.
-	 *
-	 * @param WP_Post|WP_Term|null $value
-	 *
-	 * @return $this
-	 */
-	private function override_wp_object( $value ) {
-		if ( is_object( $value ) ) {
-			$this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
-		} else {
-			$this->attributes[ self::OBJECT_KEY ] = null;
-
-			if ( $this->uses_wp_object() ) {
-				$this->create_wp_object();
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Overrides the current table attributes array with a provided one.
-	 *
-	 * @param array $value
-	 *
-	 * @return $this
-	 */
-	private function override_table( array $value ) {
-		$this->attributes[ self::TABLE_KEY ] = $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 = static::get_post_type();
-		}
-
-		if ( $this instanceof UsesWordPressTerm ) {
-			$object->taxonomy = static::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 ) ) {
-			return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
-		}
-
-		if ( $method = $this->has_compute_method( $name ) ) {
-			return $this->{$method}();
-		}
-
-		if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
-			return $this->attributes[ self::TABLE_KEY ][ $name ];
-		}
-
-		if ( isset( $this->defaults[ $name ] ) ) {
-			return $this->defaults[ $name ];
-		}
-
-		throw new PropertyDoesNotExistException( $name );
-	}
-
-	/**
-	 * 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_attributes = $this->original;
-
-		if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
-			unset( $original_attributes[ static::OBJECT_KEY ] );
-		}
-
-		$original = new static( $original_attributes );
-
-		try {
-			return $original->get_attribute( $name );
-		} catch ( Exception $exception ) {
-			return null;
-		}
-	}
-
-	/**
-	 * 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 = array_merge(
-			$this->get_table_keys(),
-			$this->get_wp_object_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,
+    );
+
+    /**
+     * Default attribute values.
+     *
+     * @var array
+     */
+    protected $defaults = array();
+
+    /**
+     * 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->unguard();
+        $this->refresh( $attributes );
+        $this->reguard();
+    }
+
+    /**
+     * 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 $key => $value ) {
+            if ( $value !==
+                    $this->get_original_attribute( $key )
+            ) {
+                $changed[ $key ] = $value;
+            }
+        }
+
+        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 ( self::TABLE_KEY === $name ) {
+            return $this->override_table( $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 ];
+        }
+
+        foreach ( $this->original[ self::TABLE_KEY ] as $key => $item ) {
+            if ( is_object( $item ) ) {
+                $this->original[ $key ] = clone $item;
+            }
+        }
+
+        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 WordPress object with a provided one.
+     *
+     * Resets the post's default values and stores it in the attributes.
+     *
+     * @param WP_Post|WP_Term|null $value
+     *
+     * @return $this
+     */
+    private function override_wp_object( $value ) {
+        if ( is_object( $value ) ) {
+            $this->attributes[ self::OBJECT_KEY ] = $this->set_wp_object_constants( $value );
+        } else {
+            $this->attributes[ self::OBJECT_KEY ] = null;
+
+            if ( $this->uses_wp_object() ) {
+                $this->create_wp_object();
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Overrides the current table attributes array with a provided one.
+     *
+     * @param array $value
+     *
+     * @return $this
+     */
+    private function override_table( array $value ) {
+        $this->attributes[ self::TABLE_KEY ] = $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 = static::get_post_type();
+        }
+
+        if ( $this instanceof UsesWordPressTerm ) {
+            $object->taxonomy = static::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 ) ) {
+            return $this->attributes[ self::OBJECT_KEY ]->{$this->{$method}()};
+        }
+
+        if ( $method = $this->has_compute_method( $name ) ) {
+            return $this->{$method}();
+        }
+
+        if ( isset( $this->attributes[ self::TABLE_KEY ][ $name ] ) ) {
+            return $this->attributes[ self::TABLE_KEY ][ $name ];
+        }
+
+        if ( isset( $this->defaults[ $name ] ) ) {
+            return $this->defaults[ $name ];
+        }
+
+        throw new PropertyDoesNotExistException( $name );
+    }
+
+    /**
+     * 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_attributes = $this->original;
+
+        if ( ! is_object( $original_attributes[ static::OBJECT_KEY ] ) ) {
+            unset( $original_attributes[ static::OBJECT_KEY ] );
+        }
+
+        $original = new static( $original_attributes );
+
+        try {
+            return $original->get_attribute( $name );
+        } catch ( Exception $exception ) {
+            return null;
+        }
+    }
+
+    /**
+     * 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 = array_merge(
+            $this->get_table_keys(),
+            $this->get_wp_object_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/Type.php

Indentation +153 added lines, -153 removed lines

@@ -15,157 +15,157 @@
  */
 class Type {
 
-	/**
-	 * Type to validate against.
-	 *
-	 * @var string
-	 */
-	private $type;
-
-	/**
-	 * Type constructor.
-	 *
-	 * @param string $type
-	 */
-	public function __construct( $type ) {
-		$this->type = $this->determine( $type );
-	}
-
-	/**
-	 * Get validation type.
-	 *
-	 * @return string
-	 */
-	public function get_type() {
-		return $this->type;
-	}
-
-	/**
-	 * Returns whether the type is an Axolotl model.
-	 *
-	 * @return bool
-	 */
-	public function is_model() {
-		if ( ! class_exists( $this->type ) ) {
-			return false;
-		}
-
-		$reflection = new ReflectionClass( $this->type );
-		return $reflection->isSubclassOf( 'Intraxia\Jaxion\Axolotl\Model' );
-	}
-
-	/**
-	 * Create a new model from the given data.
-	 *
-	 * @param array $data Data for the model.
-	 *
-	 * @return Model
-	 */
-	public function create_model( array $data ) {
-		return new $this->type( $data );
-	}
-
-	/**
-	 * Validates an array of element.
-	 *
-	 * @param array $elements Elements to be validated.
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function validate_elements( array $elements ) {
-		foreach ( $elements as $element ) {
-			$this->validate_element( $element );
-		}
-	}
-
-	/**
-	 * Validate whether the
-	 *
-	 * @param mixed $element Element to validate.
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function validate_element( $element ) {
-		$type = gettype( $element );
-		$callable = $this->type === 'callable';
-		$is_object = 'object' === $type;
-		$loose_check = $this->type === 'object';
-
-		// callable must be callable
-		if ( $callable && ! is_callable( $element ) ) {
-			throw new InvalidArgumentException( 'Item must be callable' );
-		}
-
-		// target isn't callable, object must be an instance of target
-		if ( ! $loose_check && ! $callable && $is_object && ! is_a( $element, $this->type ) ) {
-			throw new InvalidArgumentException( "Item is not type or subtype of $this->type" );
-		}
-
-		// a non callable, non object type should match the target string
-		if ( ! $callable && ! $is_object && $type !== $this->type ) {
-			throw new InvalidArgumentException( "Item is not of type: $this->type" );
-		}
-	}
-
-	/**
-	 * Determine the type to validate against.
-	 *
-	 * @param string $type     Type to determine.
-	 * @param bool   $key_type Whether the type is for keys.
-	 *
-	 * @return string
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	private function determine( $type, $key_type = false ) {
-		if ( ! $key_type && $this->non_scalar_type_exists( $type ) ) {
-			return $type;
-		}
-
-		if ( $scalar_type = $this->determine_scalar( $type ) ) {
-			if ( $key_type && (in_array( $scalar_type, [ 'double', 'boolean' ] )) ) {
-				throw new InvalidArgumentException( 'This type is not supported as a key.' );
-			}
-
-			return $scalar_type;
-		}
-
-		throw new InvalidArgumentException( 'This type does not exist.' );
-	}
-
-	/**
-	 * Determines whether the given type exists.
-	 *
-	 * @param string $type Type to check.
-	 *
-	 * @return bool
-	 */
-	private function non_scalar_type_exists( $type ) {
-		return class_exists( $type )
-				|| interface_exists( $type )
-				|| in_array( $type, [ 'array', 'object', 'callable' ] );
-	}
-
-	/**
-	 * Returns the type if it's scalar, otherwise, returns null.
-	 *
-	 * @param string $type Type to check.
-	 *
-	 * @return string|null
-	 */
-	private function determine_scalar( $type ) {
-		$synonyms = array(
-			'int' => 'integer',
-			'float' => 'double',
-			'bool' => 'boolean',
-		);
-
-		if ( array_key_exists( $type, $synonyms ) ) {
-			$type = $synonyms[ $type ];
-		}
-
-		return in_array( $type, array( 'string', 'integer', 'double', 'boolean' ) ) ?
-			$type :
-			null;
-	}
+    /**
+     * Type to validate against.
+     *
+     * @var string
+     */
+    private $type;
+
+    /**
+     * Type constructor.
+     *
+     * @param string $type
+     */
+    public function __construct( $type ) {
+        $this->type = $this->determine( $type );
+    }
+
+    /**
+     * Get validation type.
+     *
+     * @return string
+     */
+    public function get_type() {
+        return $this->type;
+    }
+
+    /**
+     * Returns whether the type is an Axolotl model.
+     *
+     * @return bool
+     */
+    public function is_model() {
+        if ( ! class_exists( $this->type ) ) {
+            return false;
+        }
+
+        $reflection = new ReflectionClass( $this->type );
+        return $reflection->isSubclassOf( 'Intraxia\Jaxion\Axolotl\Model' );
+    }
+
+    /**
+     * Create a new model from the given data.
+     *
+     * @param array $data Data for the model.
+     *
+     * @return Model
+     */
+    public function create_model( array $data ) {
+        return new $this->type( $data );
+    }
+
+    /**
+     * Validates an array of element.
+     *
+     * @param array $elements Elements to be validated.
+     *
+     * @throws InvalidArgumentException
+     */
+    public function validate_elements( array $elements ) {
+        foreach ( $elements as $element ) {
+            $this->validate_element( $element );
+        }
+    }
+
+    /**
+     * Validate whether the
+     *
+     * @param mixed $element Element to validate.
+     *
+     * @throws InvalidArgumentException
+     */
+    public function validate_element( $element ) {
+        $type = gettype( $element );
+        $callable = $this->type === 'callable';
+        $is_object = 'object' === $type;
+        $loose_check = $this->type === 'object';
+
+        // callable must be callable
+        if ( $callable && ! is_callable( $element ) ) {
+            throw new InvalidArgumentException( 'Item must be callable' );
+        }
+
+        // target isn't callable, object must be an instance of target
+        if ( ! $loose_check && ! $callable && $is_object && ! is_a( $element, $this->type ) ) {
+            throw new InvalidArgumentException( "Item is not type or subtype of $this->type" );
+        }
+
+        // a non callable, non object type should match the target string
+        if ( ! $callable && ! $is_object && $type !== $this->type ) {
+            throw new InvalidArgumentException( "Item is not of type: $this->type" );
+        }
+    }
+
+    /**
+     * Determine the type to validate against.
+     *
+     * @param string $type     Type to determine.
+     * @param bool   $key_type Whether the type is for keys.
+     *
+     * @return string
+     *
+     * @throws InvalidArgumentException
+     */
+    private function determine( $type, $key_type = false ) {
+        if ( ! $key_type && $this->non_scalar_type_exists( $type ) ) {
+            return $type;
+        }
+
+        if ( $scalar_type = $this->determine_scalar( $type ) ) {
+            if ( $key_type && (in_array( $scalar_type, [ 'double', 'boolean' ] )) ) {
+                throw new InvalidArgumentException( 'This type is not supported as a key.' );
+            }
+
+            return $scalar_type;
+        }
+
+        throw new InvalidArgumentException( 'This type does not exist.' );
+    }
+
+    /**
+     * Determines whether the given type exists.
+     *
+     * @param string $type Type to check.
+     *
+     * @return bool
+     */
+    private function non_scalar_type_exists( $type ) {
+        return class_exists( $type )
+                || interface_exists( $type )
+                || in_array( $type, [ 'array', 'object', 'callable' ] );
+    }
+
+    /**
+     * Returns the type if it's scalar, otherwise, returns null.
+     *
+     * @param string $type Type to check.
+     *
+     * @return string|null
+     */
+    private function determine_scalar( $type ) {
+        $synonyms = array(
+            'int' => 'integer',
+            'float' => 'double',
+            'bool' => 'boolean',
+        );
+
+        if ( array_key_exists( $type, $synonyms ) ) {
+            $type = $synonyms[ $type ];
+        }
+
+        return in_array( $type, array( 'string', 'integer', 'double', 'boolean' ) ) ?
+            $type :
+            null;
+    }
 }

src/Contract/Axolotl/Collection.php

Indentation +314 added lines, -314 removed lines

@@ -9,318 +9,318 @@
 
 interface Collection extends Iterator, Countable, Serializes {
 
-	/**
-	 * Returns the type of the collection.
-	 *
-	 * @return string
-	 */
-	public function get_type();
-
-	/**
-	 * Returns a collection with $element added.
-	 *
-	 * @param  mixed $element
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function add( $element );
-
-	/**
-	 * Removes every element from the collection.
-	 *
-	 * @return Collection
-	 */
-	public function clear();
-
-	/**
-	 * Returns true if the collection contains any elements that satisfy
-	 * $condition, returns false if it contains none.
-	 *
-	 * @param callable $condition
-	 * @return bool
-	 */
-	public function contains( callable $condition );
-
-	/**
-	 * Returns the first element in the collection that satisfies
-	 * $condition, returns false if no such element exists.
-	 *
-	 * @param callable $condition
-	 * @return mixed
-	 */
-	public function find( callable $condition );
-
-	/**
-	 * Returns the index of the first element in the collection that satisfies
-	 * $condition, returns -1 if no such element exists.
-	 *
-	 * @param callable $condition
-	 * @return int
-	 */
-	public function find_index( callable $condition );
-
-	/**
-	 * Returns the element in the collection at $index.
-	 *
-	 * @param  int $index Index to get element from.
-	 * @return mixed
-	 * @throws OutOfRangeException
-	 */
-	public function at( $index );
-
-	/**
-	 * Returns true if $index is within the collection's range and returns false
-	 * if it is not.
-	 *
-	 * @param  int $index Index to check for existence.
-	 * @return bool
-	 * @throws InvalidArgumentException
-	 */
-	public function index_exists( $index );
-
-	/**
-	 * Returns the number of elements in the collection.
-	 *
-	 * @return int
-	 */
-	public function count();
-
-	/**
-	 * Returns a collection that only contains the elements which satisfy
-	 * $condition.
-	 *
-	 * @param callable $condition
-	 * @return Collection
-	 */
-	public function filter( callable $condition );
-
-	/**
-	 * Returns the last element in the collection that satisfies $condition,
-	 * returns false if no such element exists.
-	 *
-	 * @param callable $condition
-	 * @return mixed
-	 */
-	public function find_last( callable $condition );
-
-	/**
-	 * Returns the index of the last element in the collection that satisfies
-	 * $condition, returns -1 if no such element exists.
-	 *
-	 * @param callable $condition
-	 * @return int
-	 */
-	public function find_last_index( callable $condition );
-
-	/**
-	 * Returns a collection that contains the subset of elements ranging from the
-	 * index $start to $end.
-	 *
-	 * @param  int $start Begining index to slice from.
-	 * @param  int $end   End index to slice to.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function slice( $start, $end );
-
-	/**
-	 * Inserts $element at $index.
-	 *
-	 * @param int   $index     Index to start at.
-	 * @param mixed $element Element to insert.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 * @throws OutOfRangeException
-	 */
-	public function insert( $index, $element );
-
-	/**
-	 * Inserts the range $elements at $index.
-	 *
-	 * @param int   $index
-	 * @param array $elements
-	 * @return Collection
-	 * @throws OutOfRangeException
-	 */
-	public function insert_range( $index, array $elements );
-
-	/**
-	 * Removes all of the elements that satisfy $condition.
-	 *
-	 * @param  callable $condition
-	 * @return Collection
-	 */
-	public function without( callable $condition );
-
-	/**
-	 * Removes the element at $index.
-	 *
-	 * @param  int $index Index to remove.
-	 * @return Collection
-	 * @throws OutOfRangeException
-	 */
-	public function remove_at( $index );
-
-	/**
-	 * Reverses the order of the elements in the collection.
-	 *
-	 * @return Collection
-	 */
-	public function reverse();
-
-	/**
-	 * Sorts the elements in the collection using the user supplied comparison
-	 * function $callback.
-	 *
-	 * @param callable $callback
-	 * @return Collection
-	 */
-	public function sort( callable $callback );
-
-	/**
-	 * Returns an array containing the elements in the collection.
-	 *
-	 * @return array
-	 */
-	public function to_array();
-
-	/**
-	 * Iteratively reduces the collection to a single value using the callback
-	 * function $callable.
-	 *
-	 * @param callable $callable
-	 * @param null     $initial
-	 * @return mixed
-	 */
-	public function reduce( callable $callable, $initial = null );
-
-	/**
-	 * Returns true if every element in the collection satisfies $condition,
-	 * returns false if not.
-	 *
-	 * @param callable $condition
-	 * @return bool
-	 */
-	public function every( callable $condition );
-
-	/**
-	 * Removes all of the elements in the collection starting at index $num.
-	 *
-	 * @param  int $num Number of elements to drop.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function drop( $num );
-
-	/**
-	 * Removes all of the elements in the collectioin between index 0 and $num.
-	 *
-	 * @param int $num Number of elements to drop.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function drop_right( $num );
-
-	/**
-	 * Iteratively drops elements in the collection that satisfy $condition until
-	 * an element is encountered that does not satisfy $condition.
-	 *
-	 * @param callable $condition
-	 * @return Collection
-	 */
-	public function drop_while( callable $condition );
-
-	/**
-	 * Removes the first element in the collection.
-	 *
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function tail();
-
-	/**
-	 * Removes all of the elements in the collection starting at index $num.
-	 *
-	 * @param  int $num Number of elements to take.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function take( $num );
-
-	/**
-	 * Removes all of the elements in the collection before index $num.
-	 *
-	 * @param int $num Number of elements to take.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function take_right( $num );
-
-	/**
-	 * Iterates through the collection until an element is encountered that does
-	 * not satisfy $condition, then drops all of the elements starting at that
-	 * index.
-	 *
-	 * @param callable $condition
-	 * @return Collection
-	 */
-	public function take_while( callable $condition );
-
-	/**
-	 * Applies the callback function $callable to each element in the collection.
-	 *
-	 * @param callable $callable
-	 */
-	public function each( callable $callable );
-
-	/**
-	 * Returns a new instance of the collection with the callback function
-	 * $callable applied to each element.
-	 *
-	 * @param callable $callable
-	 * @return Collection
-	 */
-	public function map( callable $callable );
-
-	/**
-	 * Iteratively reduces the collection to a single value using the callback
-	 * function $callable starting at the rightmost index.
-	 *
-	 * @param callable $callable
-	 * @param null     $initial
-	 * @return mixed
-	 */
-	public function reduce_right( callable $callable, $initial = null );
-
-	/**
-	 * Randomly reorders the elements in the collection.
-	 *
-	 * @return Collection
-	 */
-	public function shuffle();
-
-	/**
-	 * Adds every member of $elements to the collection.
-	 *
-	 * @param array|Collection $elements Array of elements to merge.
-	 * @return Collection
-	 * @throws InvalidArgumentException
-	 */
-	public function merge( $elements );
-
-	/**
-	 * Get first element of the collection
-	 *
-	 * @return mixed
-	 * @throws OutOfBoundsException
-	 */
-	public function first();
-
-	/**
-	 * Get last element of the collection
-	 *
-	 * @return mixed
-	 * @throws OutOfBoundsException
-	 */
-	public function last();
+    /**
+     * Returns the type of the collection.
+     *
+     * @return string
+     */
+    public function get_type();
+
+    /**
+     * Returns a collection with $element added.
+     *
+     * @param  mixed $element
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function add( $element );
+
+    /**
+     * Removes every element from the collection.
+     *
+     * @return Collection
+     */
+    public function clear();
+
+    /**
+     * Returns true if the collection contains any elements that satisfy
+     * $condition, returns false if it contains none.
+     *
+     * @param callable $condition
+     * @return bool
+     */
+    public function contains( callable $condition );
+
+    /**
+     * Returns the first element in the collection that satisfies
+     * $condition, returns false if no such element exists.
+     *
+     * @param callable $condition
+     * @return mixed
+     */
+    public function find( callable $condition );
+
+    /**
+     * Returns the index of the first element in the collection that satisfies
+     * $condition, returns -1 if no such element exists.
+     *
+     * @param callable $condition
+     * @return int
+     */
+    public function find_index( callable $condition );
+
+    /**
+     * Returns the element in the collection at $index.
+     *
+     * @param  int $index Index to get element from.
+     * @return mixed
+     * @throws OutOfRangeException
+     */
+    public function at( $index );
+
+    /**
+     * Returns true if $index is within the collection's range and returns false
+     * if it is not.
+     *
+     * @param  int $index Index to check for existence.
+     * @return bool
+     * @throws InvalidArgumentException
+     */
+    public function index_exists( $index );
+
+    /**
+     * Returns the number of elements in the collection.
+     *
+     * @return int
+     */
+    public function count();
+
+    /**
+     * Returns a collection that only contains the elements which satisfy
+     * $condition.
+     *
+     * @param callable $condition
+     * @return Collection
+     */
+    public function filter( callable $condition );
+
+    /**
+     * Returns the last element in the collection that satisfies $condition,
+     * returns false if no such element exists.
+     *
+     * @param callable $condition
+     * @return mixed
+     */
+    public function find_last( callable $condition );
+
+    /**
+     * Returns the index of the last element in the collection that satisfies
+     * $condition, returns -1 if no such element exists.
+     *
+     * @param callable $condition
+     * @return int
+     */
+    public function find_last_index( callable $condition );
+
+    /**
+     * Returns a collection that contains the subset of elements ranging from the
+     * index $start to $end.
+     *
+     * @param  int $start Begining index to slice from.
+     * @param  int $end   End index to slice to.
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function slice( $start, $end );
+
+    /**
+     * Inserts $element at $index.
+     *
+     * @param int   $index     Index to start at.
+     * @param mixed $element Element to insert.
+     * @return Collection
+     * @throws InvalidArgumentException
+     * @throws OutOfRangeException
+     */
+    public function insert( $index, $element );
+
+    /**
+     * Inserts the range $elements at $index.
+     *
+     * @param int   $index
+     * @param array $elements
+     * @return Collection
+     * @throws OutOfRangeException
+     */
+    public function insert_range( $index, array $elements );
+
+    /**
+     * Removes all of the elements that satisfy $condition.
+     *
+     * @param  callable $condition
+     * @return Collection
+     */
+    public function without( callable $condition );
+
+    /**
+     * Removes the element at $index.
+     *
+     * @param  int $index Index to remove.
+     * @return Collection
+     * @throws OutOfRangeException
+     */
+    public function remove_at( $index );
+
+    /**
+     * Reverses the order of the elements in the collection.
+     *
+     * @return Collection
+     */
+    public function reverse();
+
+    /**
+     * Sorts the elements in the collection using the user supplied comparison
+     * function $callback.
+     *
+     * @param callable $callback
+     * @return Collection
+     */
+    public function sort( callable $callback );
+
+    /**
+     * Returns an array containing the elements in the collection.
+     *
+     * @return array
+     */
+    public function to_array();
+
+    /**
+     * Iteratively reduces the collection to a single value using the callback
+     * function $callable.
+     *
+     * @param callable $callable
+     * @param null     $initial
+     * @return mixed
+     */
+    public function reduce( callable $callable, $initial = null );
+
+    /**
+     * Returns true if every element in the collection satisfies $condition,
+     * returns false if not.
+     *
+     * @param callable $condition
+     * @return bool
+     */
+    public function every( callable $condition );
+
+    /**
+     * Removes all of the elements in the collection starting at index $num.
+     *
+     * @param  int $num Number of elements to drop.
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function drop( $num );
+
+    /**
+     * Removes all of the elements in the collectioin between index 0 and $num.
+     *
+     * @param int $num Number of elements to drop.
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function drop_right( $num );
+
+    /**
+     * Iteratively drops elements in the collection that satisfy $condition until
+     * an element is encountered that does not satisfy $condition.
+     *
+     * @param callable $condition
+     * @return Collection
+     */
+    public function drop_while( callable $condition );
+
+    /**
+     * Removes the first element in the collection.
+     *
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function tail();
+
+    /**
+     * Removes all of the elements in the collection starting at index $num.
+     *
+     * @param  int $num Number of elements to take.
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function take( $num );
+
+    /**
+     * Removes all of the elements in the collection before index $num.
+     *
+     * @param int $num Number of elements to take.
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function take_right( $num );
+
+    /**
+     * Iterates through the collection until an element is encountered that does
+     * not satisfy $condition, then drops all of the elements starting at that
+     * index.
+     *
+     * @param callable $condition
+     * @return Collection
+     */
+    public function take_while( callable $condition );
+
+    /**
+     * Applies the callback function $callable to each element in the collection.
+     *
+     * @param callable $callable
+     */
+    public function each( callable $callable );
+
+    /**
+     * Returns a new instance of the collection with the callback function
+     * $callable applied to each element.
+     *
+     * @param callable $callable
+     * @return Collection
+     */
+    public function map( callable $callable );
+
+    /**
+     * Iteratively reduces the collection to a single value using the callback
+     * function $callable starting at the rightmost index.
+     *
+     * @param callable $callable
+     * @param null     $initial
+     * @return mixed
+     */
+    public function reduce_right( callable $callable, $initial = null );
+
+    /**
+     * Randomly reorders the elements in the collection.
+     *
+     * @return Collection
+     */
+    public function shuffle();
+
+    /**
+     * Adds every member of $elements to the collection.
+     *
+     * @param array|Collection $elements Array of elements to merge.
+     * @return Collection
+     * @throws InvalidArgumentException
+     */
+    public function merge( $elements );
+
+    /**
+     * Get first element of the collection
+     *
+     * @return mixed
+     * @throws OutOfBoundsException
+     */
+    public function first();
+
+    /**
+     * Get last element of the collection
+     *
+     * @return mixed
+     * @throws OutOfBoundsException
+     */
+    public function last();
 }

src/Axolotl/Collection.php

Indentation +735 added lines, -735 removed lines

@@ -15,739 +15,739 @@
  */
 class Collection implements CollectionContract {
 
-	/**
-	 * Collection elements.
-	 *
-	 * @var array
-	 */
-	protected $elements = array();
-
-	/**
-	 * Collection type to enforce.
-	 *
-	 * @var Type
-	 */
-	private $type;
-
-	/**
-	 * Where Collection is in loop.
-	 *
-	 * @var int
-	 */
-	protected $position = 0;
-
-	/**
-	 * Collection constructor.
-	 *
-	 * @param string $type
-	 * @param array  $elements
-	 */
-	public function __construct( $type, array $elements = array() ) {
-		$this->type = new Type( $type );
-
-		if ( $elements ) {
-			$this->type->validate_elements( $elements );
-		}
-
-		$this->elements = $elements;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return string
-	 */
-	public function get_type() {
-		return $this->type->get_type();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param mixed $element
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function add( $element ) {
-		if ( $this->type->is_model() && is_array( $element ) ) {
-			$element = $this->type->create_model( $element );
-		}
-
-		$this->type->validate_element( $element );
-
-		$elements   = $this->elements;
-		$elements[] = $element;
-
-		$collection = new static( $this->get_type() );
-		$collection->set_from_trusted( $elements );
-
-		return $collection;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return Collection
-	 */
-	public function clear() {
-		return new static( $this->get_type() );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return bool
-	 */
-	public function contains( callable $condition ) {
-		return (bool) $this->find( $condition );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return mixed
-	 */
-	public function find( callable $condition ) {
-		$index = $this->find_index( $condition );
-
-		return -1 === $index ? false : $this->elements[ $index ];
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return int
-	 */
-	public function find_index( callable $condition ) {
-		$index = -1;
-
-		for ( $i = 0, $count = count( $this->elements ); $i < $count; $i++ ) {
-			if ( call_user_func( $condition, ($this->at( $i ) ) ) ) {
-				$index = $i;
-				break;
-			}
-		}
-
-		return $index;
-	}
-
-	/**
-	 * Fetches the element at the provided index.
-	 *
-	 * @param int $index Index to get element from.
-	 *
-	 * @return mixed
-	 *
-	 * @throws OutOfRangeException
-	 */
-	public function at( $index ) {
-		$this->validate_index( $index );
-
-		return $this->elements[ $index ];
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  int $index Index to check for existence.
-	 *
-	 * @return bool
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function index_exists( $index ) {
-		if ( ! is_int( $index ) ) {
-			throw new InvalidArgumentException( 'Index must be an integer' );
-		}
-
-		if ( $index < 0 ) {
-			throw new InvalidArgumentException( 'Index must be a non-negative integer' );
-		}
-
-		return $index < $this->count();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return mixed
-	 */
-	public function filter( callable $condition ) {
-		$elements = array();
-
-		foreach ( $this->elements as $element ) {
-			if ( call_user_func( $condition, $element ) ) {
-				$elements[] = $element;
-			}
-		}
-
-		return $this->new_from_trusted( $elements );
-	}
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return mixed
-	 */
-	public function find_last( callable $condition ) {
-		$index = $this->find_last_index( $condition );
-
-		return -1 === $index ? null : $this->elements[ $index ];
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition
-	 * @return int
-	 */
-	public function find_last_index( callable $condition ) {
-		$index = -1;
-
-		for ( $i = count( $this->elements ) - 1; $i >= 0; $i-- ) {
-			if ( call_user_func( $condition, $this->elements[ $i ] ) ) {
-				$index = $i;
-				break;
-			}
-		}
-
-		return $index;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  int $start Begining index to slice from.
-	 * @param  int $end   End index to slice to.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function slice( $start, $end ) {
-		if ( $start < 0 || ! is_int( $start ) ) {
-			throw new InvalidArgumentException( 'Start must be a non-negative integer' );
-		}
-
-		if ( $end < 0 || ! is_int( $end ) ) {
-			throw new InvalidArgumentException( 'End must be a positive integer' );
-		}
-
-		if ( $start > $end ) {
-			throw new InvalidArgumentException( 'End must be greater than start' );
-		}
-
-		if ( $end > $this->count() + 1 ) {
-			throw new InvalidArgumentException( 'End must be less than the count of the items in the Collection' );
-		}
-
-		$length = $end - $start + 1;
-		$subset = array_slice( $this->elements, $start, $length );
-
-		$collection = new static($this->type);
-		$collection->set_from_trusted( $subset );
-
-		return $collection;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param int   $index     Index to start at.
-	 * @param mixed $element Element to insert.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 * @throws OutOfRangeException
-	 */
-	public function insert( $index, $element ) {
-		$this->validate_index( $index );
-		$this->type->validate_element( $element );
-
-		$a = array_slice( $this->elements, 0, $index );
-		$b = array_slice( $this->elements, $index, count( $this->elements ) );
-
-		$a[] = $element;
-
-		return $this->new_from_trusted( array_merge( $a, $b ) );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param int   $index    Index to start insertion at.
-	 * @param array $elements Elements in insert.
-	 *
-	 * @return Collection
-	 *
-	 * @throws OutOfRangeException
-	 */
-	public function insert_range( $index, array $elements ) {
-		$this->validate_index( $index );
-		$this->type->validate_elements( $elements );
-
-		// To work with negative index, get the positive relation to 0 index
-		$index < 0 && $index = $this->count() + $index + 1;
-
-		$partA = array_slice( $this->elements, 0, $index );
-		$partB = array_slice( $this->elements, $index, count( $this->elements ) );
-
-		$elements1 = array_merge( $partA, $elements );
-		$elements1 = array_merge( $elements1, $partB );
-
-		$col = new static( $this->type );
-		$col->set_from_trusted( $elements1 );
-
-		return $col;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return Collection
-	 */
-	public function without( callable $condition ) {
-		$inverse = function ( $element ) use ( $condition ) {
-			return ! call_user_func( $condition, $element );
-		};
-
-		return $this->filter( $inverse );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  int $index Index to remove.
-	 *
-	 * @return Collection
-	 *
-	 * @throws OutOfRangeException
-	 */
-	public function remove_at( $index ) {
-		$this->validate_index( $index );
-
-		$elements = $this->elements;
-
-		return $this->new_from_trusted(
-			array_merge(
-				array_slice( $elements, 0, $index ),
-				array_slice( $elements, $index + 1, count( $elements ) )
-			)
-		);
-	}
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return Collection
-	 */
-	public function reverse() {
-		return $this->new_from_trusted(
-			array_reverse( $this->elements )
-		);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callback Sort callback.
-	 *
-	 * @return Collection
-	 */
-	public function sort( callable $callback ) {
-		$elements = $this->elements;
-		usort( $elements, $callback );
-		return $this->new_from_trusted( $elements );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return array
-	 */
-	public function to_array() {
-		return $this->elements;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callable Reducer function.
-	 *
-	 * @param null     $initial  Initial reducer value.
-	 *
-	 * @return mixed
-	 */
-	public function reduce( callable $callable, $initial = null ) {
-		return array_reduce( $this->elements, $callable, $initial );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $condition Condition callback.
-	 *
-	 * @return bool
-	 */
-	public function every( callable $condition ) {
-		$response = true;
-
-		foreach ( $this->elements as $element ) {
-			$result = call_user_func( $condition, $element );
-
-			if ( false === $result ) {
-				$response = false;
-				break;
-			}
-		}
-
-		return $response;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  int $num Number of elements to drop.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function drop( $num ) {
-		return $this->slice( $num, $this->count() );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param int $num Number of elements to drop.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function drop_right( $num ) {
-		return $num !== $this->count()
-			? $this->slice( 0, $this->count() - $num - 1 )
-			: $this->clear();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $condition Condition callback.
-	 *
-	 * @return Collection
-	 */
-	public function drop_while( callable $condition ) {
-		$count = $this->count_while_true( $condition );
-		return $count ? $this->drop( $count ) : $this;
-	}
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function tail() {
-		return $this->slice( 1, $this->count() );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  int $num Number of elements to take.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function take( $num ) {
-		return $this->slice( 0, $num - 1 );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param int $num Number of elements to take.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function take_right( $num ) {
-		return $this->slice( $this->count() - $num, $this->count() );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $condition Callback function.
-	 *
-	 * @return Collection
-	 */
-	public function take_while( callable $condition ) {
-		$count = $this->count_while_true( $condition );
-
-		return $count ? $this->take( $count ) : $this->clear();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callable Callback function.
-	 */
-	public function each( callable $callable ) {
-		foreach ( $this->elements as $element ) {
-			call_user_func( $callable, $element );
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callable Callback function.
-	 *
-	 * @return Collection
-	 */
-	public function map( callable $callable ) {
-		$elements = array();
-		$type = null;
-		foreach ( $this->elements as $element ) {
-			$result = call_user_func( $callable, $element );
-
-			if ( null === $type ) {
-				$type = gettype( $result );
-
-				if ( 'object' === $type ) {
-					$type = get_class( $result );
-				}
-			}
-
-			$elements[] = $result;
-		}
-
-		return $this->new_from_trusted( $elements, $type ? : $this->get_type() );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callable Reducer function.
-	 * @param null     $initial  Initial value.
-	 *
-	 * @return mixed
-	 */
-	public function reduce_right( callable $callable, $initial = null ) {
-		return array_reduce(
-			array_reverse( $this->elements ),
-			$callable,
-			$initial
-		);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return Collection
-	 */
-	public function shuffle() {
-		$elements = $this->elements;
-		shuffle( $elements );
-
-		return $this->new_from_trusted( $elements );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param array|Collection $elements Array of elements to merge.
-	 *
-	 * @return Collection
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function merge( $elements ) {
-		if ( $elements instanceof static ) {
-			$elements = $elements->to_array();
-		}
-
-		if ( ! is_array( $elements ) ) {
-			throw new InvalidArgumentException( 'Merge must be given array or Collection' );
-		}
-
-		$this->type->validate_elements( $elements );
-
-		return $this->new_from_trusted(
-			array_merge( $this->elements, $elements )
-		);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return mixed
-	 *
-	 * @throws OutOfBoundsException
-	 */
-	public function first() {
-		if ( empty( $this->elements ) ) {
-			throw new OutOfBoundsException( 'Cannot get first element of empty Collection' );
-		}
-
-		return reset( $this->elements );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return mixed
-	 *
-	 * @throws OutOfBoundsException
-	 */
-	public function last() {
-		if ( empty( $this->elements ) ) {
-			throw new OutOfBoundsException( 'Cannot get last element of empty Collection' );
-		}
-
-		return end( $this->elements );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @return int
-	 */
-	public function count() {
-		return count( $this->elements );
-	}
-
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @return array
-	 */
-	public function serialize() {
-		return $this->map(function( $element ) {
-			if ( $element instanceof Serializes ) {
-				return $element->serialize();
-			}
-
-			return $element;
-		} )->to_array();
-	}
-
-	/**
-	 * 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;
-	}
-
-	/**
-	 * Creates a new instance of the Collection
-	 * from a trusted set of elements.
-	 *
-	 * @param array      $elements Array of elements to pass into new collection.
-	 * @param null|mixed $type
-	 *
-	 * @return static
-	 */
-	protected function new_from_trusted( array $elements, $type = null ) {
-		$collection = new static( null !== $type ? $type : $this->get_type() );
-		$collection->set_from_trusted( $elements );
-
-		return $collection;
-	}
-
-	/**
-	 * Sets the elements without validating them.
-	 *
-	 * @param array $elements Pre-validated elements to set.
-	 */
-	protected function set_from_trusted( array $elements ) {
-		$this->elements = $elements;
-	}
-
-	/**
-	 * Number of elements true for the condition.
-	 *
-	 * @param callable $condition Condition to check.
-	 * @return int
-	 */
-	protected function count_while_true( callable $condition ) {
-		$count = 0;
-
-		foreach ( $this->elements as $element ) {
-			if ( ! $condition($element) ) {
-				break;
-			}
-			$count++;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * Validates a number to be used as an index.
-	 *
-	 * @param  integer $index The number to be validated as an index.
-	 *
-	 * @throws OutOfRangeException
-	 */
-	protected function validate_index( $index ) {
-		$exists = $this->index_exists( $index );
-
-		if ( ! $exists ) {
-			throw new OutOfRangeException( 'Index out of bounds of collection' );
-		}
-	}
+    /**
+     * Collection elements.
+     *
+     * @var array
+     */
+    protected $elements = array();
+
+    /**
+     * Collection type to enforce.
+     *
+     * @var Type
+     */
+    private $type;
+
+    /**
+     * Where Collection is in loop.
+     *
+     * @var int
+     */
+    protected $position = 0;
+
+    /**
+     * Collection constructor.
+     *
+     * @param string $type
+     * @param array  $elements
+     */
+    public function __construct( $type, array $elements = array() ) {
+        $this->type = new Type( $type );
+
+        if ( $elements ) {
+            $this->type->validate_elements( $elements );
+        }
+
+        $this->elements = $elements;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return string
+     */
+    public function get_type() {
+        return $this->type->get_type();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param mixed $element
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function add( $element ) {
+        if ( $this->type->is_model() && is_array( $element ) ) {
+            $element = $this->type->create_model( $element );
+        }
+
+        $this->type->validate_element( $element );
+
+        $elements   = $this->elements;
+        $elements[] = $element;
+
+        $collection = new static( $this->get_type() );
+        $collection->set_from_trusted( $elements );
+
+        return $collection;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return Collection
+     */
+    public function clear() {
+        return new static( $this->get_type() );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return bool
+     */
+    public function contains( callable $condition ) {
+        return (bool) $this->find( $condition );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return mixed
+     */
+    public function find( callable $condition ) {
+        $index = $this->find_index( $condition );
+
+        return -1 === $index ? false : $this->elements[ $index ];
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return int
+     */
+    public function find_index( callable $condition ) {
+        $index = -1;
+
+        for ( $i = 0, $count = count( $this->elements ); $i < $count; $i++ ) {
+            if ( call_user_func( $condition, ($this->at( $i ) ) ) ) {
+                $index = $i;
+                break;
+            }
+        }
+
+        return $index;
+    }
+
+    /**
+     * Fetches the element at the provided index.
+     *
+     * @param int $index Index to get element from.
+     *
+     * @return mixed
+     *
+     * @throws OutOfRangeException
+     */
+    public function at( $index ) {
+        $this->validate_index( $index );
+
+        return $this->elements[ $index ];
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  int $index Index to check for existence.
+     *
+     * @return bool
+     *
+     * @throws InvalidArgumentException
+     */
+    public function index_exists( $index ) {
+        if ( ! is_int( $index ) ) {
+            throw new InvalidArgumentException( 'Index must be an integer' );
+        }
+
+        if ( $index < 0 ) {
+            throw new InvalidArgumentException( 'Index must be a non-negative integer' );
+        }
+
+        return $index < $this->count();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return mixed
+     */
+    public function filter( callable $condition ) {
+        $elements = array();
+
+        foreach ( $this->elements as $element ) {
+            if ( call_user_func( $condition, $element ) ) {
+                $elements[] = $element;
+            }
+        }
+
+        return $this->new_from_trusted( $elements );
+    }
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return mixed
+     */
+    public function find_last( callable $condition ) {
+        $index = $this->find_last_index( $condition );
+
+        return -1 === $index ? null : $this->elements[ $index ];
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition
+     * @return int
+     */
+    public function find_last_index( callable $condition ) {
+        $index = -1;
+
+        for ( $i = count( $this->elements ) - 1; $i >= 0; $i-- ) {
+            if ( call_user_func( $condition, $this->elements[ $i ] ) ) {
+                $index = $i;
+                break;
+            }
+        }
+
+        return $index;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  int $start Begining index to slice from.
+     * @param  int $end   End index to slice to.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function slice( $start, $end ) {
+        if ( $start < 0 || ! is_int( $start ) ) {
+            throw new InvalidArgumentException( 'Start must be a non-negative integer' );
+        }
+
+        if ( $end < 0 || ! is_int( $end ) ) {
+            throw new InvalidArgumentException( 'End must be a positive integer' );
+        }
+
+        if ( $start > $end ) {
+            throw new InvalidArgumentException( 'End must be greater than start' );
+        }
+
+        if ( $end > $this->count() + 1 ) {
+            throw new InvalidArgumentException( 'End must be less than the count of the items in the Collection' );
+        }
+
+        $length = $end - $start + 1;
+        $subset = array_slice( $this->elements, $start, $length );
+
+        $collection = new static($this->type);
+        $collection->set_from_trusted( $subset );
+
+        return $collection;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param int   $index     Index to start at.
+     * @param mixed $element Element to insert.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     * @throws OutOfRangeException
+     */
+    public function insert( $index, $element ) {
+        $this->validate_index( $index );
+        $this->type->validate_element( $element );
+
+        $a = array_slice( $this->elements, 0, $index );
+        $b = array_slice( $this->elements, $index, count( $this->elements ) );
+
+        $a[] = $element;
+
+        return $this->new_from_trusted( array_merge( $a, $b ) );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param int   $index    Index to start insertion at.
+     * @param array $elements Elements in insert.
+     *
+     * @return Collection
+     *
+     * @throws OutOfRangeException
+     */
+    public function insert_range( $index, array $elements ) {
+        $this->validate_index( $index );
+        $this->type->validate_elements( $elements );
+
+        // To work with negative index, get the positive relation to 0 index
+        $index < 0 && $index = $this->count() + $index + 1;
+
+        $partA = array_slice( $this->elements, 0, $index );
+        $partB = array_slice( $this->elements, $index, count( $this->elements ) );
+
+        $elements1 = array_merge( $partA, $elements );
+        $elements1 = array_merge( $elements1, $partB );
+
+        $col = new static( $this->type );
+        $col->set_from_trusted( $elements1 );
+
+        return $col;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return Collection
+     */
+    public function without( callable $condition ) {
+        $inverse = function ( $element ) use ( $condition ) {
+            return ! call_user_func( $condition, $element );
+        };
+
+        return $this->filter( $inverse );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  int $index Index to remove.
+     *
+     * @return Collection
+     *
+     * @throws OutOfRangeException
+     */
+    public function remove_at( $index ) {
+        $this->validate_index( $index );
+
+        $elements = $this->elements;
+
+        return $this->new_from_trusted(
+            array_merge(
+                array_slice( $elements, 0, $index ),
+                array_slice( $elements, $index + 1, count( $elements ) )
+            )
+        );
+    }
+    /**
+     * {@inheritdoc}
+     *
+     * @return Collection
+     */
+    public function reverse() {
+        return $this->new_from_trusted(
+            array_reverse( $this->elements )
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callback Sort callback.
+     *
+     * @return Collection
+     */
+    public function sort( callable $callback ) {
+        $elements = $this->elements;
+        usort( $elements, $callback );
+        return $this->new_from_trusted( $elements );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return array
+     */
+    public function to_array() {
+        return $this->elements;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callable Reducer function.
+     *
+     * @param null     $initial  Initial reducer value.
+     *
+     * @return mixed
+     */
+    public function reduce( callable $callable, $initial = null ) {
+        return array_reduce( $this->elements, $callable, $initial );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $condition Condition callback.
+     *
+     * @return bool
+     */
+    public function every( callable $condition ) {
+        $response = true;
+
+        foreach ( $this->elements as $element ) {
+            $result = call_user_func( $condition, $element );
+
+            if ( false === $result ) {
+                $response = false;
+                break;
+            }
+        }
+
+        return $response;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  int $num Number of elements to drop.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function drop( $num ) {
+        return $this->slice( $num, $this->count() );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param int $num Number of elements to drop.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function drop_right( $num ) {
+        return $num !== $this->count()
+            ? $this->slice( 0, $this->count() - $num - 1 )
+            : $this->clear();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $condition Condition callback.
+     *
+     * @return Collection
+     */
+    public function drop_while( callable $condition ) {
+        $count = $this->count_while_true( $condition );
+        return $count ? $this->drop( $count ) : $this;
+    }
+    /**
+     * {@inheritdoc}
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function tail() {
+        return $this->slice( 1, $this->count() );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  int $num Number of elements to take.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function take( $num ) {
+        return $this->slice( 0, $num - 1 );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param int $num Number of elements to take.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function take_right( $num ) {
+        return $this->slice( $this->count() - $num, $this->count() );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $condition Callback function.
+     *
+     * @return Collection
+     */
+    public function take_while( callable $condition ) {
+        $count = $this->count_while_true( $condition );
+
+        return $count ? $this->take( $count ) : $this->clear();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callable Callback function.
+     */
+    public function each( callable $callable ) {
+        foreach ( $this->elements as $element ) {
+            call_user_func( $callable, $element );
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callable Callback function.
+     *
+     * @return Collection
+     */
+    public function map( callable $callable ) {
+        $elements = array();
+        $type = null;
+        foreach ( $this->elements as $element ) {
+            $result = call_user_func( $callable, $element );
+
+            if ( null === $type ) {
+                $type = gettype( $result );
+
+                if ( 'object' === $type ) {
+                    $type = get_class( $result );
+                }
+            }
+
+            $elements[] = $result;
+        }
+
+        return $this->new_from_trusted( $elements, $type ? : $this->get_type() );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callable Reducer function.
+     * @param null     $initial  Initial value.
+     *
+     * @return mixed
+     */
+    public function reduce_right( callable $callable, $initial = null ) {
+        return array_reduce(
+            array_reverse( $this->elements ),
+            $callable,
+            $initial
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return Collection
+     */
+    public function shuffle() {
+        $elements = $this->elements;
+        shuffle( $elements );
+
+        return $this->new_from_trusted( $elements );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param array|Collection $elements Array of elements to merge.
+     *
+     * @return Collection
+     *
+     * @throws InvalidArgumentException
+     */
+    public function merge( $elements ) {
+        if ( $elements instanceof static ) {
+            $elements = $elements->to_array();
+        }
+
+        if ( ! is_array( $elements ) ) {
+            throw new InvalidArgumentException( 'Merge must be given array or Collection' );
+        }
+
+        $this->type->validate_elements( $elements );
+
+        return $this->new_from_trusted(
+            array_merge( $this->elements, $elements )
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     *
+     * @throws OutOfBoundsException
+     */
+    public function first() {
+        if ( empty( $this->elements ) ) {
+            throw new OutOfBoundsException( 'Cannot get first element of empty Collection' );
+        }
+
+        return reset( $this->elements );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return mixed
+     *
+     * @throws OutOfBoundsException
+     */
+    public function last() {
+        if ( empty( $this->elements ) ) {
+            throw new OutOfBoundsException( 'Cannot get last element of empty Collection' );
+        }
+
+        return end( $this->elements );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return int
+     */
+    public function count() {
+        return count( $this->elements );
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return array
+     */
+    public function serialize() {
+        return $this->map(function( $element ) {
+            if ( $element instanceof Serializes ) {
+                return $element->serialize();
+            }
+
+            return $element;
+        } )->to_array();
+    }
+
+    /**
+     * 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;
+    }
+
+    /**
+     * Creates a new instance of the Collection
+     * from a trusted set of elements.
+     *
+     * @param array      $elements Array of elements to pass into new collection.
+     * @param null|mixed $type
+     *
+     * @return static
+     */
+    protected function new_from_trusted( array $elements, $type = null ) {
+        $collection = new static( null !== $type ? $type : $this->get_type() );
+        $collection->set_from_trusted( $elements );
+
+        return $collection;
+    }
+
+    /**
+     * Sets the elements without validating them.
+     *
+     * @param array $elements Pre-validated elements to set.
+     */
+    protected function set_from_trusted( array $elements ) {
+        $this->elements = $elements;
+    }
+
+    /**
+     * Number of elements true for the condition.
+     *
+     * @param callable $condition Condition to check.
+     * @return int
+     */
+    protected function count_while_true( callable $condition ) {
+        $count = 0;
+
+        foreach ( $this->elements as $element ) {
+            if ( ! $condition($element) ) {
+                break;
+            }
+            $count++;
+        }
+
+        return $count;
+    }
+
+    /**
+     * Validates a number to be used as an index.
+     *
+     * @param  integer $index The number to be validated as an index.
+     *
+     * @throws OutOfRangeException
+     */
+    protected function validate_index( $index ) {
+        $exists = $this->index_exists( $index );
+
+        if ( ! $exists ) {
+            throw new OutOfRangeException( 'Index out of bounds of collection' );
+        }
+    }
 }