ci-bonfire / Sprint

myth/UIKits/BaseUIKit.php

Indentation +355 added lines, -355 removed lines

@@ -38,228 +38,228 @@ 
  */
 abstract class BaseUIKit {
 
-    /**
-     * Bucket for methods to control their current state between method calls.
-     * @var array
-     */
-    protected $states = [];
-
-    protected $name = '';
-
-    /**
-     * Attached to nav items that are considered active.
-     * @var string
-     */
-    protected $active_class = 'active';
-
-    //--------------------------------------------------------------------
-
-    public function name()
-    {
-        return $this->name;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Grids
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a row wrapper of HTML. We would have simple returned the
-     * the class for it, but some frameworks use a completely different
-     * approach to rows and columns than the reference Bootstrap and Foundation.
-     *
-     * @param array $options
-     * @return mixed
-     */
-    abstract public function row($options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates the CSS for a column in a grid.
-     *
-     * The attribute array is made up of key/value pairs with the
-     * key being the size, and the value being the number of columns/offset
-     * in a 12-column grid.
-     *
-     * Note that we currently DO NOT support offset columns.
-     *
-     * Valid sizes - 's', 'm', 'l', 'xl', 's-offset', 'm-offset', 'l-offset', 'xl-offset'
-     *
-     * Please note that that sizes are different than in Bootstrap. For example, for a 'xs'
-     * column size in Bootstrap, you would use 's' here. 'sm' = 'm', etc.
-     *
-     * @param array $attributes
-     * @return mixed
-     */
-    abstract public function column($options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Navigation
-    //--------------------------------------------------------------------
-
-    /**
-     * Generates the container code for a navbar, typically used along the
-     * top of a page.
-     *
-     * @param array    $options
-     * @param callable $c
-     * @return string
-     */
-    abstract public function navbar($options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Builds the HTML for the Title portion of the navbar. This typically
-     * includes the code for the hamburger menu on small resolutions.
-     *
-     * @param        $title
-     * @param string $url
-     * @return string
-     */
-    abstract public function navbarTitle($title, $url='#');
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a UL meant to pull to the right within the navbar.
-     *
-     * Available options:
-     *      'class'     - An additional class to add
-     *
-     * @param array    $options
-     * @param callable $c
-     * @return string
-     */
-    abstract public function navbarRight($options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a single list item for use within a nav section.
-     *
-     * @param       $title
-     * @param       $url
-     * @param array $options
-     * @return string
-     */
-    abstract public function navItem($title, $url, $options=[], $isActive=false);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Builds the shell of a Dropdown button for use within a nav area.
-     *
-     * @param          $title
-     * @param array    $options
-     * @param callable $c
-     */
-    abstract public function navDropdown($title,$options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a divider for use within a nav list.
-     *
-     * @return string
-     */
-    abstract public function navDivider();
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a list of nav items to function as breadcrumbs for a site.
-     *
-     * @param array    $options
-     * @param callable $c
-     * @return mixed
-     */
-    abstract public function breadcrumb($options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Buttons
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a simple button.
-     *
-     * $style can be 'default', 'primary', 'success', 'info', 'warning', 'danger'
-     * $size can be 'default', 'small', 'xsmall', 'large'
-     *
-     * @param       $title
-     * @param string $style
-     * @param array $options
-     * @return mixed
-     */
-    abstract public function button($title, $style='default', $size='default', $options=[]);
-
-    /**
-     * Creates a simple link styled as a button.
-     *
-     * $style can be 'default', 'primary', 'success', 'info', 'warning', 'danger'
-     * $size can be 'default', 'small', 'xsmall', 'large'
-     *
-     * @param       $title
-     * @param string $url
-     * @param string $style
-     * @param array $options
-     * @return mixed
-     */
-    abstract public function buttonLink($title, $url='#', $style='default', $size='default', $options=[]);
-
-    /**
-     * Creates button groups wrapping HTML.
-     *
-     * @param          $options
-     * @param callable $c
-     * @return mixed
-     */
-    abstract public function buttonGroup($options, \Closure $c);
-
-    /**
-     * Creates the button bar wrapping HTML.
-     *
-     * @param          $options
-     * @param callable $c
-     * @return mixed
-     */
-    abstract public function buttonBar($options, \Closure $c);
-
-    /**
-     * Creates a button that also has a dropdown menu. Also called Split Buttons
-     * by some frameworks.
-     *
-     * @param        $title
-     * @param string $style
-     * @param string $size
-     * @param array  $options
-     * @param callable $c
-     * @return mixed
-     */
-    abstract public function buttonDropdown($title, $style='default', $size='default', $options=[], \Closure $c);
-
-    //--------------------------------------------------------------------
-    // Notices
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates an 'alert-box' style of notice grid.
-     *
-     * $style can be 'default', 'primary', 'success', 'info', 'warning', 'danger'
-     *
-     * @param $content
-     * @param string $style
-     * @param bool $closable
-     * @return mixed
-     */
-    abstract public function notice($content, $style='success', $closable=true);
+	/**
+	 * Bucket for methods to control their current state between method calls.
+	 * @var array
+	 */
+	protected $states = [];
+
+	protected $name = '';
+
+	/**
+	 * Attached to nav items that are considered active.
+	 * @var string
+	 */
+	protected $active_class = 'active';
+
+	//--------------------------------------------------------------------
+
+	public function name()
+	{
+		return $this->name;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Grids
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a row wrapper of HTML. We would have simple returned the
+	 * the class for it, but some frameworks use a completely different
+	 * approach to rows and columns than the reference Bootstrap and Foundation.
+	 *
+	 * @param array $options
+	 * @return mixed
+	 */
+	abstract public function row($options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates the CSS for a column in a grid.
+	 *
+	 * The attribute array is made up of key/value pairs with the
+	 * key being the size, and the value being the number of columns/offset
+	 * in a 12-column grid.
+	 *
+	 * Note that we currently DO NOT support offset columns.
+	 *
+	 * Valid sizes - 's', 'm', 'l', 'xl', 's-offset', 'm-offset', 'l-offset', 'xl-offset'
+	 *
+	 * Please note that that sizes are different than in Bootstrap. For example, for a 'xs'
+	 * column size in Bootstrap, you would use 's' here. 'sm' = 'm', etc.
+	 *
+	 * @param array $attributes
+	 * @return mixed
+	 */
+	abstract public function column($options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Navigation
+	//--------------------------------------------------------------------
+
+	/**
+	 * Generates the container code for a navbar, typically used along the
+	 * top of a page.
+	 *
+	 * @param array    $options
+	 * @param callable $c
+	 * @return string
+	 */
+	abstract public function navbar($options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Builds the HTML for the Title portion of the navbar. This typically
+	 * includes the code for the hamburger menu on small resolutions.
+	 *
+	 * @param        $title
+	 * @param string $url
+	 * @return string
+	 */
+	abstract public function navbarTitle($title, $url='#');
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a UL meant to pull to the right within the navbar.
+	 *
+	 * Available options:
+	 *      'class'     - An additional class to add
+	 *
+	 * @param array    $options
+	 * @param callable $c
+	 * @return string
+	 */
+	abstract public function navbarRight($options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a single list item for use within a nav section.
+	 *
+	 * @param       $title
+	 * @param       $url
+	 * @param array $options
+	 * @return string
+	 */
+	abstract public function navItem($title, $url, $options=[], $isActive=false);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Builds the shell of a Dropdown button for use within a nav area.
+	 *
+	 * @param          $title
+	 * @param array    $options
+	 * @param callable $c
+	 */
+	abstract public function navDropdown($title,$options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a divider for use within a nav list.
+	 *
+	 * @return string
+	 */
+	abstract public function navDivider();
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a list of nav items to function as breadcrumbs for a site.
+	 *
+	 * @param array    $options
+	 * @param callable $c
+	 * @return mixed
+	 */
+	abstract public function breadcrumb($options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Buttons
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a simple button.
+	 *
+	 * $style can be 'default', 'primary', 'success', 'info', 'warning', 'danger'
+	 * $size can be 'default', 'small', 'xsmall', 'large'
+	 *
+	 * @param       $title
+	 * @param string $style
+	 * @param array $options
+	 * @return mixed
+	 */
+	abstract public function button($title, $style='default', $size='default', $options=[]);
+
+	/**
+	 * Creates a simple link styled as a button.
+	 *
+	 * $style can be 'default', 'primary', 'success', 'info', 'warning', 'danger'
+	 * $size can be 'default', 'small', 'xsmall', 'large'
+	 *
+	 * @param       $title
+	 * @param string $url
+	 * @param string $style
+	 * @param array $options
+	 * @return mixed
+	 */
+	abstract public function buttonLink($title, $url='#', $style='default', $size='default', $options=[]);
+
+	/**
+	 * Creates button groups wrapping HTML.
+	 *
+	 * @param          $options
+	 * @param callable $c
+	 * @return mixed
+	 */
+	abstract public function buttonGroup($options, \Closure $c);
+
+	/**
+	 * Creates the button bar wrapping HTML.
+	 *
+	 * @param          $options
+	 * @param callable $c
+	 * @return mixed
+	 */
+	abstract public function buttonBar($options, \Closure $c);
+
+	/**
+	 * Creates a button that also has a dropdown menu. Also called Split Buttons
+	 * by some frameworks.
+	 *
+	 * @param        $title
+	 * @param string $style
+	 * @param string $size
+	 * @param array  $options
+	 * @param callable $c
+	 * @return mixed
+	 */
+	abstract public function buttonDropdown($title, $style='default', $size='default', $options=[], \Closure $c);
+
+	//--------------------------------------------------------------------
+	// Notices
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates an 'alert-box' style of notice grid.
+	 *
+	 * $style can be 'default', 'primary', 'success', 'info', 'warning', 'danger'
+	 *
+	 * @param $content
+	 * @param string $style
+	 * @param bool $closable
+	 * @return mixed
+	 */
+	abstract public function notice($content, $style='success', $closable=true);
 
 	//--------------------------------------------------------------------
 	// Forms
@@ -278,137 +278,137 @@ 
 	 */
 	abstract public function inputWrap($label_text, $options=[], \Closure $c);
 
-    //--------------------------------------------------------------------
-    // Utility Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Helper method to run a Closure and collect the output of it.
-     *
-     * @param callable $c
-     * @return string
-     */
-    protected function runClosure(\Closure $c)
-    {
-        if (! is_callable($c)) return '';
-
-        ob_start();
-        $c();
-        $output = ob_get_contents();
-        ob_end_clean();
-
-        return $output;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Provides a single method call to get the $classes, $id, and $attributes
-     * from the options array.
-     *
-     * @param        $options
-     * @param string $initial_classes
-     * @param bool   $fullClassString
-     * @return array
-     */
-    protected function parseStandardOptions($options, $initial_classes='', $fullClassString=false)
-    {
-        return [
-            $this->buildClassString($initial_classes, $options, $fullClassString),
-            $this->buildIdFromOptions($options),
-            $this->buildAttributesFromOptions($options)
-        ];
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets the element that is to be considered the active item. This is
-     * based on the navItem's $title so it must match, though it is NOT
-     * case sensitive.
-     *
-     * @param $title
-     * @return mixed
-     */
-    public function setActiveNavItem($title)
-    {
-        $this->states['activeNavItem'] = strtolower($title);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Combines an initial classes string with a 'class' item that
-     * might be available within the options array.
-     *
-     * If 'buildEntireString' is TRUE will return the string with the 'class=""' portion.
-     * Otherwise, just returns the raw classes.
-     *
-     * @param string $initial
-     * @param array $options
-     * @return array
-     */
-    protected function buildClassString($initial, $options, $buildEntireString=false)
-    {
-        $classes = explode(' ', $initial);
-
-        if (isset($options['class']))
-        {
-            $classes = array_merge($classes, explode(' ', $options['class']));
-        }
-
-        if (isset($this->states['activeNavItem']) && isset($this->states['activeNavTitle']) &&
-            $this->states['activeNavItem'] == strtolower($this->states['activeNavTitle']))
-        {
-            $classes[] = $this->active_class;
-        }
-
-        $classes = implode(' ', $classes);
-
-        // Substitute the active class for a placeholder.
-        $classes = str_replace('{active}', $this->active_class, $classes);
-
-        return $buildEntireString ? "class='{$classes}'" : $classes;
-    }
-    //--------------------------------------------------------------------
-
-    /**
-     * Checks the options array for an ID and returns the entire string.
-     *
-     * Example Return:
-     *      id='MyID'
-     *
-     * @param $options
-     * @return string
-     */
-    protected function buildIdFromOptions($options)
-    {
-        return isset($options['id']) ? "id='{$options['id']}'" : ' ';
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Parses out attributes from the options array. The attributes array
-     * should all contain no key names, only values, so:
-     *
-     * 'attributes' => [
-     *      'style="width:100%",
-     *      'required'
-     * ]
-     *
-     * @param $options
-     * @return string
-     */
-    protected function buildAttributesFromOptions($options)
-    {
-        if (isset($options['attributes']) && ! is_array($options['attributes']))
-        {
-            $options['attributes'] = [ $options['attributes'] ];
-        }
-
-        return isset($options['attributes']) ? implode($options['attributes']) : '';
-    }
-
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
+	// Utility Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Helper method to run a Closure and collect the output of it.
+	 *
+	 * @param callable $c
+	 * @return string
+	 */
+	protected function runClosure(\Closure $c)
+	{
+		if (! is_callable($c)) return '';
+
+		ob_start();
+		$c();
+		$output = ob_get_contents();
+		ob_end_clean();
+
+		return $output;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Provides a single method call to get the $classes, $id, and $attributes
+	 * from the options array.
+	 *
+	 * @param        $options
+	 * @param string $initial_classes
+	 * @param bool   $fullClassString
+	 * @return array
+	 */
+	protected function parseStandardOptions($options, $initial_classes='', $fullClassString=false)
+	{
+		return [
+			$this->buildClassString($initial_classes, $options, $fullClassString),
+			$this->buildIdFromOptions($options),
+			$this->buildAttributesFromOptions($options)
+		];
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets the element that is to be considered the active item. This is
+	 * based on the navItem's $title so it must match, though it is NOT
+	 * case sensitive.
+	 *
+	 * @param $title
+	 * @return mixed
+	 */
+	public function setActiveNavItem($title)
+	{
+		$this->states['activeNavItem'] = strtolower($title);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Combines an initial classes string with a 'class' item that
+	 * might be available within the options array.
+	 *
+	 * If 'buildEntireString' is TRUE will return the string with the 'class=""' portion.
+	 * Otherwise, just returns the raw classes.
+	 *
+	 * @param string $initial
+	 * @param array $options
+	 * @return array
+	 */
+	protected function buildClassString($initial, $options, $buildEntireString=false)
+	{
+		$classes = explode(' ', $initial);
+
+		if (isset($options['class']))
+		{
+			$classes = array_merge($classes, explode(' ', $options['class']));
+		}
+
+		if (isset($this->states['activeNavItem']) && isset($this->states['activeNavTitle']) &&
+			$this->states['activeNavItem'] == strtolower($this->states['activeNavTitle']))
+		{
+			$classes[] = $this->active_class;
+		}
+
+		$classes = implode(' ', $classes);
+
+		// Substitute the active class for a placeholder.
+		$classes = str_replace('{active}', $this->active_class, $classes);
+
+		return $buildEntireString ? "class='{$classes}'" : $classes;
+	}
+	//--------------------------------------------------------------------
+
+	/**
+	 * Checks the options array for an ID and returns the entire string.
+	 *
+	 * Example Return:
+	 *      id='MyID'
+	 *
+	 * @param $options
+	 * @return string
+	 */
+	protected function buildIdFromOptions($options)
+	{
+		return isset($options['id']) ? "id='{$options['id']}'" : ' ';
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Parses out attributes from the options array. The attributes array
+	 * should all contain no key names, only values, so:
+	 *
+	 * 'attributes' => [
+	 *      'style="width:100%",
+	 *      'required'
+	 * ]
+	 *
+	 * @param $options
+	 * @return string
+	 */
+	protected function buildAttributesFromOptions($options)
+	{
+		if (isset($options['attributes']) && ! is_array($options['attributes']))
+		{
+			$options['attributes'] = [ $options['attributes'] ];
+		}
+
+		return isset($options['attributes']) ? implode($options['attributes']) : '';
+	}
+
+	//--------------------------------------------------------------------
 }

myth/Settings/DatabaseStore.php

Indentation +179 added lines, -179 removed lines

@@ -32,183 +32,183 @@
 
 class DatabaseStore implements SettingsStoreInterface {
 
-    protected $ci;
-
-    protected $db;
-
-    //--------------------------------------------------------------------
-
-    public function __construct( $ci=null )
-    {
-        if (is_object($ci))
-        {
-            $this->ci =& $ci;
-        }
-        else {
-            $this->ci =& get_instance();
-        }
-
-        // Ensure that the database is loaded.
-        if (empty($this->ci->db))
-        {
-            $this->ci->load->database();
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Inserts or Replaces an setting value.
-     *
-     * @param $key
-     * @param null $value
-     * @param string $group
-     * @return bool
-     */
-    public function save($key, $value=null, $group='app')
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $where = [
-            'name'  => $key,
-            'group' => $group
-        ];
-        $this->ci->db->delete('settings', $where);
-
-        if (is_array($value) || is_object($value))
-        {
-            $value = serialize($value);
-        }
-
-        $data = [
-            'name'  => $key,
-            'value' => $value,
-            'group' => $group
-        ];
-        return $this->ci->db->insert('settings', $data);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves a single item.
-     *
-     * @param $key
-     * @param string $group
-     * @return mixed
-     */
-    public function get($key, $group='app')
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $where = [
-            'name'  => $key,
-            'group' => $group
-        ];
-
-        $query = $this->ci->db->where($where)
-                              ->get('settings');
-
-        if (! $query->num_rows())
-        {
-            return false;
-        }
-
-        $value = $query->row()->value;
-
-        // Check to see if it needs to be unserialized
-        $data = @unserialize($value);   // We don't need to issue an E_NOTICE here...
-
-        // Check for a value of false or
-        if ($value === 'b:0;' || $data !== false)
-        {
-            $value = $data;
-        }
-
-        return $value;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Deletes a single item.
-     *
-     * @param $key
-     * @param $group
-     * @return mixed
-     */
-    public function delete($key, $group='app')
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $where = [
-            'name'  => $key,
-            'group' => $group
-        ];
-
-        return $this->ci->db->delete('settings', $where);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Searches the store for any items with $field = $value.
-     *
-     * @param $field
-     * @param $value
-     * @return mixed
-     */
-    public function findBy($field, $value)
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $query = $this->ci->db->where($field, $value)
-                              ->get('settings');
-
-        if (! $query->num_rows())
-        {
-            return false;
-        }
-
-        return $query->result_array();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves all items in the store either globally or for a single group.
-     *
-     * @param string $group
-     * @return mixed
-     */
-    public function all($group=null)
-    {
-        if (empty($this->ci->db) || ! is_object($this->ci->db))
-        {
-            return false;
-        }
-
-        $query = $this->ci->db->get('settings');
-
-        if (! $query->num_rows())
-        {
-            return false;
-        }
-
-        return $query->result_array();
-    }
-
-    //--------------------------------------------------------------------
+	protected $ci;
+
+	protected $db;
+
+	//--------------------------------------------------------------------
+
+	public function __construct( $ci=null )
+	{
+		if (is_object($ci))
+		{
+			$this->ci =& $ci;
+		}
+		else {
+			$this->ci =& get_instance();
+		}
+
+		// Ensure that the database is loaded.
+		if (empty($this->ci->db))
+		{
+			$this->ci->load->database();
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Inserts or Replaces an setting value.
+	 *
+	 * @param $key
+	 * @param null $value
+	 * @param string $group
+	 * @return bool
+	 */
+	public function save($key, $value=null, $group='app')
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$where = [
+			'name'  => $key,
+			'group' => $group
+		];
+		$this->ci->db->delete('settings', $where);
+
+		if (is_array($value) || is_object($value))
+		{
+			$value = serialize($value);
+		}
+
+		$data = [
+			'name'  => $key,
+			'value' => $value,
+			'group' => $group
+		];
+		return $this->ci->db->insert('settings', $data);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves a single item.
+	 *
+	 * @param $key
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function get($key, $group='app')
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$where = [
+			'name'  => $key,
+			'group' => $group
+		];
+
+		$query = $this->ci->db->where($where)
+							  ->get('settings');
+
+		if (! $query->num_rows())
+		{
+			return false;
+		}
+
+		$value = $query->row()->value;
+
+		// Check to see if it needs to be unserialized
+		$data = @unserialize($value);   // We don't need to issue an E_NOTICE here...
+
+		// Check for a value of false or
+		if ($value === 'b:0;' || $data !== false)
+		{
+			$value = $data;
+		}
+
+		return $value;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Deletes a single item.
+	 *
+	 * @param $key
+	 * @param $group
+	 * @return mixed
+	 */
+	public function delete($key, $group='app')
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$where = [
+			'name'  => $key,
+			'group' => $group
+		];
+
+		return $this->ci->db->delete('settings', $where);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Searches the store for any items with $field = $value.
+	 *
+	 * @param $field
+	 * @param $value
+	 * @return mixed
+	 */
+	public function findBy($field, $value)
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$query = $this->ci->db->where($field, $value)
+							  ->get('settings');
+
+		if (! $query->num_rows())
+		{
+			return false;
+		}
+
+		return $query->result_array();
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves all items in the store either globally or for a single group.
+	 *
+	 * @param string $group
+	 * @return mixed
+	 */
+	public function all($group=null)
+	{
+		if (empty($this->ci->db) || ! is_object($this->ci->db))
+		{
+			return false;
+		}
+
+		$query = $this->ci->db->get('settings');
+
+		if (! $query->num_rows())
+		{
+			return false;
+		}
+
+		return $query->result_array();
+	}
+
+	//--------------------------------------------------------------------
 }

build/scripts/InitialCleanup.php

Indentation +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 
 	public function __construct($destination)
 	{
-	    $this->source_path = realpath(BUILDBASE .'../');
+		$this->source_path = realpath(BUILDBASE .'../');
 
 		if (empty($this->source_path))
 		{

application/config/api.php

Indentation +29 added lines, -29 removed lines

@@ -1,34 +1,34 @@
 <?php
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 /**
  * BUILD TOOL

system/core/Config.php

Indentation +35 added lines, -35 removed lines

@@ -1,40 +1,40 @@
 <?php
 /**
- * CodeIgniter
- *
- * An open source application development framework for PHP
- *
- * This content is released under the MIT License (MIT)
- *
- * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package	CodeIgniter
- * @author	EllisLab Dev Team
- * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
- * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
- * @license	http://opensource.org/licenses/MIT	MIT License
- * @link	http://codeigniter.com
- * @since	Version 1.0.0
- * @filesource
- */
+	 * CodeIgniter
+	 *
+	 * An open source application development framework for PHP
+	 *
+	 * This content is released under the MIT License (MIT)
+	 *
+	 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package	CodeIgniter
+	 * @author	EllisLab Dev Team
+	 * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
+	 * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
+	 * @license	http://opensource.org/licenses/MIT	MIT License
+	 * @link	http://codeigniter.com
+	 * @since	Version 1.0.0
+	 * @filesource
+	 */
 defined('BASEPATH') OR exit('No direct script access allowed');
 
 /**

system/helpers/language_helper.php

Indentation +35 added lines, -35 removed lines

@@ -1,40 +1,40 @@
 <?php
 /**
- * CodeIgniter
- *
- * An open source application development framework for PHP
- *
- * This content is released under the MIT License (MIT)
- *
- * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package	CodeIgniter
- * @author	EllisLab Dev Team
- * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
- * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
- * @license	http://opensource.org/licenses/MIT	MIT License
- * @link	http://codeigniter.com
- * @since	Version 1.0.0
- * @filesource
- */
+	 * CodeIgniter
+	 *
+	 * An open source application development framework for PHP
+	 *
+	 * This content is released under the MIT License (MIT)
+	 *
+	 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package	CodeIgniter
+	 * @author	EllisLab Dev Team
+	 * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
+	 * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
+	 * @license	http://opensource.org/licenses/MIT	MIT License
+	 * @link	http://codeigniter.com
+	 * @since	Version 1.0.0
+	 * @filesource
+	 */
 defined('BASEPATH') OR exit('No direct script access allowed');
 
 /**

system/libraries/Form_validation.php

Indentation +35 added lines, -35 removed lines

@@ -1,40 +1,40 @@
 <?php
 /**
- * CodeIgniter
- *
- * An open source application development framework for PHP
- *
- * This content is released under the MIT License (MIT)
- *
- * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package	CodeIgniter
- * @author	EllisLab Dev Team
- * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
- * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
- * @license	http://opensource.org/licenses/MIT	MIT License
- * @link	http://codeigniter.com
- * @since	Version 1.0.0
- * @filesource
- */
+	 * CodeIgniter
+	 *
+	 * An open source application development framework for PHP
+	 *
+	 * This content is released under the MIT License (MIT)
+	 *
+	 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package	CodeIgniter
+	 * @author	EllisLab Dev Team
+	 * @copyright	Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
+	 * @copyright	Copyright (c) 2014 - 2015, British Columbia Institute of Technology (http://bcit.ca/)
+	 * @license	http://opensource.org/licenses/MIT	MIT License
+	 * @link	http://codeigniter.com
+	 * @since	Version 1.0.0
+	 * @filesource
+	 */
 defined('BASEPATH') OR exit('No direct script access allowed');
 
 /**

myth/CIModules/docs/controllers/Docs.php

Indentation +259 added lines, -259 removed lines

@@ -33,284 +33,284 @@
 class Docs extends \Myth\Controllers\ThemedController
 {
 
-    protected $ignoreFiles = array('_404.md');
+	protected $ignoreFiles = array('_404.md');
 
-    protected $tocFile;
+	protected $tocFile;
 
-    protected $doc_folders = [];
+	protected $doc_folders = [];
 
-    protected $current_group = null;
+	protected $current_group = null;
 
-    protected $current_path = null;
+	protected $current_path = null;
 
-    private $showAppDocs;
+	private $showAppDocs;
 
-    private $showDevDocs;
+	private $showDevDocs;
 
-    protected $theme = 'docs';
+	protected $theme = 'docs';
 
-    protected $auto_escape = false;
+	protected $auto_escape = false;
 
-    //--------------------------------------------------------------------------
+	//--------------------------------------------------------------------------
 
-    /**
-     * Constructor
-     *
-     * @return \Docs
-     */
-    public function __construct()
-    {
-        parent::__construct();
+	/**
+	 * Constructor
+	 *
+	 * @return \Docs
+	 */
+	public function __construct()
+	{
+		parent::__construct();
 
-        $this->load->config('docs');
-        $this->lang->load('docs');
+		$this->load->config('docs');
+		$this->lang->load('docs');
 
-        // Save our folders
-        $this->doc_folders = config_item('docs.folders');
+		// Save our folders
+		$this->doc_folders = config_item('docs.folders');
 
-        list($this->current_group, $this->current_path) = $this->determineFromURL();
+		list($this->current_group, $this->current_path) = $this->determineFromURL();
 
-        $this->determineVisibleGroups($this->current_group, $this->current_path);
+		$this->determineVisibleGroups($this->current_group, $this->current_path);
 
-        $this->load->helper('form');
-        $this->load->helper('language');
+		$this->load->helper('form');
+		$this->load->helper('language');
 
-        $this->docbuilder = new \Myth\Docs\Builder( array('apppath' => APPPATH) );
+		$this->docbuilder = new \Myth\Docs\Builder( array('apppath' => APPPATH) );
 
-        $formatter = function ($str) {
-            $converter = new \League\CommonMark\CommonMarkConverter();
-            return $converter->convertToHtml($str);
-        };
-        $this->docbuilder->registerFormatter($formatter, true);
-    }
+		$formatter = function ($str) {
+			$converter = new \League\CommonMark\CommonMarkConverter();
+			return $converter->convertToHtml($str);
+		};
+		$this->docbuilder->registerFormatter($formatter, true);
+	}
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Display the list of documents available and the current document
-     *
-     * @return void
-     */
-    public function index()
-    {
-        $data = array();
+	/**
+	 * Display the list of documents available and the current document
+	 *
+	 * @return void
+	 */
+	public function index()
+	{
+		$data = array();
 
-        // Make sure the builder knows where to look
-        foreach ($this->doc_folders as $alias => $folder) {
-            $this->docbuilder->addDocFolder($alias, $folder);
-        }
-
-        try {
-            $content = $this->docbuilder->readPage($this->current_path, $this->current_group);
-            $content = $this->docbuilder->postProcess($content, site_url(), current_url());
-
-            $data['sidebar'] = $this->buildSidebar($content);
-            $data['toc']     = $this->buildTOC();
-            $data['content'] = $content;
-            $data['page_title'] = $this->docbuilder->pageTitle();
-        } catch (Exception $e) {
-            $this->setMessage($e->getMessage(), 'warning');
-        }
-
-        $this->render($data, config_item('docs.cache_time'));
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Display search results and handles the search itself.
-     *
-     * @return void
-     */
-    public function search()
-    {
-        $this->benchmark->mark('search_start');
-        $this->docsearch = new \Myth\Docs\Search();
-        $this->load->helper('markdown_extended');
-        $this->docsearch->registerFormatter('MarkdownExtended', true);
-
-        $data = array();
-
-        $terms = $this->input->post('search_terms');
-
-        if ($terms) {
-            $search_folders = $this->doc_folders;
-
-            $data['results'] = $this->docsearch->search($terms, $search_folders);
-        }
-
-        $this->benchmark->mark('search_end');
-
-        $data['search_time']  = $this->benchmark->elapsed_time('search_start', 'search_end');
-        $data['search_terms'] = $terms;
-        $data['page_title'] = 'Search Results';
-
-        $this->render($data);
-    }
-
-    //--------------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------------
-
-    /**
-     * Determines which groups are allowed to be viewed by the current system
-     * and the user/environment.
-     *
-     * todo Allow docs groups to be shown/hidden per-environment, using assoc-array for permitted environments
-     */
-    private function determineVisibleGroups($current_group, $current_path)
-    {
-        // Is displaying docs permitted for this environment?
-        if (config_item('docs.permitted_environments')
-            && !in_array(ENVIRONMENT, config_item('docs.permitted_environments'))
-        ) {
-            $this->setMessage(lang('docs_env_disabled'), 'danger');
-            redirect();
-        }
-
-        $this->showAppDocs = config_item('docs.show_app_docs');
-        $this->showDevDocs = config_item('docs.show_dev_docs');
-        $this->tocFile     = config_item('docs.toc_file') ?: '_toc.ini';
-
-        // Make sure we can still get to the search method.
-        if ($current_group == 'search') {
-            $this->current_group = false;
-        } // Are we allowed to show developer docs in this environment?
-        elseif ($current_group == 'developer'
-                && !$this->showDevDocs
-                && ENVIRONMENT != 'development'
-        ) {
-            if ($this->showAppDocs) {
-                $this->setMessage(lang('docs_not_allowed_dev'), 'warning');
-
-                redirect('docs/application');
-            }
-
-            show_error(lang('docs_not_allowed'));
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines the current doc group and file path from the current URL.
-     *
-     * Returns an array with the group and file path in the 0 and 1 positions, respectively.
-     *
-     * @return array
-     */
-    private function determineFromURL()
-    {
-        $return = [
-            '', // Group
-            '', // File Path
-        ];
-
-        $segments = $this->uri->segment_array();
-
-        // Remove the 'docs' from the array
-        // for now, we assume this is the first one
-        // since that is how Bonfire is setup to show docs
-        // @todo Make it so the path can be modified and this still works.
-        array_shift($segments);
-
-        // If nothing left, then assign the default group and redirect to
-        // a page we can do something with...
-        if (!count($segments)) {
-            redirect('docs/' . config_item('docs.default_group'));
-        }
-
-        // Do we have a group specified? Bonfire Docs requires that a group
-        // be part of the URI so it should be the first element on the array.
-        $return[0] = array_shift($segments);
-
-        // If there's any more left, then join them together and they'll
-        // form the path to the file. This will allow for subfolders with the
-        // docs folder itself.
-        $return[1] = count($segments) ? implode('/', $segments) : 'index';
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Builds a TOC for the sidebar out of files found in the following folders:
-     *      - application/docs
-     *      - bonfire/docs
-     *      - {module}/docs
-     *
-     * @param $content  The HTML generated for the page content.
-     * @return string   The HTML for the sidebar.
-     */
-    private function buildSidebar(&$content)
-    {
-        $data = [];
-
-        // Set the remaining data for the view
-        $data['docsDir'] = 'docs/' . $this->current_group . '/';
-        $data['docsExt'] = config_item('docs.extension');
-
-        $data['docMap'] = $this->docbuilder->buildDocumentMap($content);
-
-        return $this->docbuilder->postProcess(
-            $this->load->view('docs/_document_map', $data, true),
-            site_url(),
-            current_url()
-        );
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Builds out the nested lists of items that are needed
-     */
-    private function buildTOC()
-    {
-        $folder = $this->doc_folders[$this->current_group] . '/';
-
-        $map = $this->docbuilder->buildTOC($folder);
-
-        return $this->docbuilder->postProcess(
-            $this->load->view('docs/_toc', ['map' => $map], true),
-            site_url(),
-            current_url()
-        );
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Checks all modules to see if they include docs and prepares their doc
-     * information for use in the sidebar.
-     *
-     * @return array
-     */
-    private function get_module_docs()
-    {
-        $docs_modules = array();
-        foreach (\Bonfire\Modules::list_modules() as $module) {
-            $ignored_folders = array();
-            $path            = \Bonfire\Modules::path($module) . $this->docsDir;
-
-            // If these are developer docs, add the folder to the path.
-            if ($this->current_group == $this->docsTypeBf) {
-                $path .= '/' . $this->docsTypeBf;
-            } // For Application docs, ignore the 'developers' folder.
-            else {
-                $ignored_folders[] = $this->docsTypeBf;
-            }
-
-            if (is_dir($path)) {
-                $files = $this->get_folder_files($path, $module, $ignored_folders);
-                if (is_array($files) && count($files)) {
-                    $docs_modules[$module] = $files;
-                }
-            }
-        }
-
-        return $docs_modules;
-    }
-    //--------------------------------------------------------------------
+		// Make sure the builder knows where to look
+		foreach ($this->doc_folders as $alias => $folder) {
+			$this->docbuilder->addDocFolder($alias, $folder);
+		}
+
+		try {
+			$content = $this->docbuilder->readPage($this->current_path, $this->current_group);
+			$content = $this->docbuilder->postProcess($content, site_url(), current_url());
+
+			$data['sidebar'] = $this->buildSidebar($content);
+			$data['toc']     = $this->buildTOC();
+			$data['content'] = $content;
+			$data['page_title'] = $this->docbuilder->pageTitle();
+		} catch (Exception $e) {
+			$this->setMessage($e->getMessage(), 'warning');
+		}
+
+		$this->render($data, config_item('docs.cache_time'));
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Display search results and handles the search itself.
+	 *
+	 * @return void
+	 */
+	public function search()
+	{
+		$this->benchmark->mark('search_start');
+		$this->docsearch = new \Myth\Docs\Search();
+		$this->load->helper('markdown_extended');
+		$this->docsearch->registerFormatter('MarkdownExtended', true);
+
+		$data = array();
+
+		$terms = $this->input->post('search_terms');
+
+		if ($terms) {
+			$search_folders = $this->doc_folders;
+
+			$data['results'] = $this->docsearch->search($terms, $search_folders);
+		}
+
+		$this->benchmark->mark('search_end');
+
+		$data['search_time']  = $this->benchmark->elapsed_time('search_start', 'search_end');
+		$data['search_terms'] = $terms;
+		$data['page_title'] = 'Search Results';
+
+		$this->render($data);
+	}
+
+	//--------------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------------
+
+	/**
+	 * Determines which groups are allowed to be viewed by the current system
+	 * and the user/environment.
+	 *
+	 * todo Allow docs groups to be shown/hidden per-environment, using assoc-array for permitted environments
+	 */
+	private function determineVisibleGroups($current_group, $current_path)
+	{
+		// Is displaying docs permitted for this environment?
+		if (config_item('docs.permitted_environments')
+			&& !in_array(ENVIRONMENT, config_item('docs.permitted_environments'))
+		) {
+			$this->setMessage(lang('docs_env_disabled'), 'danger');
+			redirect();
+		}
+
+		$this->showAppDocs = config_item('docs.show_app_docs');
+		$this->showDevDocs = config_item('docs.show_dev_docs');
+		$this->tocFile     = config_item('docs.toc_file') ?: '_toc.ini';
+
+		// Make sure we can still get to the search method.
+		if ($current_group == 'search') {
+			$this->current_group = false;
+		} // Are we allowed to show developer docs in this environment?
+		elseif ($current_group == 'developer'
+				&& !$this->showDevDocs
+				&& ENVIRONMENT != 'development'
+		) {
+			if ($this->showAppDocs) {
+				$this->setMessage(lang('docs_not_allowed_dev'), 'warning');
+
+				redirect('docs/application');
+			}
+
+			show_error(lang('docs_not_allowed'));
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines the current doc group and file path from the current URL.
+	 *
+	 * Returns an array with the group and file path in the 0 and 1 positions, respectively.
+	 *
+	 * @return array
+	 */
+	private function determineFromURL()
+	{
+		$return = [
+			'', // Group
+			'', // File Path
+		];
+
+		$segments = $this->uri->segment_array();
+
+		// Remove the 'docs' from the array
+		// for now, we assume this is the first one
+		// since that is how Bonfire is setup to show docs
+		// @todo Make it so the path can be modified and this still works.
+		array_shift($segments);
+
+		// If nothing left, then assign the default group and redirect to
+		// a page we can do something with...
+		if (!count($segments)) {
+			redirect('docs/' . config_item('docs.default_group'));
+		}
+
+		// Do we have a group specified? Bonfire Docs requires that a group
+		// be part of the URI so it should be the first element on the array.
+		$return[0] = array_shift($segments);
+
+		// If there's any more left, then join them together and they'll
+		// form the path to the file. This will allow for subfolders with the
+		// docs folder itself.
+		$return[1] = count($segments) ? implode('/', $segments) : 'index';
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Builds a TOC for the sidebar out of files found in the following folders:
+	 *      - application/docs
+	 *      - bonfire/docs
+	 *      - {module}/docs
+	 *
+	 * @param $content  The HTML generated for the page content.
+	 * @return string   The HTML for the sidebar.
+	 */
+	private function buildSidebar(&$content)
+	{
+		$data = [];
+
+		// Set the remaining data for the view
+		$data['docsDir'] = 'docs/' . $this->current_group . '/';
+		$data['docsExt'] = config_item('docs.extension');
+
+		$data['docMap'] = $this->docbuilder->buildDocumentMap($content);
+
+		return $this->docbuilder->postProcess(
+			$this->load->view('docs/_document_map', $data, true),
+			site_url(),
+			current_url()
+		);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Builds out the nested lists of items that are needed
+	 */
+	private function buildTOC()
+	{
+		$folder = $this->doc_folders[$this->current_group] . '/';
+
+		$map = $this->docbuilder->buildTOC($folder);
+
+		return $this->docbuilder->postProcess(
+			$this->load->view('docs/_toc', ['map' => $map], true),
+			site_url(),
+			current_url()
+		);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Checks all modules to see if they include docs and prepares their doc
+	 * information for use in the sidebar.
+	 *
+	 * @return array
+	 */
+	private function get_module_docs()
+	{
+		$docs_modules = array();
+		foreach (\Bonfire\Modules::list_modules() as $module) {
+			$ignored_folders = array();
+			$path            = \Bonfire\Modules::path($module) . $this->docsDir;
+
+			// If these are developer docs, add the folder to the path.
+			if ($this->current_group == $this->docsTypeBf) {
+				$path .= '/' . $this->docsTypeBf;
+			} // For Application docs, ignore the 'developers' folder.
+			else {
+				$ignored_folders[] = $this->docsTypeBf;
+			}
+
+			if (is_dir($path)) {
+				$files = $this->get_folder_files($path, $module, $ignored_folders);
+				if (is_array($files) && count($files)) {
+					$docs_modules[$module] = $files;
+				}
+			}
+		}
+
+		return $docs_modules;
+	}
+	//--------------------------------------------------------------------
 
 }

myth/Docs/Search.php

Indentation +444 added lines, -444 removed lines

@@ -1,34 +1,34 @@ 
 <?php namespace Myth\Docs;
 /**
- * Sprint
- *
- * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- *
- * @package     Sprint
- * @author      Lonnie Ezell
- * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
- * @license     http://opensource.org/licenses/MIT  (MIT)
- * @link        http://sprintphp.com
- * @since       Version 1.0
- */
+	 * Sprint
+	 *
+	 * A set of power tools to enhance the CodeIgniter framework and provide consistent workflow.
+	 *
+	 * Permission is hereby granted, free of charge, to any person obtaining a copy
+	 * of this software and associated documentation files (the "Software"), to deal
+	 * in the Software without restriction, including without limitation the rights
+	 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	 * copies of the Software, and to permit persons to whom the Software is
+	 * furnished to do so, subject to the following conditions:
+	 *
+	 * The above copyright notice and this permission notice shall be included in
+	 * all copies or substantial portions of the Software.
+	 *
+	 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	 * THE SOFTWARE.
+	 *
+	 * @package     Sprint
+	 * @author      Lonnie Ezell
+	 * @copyright   Copyright 2014-2015, New Myth Media, LLC (http://newmythmedia.com)
+	 * @license     http://opensource.org/licenses/MIT  (MIT)
+	 * @link        http://sprintphp.com
+	 * @since       Version 1.0
+	 */
 
 use Myth\Docs\DocSearchInterface;
 
@@ -43,420 +43,420 @@ 
 class Search implements DocSearchInterface
 {
 
-    /**
-     * Minimum characters that can be submitted for a search.
-     *
-     * @var int
-     */
-    protected $min_chars = 3;
-
-    /**
-     * Maximum characters that can be submitted for a search.
-     *
-     * @var int
-     */
-    protected $max_chars = 30;
-
-    /**
-     * Valid file extensions we can search in.
-     *
-     * @var string
-     */
-    protected $allowed_file_types = 'html|htm|php|php4|php5|txt|md';
-
-    /**
-     * Which files should we skip over during our search?
-     *
-     * @var array
-     */
-    protected $skip_files = ['.', '..', '_404.md', '_toc.ini'];
-
-    /**
-     * How much of each file should we read.
-     * Use lower values for faster searches.
-     *
-     * @var int
-     */
-    protected $byte_size = 51200;
-
-    /**
-     * Number of words long (approximately)
-     * the result excerpt should be.
-     *
-     * @var int
-     */
-    protected $excerpt_length = 60;
-
-    /**
-     * The maximum number of results allowed from a single file.
-     *
-     * @var int
-     */
-    protected $max_per_file = 1;
-
-    protected $doc_folders = array();
-
-    protected $formatters = array();
-
-    //--------------------------------------------------------------------
-
-    /**
-     * The entry point for performing a search of the documentation.
-     *
-     * @param null $terms
-     * @param array $folders
-     *
-     * @return array|null
-     */
-    public function search($terms = null, $folders = [])
-    {
-        if (empty($terms) || empty($folders)) {
-            return null;
-        }
-
-        $results = [];
-        $this->doc_folders = $folders;
-
-        foreach ($folders as $group => $folder) {
-            $results = array_merge($results, $this->searchFolder($terms, $folder, $group));
-        }
-
-        return $results;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Searches a single directory worth of files.
-     *
-     * @param $term
-     * @param $folder
-     * @param $group_name
-     *
-     * @return array The results.
-     */
-    protected function searchFolder($term, $folder, $group_name)
-    {
-        $results = [];
-
-        $map = $this->directory_map($folder, 2);
-
-        $map = $this->flattenMap($map);
-
-        // Make sure we have something to work with.
-        if (! is_array($map) || (is_array($map) && ! count($map))) {
-            return [];
-        }
-
-        // Loop over each file and search the contents for our term.
-        foreach ($map as $dir => $file) {
-            $file_count = 0;
-
-            if (in_array($file, $this->skip_files)) {
-                continue;
-            }
-
-            // Is it a folder?
-            if (is_array($file) && count($file)) {
-                $results = array_merge($results, $this->searchFolder($term, $folder . '/' . $dir, $group_name));
-                continue;
-            }
-
-            // Make sure it's the right file type...
-            if (! preg_match("/({$this->allowed_file_types})/i", $file)) {
-                continue;
-            }
-
-            $path = is_string($dir) ? $folder . '/' . $dir . '/' . $file : $folder . '/' . $file;
-            $term_html = htmlentities($term);
-
-            // Read in the file text
-            $handle = fopen($path, 'r');
-            $text = fread($handle, $this->byte_size);
-
-            // Do we have a match in here somewhere?
-            $found = stristr($text, $term) || stristr($text, $term_html);
-
-            if (! $found) {
-                continue;
-            }
-
-            // Escape our terms to safely use in a preg_match
-            $excerpt = strip_tags($text);
-            $term = preg_quote($term);
-            $term = str_replace("/", "\/", "{$term}");
-            $term_html = preg_quote($term_html);
-            $term_html = str_replace("/", "\/", "{$term_html}");
-
-            // Add the item to our results with extracts.
-            if (preg_match_all(
-                "/((\s\S*){0,3})($term|$term_html)((\s?\S*){0,3})/i",
-                $excerpt,
-                $matches,
-                PREG_OFFSET_CAPTURE | PREG_SET_ORDER
-            )) {
-                foreach ($matches as $match) {
-                    if ($file_count >= $this->max_per_file) {
-                        continue;
-                    }
-                    $result_url = '/docs/' . $group_name . '/' . str_replace('.md', '', $file);
-
-                    foreach ($this->doc_folders as $alias => $folder) {
-                        $result_url = str_replace($folder, $alias, $result_url);
-                    }
-
-                    $results[] = [
-                        'title' => $this->extractTitle($excerpt, $file),
-                        'file' => $folder . '/' . $file,
-                        'url' => $result_url,
-                        'extract' => $this->buildExtract($excerpt, $term, $match[0][0])
-                    ];
-
-                    $file_count++;
-                }
-            }
-        }
-
-        return $results;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Stores the name of the callback method to run to convert the source
-     * files to viewable files. By default, this should be used to register
-     * a Mardown Extended formatter with the system, but could be used to
-     * extend the
-     *
-     * @param string $callback_name
-     * @param bool $cascade // If FALSE the formatting of a component ends here. If TRUE, will be passed to next formatter.
-     * @return $this
-     */
-    public function registerFormatter($callback_name = '', $cascade = false)
-    {
-        if (empty($callback_name)) return;
-
-        $this->formatters[] = array($callback_name => $cascade);
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Runs the text through the registered formatters.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function format($str)
-    {
-        if (! is_array($this->formatters)) return $str;
-
-        foreach ($this->formatters as $formatter) {
-            $method = key($formatter);
-            $cascade = $formatter[$method];
-
-            $str = call_user_func($method, $str);
-
-            if (! $cascade) return $str;
-        }
-
-        return $str;
-    }
-
-    //--------------------------------------------------------------------
-
-
-    //--------------------------------------------------------------------
-    // Protected Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Converts an array generated by directory_map into a flat array of
-     * folders, removing any nested folders and adding them to the path.
-     *
-     * @param $map
-     * @param $prefix   Used to recursively add the folder name...
-     * @return mixed
-     */
-    protected function flattenMap($map, $prefix = '')
-    {
-        if (! is_array($map) || ! count($map)) {
-            return $map;
-        }
-
-        $return = [];
-
-        foreach ($map as $folder => $files) {
-
-            // If it's a folder name and an array of files
-            // then call this method recursively to flatten it out.
-            if (is_array($files)) {
-                $return = array_merge($return, $this->flattenMap($files, $prefix . $folder));
-                continue;
-            }
-
-            // Else, add our prefix (if any) to the filename...
-            $return[] = $prefix . $files;
-        }
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Handles extracting the text surrounding our match and basic match formatting.
-     *
-     * @param $excerpt
-     * @param $term
-     * @param $match_string
-     *
-     * @return string
-     */
-    protected function buildExtract($excerpt, $term, $match_string)
-    {
-        // Find the character positions within the string that our match was found at.
-        // That way we'll know from what positions before and after this we want to grab it in.
-        $start_offset = stripos($excerpt, $match_string);
-
-        // Modify the start and end positions based on $this->excerpt_length / 2.
-        $buffer = floor($this->excerpt_length / 2);
-
-        // Adjust our start position
-        $start_offset = $start_offset - $buffer;
-        if ($start_offset < 0) {
-            $start_offset = 0;
-        }
-
-        $extract = substr($excerpt, $start_offset);
-
-        $extract = strip_tags($this->format($extract));
-
-        $extract = $this->firstXWords($extract, $this->excerpt_length);
-
-        // Wrap the search term in a span we can style.
-        $extract = str_ireplace($term, '<span class="term-hilight">' . $term . '</span>', $extract);
-
-        return $extract;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Extracts the title from a bit of markdown formatted text. If it doesn't
-     * have an h1 or h2, then it uses the filename.
-     *
-     * @param $excerpt
-     * @param $file
-     * @return string
-     */
-    protected function extractTitle($excerpt, $file)
-    {
-        $title = '';
-
-        // Easiest to work if this is split into lines.
-        $lines = explode("\n", $excerpt);
-
-        if (is_array($lines) && count($lines)) {
-            foreach ($lines as $line) {
-                if (strpos($line, '# ') === 0 || strpos($line, '## ') === 0) {
-                    $title = trim(str_replace('#', '', $line));
-                    break;
-                }
-            }
-        }
-
-        // If it's empty, we'll use the filename.
-        if (empty($title)) {
-            $title = str_replace('_', ' ', $file);
-            $title = str_replace('.md', ' ', $title);
-            $title = ucwords($title);
-        }
-
-        return $title;
-    }
-    //--------------------------------------------------------------------
-
-    /**
-     * Create a Directory Map
-     *
-     * Reads the specified directory and builds an array
-     * representation of it. Sub-folders contained with the
-     * directory will be mapped as well.
-     *
-     * @param    string $source_dir Path to source
-     * @param    int $directory_depth Depth of directories to traverse
-     *                        (0 = fully recursive, 1 = current dir, etc)
-     * @param    bool $hidden Whether to show hidden files
-     * @return    array
-     */
-    protected function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
-    {
-        if ($fp = @opendir($source_dir)) {
-            $filedata = array();
-            $new_depth = $directory_depth - 1;
-            $source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
-
-            while (FALSE !== ($file = readdir($fp))) {
-                // Remove '.', '..', and hidden files [optional]
-                if ($file === '.' OR $file === '..' OR ($hidden === FALSE && $file[0] === '.')) {
-                    continue;
-                }
-
-                is_dir($source_dir . $file) && $file .= DIRECTORY_SEPARATOR;
-
-                if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir . $file))
-                {
-                    $filedata[$file] = $this->directory_map($source_dir . $file, $new_depth, $hidden);
-                } else
-                {
-                    // Replace the directory separator here with a forward slash since
-                    // Windows uses backward slashes and not all browsers will auto-replace
-                    // those slashes in URLs.
-                    $filedata[] = str_replace(DIRECTORY_SEPARATOR, '/', $file);
-                }
-            }
-
-            closedir($fp);
-            return $filedata;
-        }
-
-        return FALSE;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the first 'X' words of a string.
-     *
-     * @param $str
-     * @param int $wordCount
-     * @return string
-     */
-    protected function firstXWords($str, $wordCount = 10)
-    {
-        return implode(
-            '',
-            array_slice(
-                preg_split(
-                    '/([\s,\.;\?\!]+)/',
-                    $str,
-                    $wordCount * 2 + 1,
-                    PREG_SPLIT_DELIM_CAPTURE
-                ),
-                0,
-                $wordCount * 2 - 1
-            )
-        );
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Minimum characters that can be submitted for a search.
+	 *
+	 * @var int
+	 */
+	protected $min_chars = 3;
+
+	/**
+	 * Maximum characters that can be submitted for a search.
+	 *
+	 * @var int
+	 */
+	protected $max_chars = 30;
+
+	/**
+	 * Valid file extensions we can search in.
+	 *
+	 * @var string
+	 */
+	protected $allowed_file_types = 'html|htm|php|php4|php5|txt|md';
+
+	/**
+	 * Which files should we skip over during our search?
+	 *
+	 * @var array
+	 */
+	protected $skip_files = ['.', '..', '_404.md', '_toc.ini'];
+
+	/**
+	 * How much of each file should we read.
+	 * Use lower values for faster searches.
+	 *
+	 * @var int
+	 */
+	protected $byte_size = 51200;
+
+	/**
+	 * Number of words long (approximately)
+	 * the result excerpt should be.
+	 *
+	 * @var int
+	 */
+	protected $excerpt_length = 60;
+
+	/**
+	 * The maximum number of results allowed from a single file.
+	 *
+	 * @var int
+	 */
+	protected $max_per_file = 1;
+
+	protected $doc_folders = array();
+
+	protected $formatters = array();
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * The entry point for performing a search of the documentation.
+	 *
+	 * @param null $terms
+	 * @param array $folders
+	 *
+	 * @return array|null
+	 */
+	public function search($terms = null, $folders = [])
+	{
+		if (empty($terms) || empty($folders)) {
+			return null;
+		}
+
+		$results = [];
+		$this->doc_folders = $folders;
+
+		foreach ($folders as $group => $folder) {
+			$results = array_merge($results, $this->searchFolder($terms, $folder, $group));
+		}
+
+		return $results;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Searches a single directory worth of files.
+	 *
+	 * @param $term
+	 * @param $folder
+	 * @param $group_name
+	 *
+	 * @return array The results.
+	 */
+	protected function searchFolder($term, $folder, $group_name)
+	{
+		$results = [];
+
+		$map = $this->directory_map($folder, 2);
+
+		$map = $this->flattenMap($map);
+
+		// Make sure we have something to work with.
+		if (! is_array($map) || (is_array($map) && ! count($map))) {
+			return [];
+		}
+
+		// Loop over each file and search the contents for our term.
+		foreach ($map as $dir => $file) {
+			$file_count = 0;
+
+			if (in_array($file, $this->skip_files)) {
+				continue;
+			}
+
+			// Is it a folder?
+			if (is_array($file) && count($file)) {
+				$results = array_merge($results, $this->searchFolder($term, $folder . '/' . $dir, $group_name));
+				continue;
+			}
+
+			// Make sure it's the right file type...
+			if (! preg_match("/({$this->allowed_file_types})/i", $file)) {
+				continue;
+			}
+
+			$path = is_string($dir) ? $folder . '/' . $dir . '/' . $file : $folder . '/' . $file;
+			$term_html = htmlentities($term);
+
+			// Read in the file text
+			$handle = fopen($path, 'r');
+			$text = fread($handle, $this->byte_size);
+
+			// Do we have a match in here somewhere?
+			$found = stristr($text, $term) || stristr($text, $term_html);
+
+			if (! $found) {
+				continue;
+			}
+
+			// Escape our terms to safely use in a preg_match
+			$excerpt = strip_tags($text);
+			$term = preg_quote($term);
+			$term = str_replace("/", "\/", "{$term}");
+			$term_html = preg_quote($term_html);
+			$term_html = str_replace("/", "\/", "{$term_html}");
+
+			// Add the item to our results with extracts.
+			if (preg_match_all(
+				"/((\s\S*){0,3})($term|$term_html)((\s?\S*){0,3})/i",
+				$excerpt,
+				$matches,
+				PREG_OFFSET_CAPTURE | PREG_SET_ORDER
+			)) {
+				foreach ($matches as $match) {
+					if ($file_count >= $this->max_per_file) {
+						continue;
+					}
+					$result_url = '/docs/' . $group_name . '/' . str_replace('.md', '', $file);
+
+					foreach ($this->doc_folders as $alias => $folder) {
+						$result_url = str_replace($folder, $alias, $result_url);
+					}
+
+					$results[] = [
+						'title' => $this->extractTitle($excerpt, $file),
+						'file' => $folder . '/' . $file,
+						'url' => $result_url,
+						'extract' => $this->buildExtract($excerpt, $term, $match[0][0])
+					];
+
+					$file_count++;
+				}
+			}
+		}
+
+		return $results;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Stores the name of the callback method to run to convert the source
+	 * files to viewable files. By default, this should be used to register
+	 * a Mardown Extended formatter with the system, but could be used to
+	 * extend the
+	 *
+	 * @param string $callback_name
+	 * @param bool $cascade // If FALSE the formatting of a component ends here. If TRUE, will be passed to next formatter.
+	 * @return $this
+	 */
+	public function registerFormatter($callback_name = '', $cascade = false)
+	{
+		if (empty($callback_name)) return;
+
+		$this->formatters[] = array($callback_name => $cascade);
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Runs the text through the registered formatters.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function format($str)
+	{
+		if (! is_array($this->formatters)) return $str;
+
+		foreach ($this->formatters as $formatter) {
+			$method = key($formatter);
+			$cascade = $formatter[$method];
+
+			$str = call_user_func($method, $str);
+
+			if (! $cascade) return $str;
+		}
+
+		return $str;
+	}
+
+	//--------------------------------------------------------------------
+
+
+	//--------------------------------------------------------------------
+	// Protected Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Converts an array generated by directory_map into a flat array of
+	 * folders, removing any nested folders and adding them to the path.
+	 *
+	 * @param $map
+	 * @param $prefix   Used to recursively add the folder name...
+	 * @return mixed
+	 */
+	protected function flattenMap($map, $prefix = '')
+	{
+		if (! is_array($map) || ! count($map)) {
+			return $map;
+		}
+
+		$return = [];
+
+		foreach ($map as $folder => $files) {
+
+			// If it's a folder name and an array of files
+			// then call this method recursively to flatten it out.
+			if (is_array($files)) {
+				$return = array_merge($return, $this->flattenMap($files, $prefix . $folder));
+				continue;
+			}
+
+			// Else, add our prefix (if any) to the filename...
+			$return[] = $prefix . $files;
+		}
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Handles extracting the text surrounding our match and basic match formatting.
+	 *
+	 * @param $excerpt
+	 * @param $term
+	 * @param $match_string
+	 *
+	 * @return string
+	 */
+	protected function buildExtract($excerpt, $term, $match_string)
+	{
+		// Find the character positions within the string that our match was found at.
+		// That way we'll know from what positions before and after this we want to grab it in.
+		$start_offset = stripos($excerpt, $match_string);
+
+		// Modify the start and end positions based on $this->excerpt_length / 2.
+		$buffer = floor($this->excerpt_length / 2);
+
+		// Adjust our start position
+		$start_offset = $start_offset - $buffer;
+		if ($start_offset < 0) {
+			$start_offset = 0;
+		}
+
+		$extract = substr($excerpt, $start_offset);
+
+		$extract = strip_tags($this->format($extract));
+
+		$extract = $this->firstXWords($extract, $this->excerpt_length);
+
+		// Wrap the search term in a span we can style.
+		$extract = str_ireplace($term, '<span class="term-hilight">' . $term . '</span>', $extract);
+
+		return $extract;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Extracts the title from a bit of markdown formatted text. If it doesn't
+	 * have an h1 or h2, then it uses the filename.
+	 *
+	 * @param $excerpt
+	 * @param $file
+	 * @return string
+	 */
+	protected function extractTitle($excerpt, $file)
+	{
+		$title = '';
+
+		// Easiest to work if this is split into lines.
+		$lines = explode("\n", $excerpt);
+
+		if (is_array($lines) && count($lines)) {
+			foreach ($lines as $line) {
+				if (strpos($line, '# ') === 0 || strpos($line, '## ') === 0) {
+					$title = trim(str_replace('#', '', $line));
+					break;
+				}
+			}
+		}
+
+		// If it's empty, we'll use the filename.
+		if (empty($title)) {
+			$title = str_replace('_', ' ', $file);
+			$title = str_replace('.md', ' ', $title);
+			$title = ucwords($title);
+		}
+
+		return $title;
+	}
+	//--------------------------------------------------------------------
+
+	/**
+	 * Create a Directory Map
+	 *
+	 * Reads the specified directory and builds an array
+	 * representation of it. Sub-folders contained with the
+	 * directory will be mapped as well.
+	 *
+	 * @param    string $source_dir Path to source
+	 * @param    int $directory_depth Depth of directories to traverse
+	 *                        (0 = fully recursive, 1 = current dir, etc)
+	 * @param    bool $hidden Whether to show hidden files
+	 * @return    array
+	 */
+	protected function directory_map($source_dir, $directory_depth = 0, $hidden = FALSE)
+	{
+		if ($fp = @opendir($source_dir)) {
+			$filedata = array();
+			$new_depth = $directory_depth - 1;
+			$source_dir = rtrim($source_dir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+
+			while (FALSE !== ($file = readdir($fp))) {
+				// Remove '.', '..', and hidden files [optional]
+				if ($file === '.' OR $file === '..' OR ($hidden === FALSE && $file[0] === '.')) {
+					continue;
+				}
+
+				is_dir($source_dir . $file) && $file .= DIRECTORY_SEPARATOR;
+
+				if (($directory_depth < 1 OR $new_depth > 0) && is_dir($source_dir . $file))
+				{
+					$filedata[$file] = $this->directory_map($source_dir . $file, $new_depth, $hidden);
+				} else
+				{
+					// Replace the directory separator here with a forward slash since
+					// Windows uses backward slashes and not all browsers will auto-replace
+					// those slashes in URLs.
+					$filedata[] = str_replace(DIRECTORY_SEPARATOR, '/', $file);
+				}
+			}
+
+			closedir($fp);
+			return $filedata;
+		}
+
+		return FALSE;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the first 'X' words of a string.
+	 *
+	 * @param $str
+	 * @param int $wordCount
+	 * @return string
+	 */
+	protected function firstXWords($str, $wordCount = 10)
+	{
+		return implode(
+			'',
+			array_slice(
+				preg_split(
+					'/([\s,\.;\?\!]+)/',
+					$str,
+					$wordCount * 2 + 1,
+					PREG_SPLIT_DELIM_CAPTURE
+				),
+				0,
+				$wordCount * 2 - 1
+			)
+		);
+	}
+
+	//--------------------------------------------------------------------
 
 }