Kohana user guide and api browser.
Class declared in MODPATH/userguide/classes/controller/userguide.php on line 3.
boolean $auto_renderlink to thisauto render template
Request $requestlink to thisRequest that created the controller
Response $responselink to thisThe response that will be returned from controller
publicfunctionaction_api(){// Enable the missing class autoloader. If a class cannot be found a// fake class will be created that extends Kodoc_Missingspl_autoload_register(array('Kodoc_Missing','create_class'));// Get the class from the request$class=$this->request->param('class');// If no class was passed to the url, display the API index pageif( !$class){$this->template->title ='Table of Contents';$this->template->content = View::factory('userguide/api/toc')->set('classes', Kodoc::class_methods())->set('route',$this->request->route());}else{// Create the Kodoc_Class version of this class.$_class= Kodoc_Class::factory($class);// If the class requested and the actual class name are different// (different case, orm vs ORM, auth vs Auth) redirectif($_class->class->name !=$class){$this->request->redirect($this->request->route()->uri(array('class'=>$_class->class->name)));}// If this classes immediate parent is Kodoc_Missing, then it should 404if($_class->class->getParentClass() AND$_class->class->getParentClass()->name =='Kodoc_Missing')return$this->error('That class was not found. Check your url and make sure that the module with that class is enabled.');// If this classes package has been disabled via the config, 404if( ! Kodoc::show_class($_class))return$this->error('That class is in package that is hidden. Check the <code>api_packages</code> config setting.');// Everything is fine, display the class.$this->template->title =$class;$this->template->content = View::factory('userguide/api/class')->set('doc', Kodoc::factory($class))->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()] ='API Browser';$breadcrumb[] =$this->template->title;}
publicfunctionaction_docs(){$module=$this->request->param('module');$page=$this->request->param('page');// Trim trailing slash$page= rtrim($page,'/');// If no module provided in the url, show the user guide index page, which lists the modules.if( !$module){return$this->index();}// If this module's userguide pages are disabled, show the error pageif( ! Kohana::$config->load('userguide.modules.'.$module.'.enabled')){return$this->error('That module doesn\'t exist, or has userguide pages disabled.');}// Prevent "guide/module" and "guide/module/index" from having duplicate contentif($page=='index'){return$this->error('Userguide page not found');}// If a module is set, but no page was provided in the url, show the index pageif( !$page){$page='index';}// Find the markdown file for this page$file=$this->file($module.'/'.$page);// If it's not found, show the error pageif( !$file){return$this->error('Userguide page not found');}// Namespace the markdown parserKodoc_Markdown::$base_url= URL::site($this->guide->uri()).'/'.$module.'/';Kodoc_Markdown::$image_url= URL::site($this->media->uri()).'/'.$module.'/';// Set the page title$this->template->title =$page=='index'? Kohana::$config->load('userguide.modules.'.$module.'.name') :$this->title($page);// Parse the page contents into the templateKodoc_Markdown::$show_toc= true;$this->template->content = Kodoc_Markdown::markdown(file_get_contents($file));Kodoc_Markdown::$show_toc= false;// Attach this module's menu to the template$this->template->menu = Kodoc_Markdown::markdown($this->_get_all_menu_markdown());// Bind the breadcrumb$this->template->bind('breadcrumb',$breadcrumb);// Bind the copyright$this->template->copyright = Kohana::$config->load('userguide.modules.'.$module.'.copyright');// Add the breadcrumb trail$breadcrumb=array();$breadcrumb[$this->guide->uri()] ='User Guide';$breadcrumb[$this->guide->uri(array('module'=>$module))] = Kohana::$config->load('userguide.modules.'.$module.'.name');// TODO try and get parent category names (from menu). Regex magic or javascript dom stuff perhaps?// Only add the current page title to breadcrumbs if it isn't the index, otherwise we get repeats.if($page!='index'){$breadcrumb[] =$this->template->title;}}
publicfunctionaction_media(){// 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/guide',$file,$ext)){// Check if the browser sent an "if-none-match: <etag>" header, and tell if the file hasn't changed$this->response->check_cache(sha1($this->request->uri()).filemtime($file),$this->request);// Send the file content as the response$this->response->body(file_get_contents($file));// Set the proper headers to allow caching$this->response->headers('content-type', File::mime_by_ext($ext));$this->response->headers('last-modified',date('r',filemtime($file)));}else{// Return a 404 status$this->response->status(404);}}
Assigns the template View as the request response.
publicfunctionafter(){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/jquery.cookie.js')),$media->uri(array('file'=>'js/kodoc.js')),// Syntax Highlighter$media->uri(array('file'=>'js/shCore.js')),$media->uri(array('file'=>'js/shBrushPhp.js')),);// Add languages$this->template->translations = Kohana::message('userguide','translations');}returnparent::after();}
Loads the template View object.
publicfunctionbefore(){parent::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');// Set the base URL for links and imagesKodoc_Markdown::$base_url= URL::site($this->guide->uri()).'/';Kodoc_Markdown::$image_url= URL::site($this->media->uri()).'/';}// Default show_comments to config value$this->template->show_comments = Kohana::$config->load('userguide.show_comments');}
publicfunctionerror($message){$this->response->status(404);$this->template->title ="Userguide - Error";$this->template->content = View::factory('userguide/error',array('message'=>$message));// Don't show disqus on error pages$this->template->show_comments = FALSE;// If we are in a module and that module has a menu, show thatif($module=$this->request->param('module') AND$menu=$this->file($module.'/menu') AND Kohana::$config->load('userguide.modules.'.$module.'.enabled')){// Namespace the markdown parserKodoc_Markdown::$base_url= URL::site($this->guide->uri()).'/'.$module.'/';Kodoc_Markdown::$image_url= URL::site($this->media->uri()).'/'.$module.'/';$this->template->menu = Kodoc_Markdown::markdown($this->_get_all_menu_markdown());$this->template->breadcrumb =array($this->guide->uri() =>'User Guide',$this->guide->uri(array('module'=>$module)) => Kohana::$config->load('userguide.modules.'.$module.'.name'),'Error');}// If we are in the api browser, show the menu and show the api browser in the breadcrumbselseif(Route::name($this->request->route()) =='docs/api'){$this->template->menu = Kodoc::menu();// Bind the breadcrumb$this->template->breadcrumb =array($this->guide->uri(array('page'=> NULL)) =>'User Guide',$this->request->route()->uri() =>'API Browser','Error');}// Otherwise, show the userguide module menu on the sideelse{$this->template->menu = View::factory('userguide/menu',array('modules'=>$this->_modules()));$this->template->breadcrumb =array($this->request->route()->uri() =>'User Guide','Error');}}
Locates the appropriate markdown file for a given guide page. Page URLS can be specified in one of three forms:
In every case, the userguide will search the cascading file system paths for the file guide/userguide/adding.md.
string
$page
required - The relative URL of the guide pagestring
publicfunctionfile($page){// Strip optional .md or .markdown suffix from the passed filename$info=pathinfo($page);if(isset($info['extension'])AND (($info['extension'] ==='md') OR ($info['extension'] ==='markdown'))){$page=$info['dirname'].DIRECTORY_SEPARATOR.$info['filename'];}returnKohana::find_file('guide',$page,'md');}
publicfunctionindex(){$this->template->title ="Userguide";$this->template->breadcrumb =array('User Guide');$this->template->content = View::factory('userguide/index',array('modules'=>$this->_modules()));$this->template->menu = View::factory('userguide/menu',array('modules'=>$this->_modules()));// Don't show disqus on the index page$this->template->show_comments = FALSE;}
publicfunctionsection($page){$markdown=$this->_get_all_menu_markdown();if(preg_match('~\*{2}(.+?)\*{2}[^*]+\[[^\]]+\]\('.preg_quote($page).'\)~mu',$markdown,$matches)){return$matches[1];}return$page;}
publicfunctiontitle($page){$markdown=$this->_get_all_menu_markdown();if(preg_match('~\[([^\]]+)\]\('.preg_quote($page).'\)~mu',$markdown,$matches)){// Found a title for this linkreturn$matches[1];}return$page;}
Creates a new controller instance. Each controller must be constructed with the request object that created it.
Request
$request
required - Request that created the controllerResponse
$response
required - The request's responsevoid
publicfunction__construct(Request$request, Response$response){// Assign the request to the controller$this->request =$request;// Assign a response to the controller$this->response =$response;}
protectedfunction_get_all_menu_markdown(){// Only do this once per request...static$markdown='';if(empty($markdown)){// Get menu items$file=$this->file($this->request->param('module').'/menu');if($fileAND$text=file_get_contents($file)){// Add spans around non-link categories. This is a terrible hack.//echo Debug::vars($text);//$text = preg_replace('/(\s*[\-\*\+]\s*)(.*)/','$1<span>$2</span>',$text);$text= preg_replace('/^(\s*[\-\*\+]\s*)([^\[\]]+)$/m','$1<span>$2</span>',$text);//echo Debug::vars($text);$markdown.=$text;}}return$markdown;}
protectedfunction_modules(){$modules=array_reverse(Kohana::$config->load('userguide.modules'));if(isset($modules['kohana'])){$kohana=$modules['kohana'];unset($modules['kohana']);$modules=array_merge(array('kohana'=>$kohana),$modules);}// Remove modules that have been disabled via configforeach($modulesas$key=>$value){if( ! Kohana::$config->load('userguide.modules.'.$key.'.enabled')){unset($modules[$key]);}}return$modules;}