ci-bonfire / Sprint

myth/Controllers/CLIController.php

Indentation +138 added lines, -138 removed lines

@@ -41,144 +41,144 @@
  */
 class CLIController extends \CI_Controller {
 
-    /**
-     * Holds short descriptions for the public functions in this class.
-     * Each 'key' in the array should match the function name.
-     *
-     * @var array
-     */
-    protected $descriptions = [];
-
-    /**
-     * Holds long descriptions for the public functions in this class.
-     * Each 'key' in the array should match the function name.
-     * @var array
-     */
-    protected $long_descriptions = [];
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Ensures that we are running on the CLI, and collects basic settings
-     * like collecting our command line arguments into a pretty array.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-
-        // Restrict usage to the command line.
-        if (! is_cli() )
-        {
-            show_error( lang('cli_required') );
-        }
-
-        // Make sure the CLI library is loaded and ready.
+	/**
+	 * Holds short descriptions for the public functions in this class.
+	 * Each 'key' in the array should match the function name.
+	 *
+	 * @var array
+	 */
+	protected $descriptions = [];
+
+	/**
+	 * Holds long descriptions for the public functions in this class.
+	 * Each 'key' in the array should match the function name.
+	 * @var array
+	 */
+	protected $long_descriptions = [];
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Ensures that we are running on the CLI, and collects basic settings
+	 * like collecting our command line arguments into a pretty array.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Restrict usage to the command line.
+		if (! is_cli() )
+		{
+			show_error( lang('cli_required') );
+		}
+
+		// Make sure the CLI library is loaded and ready.
 //        CLI::_init();
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * A default index method that all CLI Controllers can share. Will
-     * list all of the methods and their short descriptions, if available.
-     */
-    public function index()
-    {
-        CLI::new_line();
-        CLI::write( lang('cli.available_commands') );
-
-        $this->sayDescriptions($this->descriptions);
-
-        CLI::new_line();
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Grabs the short description of a command, if it exists.
-     *
-     * @param null $method
-     */
-    public function describeMethod($method=null)
-    {
-        if (empty($this->descriptions[$method]))
-        {
-            return CLI::error( lang('cli.bad_description') );
-        }
-
-        CLI::write("\t{$this->descriptions[$method]}", 'yellow');
-    }
-
-    //--------------------------------------------------------------------
-
-    public function longDescribeMethod($method=null)
-    {
-        if (empty($this->long_descriptions[$method]))
-        {
-            return CLI::error( lang('cli.no_help') );
-        }
-
-        CLI::write("\t{$this->long_descriptions[$method]}", 'yellow');
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    protected function sayDescriptions($descriptions)
-    {
-        $names      = array_keys($descriptions);
-        $syntaxes   = array_column($descriptions, 0);
-        $descs      = array_column($descriptions, 1);
-
-        // Pad each item to the same length
-        $names      = $this->padArray($names);
-        $syntaxes   = $this->padArray($syntaxes);
-
-        for ($i=0; $i < count($names); $i++)
-        {
-            $out = CLI::color($names[$i], 'yellow');
-
-            // The rest of the items stay default color.
-            if (isset($syntaxes[$i]))
-            {
-                $out .= $syntaxes[$i];
-            }
-
-            if (isset($descs[$i]))
-            {
-                $out .= CLI::wrap($descs[$i], 125, strlen($names[$i]) + strlen($syntaxes[$i]));
-            }
-
-            CLI::write($out);
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns a new array where all of the string elements have
-     * been padding with trailling spaces to be the same length.
-     *
-     * @param array $array
-     * @param int $extra // How many extra spaces to add at the end
-     * @return array
-     */
-    protected function padArray($array, $extra=2)
-    {
-        $max = max(array_map('strlen', $array)) + $extra;
-
-        foreach ($array as &$item)
-        {
-            $item = str_pad($item, $max);
-        }
-
-        return $array;
-    }
-
-    //--------------------------------------------------------------------
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * A default index method that all CLI Controllers can share. Will
+	 * list all of the methods and their short descriptions, if available.
+	 */
+	public function index()
+	{
+		CLI::new_line();
+		CLI::write( lang('cli.available_commands') );
+
+		$this->sayDescriptions($this->descriptions);
+
+		CLI::new_line();
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Grabs the short description of a command, if it exists.
+	 *
+	 * @param null $method
+	 */
+	public function describeMethod($method=null)
+	{
+		if (empty($this->descriptions[$method]))
+		{
+			return CLI::error( lang('cli.bad_description') );
+		}
+
+		CLI::write("\t{$this->descriptions[$method]}", 'yellow');
+	}
+
+	//--------------------------------------------------------------------
+
+	public function longDescribeMethod($method=null)
+	{
+		if (empty($this->long_descriptions[$method]))
+		{
+			return CLI::error( lang('cli.no_help') );
+		}
+
+		CLI::write("\t{$this->long_descriptions[$method]}", 'yellow');
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	protected function sayDescriptions($descriptions)
+	{
+		$names      = array_keys($descriptions);
+		$syntaxes   = array_column($descriptions, 0);
+		$descs      = array_column($descriptions, 1);
+
+		// Pad each item to the same length
+		$names      = $this->padArray($names);
+		$syntaxes   = $this->padArray($syntaxes);
+
+		for ($i=0; $i < count($names); $i++)
+		{
+			$out = CLI::color($names[$i], 'yellow');
+
+			// The rest of the items stay default color.
+			if (isset($syntaxes[$i]))
+			{
+				$out .= $syntaxes[$i];
+			}
+
+			if (isset($descs[$i]))
+			{
+				$out .= CLI::wrap($descs[$i], 125, strlen($names[$i]) + strlen($syntaxes[$i]));
+			}
+
+			CLI::write($out);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns a new array where all of the string elements have
+	 * been padding with trailling spaces to be the same length.
+	 *
+	 * @param array $array
+	 * @param int $extra // How many extra spaces to add at the end
+	 * @return array
+	 */
+	protected function padArray($array, $extra=2)
+	{
+		$max = max(array_map('strlen', $array)) + $extra;
+
+		foreach ($array as &$item)
+		{
+			$item = str_pad($item, $max);
+		}
+
+		return $array;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Controllers/ThemedController.php

Indentation +353 added lines, -353 removed lines

@@ -41,358 +41,358 @@
  */
 class ThemedController extends BaseController
 {
-    /**
-     * Stores data variables to be sent to the view.
-     * @var array
-     */
-    protected $vars = array();
-
-    /**
-     * Stores current status message.
-     * @var
-     */
-    protected $message;
-
-    /**
-     * The UIKit to make available to the template views.
-     * @var string
-     */
-    protected $uikit = '';
-
-    /**
-     * An instance of an active Themer to use.
-     * @var null
-     */
-    protected $themer = null;
-
-    /**
-     * Allows per-controller override of theme.
-     * @var null
-     */
-    protected $theme = null;
-
-    /**
-     * Per-controller override of the current layout file.
-     * @var null
-     */
-    protected $layout = null;
-
-    /**
-     * Stores an array of javascript files.
-     * @var array
-     */
-    protected $external_scripts = array();
-
-    /**
-     * Stores an array of CSS stylesheets.
-     * @var array
-     */
-    protected $stylesheets = array();
-
-    /**
-     * A MenuCollection instance
-     * @var
-     */
-    protected $meta;
-
-    /**
-     * Whether set() should escape the output...
-     * @var bool
-     */
-    protected $auto_escape = null;
-
-    /**
-     * An instance of ZendFrameworks Escaper
-     * @var null
-     */
-    protected $escaper = null;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Constructor takes care of getting the template engine up and running
-     * and bound to our DI object, as well as any other preliminary needs,
-     * like detecting the variant to use, etc.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-
-        // Setup our Template Engine
-        $themer = config_item('active_themer');
-
-        if (empty($themer)) {
-            throw new \RuntimeException( lang('no_themer') );
-        }
-
-        $this->themer = new $themer( get_instance() );
-
-        // Register our paths with the themer
-        $paths = config_item('theme.paths');
-
-        foreach ($paths as $key => $path) {
-            $this->themer->addThemePath($key, $path);
-        }
-
-        // Set our default theme.
-        $this->themer->setDefaultTheme( config_item('theme.default_theme') );
-
-        // Register our variants with the engine.
-        $variants = config_item('theme.variants');
-
-        foreach ($variants as $key => $value) {
-            $this->themer->addVariant($key, $value);
-        }
-
-        $this->detectVariant();
-
-        // Ensure that our UIKit is loaded up if we're using one.
-        $uikit = config_item('theme.uikit');
-
-        if ($uikit)
-        {
-            $this->uikit = new $uikit();
-        }
-
-        // Load up our meta collection
-        $this->meta = new MetaCollection( get_instance() );
-
-        // Should we autoescape vars?
-        if (is_null($this->auto_escape))
-        {
-            $this->auto_escape = config_item( 'theme.auto_escape' );
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Provides a common interface with the other rendering methods to
-     * set the output of the method. Uses the current instance of $this->template.
-     * Ensures that any data we've stored through $this->setVar() are present
-     * and includes the status messages into the data.
-     *
-     * @param array $data
-     * @param int   $cache_time
-     */
-    public function render($data = array(), $cache_time=0)
-    {
-	    if ($cache_time > 0)
-	    {
-		    $this->output->cache( (int)$cache_time );
-	    }
-
-        // Determine the correct theme to use
-        $theme = ! empty($this->theme) ? $this->theme : config_item('theme.default_theme');
-        $this->themer->setTheme($theme);
-
-        // Determine the correct layout to use
-        $layout = !empty($this->layout) ? $this->layout : null;
-        $this->themer->setLayout($layout);
-
-        // Merge any saved vars into the data
-        // But first, escape the data if needed
-        if ($this->auto_escape)
-        {
-            $data = esc($data, 'html');
-        }
-        $data = array_merge($data, $this->vars);
-
-        // Make sure the MetaCollection is available in the view.
-        $data['html_meta'] = $this->meta;
-
-        // Include our UIKit so views can use it
-        if (! empty($this->uikit)) {
-            $data['uikit'] = $this->uikit;
-        }
-
-        // Build our notices from the theme's view file.
-        $data['notice'] = $this->themer->display($this->themer->theme() . ':notice', ["notice" => $this->message()]);
-
-        // Make sure any scripts/stylesheets are available to the view
-        $data['external_scripts'] = $this->external_scripts;
-        $data['stylesheets'] = $this->stylesheets;
-
-        $this->themer->set($data);
-
-        $this->output->set_content_type('html')
-                     ->set_output($this->themer->render());
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a data variable to be sent to the view during the render() method.
-     * Will auto-escape data on the way in, unless specifically told not to.
-     *
-     * Uses ZendFramework's Escaper to handle the data escaping,
-     * based on context. Valid contexts are:
-     *      - html
-     *      - htmlAttr
-     *      - js
-     *      - css
-     *      - url
-     *
-     * @param string $name
-     * @param mixed $value
-     * @param string $context
-     * @param bool $do_escape
-     */
-    public function setVar($name, $value = null, $context='html', $do_escape=null)
-    {
-        $escape = $do_escape == true ? true : $this->auto_escape;
-
-        if (is_null($this->escaper))
-        {
-            $this->escaper = new Escaper(config_item('charset'));
-        }
-
-        if (is_array($name))
-        {
-            foreach ($name as $k => $v)
-            {
-                $this->vars[$k] = $escape ? esc($v, $context, $this->escaper) : $v;
-            }
-        }
-        else
-        {
-            $this->vars[$name] = $escape ? esc($value, $context, $this->escaper) : $value;
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Status Messages
-    //--------------------------------------------------------------------
-
-    /**
-     * Sets a status message (for displaying small success/error messages).
-     * This is used in place of the session->flashdata functions since you
-     * don't always want to have to refresh the page to show the message.
-     *
-     * @param string $message The message to save.
-     * @param string $type The string to be included as the CSS class of the containing div.
-     */
-    public function setMessage($message = '', $type = 'info')
-    {
-        if (! empty($message)) {
-            if (isset($this->session)) {
-                $this->session->set_flashdata('message', $type . '::' . $message);
-            }
-
-            $this->message = array(
-                'type' => $type,
-                'message' => $message
-            );
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves the status message to display (if any).
-     *
-     * @param  string $message [description]
-     * @param  string $type [description]
-     * @return array
-     */
-    public function message($message = '', $type = 'info')
-    {
-        $return = array(
-            'message' => $message,
-            'type' => $type
-        );
-
-        // Does session data exist?
-        if (empty($message) && class_exists('CI_Session')) {
-            $message = $this->session->flashdata('message');
-
-            if (! empty($message)) {
-                // Split out our message parts
-                $temp_message = explode('::', $message);
-                $return['type'] = $temp_message[0];
-                $return['message'] = $temp_message[1];
-
-                unset($temp_message);
-            }
-        }
-
-        // If message is empty, we need to check our own storage.
-        if (empty($message)) {
-            if (empty($this->message['message'])) {
-                return '';
-            }
-
-            $return = $this->message;
-        }
-
-        // Clear our session data so we don't get extra messages on rare occasions.
-        if (class_exists('CI_Session')) {
-            $this->session->set_flashdata('message', '');
-        }
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Utility Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Detects whether the item is being displayed on a desktop, phone,
-     * or tablet device.
-     */
-    protected function detectVariant()
-    {
-        // Variant Detection and setup
-        if (config_item('autodetect_variant') === true) {
-            $detect = new \Mobile_Detect();
-
-            if ($detect->isMobile()) {
-                $this->template->setVariant('phone');
-            } else if ($detect->isTablet()) {
-                $this->template->setVariant('tablet');
-            }
-        }
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // 'Asset' functions
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an external javascript file to the 'external_scripts' array.
-     *
-     * @param [type] $filename [description]
-     */
-    public function addScript($filename)
-    {
-        if (strpos($filename, 'http') === FALSE) {
-            $filename = base_url() . 'assets/js/' . $filename;
-        }
-
-        $this->external_scripts[] = $filename;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Adds an external stylesheet file to the 'stylesheets' array.
-     */
-    public function addStyle($filename)
-    {
-        if (strpos($filename, 'http') === FALSE) {
-            $filename = base_url() . 'assets/css/' . $filename;
-        }
-
-        $this->stylesheets[] = $filename;
-    }
-
-    //--------------------------------------------------------------------
+	/**
+	 * Stores data variables to be sent to the view.
+	 * @var array
+	 */
+	protected $vars = array();
+
+	/**
+	 * Stores current status message.
+	 * @var
+	 */
+	protected $message;
+
+	/**
+	 * The UIKit to make available to the template views.
+	 * @var string
+	 */
+	protected $uikit = '';
+
+	/**
+	 * An instance of an active Themer to use.
+	 * @var null
+	 */
+	protected $themer = null;
+
+	/**
+	 * Allows per-controller override of theme.
+	 * @var null
+	 */
+	protected $theme = null;
+
+	/**
+	 * Per-controller override of the current layout file.
+	 * @var null
+	 */
+	protected $layout = null;
+
+	/**
+	 * Stores an array of javascript files.
+	 * @var array
+	 */
+	protected $external_scripts = array();
+
+	/**
+	 * Stores an array of CSS stylesheets.
+	 * @var array
+	 */
+	protected $stylesheets = array();
+
+	/**
+	 * A MenuCollection instance
+	 * @var
+	 */
+	protected $meta;
+
+	/**
+	 * Whether set() should escape the output...
+	 * @var bool
+	 */
+	protected $auto_escape = null;
+
+	/**
+	 * An instance of ZendFrameworks Escaper
+	 * @var null
+	 */
+	protected $escaper = null;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Constructor takes care of getting the template engine up and running
+	 * and bound to our DI object, as well as any other preliminary needs,
+	 * like detecting the variant to use, etc.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Setup our Template Engine
+		$themer = config_item('active_themer');
+
+		if (empty($themer)) {
+			throw new \RuntimeException( lang('no_themer') );
+		}
+
+		$this->themer = new $themer( get_instance() );
+
+		// Register our paths with the themer
+		$paths = config_item('theme.paths');
+
+		foreach ($paths as $key => $path) {
+			$this->themer->addThemePath($key, $path);
+		}
+
+		// Set our default theme.
+		$this->themer->setDefaultTheme( config_item('theme.default_theme') );
+
+		// Register our variants with the engine.
+		$variants = config_item('theme.variants');
+
+		foreach ($variants as $key => $value) {
+			$this->themer->addVariant($key, $value);
+		}
+
+		$this->detectVariant();
+
+		// Ensure that our UIKit is loaded up if we're using one.
+		$uikit = config_item('theme.uikit');
+
+		if ($uikit)
+		{
+			$this->uikit = new $uikit();
+		}
+
+		// Load up our meta collection
+		$this->meta = new MetaCollection( get_instance() );
+
+		// Should we autoescape vars?
+		if (is_null($this->auto_escape))
+		{
+			$this->auto_escape = config_item( 'theme.auto_escape' );
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Provides a common interface with the other rendering methods to
+	 * set the output of the method. Uses the current instance of $this->template.
+	 * Ensures that any data we've stored through $this->setVar() are present
+	 * and includes the status messages into the data.
+	 *
+	 * @param array $data
+	 * @param int   $cache_time
+	 */
+	public function render($data = array(), $cache_time=0)
+	{
+		if ($cache_time > 0)
+		{
+			$this->output->cache( (int)$cache_time );
+		}
+
+		// Determine the correct theme to use
+		$theme = ! empty($this->theme) ? $this->theme : config_item('theme.default_theme');
+		$this->themer->setTheme($theme);
+
+		// Determine the correct layout to use
+		$layout = !empty($this->layout) ? $this->layout : null;
+		$this->themer->setLayout($layout);
+
+		// Merge any saved vars into the data
+		// But first, escape the data if needed
+		if ($this->auto_escape)
+		{
+			$data = esc($data, 'html');
+		}
+		$data = array_merge($data, $this->vars);
+
+		// Make sure the MetaCollection is available in the view.
+		$data['html_meta'] = $this->meta;
+
+		// Include our UIKit so views can use it
+		if (! empty($this->uikit)) {
+			$data['uikit'] = $this->uikit;
+		}
+
+		// Build our notices from the theme's view file.
+		$data['notice'] = $this->themer->display($this->themer->theme() . ':notice', ["notice" => $this->message()]);
+
+		// Make sure any scripts/stylesheets are available to the view
+		$data['external_scripts'] = $this->external_scripts;
+		$data['stylesheets'] = $this->stylesheets;
+
+		$this->themer->set($data);
+
+		$this->output->set_content_type('html')
+					 ->set_output($this->themer->render());
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a data variable to be sent to the view during the render() method.
+	 * Will auto-escape data on the way in, unless specifically told not to.
+	 *
+	 * Uses ZendFramework's Escaper to handle the data escaping,
+	 * based on context. Valid contexts are:
+	 *      - html
+	 *      - htmlAttr
+	 *      - js
+	 *      - css
+	 *      - url
+	 *
+	 * @param string $name
+	 * @param mixed $value
+	 * @param string $context
+	 * @param bool $do_escape
+	 */
+	public function setVar($name, $value = null, $context='html', $do_escape=null)
+	{
+		$escape = $do_escape == true ? true : $this->auto_escape;
+
+		if (is_null($this->escaper))
+		{
+			$this->escaper = new Escaper(config_item('charset'));
+		}
+
+		if (is_array($name))
+		{
+			foreach ($name as $k => $v)
+			{
+				$this->vars[$k] = $escape ? esc($v, $context, $this->escaper) : $v;
+			}
+		}
+		else
+		{
+			$this->vars[$name] = $escape ? esc($value, $context, $this->escaper) : $value;
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Status Messages
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sets a status message (for displaying small success/error messages).
+	 * This is used in place of the session->flashdata functions since you
+	 * don't always want to have to refresh the page to show the message.
+	 *
+	 * @param string $message The message to save.
+	 * @param string $type The string to be included as the CSS class of the containing div.
+	 */
+	public function setMessage($message = '', $type = 'info')
+	{
+		if (! empty($message)) {
+			if (isset($this->session)) {
+				$this->session->set_flashdata('message', $type . '::' . $message);
+			}
+
+			$this->message = array(
+				'type' => $type,
+				'message' => $message
+			);
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves the status message to display (if any).
+	 *
+	 * @param  string $message [description]
+	 * @param  string $type [description]
+	 * @return array
+	 */
+	public function message($message = '', $type = 'info')
+	{
+		$return = array(
+			'message' => $message,
+			'type' => $type
+		);
+
+		// Does session data exist?
+		if (empty($message) && class_exists('CI_Session')) {
+			$message = $this->session->flashdata('message');
+
+			if (! empty($message)) {
+				// Split out our message parts
+				$temp_message = explode('::', $message);
+				$return['type'] = $temp_message[0];
+				$return['message'] = $temp_message[1];
+
+				unset($temp_message);
+			}
+		}
+
+		// If message is empty, we need to check our own storage.
+		if (empty($message)) {
+			if (empty($this->message['message'])) {
+				return '';
+			}
+
+			$return = $this->message;
+		}
+
+		// Clear our session data so we don't get extra messages on rare occasions.
+		if (class_exists('CI_Session')) {
+			$this->session->set_flashdata('message', '');
+		}
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Utility Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Detects whether the item is being displayed on a desktop, phone,
+	 * or tablet device.
+	 */
+	protected function detectVariant()
+	{
+		// Variant Detection and setup
+		if (config_item('autodetect_variant') === true) {
+			$detect = new \Mobile_Detect();
+
+			if ($detect->isMobile()) {
+				$this->template->setVariant('phone');
+			} else if ($detect->isTablet()) {
+				$this->template->setVariant('tablet');
+			}
+		}
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// 'Asset' functions
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an external javascript file to the 'external_scripts' array.
+	 *
+	 * @param [type] $filename [description]
+	 */
+	public function addScript($filename)
+	{
+		if (strpos($filename, 'http') === FALSE) {
+			$filename = base_url() . 'assets/js/' . $filename;
+		}
+
+		$this->external_scripts[] = $filename;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Adds an external stylesheet file to the 'stylesheets' array.
+	 */
+	public function addStyle($filename)
+	{
+		if (strpos($filename, 'http') === FALSE) {
+			$filename = base_url() . 'assets/css/' . $filename;
+		}
+
+		$this->stylesheets[] = $filename;
+	}
+
+	//--------------------------------------------------------------------
 }
 

myth/Cron/CronManager.php

Indentation +252 added lines, -252 removed lines

@@ -34,257 +34,257 @@
 
 class CronManager {
 
-    protected static $tasks = [];
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Schedules a new task in the system.
-     *
-     * @param $alias
-     * @param $time_string
-     * @param callable|string $task
-     */
-    public static function schedule($alias, $time_string, $task)
-    {
-        // Valid Alias?
-        if (! is_string($alias) || empty($alias))
-        {
-            throw new \RuntimeException( lang('cron.bad_alias') );
-        }
-
-        // Valid TimeString?
-        if (! is_string($time_string) || empty($time_string))
-        {
-            throw new \RuntimeException( lang('cron.bad_timestring') );
-        }
-
-        // Valid Task?
-        if (! is_callable($task) && ! is_string($task))
-        {
-            throw new \RuntimeException( lang('cron.bad_task') . $alias);
-        }
-
-        static::$tasks[$alias] = new CronTask($time_string, $task);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes a single task from the system.
-     *
-     * @param $alias
-     */
-    public static function remove($alias)
-    {
-        if (empty(static::$tasks[$alias]))
-        {
-            return null;
-        }
-
-        unset(static::$tasks[$alias]);
-
-        return true;
-    }
-
-    //--------------------------------------------------------------------
-
-
-    /**
-     * Provides an array of all tasks in the system. The format will be
-     * like:
-     *      [
-     *          'alias' => [
-     *              'next_run'  => '123456789',
-     *              'prev_run'  => '123456789',
-     *              'task'  => mixed
-     *          ],
-     *          ...
-     *      ]
-     */
-    public static function listAll($current_time='now')
-    {
-        if (! count(static::$tasks))
-        {
-            return null;
-        }
-
-        $output = array();
-
-        foreach (static::$tasks as $alias => $task)
-        {
-            $output[$alias] = [
-                'next_run'  => $task->nextRunDate($current_time),
-                'prev_run'  => $task->previousRunDate($current_time),
-                'task'      => $task->task()
-            ];
-        }
-
-        return $output;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the task object assigned to an alias.
-     *
-     * @param $alias
-     * @return null|CronTask object
-     */
-    public static function task($alias)
-    {
-        if (empty(static::$tasks[$alias]) )
-        {
-            return null;
-        }
-
-        return static::$tasks[$alias];
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns all tasks currently in the system.
-     *
-     * @return array
-     */
-    public static function tasks()
-    {
-        return count(static::$tasks) ? static::$tasks : null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Runs all tasks scheduled to run right now.
-     *
-     * Can be limited to a single task by passing it's alias in the first param.
-     *
-     * Returns the output of all task runs as a single string. Perfect for
-     * emailing to users on completion
-     *
-     * @param null $alias
-     * @param bool $force_run
-     * @param string $current_time
-     * @return string
-     */
-    public static function run($alias=null, $force_run=false, $current_time='now')
-    {
-        $tasks = static::$tasks;
-
-        if (! empty($alias) && isset($tasks[$alias]))
-        {
-            $tasks = [$alias => $tasks[$alias] ];
-        }
-
-        $output = '';
-
-        $count = 0; // How many tasks have ran?
-
-        foreach ($tasks as $alias => $task)
-        {
-            if ($task->isDue($current_time) || $force_run === true)
-            {
-                $output .= sprintf( lang('cron.running_task'), $alias);
-
-                try {
-                    $result = self::runTask($alias);
-
-                    if (is_bool($result))
-                    {
-                        $output .= $result === true ? lang('done') ."\n" : lang('failed') ."\n";
-                    }
-                    else if (is_string($result))
-                    {
-                        $output .= sprintf( lang('cron.done_with_msg'), $result);
-                    }
-                }
-                catch (\Exception $e)
-                {
-                    $output .= "[Exception] ". $e->getMessage() ."\n";
-                }
-
-                $count++;
-            }
-            else
-            {
-                $output .= sprintf( lang('cron.not_scheduled_until'), $alias, $task->nextRunDate() );
-            }
-        }
-
-        if (! $count)
-        {
-            $output .= lang('cron.nothing_scheduled');
-        }
-
-        return $output;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Clears all tasks from the system
-     */
-    public static function reset()
-    {
-        static::$tasks = [];
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Protected Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Runs a single Task.
-     *
-     * NOTE: Tasks MUST return a true/false value only.
-     *
-     * @param $alias
-     * @return bool
-     */
-    protected static function runTask($alias)
-    {
-        $task = static::$tasks[$alias]->task();
-
-        $success = false;
-
-        // If it's a standard callable item,
-        // then run it.
-        if (is_callable($task))
-        {
-            $success = call_user_func($task);
-        }
-
-        // Otherwise, if it's a string it should be
-        // a library:method string so try to run it.
-        else if (is_string($task) && ! empty($task) && strpos($task, ':') !== false)
-        {
-            list($class, $method) = explode(':', $task);
-
-            // Let PHP try to autoload it through any available autoloaders
-            // (including Composer and user's custom autoloaders). If we
-            // don't find it, then assume it's a CI library that we can reach.
-            if (class_exists($class)) {
-                $class = new $class();
-            } else {
-                get_instance()->load->library($class);
-                $class =& get_instance()->$class;
-            }
-
-            if (! method_exists($class, $method)) {
-                log_message('error', "[CRON] Method not found: {$class}::{$method}");
-                return $success;
-            }
-
-            // Call the class with our parameters
-            $success = $class->{$method}();
-        }
-
-        return $success;
-    }
-
-    //--------------------------------------------------------------------
+	protected static $tasks = [];
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Schedules a new task in the system.
+	 *
+	 * @param $alias
+	 * @param $time_string
+	 * @param callable|string $task
+	 */
+	public static function schedule($alias, $time_string, $task)
+	{
+		// Valid Alias?
+		if (! is_string($alias) || empty($alias))
+		{
+			throw new \RuntimeException( lang('cron.bad_alias') );
+		}
+
+		// Valid TimeString?
+		if (! is_string($time_string) || empty($time_string))
+		{
+			throw new \RuntimeException( lang('cron.bad_timestring') );
+		}
+
+		// Valid Task?
+		if (! is_callable($task) && ! is_string($task))
+		{
+			throw new \RuntimeException( lang('cron.bad_task') . $alias);
+		}
+
+		static::$tasks[$alias] = new CronTask($time_string, $task);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes a single task from the system.
+	 *
+	 * @param $alias
+	 */
+	public static function remove($alias)
+	{
+		if (empty(static::$tasks[$alias]))
+		{
+			return null;
+		}
+
+		unset(static::$tasks[$alias]);
+
+		return true;
+	}
+
+	//--------------------------------------------------------------------
+
+
+	/**
+	 * Provides an array of all tasks in the system. The format will be
+	 * like:
+	 *      [
+	 *          'alias' => [
+	 *              'next_run'  => '123456789',
+	 *              'prev_run'  => '123456789',
+	 *              'task'  => mixed
+	 *          ],
+	 *          ...
+	 *      ]
+	 */
+	public static function listAll($current_time='now')
+	{
+		if (! count(static::$tasks))
+		{
+			return null;
+		}
+
+		$output = array();
+
+		foreach (static::$tasks as $alias => $task)
+		{
+			$output[$alias] = [
+				'next_run'  => $task->nextRunDate($current_time),
+				'prev_run'  => $task->previousRunDate($current_time),
+				'task'      => $task->task()
+			];
+		}
+
+		return $output;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the task object assigned to an alias.
+	 *
+	 * @param $alias
+	 * @return null|CronTask object
+	 */
+	public static function task($alias)
+	{
+		if (empty(static::$tasks[$alias]) )
+		{
+			return null;
+		}
+
+		return static::$tasks[$alias];
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns all tasks currently in the system.
+	 *
+	 * @return array
+	 */
+	public static function tasks()
+	{
+		return count(static::$tasks) ? static::$tasks : null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Runs all tasks scheduled to run right now.
+	 *
+	 * Can be limited to a single task by passing it's alias in the first param.
+	 *
+	 * Returns the output of all task runs as a single string. Perfect for
+	 * emailing to users on completion
+	 *
+	 * @param null $alias
+	 * @param bool $force_run
+	 * @param string $current_time
+	 * @return string
+	 */
+	public static function run($alias=null, $force_run=false, $current_time='now')
+	{
+		$tasks = static::$tasks;
+
+		if (! empty($alias) && isset($tasks[$alias]))
+		{
+			$tasks = [$alias => $tasks[$alias] ];
+		}
+
+		$output = '';
+
+		$count = 0; // How many tasks have ran?
+
+		foreach ($tasks as $alias => $task)
+		{
+			if ($task->isDue($current_time) || $force_run === true)
+			{
+				$output .= sprintf( lang('cron.running_task'), $alias);
+
+				try {
+					$result = self::runTask($alias);
+
+					if (is_bool($result))
+					{
+						$output .= $result === true ? lang('done') ."\n" : lang('failed') ."\n";
+					}
+					else if (is_string($result))
+					{
+						$output .= sprintf( lang('cron.done_with_msg'), $result);
+					}
+				}
+				catch (\Exception $e)
+				{
+					$output .= "[Exception] ". $e->getMessage() ."\n";
+				}
+
+				$count++;
+			}
+			else
+			{
+				$output .= sprintf( lang('cron.not_scheduled_until'), $alias, $task->nextRunDate() );
+			}
+		}
+
+		if (! $count)
+		{
+			$output .= lang('cron.nothing_scheduled');
+		}
+
+		return $output;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Clears all tasks from the system
+	 */
+	public static function reset()
+	{
+		static::$tasks = [];
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Protected Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Runs a single Task.
+	 *
+	 * NOTE: Tasks MUST return a true/false value only.
+	 *
+	 * @param $alias
+	 * @return bool
+	 */
+	protected static function runTask($alias)
+	{
+		$task = static::$tasks[$alias]->task();
+
+		$success = false;
+
+		// If it's a standard callable item,
+		// then run it.
+		if (is_callable($task))
+		{
+			$success = call_user_func($task);
+		}
+
+		// Otherwise, if it's a string it should be
+		// a library:method string so try to run it.
+		else if (is_string($task) && ! empty($task) && strpos($task, ':') !== false)
+		{
+			list($class, $method) = explode(':', $task);
+
+			// Let PHP try to autoload it through any available autoloaders
+			// (including Composer and user's custom autoloaders). If we
+			// don't find it, then assume it's a CI library that we can reach.
+			if (class_exists($class)) {
+				$class = new $class();
+			} else {
+				get_instance()->load->library($class);
+				$class =& get_instance()->$class;
+			}
+
+			if (! method_exists($class, $method)) {
+				log_message('error', "[CRON] Method not found: {$class}::{$method}");
+				return $success;
+			}
+
+			// Call the class with our parameters
+			$success = $class->{$method}();
+		}
+
+		return $success;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Cron/CronTask.php

Indentation +291 added lines, -291 removed lines

@@ -45,301 +45,301 @@
  */
 class CronTask {
 
-    /**
-     * The original scheduled string.
-     * Any valid relative time string.
-     * http://php.net/manual/en/datetime.formats.relative.php
-     *
-     * @var
-     */
-    protected $schedule;
-
-    /**
-     * Stores the callable or library name:method to run.
-     *
-     * @var
-     */
-    protected $task;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Stores our scheduled string and actual task.
-     *
-     * @param $schedule
-     * @param callable $task
-     */
-    public function __construct($schedule, $task)
-    {
-        $this->schedule = $schedule;
-
-        // If $task is not callable, it should be a library:method
-        // string that we can parse. But it must have the colon in the string.
-        if (! is_callable($task) && strpos($task, ':') === false)
-        {
-            throw new \RuntimeException( lang('cron.invalid_task') );
-        }
-
-        $this->task = $task;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Calculates the next date this task is supposed to run.
-     *
-     * @param int|'now' $current_time
-     *
-     * @return timestamp|null
-     */
-    public function nextRunDate($current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        $scheduleType = $this->determineScheduleType($this->schedule);
-
-        switch ($scheduleType)
-        {
-            case 'time':
-                return $this->findDateInterval($this->schedule, 'next', $current_time);
-                break;
-            case 'ordinal':
-                return strtotime($this->schedule, $current_time);
-                break;
-            case 'increment':
-                return strtotime($this->schedule, $current_time);
-                break;
-        }
-
-        return null;
-    }
+	/**
+	 * The original scheduled string.
+	 * Any valid relative time string.
+	 * http://php.net/manual/en/datetime.formats.relative.php
+	 *
+	 * @var
+	 */
+	protected $schedule;
+
+	/**
+	 * Stores the callable or library name:method to run.
+	 *
+	 * @var
+	 */
+	protected $task;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Stores our scheduled string and actual task.
+	 *
+	 * @param $schedule
+	 * @param callable $task
+	 */
+	public function __construct($schedule, $task)
+	{
+		$this->schedule = $schedule;
+
+		// If $task is not callable, it should be a library:method
+		// string that we can parse. But it must have the colon in the string.
+		if (! is_callable($task) && strpos($task, ':') === false)
+		{
+			throw new \RuntimeException( lang('cron.invalid_task') );
+		}
+
+		$this->task = $task;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Calculates the next date this task is supposed to run.
+	 *
+	 * @param int|'now' $current_time
+	 *
+	 * @return timestamp|null
+	 */
+	public function nextRunDate($current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		$scheduleType = $this->determineScheduleType($this->schedule);
+
+		switch ($scheduleType)
+		{
+			case 'time':
+				return $this->findDateInterval($this->schedule, 'next', $current_time);
+				break;
+			case 'ordinal':
+				return strtotime($this->schedule, $current_time);
+				break;
+			case 'increment':
+				return strtotime($this->schedule, $current_time);
+				break;
+		}
+
+		return null;
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Calculates the last time the task should have ran.
-     *
-     * @param int|'now' $current_time
-     *
-     * @return timestamp|null
-     */
-    public function previousRunDate($current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        $scheduleType = $this->determineScheduleType($this->schedule);
-
-        switch ($scheduleType)
-        {
-            case 'time':
-                return $this->findDateInterval($this->schedule, 'prev', $current_time);
-                break;
-            case 'ordinal':
-                return $this->findPreviousOrdinal($this->schedule, $current_time);
-                break;
-            case 'increment':
-                return strtotime('-1 '. $this->schedule, $current_time);
-                break;
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines if the task is due to be run now.
-     *
-     * @param string $current_time
-     * @internal param $ int|'now' $current_time
-     *
-     * @return bool
-     */
-    public function isDue($current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        // For easier matching, and I can't imagine people needing cronjob
-        // accuracy to the seconds, we'll just take the current minute.
-        return date('Y-m-d H:i', $current_time) == date('Y-m-d H:i', $this->nextRunDate($current_time) );
-    }
+	//--------------------------------------------------------------------
+
+	/**
+	 * Calculates the last time the task should have ran.
+	 *
+	 * @param int|'now' $current_time
+	 *
+	 * @return timestamp|null
+	 */
+	public function previousRunDate($current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		$scheduleType = $this->determineScheduleType($this->schedule);
+
+		switch ($scheduleType)
+		{
+			case 'time':
+				return $this->findDateInterval($this->schedule, 'prev', $current_time);
+				break;
+			case 'ordinal':
+				return $this->findPreviousOrdinal($this->schedule, $current_time);
+				break;
+			case 'increment':
+				return strtotime('-1 '. $this->schedule, $current_time);
+				break;
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines if the task is due to be run now.
+	 *
+	 * @param string $current_time
+	 * @internal param $ int|'now' $current_time
+	 *
+	 * @return bool
+	 */
+	public function isDue($current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		// For easier matching, and I can't imagine people needing cronjob
+		// accuracy to the seconds, we'll just take the current minute.
+		return date('Y-m-d H:i', $current_time) == date('Y-m-d H:i', $this->nextRunDate($current_time) );
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Formats the timestamp produced by nextRunDate and previousRunDate
-     * into any format available to date.
-     *
-     * @param $format_string
-     * @return bool|string
-     */
-    public function format($format_string)
-    {
-        return date($format_string, strtotime($this->schedule));
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the associated task.
-     *
-     * return callable|string
-     */
-    public function task()
-    {
-        return $this->task;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Gets the original schedule string.
-     */
-    public function schedule()
-    {
-        return $this->schedule;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Checks the schedule text and determines how we have to treat
-     * the schedule when determining next and previous values.
-     *
-     * Potential Types are:
-     *
-     *  - increment         Can simply add a +x/-x to the front to get the value.
-     *  - time              Something like "every 5 minutes"
-     *  - ordinal           Like "first", "second", etc.
-     *
-     * @param $schedule
-     * @return null|string
-     */
-    public function determineScheduleType($schedule)
-    {
-        $incs = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sun', 'mon', 'tue',
-                'wed', 'thu', 'fri', 'sat', 'weekday', 'weekdays', 'midnight', 'noon'];
-        $bigger_incs = [ 'back of', 'front of', 'first day of', 'last day of'];
-        $ordinals = ['first', 'second', 'third', 'fourth', 'fifth', 'sixth', 'seventh', 'eighth', 'ninth', 'tenth', 'eleventh', 'twelfth'];
-        $schedule = trim( strtolower($schedule) );
-
-        $multiple_words = strpos($schedule, ' ');
-        $first_word = substr($schedule, 0, $multiple_words ? $multiple_words : strlen($schedule));
-
-        // Is the first character a number? Then it's a time
-        if ( is_numeric( $first_word ) )
-        {
-            return 'time';
-        }
-
-
-        // First, try the shorter increments. We do increments in
-        // two passes becuase this should be faster than the loop.
-        if (in_array($first_word, $incs))
-        {
-            return 'increment';
-        }
-
-        // But we have to loop before checking ordinals since
-        // ordinals may have same first word as these phrases.
-        foreach ($bigger_incs as $test)
-        {
-            if (strpos($schedule, $test) === 0)
-            {
-                return 'increment';
-            }
-        }
-
-        if (in_array($first_word, $ordinals))
-        {
-            return 'ordinal';
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines the correct time for 'time' type intervals where
-     * the timestamp is expected to happen every 'x period', like
-     * 'every 5 minutes', every 3 days, etc.
-     *
-     * @param $schedule
-     * @param $type
-     * @return float|int|null
-     */
-    public function findDateInterval($schedule, $type, $current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+	//--------------------------------------------------------------------
+
+	/**
+	 * Formats the timestamp produced by nextRunDate and previousRunDate
+	 * into any format available to date.
+	 *
+	 * @param $format_string
+	 * @return bool|string
+	 */
+	public function format($format_string)
+	{
+		return date($format_string, strtotime($this->schedule));
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the associated task.
+	 *
+	 * return callable|string
+	 */
+	public function task()
+	{
+		return $this->task;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Gets the original schedule string.
+	 */
+	public function schedule()
+	{
+		return $this->schedule;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Checks the schedule text and determines how we have to treat
+	 * the schedule when determining next and previous values.
+	 *
+	 * Potential Types are:
+	 *
+	 *  - increment         Can simply add a +x/-x to the front to get the value.
+	 *  - time              Something like "every 5 minutes"
+	 *  - ordinal           Like "first", "second", etc.
+	 *
+	 * @param $schedule
+	 * @return null|string
+	 */
+	public function determineScheduleType($schedule)
+	{
+		$incs = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sun', 'mon', 'tue',
+				'wed', 'thu', 'fri', 'sat', 'weekday', 'weekdays', 'midnight', 'noon'];
+		$bigger_incs = [ 'back of', 'front of', 'first day of', 'last day of'];
+		$ordinals = ['first', 'second', 'third', 'fourth', 'fifth', 'sixth', 'seventh', 'eighth', 'ninth', 'tenth', 'eleventh', 'twelfth'];
+		$schedule = trim( strtolower($schedule) );
+
+		$multiple_words = strpos($schedule, ' ');
+		$first_word = substr($schedule, 0, $multiple_words ? $multiple_words : strlen($schedule));
+
+		// Is the first character a number? Then it's a time
+		if ( is_numeric( $first_word ) )
+		{
+			return 'time';
+		}
+
+
+		// First, try the shorter increments. We do increments in
+		// two passes becuase this should be faster than the loop.
+		if (in_array($first_word, $incs))
+		{
+			return 'increment';
+		}
+
+		// But we have to loop before checking ordinals since
+		// ordinals may have same first word as these phrases.
+		foreach ($bigger_incs as $test)
+		{
+			if (strpos($schedule, $test) === 0)
+			{
+				return 'increment';
+			}
+		}
+
+		if (in_array($first_word, $ordinals))
+		{
+			return 'ordinal';
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines the correct time for 'time' type intervals where
+	 * the timestamp is expected to happen every 'x period', like
+	 * 'every 5 minutes', every 3 days, etc.
+	 *
+	 * @param $schedule
+	 * @param $type
+	 * @return float|int|null
+	 */
+	public function findDateInterval($schedule, $type, $current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
 
 //        list($int, $period) = explode(' ', $schedule);
 
-        $diff = strtotime($schedule, $current_time) - $current_time;
-
-        $return = null;
-
-        switch ($type)
-        {
-            case 'next':
-                $next = floor($current_time / $diff) * $diff;
-
-                // Does next already match the current time?
-                if (date('Y-m-d H:i', $next) == date('Y-m-d H:i', $current_time))
-                {
-                    $return = $next;
-                }
-                else {
-                    $return = $next + $diff;
-                }
-                break;
-            case 'prev':
-                $next = ceil($current_time / $diff) * $diff;
-                $return = $next - $diff;
-                break;
-        }
-
-        if (is_numeric($return))
-        {
-            $return = (int)$return;
-        }
-
-        return $return;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Determines the timestamp of the previous ordinal-based time, like
-     * 'second Monday'.
-     *
-     * @param $schedule
-     * @param string $current_time
-     * @return int|null
-     */
-    public function findPreviousOrdinal($schedule, $current_time='now')
-    {
-        $current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
-
-        if (empty($schedule)) return null;
-
-        // Loop through months in reverse, checking each one to
-        // see if the ordinal is in the past. If so - wer'e done.
-        foreach ([0, -1, -2, -3, -4, -5, -6, -7, -8, -9, -10, -11, -12] as $i)
-        {
-            $lastmonth = strtotime("last day of {$i} month", $current_time);
-
-            $test = strtotime($schedule, $lastmonth);
-
-            if ($test <= $current_time)
-            {
-                return $test;
-            }
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
+		$diff = strtotime($schedule, $current_time) - $current_time;
+
+		$return = null;
+
+		switch ($type)
+		{
+			case 'next':
+				$next = floor($current_time / $diff) * $diff;
+
+				// Does next already match the current time?
+				if (date('Y-m-d H:i', $next) == date('Y-m-d H:i', $current_time))
+				{
+					$return = $next;
+				}
+				else {
+					$return = $next + $diff;
+				}
+				break;
+			case 'prev':
+				$next = ceil($current_time / $diff) * $diff;
+				$return = $next - $diff;
+				break;
+		}
+
+		if (is_numeric($return))
+		{
+			$return = (int)$return;
+		}
+
+		return $return;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Determines the timestamp of the previous ordinal-based time, like
+	 * 'second Monday'.
+	 *
+	 * @param $schedule
+	 * @param string $current_time
+	 * @return int|null
+	 */
+	public function findPreviousOrdinal($schedule, $current_time='now')
+	{
+		$current_time = is_numeric($current_time) ? (int)$current_time : strtotime($current_time);
+
+		if (empty($schedule)) return null;
+
+		// Loop through months in reverse, checking each one to
+		// see if the ordinal is in the past. If so - wer'e done.
+		foreach ([0, -1, -2, -3, -4, -5, -6, -7, -8, -9, -10, -11, -12] as $i)
+		{
+			$lastmonth = strtotime("last day of {$i} month", $current_time);
+
+			$test = strtotime($schedule, $lastmonth);
+
+			if ($test <= $current_time)
+			{
+				return $test;
+			}
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Docs/Builder.php

Indentation +718 added lines, -718 removed lines

@@ -60,725 +60,725 @@
 class Builder implements DocBuilderInterface
 {
 
-    protected $docs_ext = '.md';
-
-    protected $ignore_files = ['_404.md'];
-
-    protected $doc_folders = [];
-
-    /**
-     * Stores the current folder alias,
-     * once the file has been found.
-     *
-     * @var null
-     */
-    protected $current_folder = null;
-
-    protected $table_classes = 'table table-hover';
-
-    protected $apppath = '';
-
-    protected $formatters = [];
-
-    protected $page_title = null;
-
-    //--------------------------------------------------------------------
-
-    public function __construct($config = array())
-    {
-        $this->apppath = ! empty($config['apppath']) ? rtrim($config['apppath'], '/') . '/' : '';
-    }
-
-    //--------------------------------------------------------------------
-
-    public function pageTitle()
-    {
-        return $this->page_title;
-    }
-
-    //--------------------------------------------------------------------
-
-
-
-    /**
-     * Does the actual work of reading in and parsing the help file.
-     * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
-     * it will limit it's search to that single folder. If nothing is passed, it will
-     * search through all of the folders in the order they were given to the library,
-     * until it finds the first one.
-     *
-     * @param string $path The 'path' of the file (relative to the docs
-     *                                 folder. Usually from the URI)
-     * @param string $restrictToFolder (Optional) The folder nickname
-     *
-     * @return string
-     */
-    public function readPage($path, $restrictToFolder = null)
-    {
-        // Clean up our path
-        $path = trim($path, '/ ');
-
-        $content = $this->locateAndReadFile($path, $restrictToFolder);
-
-        $content = $this->parse($content);
-
-        return $content;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Parses the contents. Currently runs through the Markdown Extended
-     * parser to convert to HTML.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function parse($str)
-    {
-        return $this->format($str);
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Perform a few housekeeping tasks on a page, like rewriting URLs to full
-     * URLs, not relative, ensuring they link correctly, etc.
-     *
-     * @param      $content
-     * @param null $site_url
-     * @param null $current_url
-     * @return string   The post-processed HTML.
-     */
-    public function postProcess($content, $site_url = null, $current_url = null)
-    {
-        if (empty($content)) {
-            return $content;
-        }
-
-        try {
-            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
-        } catch (\Exception $e) {
-            // SimpleXML barfed on us, so send back the un-modified content
-            return $content;
-        }
-
-        // Prepare some things and cleanup others
-        $groups = array_keys($this->doc_folders);
-        $site_url = rtrim($site_url, '/') . '/';
-        $current_url = rtrim($current_url, '#/');
-
-        // Try to determine the current_url if one isn't set.
-        if (empty($this->current_folder)) {
-            $this->current_folder = $this->detectCurrentFolder($current_url, $groups);
-        }
-
-        /*
+	protected $docs_ext = '.md';
+
+	protected $ignore_files = ['_404.md'];
+
+	protected $doc_folders = [];
+
+	/**
+	 * Stores the current folder alias,
+	 * once the file has been found.
+	 *
+	 * @var null
+	 */
+	protected $current_folder = null;
+
+	protected $table_classes = 'table table-hover';
+
+	protected $apppath = '';
+
+	protected $formatters = [];
+
+	protected $page_title = null;
+
+	//--------------------------------------------------------------------
+
+	public function __construct($config = array())
+	{
+		$this->apppath = ! empty($config['apppath']) ? rtrim($config['apppath'], '/') . '/' : '';
+	}
+
+	//--------------------------------------------------------------------
+
+	public function pageTitle()
+	{
+		return $this->page_title;
+	}
+
+	//--------------------------------------------------------------------
+
+
+
+	/**
+	 * Does the actual work of reading in and parsing the help file.
+	 * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
+	 * it will limit it's search to that single folder. If nothing is passed, it will
+	 * search through all of the folders in the order they were given to the library,
+	 * until it finds the first one.
+	 *
+	 * @param string $path The 'path' of the file (relative to the docs
+	 *                                 folder. Usually from the URI)
+	 * @param string $restrictToFolder (Optional) The folder nickname
+	 *
+	 * @return string
+	 */
+	public function readPage($path, $restrictToFolder = null)
+	{
+		// Clean up our path
+		$path = trim($path, '/ ');
+
+		$content = $this->locateAndReadFile($path, $restrictToFolder);
+
+		$content = $this->parse($content);
+
+		return $content;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Parses the contents. Currently runs through the Markdown Extended
+	 * parser to convert to HTML.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function parse($str)
+	{
+		return $this->format($str);
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Perform a few housekeeping tasks on a page, like rewriting URLs to full
+	 * URLs, not relative, ensuring they link correctly, etc.
+	 *
+	 * @param      $content
+	 * @param null $site_url
+	 * @param null $current_url
+	 * @return string   The post-processed HTML.
+	 */
+	public function postProcess($content, $site_url = null, $current_url = null)
+	{
+		if (empty($content)) {
+			return $content;
+		}
+
+		try {
+			$xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
+		} catch (\Exception $e) {
+			// SimpleXML barfed on us, so send back the un-modified content
+			return $content;
+		}
+
+		// Prepare some things and cleanup others
+		$groups = array_keys($this->doc_folders);
+		$site_url = rtrim($site_url, '/') . '/';
+		$current_url = rtrim($current_url, '#/');
+
+		// Try to determine the current_url if one isn't set.
+		if (empty($this->current_folder)) {
+			$this->current_folder = $this->detectCurrentFolder($current_url, $groups);
+		}
+
+		/*
          * Rewrite the URLs
          */
-        foreach ($xml->xpath('//a') as $link) {
-            $link = $this->reformatAnchor($link, $groups, $current_url, $site_url);
-        }
-
-        $content = $xml->asXML();
-        $content = trim(str_replace('<?xml version="1.0" standalone="yes"?>', '', $content));
-
-        // Clean up and style the tables
-        $content = str_replace('<table>', '<table class="' . $this->table_classes . '">', $content);
-
-        return $content;
-    }
-    //--------------------------------------------------------------------
-
-    /**
-     * Allows users to define the classes that are attached to
-     * generated tables.
-     *
-     * @param null $classes
-     * @return $this
-     */
-    public function setTableClasses($classes = null)
-    {
-        $this->table_classes = $classes;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Given the contents to render, will build a list of links for the sidebar
-     * out of the headings in the file.
-     *
-     * Note: Will ONLY use h2 and h3 to build the links from.
-     *
-     * Note: The $content passed in WILL be modified by adding named anchors
-     * that match up with the locations.
-     *
-     * @param string $content The HTML to analyse for headings.
-     * @return string
-     */
-    public function buildDocumentMap(&$content)
-    {
-        if (empty($content)) {
-            return $content;
-        }
-
-        // If $content already has a wrapping <div> and </div> tags, remove them,
-        // since we'll replace them just below.
-        if (strpos($content, '<div>') === 0) {
-            $content = substr($content, 5);
-
-            // Trailing div also?
-            if (substr($content, -6) == '</div>') {
-                $content = substr($content, 0, -6);
-            }
-        }
-
-        try {
-            $xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
-        } catch (\Exception $e) {
-            // SimpleXML barfed on us, so send back the un-modified content
-            return [];
-        }
-
-        $map = [];
-        list($map, $content) = $this->extractDocMapAndAddAnchors($content, $xml, $map);
-
-        return $map;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * 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
-     * @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 = null, $cascade = false)
-    {
-        if (empty($callback)) return;
-
-        $this->formatters[] = [
-            'callable' => $callback,
-            'cascade'  => (bool)$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 = $formatter['callable'];
-            $cascade = $formatter['cascade'];
-
-            $str = call_user_func($method, $str);
-
-            if (! $cascade) return $str;
-        }
-
-        return $str;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Table of Contents methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Retrieves the list of files in a folder and preps the name and filename
-     * so it's ready for creating the HTML.
-     *
-     * @param  String $folder The path to the folder to retrieve.
-     *
-     * @return Array  An associative array @see parse_ini_file for format
-     * details.
-     */
-    public function buildTOC($folder)
-    {
-        // If the toc file exists in the folder, use it to build the links.
-        if (is_file("{$folder}/_toc.ini")) {
-            $toc = parse_ini_file("{$folder}/_toc.ini", true);
-            return $this->columnizeTOC($toc);
-        }
-
-        // If the toc file does not exist, build the links by listing the files
-        // in the directory (and any sub-directories)
-        $map = $this->directory_map($folder);
-
-        // If directory_map can not open the directory or find any files inside
-        // the directory, return an empty array.
-        if (empty($map)) {
-            return [];
-        }
-
-        // If these docs are located in the /application/docs or /bonfire/docs
-        // directory, just use $this->current_group for the root.
-        // Module docs need $this->current_group and $type.
-        $tocRoot = $this->current_folder;
-        if ($this->current_folder != strtolower($folder)) {
-            $tocRoot .= '/' . strtolower($folder);
-        }
-
-        $toc = [];
-        foreach ($map as $files) {
-            // If $files isn't an array, then make it one so that all situations
-            // may be dealt with cleanly.
-            if (! is_array($files)) {
-                $files = [$files];
-            }
-
-            foreach ($files as $file) {
-                if (in_array($file, $this->ignore_files)) {
-                    continue;
-                }
-
-                // The title for the index is the passed $type. Otherwise,
-                // build the title from the file's name.
-                if (strpos($file, 'index') === false) {
-                    $title = str_replace($this->docs_ext, '', $file);
-                    $title = str_replace('_', ' ', $title);
-                    $title = ucwords($title);
-
-                    $toc["{$tocRoot}/{$file}"] = $title;
-                } else {
-                    $toc[$tocRoot] = $type;
-                }
-            }
-        }
-
-        $toc = $this->columnizeTOC($toc);
-
-        return $toc;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Sorts the passed TOC array into columns of as close to equal length
-     * as we can get it.
-     *
-     * @param $toc
-     * @return array
-     */
-    protected function columnizeTOC($toc)
-    {
-        $section_count = count($toc);
-
-        // First - determine the size of each 'section'.
-        $sizes = [];
-
-        foreach ($toc as $section => $chapters) {
-            $sizes[] = count($chapters);
-        }
-
-        $column_avg = (int)round(array_sum($sizes) / $section_count);
-
-        // Split things into 4 columns of approximately equal size.
-        // If we only have 4 columns (or less), then make sure to
-        // deal with that also.
-        $columns = [];
-
-        $current_column = 0;
-        $current_column_count = 0;
-        $keys = array_keys($toc);
-
-        for ($i = 0; $i <= $section_count; $i++) {
-            if (! isset($keys[$i])) {
-                continue;
-            }
-
-            $section = array_shift($toc);
-
-            // Can we stay in this column?
-            if ($current_column_count <= $column_avg && $section_count > 4) {
-                // Don't forget to account for the heading also.
-                $current_column_count += count($section) + 1;
-            } else {
-                $current_column_count = 0;
-                $current_column++;
-            }
-
-            $columns[$current_column][$keys[$i]] = $section;
-        }
-
-        return $columns;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Folder Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns the current docFolders array.
-     *
-     * @return array
-     */
-    public function docFolders()
-    {
-        return $this->doc_folders;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Registers a path to be used when searching for documentation files.
-     *
-     * @param $name     A nickname to reference it by later.
-     * @param $path     The server path to the folder.
-     * @return $this
-     */
-    public function addDocFolder($name, $path)
-    {
-        // Standardize the path
-        $path = realpath($path) . '/';
-
-        // realpath will return FALSE if the path doesn't exist
-        // or the script doesn't have access to it.
-        if (! $path || $path == '/') {
-            return $this;
-        }
-
-        $name = strtolower($name);
-
-        $this->doc_folders[$name] = $path;
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes a folder from the folders we scan for documentation files
-     * within.
-     *
-     * @param $name
-     * @return $this
-     */
-    public function removeDocFolder($name)
-    {
-        $name = strtolower($name);
-
-        if (isset($this->doc_folders[$name])) {
-            unset($this->doc_folders[$name]);
-        }
-
-        return $this;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Analyzes the passed in current url string and checks against
-     * a list of groups to determine what the current group is.
-     *
-     * @param $current_url
-     * @param $groups
-     * @return string
-     */
-    protected function detectCurrentFolder($current_url, $groups = [])
-    {
-        if (! is_array($groups)) {
-            return null;
-        }
-
-        $segments = explode('/', $current_url);
-
-        // We start from the back of the array since
-        // that's most likely to be close to the end.
-        $segments = array_reverse($segments);
-
-        foreach ($segments as $segment) {
-            foreach ($groups as $group) {
-                if (strtolower($group) == strtolower($segment)) {
-                    return $group;
-                }
-            }
-        }
-
-        // Nothing found?
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    //--------------------------------------------------------------------
-    // Private Methods
-    //--------------------------------------------------------------------
-
-    /**
-     * Locates the file on disk and reads the contents into a single string.
-     *
-     * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
-     * it will limit it's search to that single folder. If nothing is passed, it will
-     * search through all of the folders in the order they were given to the library,
-     * until it finds the first one.
-     *
-     * @param string $path The 'path' of the file (relative to the docs
-     *                                 folder. Usually from the URI)
-     * @param string $restrictToFolder (Optional) The nickname of one of the
-     *                                 folders to restrict the search to.
-     *
-     * @throws RuntimeException
-     * @return null|string
-     */
-    private function locateAndReadFile($path, $restrictToFolder = null)
-    {
-        $folders = $this->doc_folders;
-
-        if (! is_null($restrictToFolder)) {
-            // Make sure the folder exists
-            if (! is_null($restrictToFolder) && ! isset($this->doc_folders[$restrictToFolder])) {
-                throw new \RuntimeException('You must add the docs folder that you wish to find docs from.');
-            }
-
-            $folders = [$this->doc_folders[$restrictToFolder]];
-        }
-
-        foreach ($folders as $alias => $folder) {
-            if (file_exists($folder . $path . $this->docs_ext)) {
-                // Store the alias so we know which folder we're in.
-                $this->current_folder = $alias;
-
-                return file_get_contents($folder . $path . $this->docs_ext);
-            }
-        }
-
-        return null;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Re-formats the passed in link.
-     *
-     * @param $link
-     * @param $current_url
-     * @param $site_url
-     * @return mixed
-     */
-    private function reformatAnchor($link, $groups, $current_url, $site_url)
-    {
-        // Grab the href value.
-        $href = $link->attributes()->href;
-
-        // If the href is null, it's probably a named anchor with no content.
-        if (! $href) {
-            // Make sure it has an href, else the XML will not close this
-            // tag correctly.
-            $link['href'] = ' ';
-
-            return $link;
-        }
-
-        // Remove any trailing # signs
-        $href = rtrim($href, '# ');
-
-        // If the href starts with #, then attach the current_url to it
-        if ($href != '' && substr_compare($href, '#', 0, 1) === 0) {
-            $link['href'] = $current_url . $href;
-
-            return $link;
-        }
-
-        // If it's a full external path, go on...
-        if ((strpos($href, 'http://') !== false || strpos($href, 'https://') !== false) &&
-            strpos($href, $site_url) === false
-        ) {
-            $link['target'] = "_blank";
-            return $link;
-        }
-
-        // If it's a full local path, get rid of it.
-        if (strpos($href, $site_url) !== false) {
-            $href = str_replace($site_url, '', $href);
-        }
-
-        // Strip out some unnecessary items, just in case they're there.
-        if (substr($href, 0, strlen('docs/')) == 'docs/') {
-            $href = substr($href, strlen('docs/'));
-        }
-
-        // This includes 'bonfire/' if it was missed during the conversion.
-        if (substr($href, 0, strlen('bonfire/')) == 'bonfire/') {
-            $href = substr($href, strlen('bonfire/'));
-        }
-
-        // If another 'group' is not already defined at the head of the link
-        // then add the current group to it.
-        $group_found = false;
-
-        foreach ($groups as $group) {
-            if (strpos($href, $group) === 0) {
-                $group_found = true;
-            }
-        }
-
-        if (! $group_found) {
-            $href = $this->current_folder . '/' . $href;
-        }
-
-        // Convert to full site_url
-        if (strpos($href, 'http') !== 0) {
-            $href = $site_url . 'docs/' . ltrim($href, '/ ');
-        }
-
-        // Save the corrected href
-        $link['href'] = $href;
-
-        return $link;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Creates a Document Map based on <h2> and <h3> tags.
-     * Also adds named anchors into the $content so the map
-     * can link to the content properly.
-     *
-     * @param $content
-     * @param $xml
-     * @param $map
-     * @return array
-     */
-    protected function extractDocMapAndAddAnchors(&$content, $xml, $map)
-    {
-        // Holds the current h2 we're processing
-        $current_obj = [];
-
-        $currentChild = 0;
-
-        foreach ($xml->children() as $childType => $line) {
-            $currentChild++;
-
-            // If it's an h1 - take the first and make it
-            // our page title.
-            if ($childType == 'h1' && empty($this->page_title))
-            {
-                $this->page_title = (string)$line;
-            }
-
-            // Make sure that our current object is
-            // stored and reset.
-            if ($childType == 'h1' || $childType == 'h2') {
-                if (count($current_obj)) {
-                    $map[] = $current_obj;
-                    $current_obj = [];
-                }
-            }
-
-            if ($childType == 'h2') {
-                $name = (string)$line;
-                $link = strtolower(str_replace(' ', '_', (string)$line));
-
-                $current_obj['name'] = $name;
-                $current_obj['link'] = '#' . $link;
-                $current_obj['items'] = [];
-
-                // Insert a named anchor into the $content
-                $anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
-
-                $search = "<h2>{$name}</h2>";
-
-                $content = str_replace($search, $anchor . $search, $content);
-            } elseif ($childType == 'h3') {
-                // Make sure we have some place to store the items.
-                if (! isset($current_obj['items'])) {
-                    $current_obj['items'] = [];
-                }
-
-                $link = strtolower(str_replace(' ', '_', (string)$line));
-                $name = (string)$line;
-
-                $current_obj['items'][] = [
-                    'name' => $name,
-                    'link' => '#' . $link
-                ];
-
-                // Insert a named anchor into the $content
-                $anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
-
-                $search = "<h3>{$name}</h3>";
-
-                $content = str_replace($search, $anchor . $search, $content);
-            }
-
-            // Is this the last element? Then close out our current object.
-            if (count($xml) == $currentChild) {
-                if (count($current_obj)) {
-                    $map[] = $current_obj;
-                }
-            }
-        }
-        return [$map, $content];
-    }
-    //--------------------------------------------------------------------
-
-    /**
-     * 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] = directory_map($source_dir . $file, $new_depth, $hidden);
-                } else {
-                    $filedata[] = $file;
-                }
-            }
-
-            closedir($fp);
-            return $filedata;
-        }
-
-        return FALSE;
-    }
-
-    //--------------------------------------------------------------------
+		foreach ($xml->xpath('//a') as $link) {
+			$link = $this->reformatAnchor($link, $groups, $current_url, $site_url);
+		}
+
+		$content = $xml->asXML();
+		$content = trim(str_replace('<?xml version="1.0" standalone="yes"?>', '', $content));
+
+		// Clean up and style the tables
+		$content = str_replace('<table>', '<table class="' . $this->table_classes . '">', $content);
+
+		return $content;
+	}
+	//--------------------------------------------------------------------
+
+	/**
+	 * Allows users to define the classes that are attached to
+	 * generated tables.
+	 *
+	 * @param null $classes
+	 * @return $this
+	 */
+	public function setTableClasses($classes = null)
+	{
+		$this->table_classes = $classes;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Given the contents to render, will build a list of links for the sidebar
+	 * out of the headings in the file.
+	 *
+	 * Note: Will ONLY use h2 and h3 to build the links from.
+	 *
+	 * Note: The $content passed in WILL be modified by adding named anchors
+	 * that match up with the locations.
+	 *
+	 * @param string $content The HTML to analyse for headings.
+	 * @return string
+	 */
+	public function buildDocumentMap(&$content)
+	{
+		if (empty($content)) {
+			return $content;
+		}
+
+		// If $content already has a wrapping <div> and </div> tags, remove them,
+		// since we'll replace them just below.
+		if (strpos($content, '<div>') === 0) {
+			$content = substr($content, 5);
+
+			// Trailing div also?
+			if (substr($content, -6) == '</div>') {
+				$content = substr($content, 0, -6);
+			}
+		}
+
+		try {
+			$xml = new \SimpleXMLElement('<?xml version="1.0" standalone="yes"?><div>' . $content . '</div>');
+		} catch (\Exception $e) {
+			// SimpleXML barfed on us, so send back the un-modified content
+			return [];
+		}
+
+		$map = [];
+		list($map, $content) = $this->extractDocMapAndAddAnchors($content, $xml, $map);
+
+		return $map;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * 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
+	 * @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 = null, $cascade = false)
+	{
+		if (empty($callback)) return;
+
+		$this->formatters[] = [
+			'callable' => $callback,
+			'cascade'  => (bool)$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 = $formatter['callable'];
+			$cascade = $formatter['cascade'];
+
+			$str = call_user_func($method, $str);
+
+			if (! $cascade) return $str;
+		}
+
+		return $str;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Table of Contents methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Retrieves the list of files in a folder and preps the name and filename
+	 * so it's ready for creating the HTML.
+	 *
+	 * @param  String $folder The path to the folder to retrieve.
+	 *
+	 * @return Array  An associative array @see parse_ini_file for format
+	 * details.
+	 */
+	public function buildTOC($folder)
+	{
+		// If the toc file exists in the folder, use it to build the links.
+		if (is_file("{$folder}/_toc.ini")) {
+			$toc = parse_ini_file("{$folder}/_toc.ini", true);
+			return $this->columnizeTOC($toc);
+		}
+
+		// If the toc file does not exist, build the links by listing the files
+		// in the directory (and any sub-directories)
+		$map = $this->directory_map($folder);
+
+		// If directory_map can not open the directory or find any files inside
+		// the directory, return an empty array.
+		if (empty($map)) {
+			return [];
+		}
+
+		// If these docs are located in the /application/docs or /bonfire/docs
+		// directory, just use $this->current_group for the root.
+		// Module docs need $this->current_group and $type.
+		$tocRoot = $this->current_folder;
+		if ($this->current_folder != strtolower($folder)) {
+			$tocRoot .= '/' . strtolower($folder);
+		}
+
+		$toc = [];
+		foreach ($map as $files) {
+			// If $files isn't an array, then make it one so that all situations
+			// may be dealt with cleanly.
+			if (! is_array($files)) {
+				$files = [$files];
+			}
+
+			foreach ($files as $file) {
+				if (in_array($file, $this->ignore_files)) {
+					continue;
+				}
+
+				// The title for the index is the passed $type. Otherwise,
+				// build the title from the file's name.
+				if (strpos($file, 'index') === false) {
+					$title = str_replace($this->docs_ext, '', $file);
+					$title = str_replace('_', ' ', $title);
+					$title = ucwords($title);
+
+					$toc["{$tocRoot}/{$file}"] = $title;
+				} else {
+					$toc[$tocRoot] = $type;
+				}
+			}
+		}
+
+		$toc = $this->columnizeTOC($toc);
+
+		return $toc;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Sorts the passed TOC array into columns of as close to equal length
+	 * as we can get it.
+	 *
+	 * @param $toc
+	 * @return array
+	 */
+	protected function columnizeTOC($toc)
+	{
+		$section_count = count($toc);
+
+		// First - determine the size of each 'section'.
+		$sizes = [];
+
+		foreach ($toc as $section => $chapters) {
+			$sizes[] = count($chapters);
+		}
+
+		$column_avg = (int)round(array_sum($sizes) / $section_count);
+
+		// Split things into 4 columns of approximately equal size.
+		// If we only have 4 columns (or less), then make sure to
+		// deal with that also.
+		$columns = [];
+
+		$current_column = 0;
+		$current_column_count = 0;
+		$keys = array_keys($toc);
+
+		for ($i = 0; $i <= $section_count; $i++) {
+			if (! isset($keys[$i])) {
+				continue;
+			}
+
+			$section = array_shift($toc);
+
+			// Can we stay in this column?
+			if ($current_column_count <= $column_avg && $section_count > 4) {
+				// Don't forget to account for the heading also.
+				$current_column_count += count($section) + 1;
+			} else {
+				$current_column_count = 0;
+				$current_column++;
+			}
+
+			$columns[$current_column][$keys[$i]] = $section;
+		}
+
+		return $columns;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Folder Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns the current docFolders array.
+	 *
+	 * @return array
+	 */
+	public function docFolders()
+	{
+		return $this->doc_folders;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Registers a path to be used when searching for documentation files.
+	 *
+	 * @param $name     A nickname to reference it by later.
+	 * @param $path     The server path to the folder.
+	 * @return $this
+	 */
+	public function addDocFolder($name, $path)
+	{
+		// Standardize the path
+		$path = realpath($path) . '/';
+
+		// realpath will return FALSE if the path doesn't exist
+		// or the script doesn't have access to it.
+		if (! $path || $path == '/') {
+			return $this;
+		}
+
+		$name = strtolower($name);
+
+		$this->doc_folders[$name] = $path;
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes a folder from the folders we scan for documentation files
+	 * within.
+	 *
+	 * @param $name
+	 * @return $this
+	 */
+	public function removeDocFolder($name)
+	{
+		$name = strtolower($name);
+
+		if (isset($this->doc_folders[$name])) {
+			unset($this->doc_folders[$name]);
+		}
+
+		return $this;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Analyzes the passed in current url string and checks against
+	 * a list of groups to determine what the current group is.
+	 *
+	 * @param $current_url
+	 * @param $groups
+	 * @return string
+	 */
+	protected function detectCurrentFolder($current_url, $groups = [])
+	{
+		if (! is_array($groups)) {
+			return null;
+		}
+
+		$segments = explode('/', $current_url);
+
+		// We start from the back of the array since
+		// that's most likely to be close to the end.
+		$segments = array_reverse($segments);
+
+		foreach ($segments as $segment) {
+			foreach ($groups as $group) {
+				if (strtolower($group) == strtolower($segment)) {
+					return $group;
+				}
+			}
+		}
+
+		// Nothing found?
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	//--------------------------------------------------------------------
+	// Private Methods
+	//--------------------------------------------------------------------
+
+	/**
+	 * Locates the file on disk and reads the contents into a single string.
+	 *
+	 * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
+	 * it will limit it's search to that single folder. If nothing is passed, it will
+	 * search through all of the folders in the order they were given to the library,
+	 * until it finds the first one.
+	 *
+	 * @param string $path The 'path' of the file (relative to the docs
+	 *                                 folder. Usually from the URI)
+	 * @param string $restrictToFolder (Optional) The nickname of one of the
+	 *                                 folders to restrict the search to.
+	 *
+	 * @throws RuntimeException
+	 * @return null|string
+	 */
+	private function locateAndReadFile($path, $restrictToFolder = null)
+	{
+		$folders = $this->doc_folders;
+
+		if (! is_null($restrictToFolder)) {
+			// Make sure the folder exists
+			if (! is_null($restrictToFolder) && ! isset($this->doc_folders[$restrictToFolder])) {
+				throw new \RuntimeException('You must add the docs folder that you wish to find docs from.');
+			}
+
+			$folders = [$this->doc_folders[$restrictToFolder]];
+		}
+
+		foreach ($folders as $alias => $folder) {
+			if (file_exists($folder . $path . $this->docs_ext)) {
+				// Store the alias so we know which folder we're in.
+				$this->current_folder = $alias;
+
+				return file_get_contents($folder . $path . $this->docs_ext);
+			}
+		}
+
+		return null;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Re-formats the passed in link.
+	 *
+	 * @param $link
+	 * @param $current_url
+	 * @param $site_url
+	 * @return mixed
+	 */
+	private function reformatAnchor($link, $groups, $current_url, $site_url)
+	{
+		// Grab the href value.
+		$href = $link->attributes()->href;
+
+		// If the href is null, it's probably a named anchor with no content.
+		if (! $href) {
+			// Make sure it has an href, else the XML will not close this
+			// tag correctly.
+			$link['href'] = ' ';
+
+			return $link;
+		}
+
+		// Remove any trailing # signs
+		$href = rtrim($href, '# ');
+
+		// If the href starts with #, then attach the current_url to it
+		if ($href != '' && substr_compare($href, '#', 0, 1) === 0) {
+			$link['href'] = $current_url . $href;
+
+			return $link;
+		}
+
+		// If it's a full external path, go on...
+		if ((strpos($href, 'http://') !== false || strpos($href, 'https://') !== false) &&
+			strpos($href, $site_url) === false
+		) {
+			$link['target'] = "_blank";
+			return $link;
+		}
+
+		// If it's a full local path, get rid of it.
+		if (strpos($href, $site_url) !== false) {
+			$href = str_replace($site_url, '', $href);
+		}
+
+		// Strip out some unnecessary items, just in case they're there.
+		if (substr($href, 0, strlen('docs/')) == 'docs/') {
+			$href = substr($href, strlen('docs/'));
+		}
+
+		// This includes 'bonfire/' if it was missed during the conversion.
+		if (substr($href, 0, strlen('bonfire/')) == 'bonfire/') {
+			$href = substr($href, strlen('bonfire/'));
+		}
+
+		// If another 'group' is not already defined at the head of the link
+		// then add the current group to it.
+		$group_found = false;
+
+		foreach ($groups as $group) {
+			if (strpos($href, $group) === 0) {
+				$group_found = true;
+			}
+		}
+
+		if (! $group_found) {
+			$href = $this->current_folder . '/' . $href;
+		}
+
+		// Convert to full site_url
+		if (strpos($href, 'http') !== 0) {
+			$href = $site_url . 'docs/' . ltrim($href, '/ ');
+		}
+
+		// Save the corrected href
+		$link['href'] = $href;
+
+		return $link;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Creates a Document Map based on <h2> and <h3> tags.
+	 * Also adds named anchors into the $content so the map
+	 * can link to the content properly.
+	 *
+	 * @param $content
+	 * @param $xml
+	 * @param $map
+	 * @return array
+	 */
+	protected function extractDocMapAndAddAnchors(&$content, $xml, $map)
+	{
+		// Holds the current h2 we're processing
+		$current_obj = [];
+
+		$currentChild = 0;
+
+		foreach ($xml->children() as $childType => $line) {
+			$currentChild++;
+
+			// If it's an h1 - take the first and make it
+			// our page title.
+			if ($childType == 'h1' && empty($this->page_title))
+			{
+				$this->page_title = (string)$line;
+			}
+
+			// Make sure that our current object is
+			// stored and reset.
+			if ($childType == 'h1' || $childType == 'h2') {
+				if (count($current_obj)) {
+					$map[] = $current_obj;
+					$current_obj = [];
+				}
+			}
+
+			if ($childType == 'h2') {
+				$name = (string)$line;
+				$link = strtolower(str_replace(' ', '_', (string)$line));
+
+				$current_obj['name'] = $name;
+				$current_obj['link'] = '#' . $link;
+				$current_obj['items'] = [];
+
+				// Insert a named anchor into the $content
+				$anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
+
+				$search = "<h2>{$name}</h2>";
+
+				$content = str_replace($search, $anchor . $search, $content);
+			} elseif ($childType == 'h3') {
+				// Make sure we have some place to store the items.
+				if (! isset($current_obj['items'])) {
+					$current_obj['items'] = [];
+				}
+
+				$link = strtolower(str_replace(' ', '_', (string)$line));
+				$name = (string)$line;
+
+				$current_obj['items'][] = [
+					'name' => $name,
+					'link' => '#' . $link
+				];
+
+				// Insert a named anchor into the $content
+				$anchor = '<a name="' . $link . '" id="' . $link . '" ></a>';
+
+				$search = "<h3>{$name}</h3>";
+
+				$content = str_replace($search, $anchor . $search, $content);
+			}
+
+			// Is this the last element? Then close out our current object.
+			if (count($xml) == $currentChild) {
+				if (count($current_obj)) {
+					$map[] = $current_obj;
+				}
+			}
+		}
+		return [$map, $content];
+	}
+	//--------------------------------------------------------------------
+
+	/**
+	 * 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] = directory_map($source_dir . $file, $new_depth, $hidden);
+				} else {
+					$filedata[] = $file;
+				}
+			}
+
+			closedir($fp);
+			return $filedata;
+		}
+
+		return FALSE;
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Docs/DocBuilderInterface.php

Indentation +103 added lines, -103 removed lines

@@ -40,117 +40,117 @@
  */
 interface DocBuilderInterface
 {
-    /**
-     * Does the actual work of reading in and parsing the help file.
-     * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
-     * it will limit it's search to that single folder. If nothing is passed, it will
-     * search through all of the folders in the order they were given to the library,
-     * until it finds the first one.
-     *
-     * @param string $path The 'path' of the file (relative to the docs
-     *                                 folder. Usually from the URI)
-     * @param string $restrictToFolder (Optional) The folder nickname
-     *
-     * @return string
-     */
-    public function readPage($path, $restrictToFolder = null);
+	/**
+	 * Does the actual work of reading in and parsing the help file.
+	 * If a folder Nickname (see addDocFolder() ) is passed as the second parameter,
+	 * it will limit it's search to that single folder. If nothing is passed, it will
+	 * search through all of the folders in the order they were given to the library,
+	 * until it finds the first one.
+	 *
+	 * @param string $path The 'path' of the file (relative to the docs
+	 *                                 folder. Usually from the URI)
+	 * @param string $restrictToFolder (Optional) The folder nickname
+	 *
+	 * @return string
+	 */
+	public function readPage($path, $restrictToFolder = null);
 
-    /**
-     * Parses the contents. Currently runs through the Markdown Extended
-     * parser to convert to HTML.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function parse($str);
+	/**
+	 * Parses the contents. Currently runs through the Markdown Extended
+	 * parser to convert to HTML.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function parse($str);
 
-    /**
-     * Perform a few housekeeping tasks on a page, like rewriting URLs to full
-     * URLs, not relative, ensuring they link correctly, etc.
-     *
-     * @param      $content
-     * @param null $site_url
-     * @param null $current_url
-     * @return string   The post-processed HTML.
-     */
-    public function postProcess($content, $site_url = null, $current_url = null);
+	/**
+	 * Perform a few housekeeping tasks on a page, like rewriting URLs to full
+	 * URLs, not relative, ensuring they link correctly, etc.
+	 *
+	 * @param      $content
+	 * @param null $site_url
+	 * @param null $current_url
+	 * @return string   The post-processed HTML.
+	 */
+	public function postProcess($content, $site_url = null, $current_url = null);
 
-    /**
-     * Allows users to define the classes that are attached to
-     * generated tables.
-     *
-     * @param null $classes
-     * @return $this
-     */
-    public function setTableClasses($classes = null);
+	/**
+	 * Allows users to define the classes that are attached to
+	 * generated tables.
+	 *
+	 * @param null $classes
+	 * @return $this
+	 */
+	public function setTableClasses($classes = null);
 
-    /**
-     * Given the contents to render, will build a list of links for the sidebar
-     * out of the headings in the file.
-     *
-     * Note: Will ONLY use h2 and h3 to build the links from.
-     *
-     * Note: The $content passed in WILL be modified by adding named anchors
-     * that match up with the locations.
-     *
-     * @param string $content The HTML to analyse for headings.
-     * @return string
-     */
-    public function buildDocumentMap(&$content);
+	/**
+	 * Given the contents to render, will build a list of links for the sidebar
+	 * out of the headings in the file.
+	 *
+	 * Note: Will ONLY use h2 and h3 to build the links from.
+	 *
+	 * Note: The $content passed in WILL be modified by adding named anchors
+	 * that match up with the locations.
+	 *
+	 * @param string $content The HTML to analyse for headings.
+	 * @return string
+	 */
+	public function buildDocumentMap(&$content);
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    /**
-     * Runs the text through the registered formatters.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function format($str);
+	/**
+	 * Runs the text through the registered formatters.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function format($str);
 
-    /**
-     * Retrieves the list of files in a folder and preps the name and filename
-     * so it's ready for creating the HTML.
-     *
-     * @param  String $folder The path to the folder to retrieve.
-     *
-     * @return Array  An associative array @see parse_ini_file for format
-     * details.
-     */
-    public function buildTOC($folder);
+	/**
+	 * Retrieves the list of files in a folder and preps the name and filename
+	 * so it's ready for creating the HTML.
+	 *
+	 * @param  String $folder The path to the folder to retrieve.
+	 *
+	 * @return Array  An associative array @see parse_ini_file for format
+	 * details.
+	 */
+	public function buildTOC($folder);
 
-    /**
-     * Returns the current docFolders array.
-     *
-     * @return array
-     */
-    public function docFolders();
+	/**
+	 * Returns the current docFolders array.
+	 *
+	 * @return array
+	 */
+	public function docFolders();
 
-    /**
-     * Registers a path to be used when searching for documentation files.
-     *
-     * @param $name     A nickname to reference it by later.
-     * @param $path     The server path to the folder.
-     * @return $this
-     */
-    public function addDocFolder($name, $path);
+	/**
+	 * Registers a path to be used when searching for documentation files.
+	 *
+	 * @param $name     A nickname to reference it by later.
+	 * @param $path     The server path to the folder.
+	 * @return $this
+	 */
+	public function addDocFolder($name, $path);
 
-    /**
-     * Removes a folder from the folders we scan for documentation files
-     * within.
-     *
-     * @param $name
-     * @return $this
-     */
-    public function removeDocFolder($name);
+	/**
+	 * Removes a folder from the folders we scan for documentation files
+	 * within.
+	 *
+	 * @param $name
+	 * @return $this
+	 */
+	public function removeDocFolder($name);
 }

myth/Docs/DocSearchInterface.php

Indentation +59 added lines, -59 removed lines

@@ -1,71 +1,71 @@
 <?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
+	 */
 
 interface DocSearchInterface {
 
-    /**
-     * 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 = []);
+	/**
+	 * 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 = []);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
-    /**
-     * Runs the text through the registered formatters.
-     *
-     * @param $str
-     * @return mixed
-     */
-    public function format($str);
+	/**
+	 * Runs the text through the registered formatters.
+	 *
+	 * @param $str
+	 * @return mixed
+	 */
+	public function format($str);
 
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
 
 }

myth/Docs/Search.php

Indentation +415 added lines, -415 removed lines

@@ -41,420 +41,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
+			)
+		);
+	}
+
+	//--------------------------------------------------------------------
 
 }

myth/Events/Events.php

Indentation +169 added lines, -169 removed lines

@@ -36,176 +36,176 @@
 
 class Events {
 
-    /**
-     * The list of listeners.
-     *
-     * @var array
-     */
-    protected static $listeners = [];
-
-    /**
-     * Flag to let us know if we've read from the config file
-     * and have all of the defined events.
-     *
-     * @var bool
-     */
-    protected static $have_read_from_file = false;
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Registers an action to happen on an event. The action can be any sort
-     * of callable:
-     *
-     *  Events::on('create', 'myFunction');               // procedural function
-     *  Events::on('create', ['myClass', 'myMethod']);    // Class::method
-     *  Events::on('create', [$myInstance, 'myMethod']);  // Method on an existing instance
-     *  Events::on('create', function() {});              // Closure
-     *
-     * @param $event_name
-     * @param callable $callback
-     * @param int $priority
-     */
-    public static function on($event_name, callable $callback, $priority=EVENTS_PRIORITY_NORMAL)
-    {
-        if (! isset(self::$listeners[$event_name]))
-        {
-            self::$listeners[$event_name] = [
-                true,   // If there's only 1 item, it's sorted.
-                [$priority],
-                [$callback]
-            ];
-        }
-        else
-        {
-            self::$listeners[$event_name][0] = false; // Not sorted
-            self::$listeners[$event_name][1][] = $priority;
-            self::$listeners[$event_name][2][] = $callback;
-        }
-    }
+	/**
+	 * The list of listeners.
+	 *
+	 * @var array
+	 */
+	protected static $listeners = [];
+
+	/**
+	 * Flag to let us know if we've read from the config file
+	 * and have all of the defined events.
+	 *
+	 * @var bool
+	 */
+	protected static $have_read_from_file = false;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Registers an action to happen on an event. The action can be any sort
+	 * of callable:
+	 *
+	 *  Events::on('create', 'myFunction');               // procedural function
+	 *  Events::on('create', ['myClass', 'myMethod']);    // Class::method
+	 *  Events::on('create', [$myInstance, 'myMethod']);  // Method on an existing instance
+	 *  Events::on('create', function() {});              // Closure
+	 *
+	 * @param $event_name
+	 * @param callable $callback
+	 * @param int $priority
+	 */
+	public static function on($event_name, callable $callback, $priority=EVENTS_PRIORITY_NORMAL)
+	{
+		if (! isset(self::$listeners[$event_name]))
+		{
+			self::$listeners[$event_name] = [
+				true,   // If there's only 1 item, it's sorted.
+				[$priority],
+				[$callback]
+			];
+		}
+		else
+		{
+			self::$listeners[$event_name][0] = false; // Not sorted
+			self::$listeners[$event_name][1][] = $priority;
+			self::$listeners[$event_name][2][] = $callback;
+		}
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Runs through all subscribed methods running them one at a time,
-     * until either:
-     *  a) All subscribers have finished or
-     *  b) a method returns false, at which point execution of subscribers stops.
-     *
-     * @param $event_name
-     * @return bool
-     */
-    public static function trigger($event_name, array $arguments = [])
-    {
-        // Read in our config/events file so that we have them all!
-        if (! self::$have_read_from_file)
-        {
-            if (is_file(APPPATH .'config/events.php'))
-            {
-                include APPPATH .'config/events.php';
-            }
-            self::$have_read_from_file = true;
-        }
-
-        foreach (self::listeners($event_name) as $listener)
-        {
-            $result = call_user_func_array($listener, $arguments);
-
-            if ($result === false)
-            {
-                return false;
-            }
-        }
-
-        return true;
-    }
+	//--------------------------------------------------------------------
+
+	/**
+	 * Runs through all subscribed methods running them one at a time,
+	 * until either:
+	 *  a) All subscribers have finished or
+	 *  b) a method returns false, at which point execution of subscribers stops.
+	 *
+	 * @param $event_name
+	 * @return bool
+	 */
+	public static function trigger($event_name, array $arguments = [])
+	{
+		// Read in our config/events file so that we have them all!
+		if (! self::$have_read_from_file)
+		{
+			if (is_file(APPPATH .'config/events.php'))
+			{
+				include APPPATH .'config/events.php';
+			}
+			self::$have_read_from_file = true;
+		}
+
+		foreach (self::listeners($event_name) as $listener)
+		{
+			$result = call_user_func_array($listener, $arguments);
+
+			if ($result === false)
+			{
+				return false;
+			}
+		}
+
+		return true;
+	}
     
-    //--------------------------------------------------------------------
-
-    /**
-     * Returns an array of listeners for a single event. They are
-     * sorted by priority.
-     *
-     * If the listener could not be found, returns FALSE, or TRUE if
-     * it was removed.
-     *
-     * @param $event_name
-     * @return array
-     */
-    public static function listeners($event_name)
-    {
-        if (! isset(self::$listeners[$event_name]))
-        {
-            return [];
-        }
-
-        // The list is not sorted
-        if (! self::$listeners[$event_name][0])
-        {
-            // Sort it!
-            array_multisort(self::$listeners[$event_name][1], SORT_NUMERIC, self::$listeners[$event_name][2]);
-
-            // Mark it as sorted already!
-            self::$listeners[$event_name][0] = true;
-        }
-
-        return self::$listeners[$event_name][2];
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes a single listener from an event.
-     *
-     * If the listener couldn't be found, returns FALSE, else TRUE if
-     * it was removed.
-     *
-     * @param $event_name
-     * @param callable $listener
-     * @return bool
-     */
-    public static function removeListener($event_name, callable $listener)
-    {
-        if (! isset(self::$listeners[$event_name]))
-        {
-            return false;
-        }
-
-        foreach (self::$listeners[$event_name][2] as $index => $check)
-        {
-            if ($check === $listener)
-            {
-                unset(self::$listeners[$event_name][1][$index]);
-                unset(self::$listeners[$event_name][2][$index]);
-
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    //--------------------------------------------------------------------
-
-    /**
-     * Removes all listeners.
-     *
-     * If the event_name is specified, only listeners for that event will be
-     * removed, otherwise all listeners for all events are removed.
-     *
-     * @param null $event_name
-     */
-    public static function removeAllListeners($event_name=null)
-    {
-        if (! is_null($event_name))
-        {
-            unset(self::$listeners[$event_name]);
-        }
-        else {
-            self::$listeners = [];
-        }
-    }
-
-    //--------------------------------------------------------------------
+	//--------------------------------------------------------------------
+
+	/**
+	 * Returns an array of listeners for a single event. They are
+	 * sorted by priority.
+	 *
+	 * If the listener could not be found, returns FALSE, or TRUE if
+	 * it was removed.
+	 *
+	 * @param $event_name
+	 * @return array
+	 */
+	public static function listeners($event_name)
+	{
+		if (! isset(self::$listeners[$event_name]))
+		{
+			return [];
+		}
+
+		// The list is not sorted
+		if (! self::$listeners[$event_name][0])
+		{
+			// Sort it!
+			array_multisort(self::$listeners[$event_name][1], SORT_NUMERIC, self::$listeners[$event_name][2]);
+
+			// Mark it as sorted already!
+			self::$listeners[$event_name][0] = true;
+		}
+
+		return self::$listeners[$event_name][2];
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes a single listener from an event.
+	 *
+	 * If the listener couldn't be found, returns FALSE, else TRUE if
+	 * it was removed.
+	 *
+	 * @param $event_name
+	 * @param callable $listener
+	 * @return bool
+	 */
+	public static function removeListener($event_name, callable $listener)
+	{
+		if (! isset(self::$listeners[$event_name]))
+		{
+			return false;
+		}
+
+		foreach (self::$listeners[$event_name][2] as $index => $check)
+		{
+			if ($check === $listener)
+			{
+				unset(self::$listeners[$event_name][1][$index]);
+				unset(self::$listeners[$event_name][2][$index]);
+
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Removes all listeners.
+	 *
+	 * If the event_name is specified, only listeners for that event will be
+	 * removed, otherwise all listeners for all events are removed.
+	 *
+	 * @param null $event_name
+	 */
+	public static function removeAllListeners($event_name=null)
+	{
+		if (! is_null($event_name))
+		{
+			unset(self::$listeners[$event_name]);
+		}
+		else {
+			self::$listeners = [];
+		}
+	}
+
+	//--------------------------------------------------------------------
 
 }