Documentation generator.
Class declared in MODPATH/userguide/classes/kodoc.php on line 3.
string $regex_class_memberlink to thisPCRE fragment for matching 'Class', 'Class::method', 'Class::method()' or 'Class::$property'
string(33) "((\w++)(?:::(\$?\w++))?(?:\(\))?)"Get all classes and methods of files in a list.
I personally don't like this as it was used on the index page. Way too much stuff on one page. It has potential for a package index page though. For example: class_methods( Kohana::list_files('classes/sprig') ) could make a nice index page for the sprig package in the api browser ~bluehawk
publicstaticfunctionclass_methods(array$list= NULL){$list= Kodoc::classes($list);$classes=array();foreach($listas$class){$_class=newReflectionClass($class);if(stripos($_class->name,'Kohana_') === 0){// Skip transparent extension classescontinue;}$methods=array();foreach($_class->getMethods()as$_method){$declares=$_method->getDeclaringClass()->name;if(stripos($declares,'Kohana_') === 0){// Remove "Kohana_"$declares=substr($declares, 7);}if($declares===$_class->name OR$declares==="Core"){$methods[] =$_method->name;}}sort($methods);$classes[$_class->name] =$methods;}return$classes;}
Returns an array of all the classes available, built by listing all files in the classes folder and then trying to create that class.
This means any empty class files (as in complety empty) will cause an exception
array
$list
= NULL - Array of files, obtained using Kohana::list_filesarray - An array of all the class names
publicstaticfunctionclasses(array$list= NULL){if($list=== NULL){$list= Kohana::list_files('classes');}$classes=array();// This will be used a lot!$ext_length=strlen(EXT);foreach($listas$name=>$path){if(is_array($path)){$classes+= Kodoc::classes($path);}elseif(substr($name, -$ext_length) === EXT){// Remove "classes/" and the extension$class=substr($name, 8, -$ext_length);// Convert slashes to underscores$class=str_replace(DIRECTORY_SEPARATOR,'_',strtolower($class));$classes[$class] =$class;}}return$classes;}
publicstaticfunctionfactory($class){returnnewKodoc_Class($class);}
Make a class#member API link using an array of matches from Kodoc::$regex_class_member
array
$matches
required - Array( 1 => link text, 2 => class name, [3 => member name] )string
publicstaticfunctionlink_class_member($matches){$link=$matches[1];$class=$matches[2];$member= NULL;if(isset($matches[3])){// If the first char is a $ it is a property, e.g. Kohana::$base_urlif($matches[3][0] ==='$'){$member='#property:'.substr($matches[3], 1);}else{$member='#'.$matches[3];}}returnHTML::anchor(Route::get('docs/api')->uri(array('class'=>$class)).$member,$link, NULL, NULL, TRUE);}
Creates an html list of all classes sorted by category (or package if no category)
string - The html for the menu
publicstaticfunctionmenu(){$classes= Kodoc::classes();foreach($classesas$class){if(isset($classes['kohana_'.$class])){// Remove extended classesunset($classes['kohana_'.$class]);}}ksort($classes);$menu=array();$route= Route::get('docs/api');foreach($classesas$class){$class= Kodoc_Class::factory($class);// Test if we should show this classif( ! Kodoc::show_class($class))continue;$link= HTML::anchor($route->uri(array('class'=>$class->class->name)),$class->class->name);if(isset($class->tags['package'])){foreach($class->tags['package']as$package){if(isset($class->tags['category'])){foreach($class->tags['category']as$category){$menu[$package][$category][] =$link;}}else{$menu[$package]['Base'][] =$link;}}}else{$menu['[Unknown]']['Base'][] =$link;}}// Sort the packagesksort($menu);returnView::factory('userguide/api/menu')->bind('menu',$menu);}
Parse a comment to extract the description and the tags
string
$comment
required - The comment retreived using ReflectionClass->getDocComment()array - Array(string $description, array $tags)
publicstaticfunctionparse($comment){// Normalize all new lines to \n$comment=str_replace(array("\r\n","\n"),"\n",$comment);// Remove the phpdoc open/close tags and split$comment=array_slice(explode("\n",$comment), 1, -1);// Tag content$tags=array();foreach($commentas$i=>$line){// Remove all leading whitespace$line= preg_replace('/^\s*\* ?/m','',$line);// Search this line for a tagif(preg_match('/^@(\S+)(?:\s*(.+))?$/',$line,$matches)){// This is a tag lineunset($comment[$i]);$name=$matches[1];$text= isset($matches[2]) ?$matches[2] :'';switch($name){case'license':if(strpos($text,'://') !== FALSE){// Convert the lincense into a link$text= HTML::anchor($text);}break;case'link':$text= preg_split('/\s+/',$text, 2);$text= HTML::anchor($text[0], isset($text[1]) ?$text[1] :$text[0]);break;case'copyright':if(strpos($text,'(c)') !== FALSE){// Convert the copyright sign$text=str_replace('(c)','©',$text);}break;case'throws':if(preg_match('/^(\w+)\W(.*)$/',$text,$matches)){$text= HTML::anchor(Route::get('docs/api')->uri(array('class'=>$matches[1])),$matches[1]).' '.$matches[2];}else{$text= HTML::anchor(Route::get('docs/api')->uri(array('class'=>$text)),$text);}break;case'uses':if(preg_match('/^'.Kodoc::$regex_class_member.'$/i',$text,$matches)){$text= Kodoc::link_class_member($matches);}break;// Don't show @access lines, they are shown elsewherecase'access':continue2;}// Add the tag$tags[$name][] =$text;}else{// Overwrite the comment line$comment[$i] = (string)$line;}}// Concat the comment lines back to a block of textif($comment= trim(implode("\n",$comment))){// Parse the comment with Markdown$comment= Kodoc_Markdown::markdown($comment);}returnarray($comment,$tags);}
Test whether a class should be shown, based on the api_packages config option
Kodoc_Class
$class
required - The class to testbool - Whether this class should be shown
publicstaticfunctionshow_class(Kodoc_Class$class){$api_packages= Kohana::$config->load('userguide.api_packages');// If api_packages is true, all packages should be shownif($api_packages=== TRUE)returnTRUE;// Get the package tags for this class (as an array)$packages= Arr::get($class->tags,'package',array('None'));$show_this= FALSE;// Loop through each package tagforeach($packagesas$package){// If this package is in the allowed packages, set show this to trueif(in_array($package,explode(',',$api_packages)))$show_this= TRUE;}return$show_this;}
Get the source of a function
string
$file
required - The filenameint
$start
required - Start line?int
$end
required - End line?
publicstaticfunctionsource($file,$start,$end){if( !$file)returnFALSE;$file= file($file, FILE_IGNORE_NEW_LINES);$file=array_slice($file,$start- 1,$end-$start+ 1);if(preg_match('/^(\s+)/',$file[0],$matches)){$padding=strlen($matches[1]);foreach($fileas&$line){$line=substr($line,$padding);}}returnimplode("\n",$file);}