Modules
Controller_Cheatsheet
extends Controller_Template
extends Kohana_Controller_Template
extends Controller
extends Kohana_Controller
Kohana cheat sheet browser.
Class declared in MODPATH/cheatsheet/classes/controller/cheatsheet.php on line 8.
Constants
- None
Properties
Properties
public
boolean$auto_renderauto render template
public
$extpublic
Request$requestRequest that created the controller
public
$template
Methods
public __construct( Request $request ) (defined in Kohana_Controller)
Creates a new controller instance. Each controller must be constructed with the request object that created it.
Parameters
-
Request$request required - Request that created the controller
Return Values
void
Source Code
public function __construct(Request $request)
{
// Assign the request to the controller
$this->request = $request;
}public action_index( ) (defined in Controller_Cheatsheet)
Source Code
public function action_index()
{
$msg = array();
$exclude_class = array_map(
'strtolower',
Kohana::config('cs.exclude_class')
);
// arrays of different mask types and precise names
$prec = array(); // like 'someword'
$ast_left = array(); // like '*someword'
$ast_right = array(); // like 'someword*'
$two_ast = array(); // like '*someword*'
foreach ($exclude_class as $mask)
{
if (strpos($mask, '*') === 0 AND (strrpos($mask, '*') === strlen($mask) - 1))
{
// any occurrence
$two_ast[] = substr($mask, 1, -1);
}
elseif (strpos($mask, '*') === 0)
{
// masked as '*someword'
$ast_left[] = substr($mask, 1);
}
elseif (strrpos($mask, '*') === strlen($mask) - 1)
{
// masked as 'someword*'
$ast_right[] = substr($mask, 0, -1);
}
else
{
$prec[] = $mask;
}
}
$classes = Kodoc::classes();
// remove excluded classes from list
foreach ($classes as $class)
{
if (isset($classes['kohana_'.$class]))
{
unset($classes['kohana_'.$class]);
}
// exclude classes that have names set precisely
if (in_array(strtolower($class), $prec))
{
unset($classes[$class]);
continue;
}
$is_class_unset = FALSE;
// exclude classes that have names set by mask of type '*someword*'
foreach ($two_ast as $mask)
{
if (strpos(strtolower($class), $mask) !== FALSE)
{
unset($classes[$class]);
$is_class_unset = TRUE;
break;
}
}
if ($is_class_unset)
{
continue;
}
// exclude classes that have names set by mask of type '*someword'
foreach ($ast_left as $mask)
{
if (substr(strtolower($class), -strlen($mask)) == $mask)
{
unset($classes[$class]);
$is_class_unset = TRUE;
break;
}
}
if ($is_class_unset)
{
continue;
}
// exclude classes that have names set by mask of type 'someword*'
foreach ($ast_right as $mask)
{
if (strpos(strtolower($class), $mask) === 0)
{
unset($classes[$class]);
break;
}
}
}
$is_cache = Kohana::config('cs.cache');
// do we need to save actual state in cache
$is_save_cache = FALSE;
// check if caching turned on
if ($is_cache)
{
// check whether classes set + exclude classes set was modified
$cache_name = sha1(serialize($classes)).$this->ext;
$dir = Kohana_Core::$cache_dir.DIRECTORY_SEPARATOR;
if ( ! is_dir($dir))
{
$msg[] = 'No cache directory '.$dir;
$is_save_cache = TRUE;
}
else
{
if (is_file($dir.$cache_name))
{
$tmp = file_get_contents($dir.$cache_name);
if ($tmp)
{
$classes = unserialize($tmp);
$msg[] = 'Data loaded from cache';
} else {
$is_save_cache = TRUE; // set for data not be taken from cache
$msg[] = 'Failed to load cache';
}
}
else
{
$is_save_cache = TRUE;
foreach (glob($dir.'*'.$this->ext) as $filename)
{
if ( ! unlink($filename))
{
$msg[] = 'Can not delete cache file '.$filename;
}
}
}
}
}
if ( ! $is_cache OR $is_save_cache)
{
foreach ($classes as $class)
{
$r_class = Kodoc_Class::factory($class);
// to prevent exception when Kodoc::properties() throws exception
try
{
$props = $r_class->properties();
} catch (Kohana_Exception $e) {
$props = array();
$msg[] = $e->getMessage();
}
$classes[$class] = array(
'description' => $r_class->description,
'modifiers' => $r_class->modifiers,
'properties' => $props,
'methods' => $r_class->methods(),
);
}
if ($is_save_cache)
{
if (is_dir($dir) AND is_writable($dir))
{
if ( ! file_put_contents($dir.$cache_name, serialize($classes)))
{
$msg[] = 'Failed to save cache';
}
} else {
$msg[] = 'Not exsisting or not writable cache dir';
}
}
}
$this->template->content = $classes;
$this->template->msg = $msg;
}
public action_invalidcache( ) (defined in Controller_Cheatsheet)
Source Code
public function action_invalidcache()
{
$dir = Kohana_Core::$cache_dir.DIRECTORY_SEPARATOR;
if (is_dir($dir))
{
$filelist = glob($dir.'*'.$this->ext);
foreach ($filelist as $filename)
{
@unlink($filename);
}
}
$this->request->redirect('cs');
}
public action_media( ) (defined in Controller_Cheatsheet)
taken from userguide module controller
Source Code
public function action_media()
{
Get the file path from the request
ile = $this->request->param('file');
Find the file extension
xt = pathinfo($file, PATHINFO_EXTENSION);
Remove the extension from the filename
ile = substr($file, 0, -(strlen($ext) + 1));
($file = Kohana::find_file('media', $file, $ext))
this->request->check_cache(sha1($this->request->uri).filemtime($file));
/ Send the file content as the response
this->request->response = file_get_contents($file);
se
Return a 404 status
this->request->status = 404;
his->request->headers['Content-Type'] = File::mime_by_ext($ext);
his->request->headers['Content-Length'] = filesize($file);
his->request->headers['Last-Modified'] = date('r', filemtime($file));
public after( ) (defined in Controller_Cheatsheet)
modified from userguide module controller
Source Code
public function after()
{
if ($this->auto_render)
{
/ Get the media route
media = Route::get('cheatsheet');
/ Add styles
this->template->styles = array(
$media->uri(array('action' => 'media', 'file' => 'css/cs.css')) => 'screen',
);
/ Add scripts
this->template->scripts = array(
$media->uri(array('action' => 'media', 'file' => 'js/jquery-1.4.4.min.js')),
$media->uri(array('action' => 'media', 'file' => 'js/jquery.columnizer.min.js')),
$media->uri(array('action' => 'media', 'file' => 'js/cs.js')),
);
}
return parent::after();
}
public before( ) (defined in Controller_Cheatsheet)
modified from userguide module controller
Source Code
public function before()
{
($this->request->action === 'media')
// Do not template media files
$this->auto_render = FALSE;
e
// Use customized Markdown parser
define('MARKDOWN_PARSER_CLASS', 'Kodoc_Markdown');
// Load Markdown support
require Kohana::find_file('vendor', 'markdown/markdown');
parent::before();
}