intraxia / jaxion

src/Utility/Str.php

Indentation +32 added lines, -32 removed lines

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

src/Contract/Core/I18n.php

Indentation +6 added lines, -6 removed lines

@@ -2,10 +2,10 @@
 namespace Intraxia\Jaxion\Contract\Core;
 
 interface I18n {
-	/**
-	 * Loads the plugin's textdomain.
-	 *
-	 * @return void
-	 */
-	public function load_plugin_textdomain();
+    /**
+     * Loads the plugin's textdomain.
+     *
+     * @return void
+     */
+    public function load_plugin_textdomain();
 }

src/Core/I18n.php

Indentation +45 added lines, -45 removed lines

@@ -11,53 +11,53 @@
  * @subpackage Core
  */
 class I18n implements I18nContract, HasActions {
-	/**
-	 * Plugin basename
-	 *
-	 * @var string
-	 */
-	private $basename;
+    /**
+     * Plugin basename
+     *
+     * @var string
+     */
+    private $basename;
 
-	/**
-	 * Plugin path.
-	 *
-	 * @var string
-	 */
-	private $path;
+    /**
+     * Plugin path.
+     *
+     * @var string
+     */
+    private $path;
 
-	/**
-	 * I18n constructor.
-	 *
-	 * @param string $basename Plugin basename.
-	 * @param string $path     Plugin path.
-	 */
-	public function __construct( $basename, $path ) {
-		$this->basename = $basename;
-		$this->path = $path;
-	}
+    /**
+     * I18n constructor.
+     *
+     * @param string $basename Plugin basename.
+     * @param string $path     Plugin path.
+     */
+    public function __construct( $basename, $path ) {
+        $this->basename = $basename;
+        $this->path = $path;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function load_plugin_textdomain() {
-		load_plugin_textdomain(
-			$this->basename,
-			false,
-			basename( $this->path ) . '/languages/'
-		);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function load_plugin_textdomain() {
+        load_plugin_textdomain(
+            $this->basename,
+            false,
+            basename( $this->path ) . '/languages/'
+        );
+    }
 
-	/**
-	 * {@inheritDoc}
-	 *
-	 * @return array
-	 */
-	public function action_hooks() {
-		return array(
-			array(
-				'hook'   => 'init',
-				'method' => 'load_plugin_textdomain',
-			),
-		);
-	}
+    /**
+     * {@inheritDoc}
+     *
+     * @return array
+     */
+    public function action_hooks() {
+        return array(
+            array(
+                'hook'   => 'init',
+                'method' => 'load_plugin_textdomain',
+            ),
+        );
+    }
 }

src/Contract/Assets/Register.php

Indentation +48 added lines, -48 removed lines

@@ -4,52 +4,52 @@
 use Intraxia\Jaxion\Contract\Core\HasActions;
 
 interface Register extends HasActions {
-	/**
-	 * Enable debug mode for the enqueued assets.
-	 *
-	 * Debug mode will enqueue unminified versions of the registered assets.
-	 * Primarily, this is intended to be used along with WordPress's `SCRIPT_DEBUG`
-	 * constant, which enables unminified core assets to be enqueued.
-	 *
-	 * @param bool $debug
-	 */
-	public function set_debug( $debug );
-
-	/**
-	 * Provides a method to register new scripts outside of the constructor.
-	 *
-	 * @param array $script
-	 */
-	public function register_script( $script );
-
-	/**
-	 * Provides a method to register new styles outside of the constructor.
-	 *
-	 * @param array $style
-	 */
-	public function register_style( $style );
-
-	/**
-	 * Enqueues the web & shared scripts on the Register.
-	 */
-	public function enqueue_web_scripts();
-
-	/**
-	 * Enqueues the web & shared styles on the Register.
-	 */
-	public function enqueue_web_styles();
-
-	/**
-	 * Enqueues the admin & shared scripts on the Register.
-	 *
-	 * @param string $hook Passes a string representing the current page.
-	 */
-	public function enqueue_admin_scripts( $hook );
-
-	/**
-	 * Enqueues the admin & shared styles on the Register.
-	 *
-	 * @param string $hook Passes a string representing the current page.
-	 */
-	public function enqueue_admin_styles( $hook );
+    /**
+     * Enable debug mode for the enqueued assets.
+     *
+     * Debug mode will enqueue unminified versions of the registered assets.
+     * Primarily, this is intended to be used along with WordPress's `SCRIPT_DEBUG`
+     * constant, which enables unminified core assets to be enqueued.
+     *
+     * @param bool $debug
+     */
+    public function set_debug( $debug );
+
+    /**
+     * Provides a method to register new scripts outside of the constructor.
+     *
+     * @param array $script
+     */
+    public function register_script( $script );
+
+    /**
+     * Provides a method to register new styles outside of the constructor.
+     *
+     * @param array $style
+     */
+    public function register_style( $style );
+
+    /**
+     * Enqueues the web & shared scripts on the Register.
+     */
+    public function enqueue_web_scripts();
+
+    /**
+     * Enqueues the web & shared styles on the Register.
+     */
+    public function enqueue_web_styles();
+
+    /**
+     * Enqueues the admin & shared scripts on the Register.
+     *
+     * @param string $hook Passes a string representing the current page.
+     */
+    public function enqueue_admin_scripts( $hook );
+
+    /**
+     * Enqueues the admin & shared styles on the Register.
+     *
+     * @param string $hook Passes a string representing the current page.
+     */
+    public function enqueue_admin_styles( $hook );
 }

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( $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( $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( $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( $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( $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( $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 reject( $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( $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, $initial = null );
-
-	/**
-	 * Returns true if every element in the collection satisfies $condition,
-	 * returns false if not.
-	 *
-	 * @param callable $condition
-	 * @return bool
-	 */
-	public function every( $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( $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( $condition );
-
-	/**
-	 * Applies the callback function $callable to each element in the collection.
-	 *
-	 * @param callable $callable
-	 */
-	public function each( $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 );
-
-	/**
-	 * 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, $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( $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( $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( $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( $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( $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( $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 reject( $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( $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, $initial = null );
+
+    /**
+     * Returns true if every element in the collection satisfies $condition,
+     * returns false if not.
+     *
+     * @param callable $condition
+     * @return bool
+     */
+    public function every( $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( $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( $condition );
+
+    /**
+     * Applies the callback function $callable to each element in the collection.
+     *
+     * @param callable $callable
+     */
+    public function each( $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 );
+
+    /**
+     * 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, $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/Contract/Axolotl/Dictionary.php

Indentation +174 added lines, -174 removed lines

@@ -5,178 +5,178 @@
 use Iterator;
 
 interface Dictionary extends Iterator, Countable, Serializes {
-	/**
-	 * Returns the type of the dictionary's keys.
-	 *
-	 * @return string
-	 */
-	public function get_key_type();
-
-	/**
-	 * Returns the type of the dictionary's values.
-	 *
-	 * @return string
-	 */
-	public function get_value_type();
-
-	/**
-	 * Returns true if $key is in the dictionary, returns false if it is not.
-	 *
-	 * @param mixed $key Key to check for.
-	 *
-	 * @return bool
-	 */
-	public function exists( $key );
-
-	/**
-	 * Returns true if the callable returns true. The callable should accept a
-	 * key and value as arguments and return a boolean.
-	 *
-	 * @param  callable $callable
-	 * @return bool
-	 */
-	public function contains( $callable );
-
-	/**
-	 * Returns the value associated with $key.
-	 *
-	 * @param mixed $key Key to get.
-	 *
-	 * @return mixed
-	 */
-	public function get( $key );
-
-	/**
-	 * Removes the key-value pair represented by $key from the dictionary.
-	 *
-	 * @param mixed $key Key to remove.
-	 *
-	 * @return static
-	 */
-	public function delete( $key );
-
-	/**
-	 * Returns true if $value is in the dictionary, returns false if not.
-	 *
-	 * @param mixed $value Value to check for existence.
-	 *
-	 * @return bool
-	 */
-	public function value_exists( $value );
-
-	/**
-	 * Returns the number of key-value pairs in the dictionary.
-	 *
-	 * @return int
-	 */
-	public function count();
-
-	/**
-	 * Removes every key-value pair from the dictionary.
-	 *
-	 * @return static
-	 */
-	public function clear();
-
-	/**
-	 * Returns the key-value pairs in the dictionary as an associative array.
-	 *
-	 * @return array
-	 */
-	public function to_array();
-
-	/**
-	 * Returns a dictionary that only contains the key-value pairs which satisfy
-	 * $condition.
-	 *
-	 * @param callable $condition
-	 *
-	 * @return static
-	 */
-	public function filter( $condition );
-
-	/**
-	 * Removes all key-value pairs from the Dictionary that do not satisfy
-	 * $condition.
-	 *
-	 * @param callable $condition
-	 *
-	 * @return Dictionary
-	 */
-	public function reject( $condition );
-
-	/**
-	 * Adds the key-value pair containing $key and $value to the dictionary.
-	 *
-	 * @param mixed $key   Key to add.
-	 * @param mixed $value Value to add.
-	 *
-	 * @return Dictionary
-	 * @throws \InvalidArgumentException
-	 */
-	public function add( $key, $value );
-
-	/**
-	 * Applies the callback function $callable to each key-value pair in the
-	 * dictionary.
-	 *
-	 * @param callable $callable
-	 */
-	public function each( $callable );
-
-	/**
-	 * Returns the value associated with $key in the dictionary, returns
-	 * $default if it does not.
-	 *
-	 * @param mixed $key     Key to fetch.
-	 * @param mixed $default Default value if key is not found.
-	 *
-	 * @return mixed
-	 */
-	public function get_or_else( $key, $default );
-
-	/**
-	 * Returns an array of all keys in the dictionary.
-	 *
-	 * @return array
-	 */
-	public function keys();
-
-	/**
-	 * Returns an array of all values in the dictionary.
-	 *
-	 * @return array
-	 */
-	public function values();
-
-	/**
-	 * Returns a new dictionary with the callback function $callable applied to
-	 * every key-value pair in the dictionary.
-	 *
-	 * @param callable $callable
-	 *
-	 * @return static
-	 */
-	public function map( $callable );
-
-	/**
-	 * Adds every key-value pair in $storage to the dictionary.
-	 *
-	 * @param array|Dictionary $source Storage object to merge.
-	 *
-	 * @return static
-	 */
-	public function merge( $source );
-
-
-	/**
-	 * Reduce the dictionary to a single value. The callable should contain
-	 * args: carry, key, value
-	 *
-	 * @param callable $callable
-	 * @param mixed    $initial
-	 *
-	 * @return mixed
-	 */
-	public function reduce( $callable, $initial );
+    /**
+     * Returns the type of the dictionary's keys.
+     *
+     * @return string
+     */
+    public function get_key_type();
+
+    /**
+     * Returns the type of the dictionary's values.
+     *
+     * @return string
+     */
+    public function get_value_type();
+
+    /**
+     * Returns true if $key is in the dictionary, returns false if it is not.
+     *
+     * @param mixed $key Key to check for.
+     *
+     * @return bool
+     */
+    public function exists( $key );
+
+    /**
+     * Returns true if the callable returns true. The callable should accept a
+     * key and value as arguments and return a boolean.
+     *
+     * @param  callable $callable
+     * @return bool
+     */
+    public function contains( $callable );
+
+    /**
+     * Returns the value associated with $key.
+     *
+     * @param mixed $key Key to get.
+     *
+     * @return mixed
+     */
+    public function get( $key );
+
+    /**
+     * Removes the key-value pair represented by $key from the dictionary.
+     *
+     * @param mixed $key Key to remove.
+     *
+     * @return static
+     */
+    public function delete( $key );
+
+    /**
+     * Returns true if $value is in the dictionary, returns false if not.
+     *
+     * @param mixed $value Value to check for existence.
+     *
+     * @return bool
+     */
+    public function value_exists( $value );
+
+    /**
+     * Returns the number of key-value pairs in the dictionary.
+     *
+     * @return int
+     */
+    public function count();
+
+    /**
+     * Removes every key-value pair from the dictionary.
+     *
+     * @return static
+     */
+    public function clear();
+
+    /**
+     * Returns the key-value pairs in the dictionary as an associative array.
+     *
+     * @return array
+     */
+    public function to_array();
+
+    /**
+     * Returns a dictionary that only contains the key-value pairs which satisfy
+     * $condition.
+     *
+     * @param callable $condition
+     *
+     * @return static
+     */
+    public function filter( $condition );
+
+    /**
+     * Removes all key-value pairs from the Dictionary that do not satisfy
+     * $condition.
+     *
+     * @param callable $condition
+     *
+     * @return Dictionary
+     */
+    public function reject( $condition );
+
+    /**
+     * Adds the key-value pair containing $key and $value to the dictionary.
+     *
+     * @param mixed $key   Key to add.
+     * @param mixed $value Value to add.
+     *
+     * @return Dictionary
+     * @throws \InvalidArgumentException
+     */
+    public function add( $key, $value );
+
+    /**
+     * Applies the callback function $callable to each key-value pair in the
+     * dictionary.
+     *
+     * @param callable $callable
+     */
+    public function each( $callable );
+
+    /**
+     * Returns the value associated with $key in the dictionary, returns
+     * $default if it does not.
+     *
+     * @param mixed $key     Key to fetch.
+     * @param mixed $default Default value if key is not found.
+     *
+     * @return mixed
+     */
+    public function get_or_else( $key, $default );
+
+    /**
+     * Returns an array of all keys in the dictionary.
+     *
+     * @return array
+     */
+    public function keys();
+
+    /**
+     * Returns an array of all values in the dictionary.
+     *
+     * @return array
+     */
+    public function values();
+
+    /**
+     * Returns a new dictionary with the callback function $callable applied to
+     * every key-value pair in the dictionary.
+     *
+     * @param callable $callable
+     *
+     * @return static
+     */
+    public function map( $callable );
+
+    /**
+     * Adds every key-value pair in $storage to the dictionary.
+     *
+     * @param array|Dictionary $source Storage object to merge.
+     *
+     * @return static
+     */
+    public function merge( $source );
+
+
+    /**
+     * Reduce the dictionary to a single value. The callable should contain
+     * args: carry, key, value
+     *
+     * @param callable $callable
+     * @param mixed    $initial
+     *
+     * @return mixed
+     */
+    public function reduce( $callable, $initial );
 }

src/Axolotl/Type.php

Indentation +154 added lines, -154 removed lines

@@ -15,158 +15,158 @@
  */
 class Type {
 
-	/**
-	 * Type to validate against.
-	 *
-	 * @var string
-	 */
-	private $type;
-
-	/**
-	 * Type constructor.
-	 *
-	 * @param string $type
-	 * @param bool   $key_type
-	 */
-	public function __construct( $type, $key_type = false ) {
-		$this->type = $this->determine( $type, $key_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, array( '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( '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
+     * @param bool   $key_type
+     */
+    public function __construct( $type, $key_type = false ) {
+        $this->type = $this->determine( $type, $key_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, array( '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( '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/Axolotl/Collection.php

Indentation +741 added lines, -741 removed lines

@@ -15,745 +15,745 @@
  */
 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 ( $this->type->is_model() ) {
-			foreach ( $elements as $idx => $element ) {
-				if ( is_array( $element ) ) {
-					$elements[ $idx ] = $this->type->create_model( $element );
-				}
-			}
-		}
-
-		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( $condition ) {
-		return (bool) $this->find( $condition );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return mixed
-	 */
-	public function find( $condition ) {
-		$index = $this->find_index( $condition );
-
-		return -1 === $index ? null : $this->elements[ $index ];
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return int
-	 */
-	public function find_index( $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 Collection
-	 */
-	public function filter( $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( $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( $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;
-
-		return $this->new_from_trusted( array_slice( $this->elements, $start, $length ) );
-	}
-
-	/**
-	 * {@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 );
-
-		if ( $index < 0 ) {
-			$index = $this->count() + $index + 1;
-		}
-
-		return $this->new_from_trusted(
-			array_merge(
-				array_slice( $this->elements, 0, $index ),
-				$elements,
-				array_slice( $this->elements, $index, count( $this->elements ) )
-			)
-		);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param  callable $condition Condition to satisfy.
-	 *
-	 * @return Collection
-	 */
-	public function reject( $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( $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, $initial = null ) {
-		return array_reduce( $this->elements, $callable, $initial );
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $condition Condition callback.
-	 *
-	 * @return bool
-	 */
-	public function every( $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 ) {
-		if ( $num > $this->count() ) {
-			$num = $this->count();
-		}
-
-		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( $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( $condition ) {
-		$count = $this->count_while_true( $condition );
-
-		return $count ? $this->take( $count ) : $this->clear();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callable Callback function.
-	 */
-	public function each( $callable ) {
-		foreach ( $this->elements as $element ) {
-			call_user_func( $callable, $element );
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 *
-	 * @param callable $callable Callback function.
-	 *
-	 * @return Collection
-	 */
-	public function map( $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, $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( $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 ( $this->type->is_model() ) {
+            foreach ( $elements as $idx => $element ) {
+                if ( is_array( $element ) ) {
+                    $elements[ $idx ] = $this->type->create_model( $element );
+                }
+            }
+        }
+
+        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( $condition ) {
+        return (bool) $this->find( $condition );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return mixed
+     */
+    public function find( $condition ) {
+        $index = $this->find_index( $condition );
+
+        return -1 === $index ? null : $this->elements[ $index ];
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return int
+     */
+    public function find_index( $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 Collection
+     */
+    public function filter( $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( $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( $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;
+
+        return $this->new_from_trusted( array_slice( $this->elements, $start, $length ) );
+    }
+
+    /**
+     * {@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 );
+
+        if ( $index < 0 ) {
+            $index = $this->count() + $index + 1;
+        }
+
+        return $this->new_from_trusted(
+            array_merge(
+                array_slice( $this->elements, 0, $index ),
+                $elements,
+                array_slice( $this->elements, $index, count( $this->elements ) )
+            )
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param  callable $condition Condition to satisfy.
+     *
+     * @return Collection
+     */
+    public function reject( $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( $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, $initial = null ) {
+        return array_reduce( $this->elements, $callable, $initial );
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $condition Condition callback.
+     *
+     * @return bool
+     */
+    public function every( $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 ) {
+        if ( $num > $this->count() ) {
+            $num = $this->count();
+        }
+
+        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( $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( $condition ) {
+        $count = $this->count_while_true( $condition );
+
+        return $count ? $this->take( $count ) : $this->clear();
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callable Callback function.
+     */
+    public function each( $callable ) {
+        foreach ( $this->elements as $element ) {
+            call_user_func( $callable, $element );
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @param callable $callable Callback function.
+     *
+     * @return Collection
+     */
+    public function map( $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, $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( $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' );
+        }
+    }
 }

src/Contract/Axolotl/UsesCustomTable.php

Indentation +12 added lines, -12 removed lines

@@ -2,17 +2,17 @@
 namespace Intraxia\Jaxion\Contract\Axolotl;
 
 interface UsesCustomTable {
-	/**
-	 * Returns the custom table name used by the model.
-	 *
-	 * @return string
-	 */
-	public static function get_table_name();
+    /**
+     * Returns the custom table name used by the model.
+     *
+     * @return string
+     */
+    public static function get_table_name();
 
-	/**
-	 * Get the attribute used as the primary key.
-	 *
-	 * @return string
-	 */
-	public static function get_primary_key();
+    /**
+     * Get the attribute used as the primary key.
+     *
+     * @return string
+     */
+    public static function get_primary_key();
 }