ci-bonfire / Sprint

myth/CIModules/docs/controllers/Docs.php

Indentation +259 added lines, -259 removed lines

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