Controller_Userguide
› Controller_Template
› Kohana_Controller_Template
› Controller
› Kohana_Controller

Class Contents

Class declared in MODPATH/userguide/classes/controller/userguide.php on line 9.

Properties

Methods

protected function _get_all_menu_markdown()
{
	// Only do this once per request...
	static $markdown = '';
	
	if (empty($markdown))
	{
		// Get core menu items
		$file = $this->file('menu');

		if ($file AND $text = file_get_contents($file))
		{
			$markdown .= $text;
		}
		
		// Look in module specific files
		foreach(Kohana::modules() as $module => $path)
		{
			if ($file = $this->file('menu.'.$module) AND $text = file_get_contents($file))
			{
				// Concatenate markdown to produce one string containing all menu items
				$markdown .="\n".$text;
			}
		}
	}
	
	return $markdown;
}

public function action_api()
{
	// Enable the missing class autoloader
	spl_autoload_register(array('Kodoc_Missing', 'create_class'));

	// Get the class from the request
	$class = $this->request->param('class');

	if ($class)
	{
		try
		{
			$_class = Kodoc_Class::factory($class);
		
			if ( ! Kodoc::show_class($_class))
				throw new Exception(__('That class is hidden'));
		}
		catch (Exception $e)
		{
			return $this->error(__('API Reference: Class not found.'));
		}
		
		$this->template->title = $class;

		$this->template->content = View::factory('userguide/api/class')
			->set('doc', Kodoc::factory($class))
			->set('route', $this->request->route);
	}
	else
	{
		$this->template->title = __('Table of Contents');

		$this->template->content = View::factory('userguide/api/toc')
			->set('classes', Kodoc::class_methods())
			->set('route', $this->request->route);
	}

	// Attach the menu to the template
	$this->template->menu = Kodoc::menu();

	// Bind the breadcrumb
	$this->template->bind('breadcrumb', $breadcrumb);

	// Get the docs URI
	$guide = Route::get('docs/guide');

	// Add the breadcrumb
	$breadcrumb = array();
	$breadcrumb[$this->guide->uri(array('page' => NULL))] = __('User Guide');
	$breadcrumb[$this->request->route->uri()] = $this->title('api');
	$breadcrumb[] = $this->template->title;
}

public function action_docs()
{
	$page = $this->request->param('page');

	if ( ! $page)
	{
		// Redirect to the default page
		$this->request->redirect($this->guide->uri(array('page' => Kohana::config('userguide')->default_page)));
	}

	$file = $this->file($page);

	if ( ! $file)
	{
		$this->error(__('Userguide page not found'));
		return;
	}

	// Set the page title
	$this->template->title = $this->title($page);

	// Parse the page contents into the template
	$this->template->content = Markdown(file_get_contents($file));

	// Attach the menu to the template
	$this->template->menu = Markdown(file_get_contents($this->file('menu')));
	
	// Bind module menu items
	$this->template->bind('module_menus', $module_menus);
	
	// Attach module-specific menu items
	$module_menus = array();
	
	foreach(Kohana::modules() as $module => $path)
	{
		if ($file = $this->file('menu.'.$module))
		{
			$module_menus[$module] = Markdown(file_get_contents($file)); 
		}
	}

	// Bind the breadcrumb
	$this->template->bind('breadcrumb', $breadcrumb);

	// Add the breadcrumb
	$breadcrumb = array();
	$breadcrumb[$this->guide->uri()] = __('User Guide');
	$breadcrumb[] = $this->section($page);
	$breadcrumb[] = $this->template->title;
}

public function action_media()
{
	// Generate and check the ETag for this file
	$this->request->check_cache(sha1($this->request->uri));

	// Get the file path from the request
	$file = $this->request->param('file');

	// Find the file extension
	$ext = pathinfo($file, PATHINFO_EXTENSION);

	// Remove the extension from the filename
	$file = substr($file, 0, -(strlen($ext) + 1));

	if ($file = Kohana::find_file('media', $file, $ext))
	{
		// Send the file content as the response
		$this->request->response = file_get_contents($file);
	}
	else
	{
		// Return a 404 status
		$this->request->status = 404;
	}

	// Set the proper headers to allow caching
	$this->request->headers['Content-Type']   = File::mime_by_ext($ext);
	$this->request->headers['Content-Length'] = filesize($file);
	$this->request->headers['Last-Modified']  = date('r', filemtime($file));
}

public function after()
{
	if ($this->auto_render)
	{
		// Get the media route
		$media = Route::get('docs/media');

		// Add styles
		$this->template->styles = array(
			$media->uri(array('file' => 'css/print.css'))  => 'print',
			$media->uri(array('file' => 'css/screen.css')) => 'screen',
			$media->uri(array('file' => 'css/kodoc.css'))  => 'screen',
			$media->uri(array('file' => 'css/shCore.css')) => 'screen',
			$media->uri(array('file' => 'css/shThemeKodoc.css')) => 'screen',
		);

		// Add scripts
		$this->template->scripts = array(
			$media->uri(array('file' => 'js/jquery.min.js')),
			$media->uri(array('file' => 'js/kodoc.js')),
			$media->uri(array('file' => 'js/shCore.js')),
			$media->uri(array('file' => 'js/shBrushPhp.js')),
		);

		// Add languages
		$this->template->translations = Kohana::message('userguide', 'translations');
	}

	return parent::after();
}

public function before()
{
	if ($this->request->action === 'media')
	{
		// Do not template media files
		$this->auto_render = FALSE;
	}
	else
	{
		// Grab the necessary routes
		$this->media = Route::get('docs/media');
		$this->guide = Route::get('docs/guide');

		if (isset($_GET['lang']))
		{
			$lang = $_GET['lang'];

			// Load the accepted language list
			$translations = array_keys(Kohana::message('userguide', 'translations'));

			if (in_array($lang, $translations))
			{
				// Set the language cookie
				Cookie::set('userguide_language', $lang, Date::YEAR);
			}

			// Reload the page
			$this->request->redirect($this->request->uri);
		}

		// Set the translation language
		I18n::$lang = Cookie::get('userguide_language', Kohana::config('userguide')->lang);

		if (defined('MARKDOWN_PARSER_CLASS'))
		{
			throw new Kohana_Exception('Markdown parser already registered. Live documentation will not work in your environment.');
		}

		// Use customized Markdown parser
		define('MARKDOWN_PARSER_CLASS', 'Kodoc_Markdown');

		if ( ! class_exists('Markdown', FALSE))
		{
			// Load Markdown support
			require Kohana::find_file('vendor', 'markdown/markdown');
		}

		// Set the base URL for links and images
		Kodoc_Markdown::$base_url  = URL::site($this->guide->uri()).'/';
		Kodoc_Markdown::$image_url = URL::site($this->media->uri()).'/';
	}

	parent::before();
}

public function error($message)
{
	$this->request->status = 404;
	$this->template->title = __('User Guide').' - '.__('Error');
	$this->template->content = View::factory('userguide/error',array('message'=>$message));
	$this->template->menu = Kodoc::menu();
	$this->template->breadcrumb = array($this->guide->uri() =>  __('User Guide'), __('Error'));
}

public function file($page)
{
	if ( ! ($file = Kohana::find_file('guide', I18n::$lang.'/'.$page, 'md')))
	{
		// Use the default file
		$file = Kohana::find_file('guide', $page, 'md');
	}

	return $file;
}

public function section($page)
{
	$markdown = $this->_get_all_menu_markdown();
	
	if (preg_match('~\*{2}(.+?)\*{2}[^*]+\[[^\]]+\]\('.preg_quote($page).'\)~mu', $markdown, $matches))
	{
		return $matches[1];
	}
	
	return $page;
}

public function title($page)
{
	$markdown = $this->_get_all_menu_markdown();
	
	if (preg_match('~\[([^\]]+)\]\('.preg_quote($page).'\)~mu', $markdown, $matches))
	{
		// Found a title for this link
		return $matches[1];
	}
	
	return $page;
}

public function __construct(Request $request)
{
	// Assign the request to the controller
	$this->request = $request;
}