intraxia / jaxion

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();
 }