Abstract template class for automatic templating
Class declared in MODPATH/gleez/classes/controller/tag.php on line 3.
boolean $auto_renderAuto render template?
boolean $debugTurn debugging on?
Request $requestRequest that created the controller
Response $responseThe response that will be returned from controller
string $site_nameThe site name
string $templatePage template
string $titleThe page title
string $title_separatorThe delimiter page header and site name
array $_accept_formatsList all supported formats for this controller (accept-type => path to format template)
boolean $_ajaxIs ajax request?
object $_authThe Auth Object
array $_benchmarkProfiling
Kohana_Config $_configThe configuration settings
array $_destiThe destination url
Format $_formatAn Format instance
boolean $_internalis internal request?
string $_page_classCurrent page class
string $_page_idCurrent page id, defaults to controller name
array $_regionsThe sidebar content
string $_response_formatHold the response format for this request
boolean $_sidebarsEnable sidebars for this request? For example: add or edit page don't requires sidebars
array $_tabsTabs navigation
object $_widgetsThe Widgets Object
array $redirectThe destination url
public function action_view()
$id = (int) $this->request->param('id', 0);
$tag = ORM::factory('tag', $id);
if( ! $tag->loaded() )
a::$log->add(LOG::ERROR, 'Attempt to access non-existent tag');
new HTTP_Exception_404( __('Tag ":tag" Not Found'), array(':tag'=>$id));
$this->title = __(':title', array(':title' => Text::ucfirst($tag->name) ) );
= View::factory('tag/view')
set('teaser', TRUE)
bind('pagination', $pagination)
bind('posts', $posts);
$posts = $tag->posts;
if(!ACL::check('administer tags') AND !ACL::check('administer content'))
s->where('status', '=', 'publish');
$total = $posts->reset(FALSE)->count_all();
otal == 0)
a::$log->add(Log::INFO, 'No posts found');
->response->body( View::factory('page/none') );
n;
$pagination = Pagination::factory(array(
rent_page' => array('source'=>'cms', 'key'=>'page'),
al_items' => $total,
ms_per_page' => 15,
' => $tag->url,
= $posts->order_by('created', 'DESC')->limit($pagination->items_per_page)
offset($pagination->offset)->find_all();
$this->response->body($view);
the canocial and shortlink for search engines
this->auto_render === TRUE )
:links( URL::canonical($tag->url, $pagination), array('rel' => 'canonical'));
:links( Route::url('tag', array('action' => 'view', 'id' => $tag->id) ), array('rel' => 'shortlink'));
}Loads the template View object, if it is direct request
voidpublic function before()
{
// Internal request only!
if ($this->request->is_initial())
{
throw new HTTP_Exception_404('Accessing an internal request <small>:type</small> externally', array(
':type' => $this->request->uri(),
));
}
ACL::Required('access content');
parent::before();
}If debugging is enabled, append profiler stats for non-production environments.
voidpublic function after()
{
if ($this->auto_render)
{
// Controller name as the default page id if none set
empty($this->_page_id) AND $this->_page_id = $this->request->controller();
// Load left and right sidebars if available
$this->_set_sidebars();
// Set appropriate column css class
$this->_set_column_class();
// Do some CSS magic to page class
$classes = array();
$classes[] = I18n::$lang;
$classes[] = $this->request->controller();
$classes[] = $this->request->action();
$classes[] = $this->request->controller() . '-' . $this->request->action();
$classes[] = $this->template->column_class;
$classes[] = $this->_page_class;
$classes[] = ($this->_auth->logged_in()) ? 'logged-in' : 'not-logged-in';
// Special check for frontpage and frontpage title
if ($this->is_frontpage())
{
// Set front variable true for themers
$this->template->front = TRUE;
// Don't show title on homepage
$this->template->title = FALSE;
// Don't show title on homepage
$this->title = FALSE;
$this->template->mission = __($this->_config->get('site_mission', ''));
}
View::set_global('is_front', $this->template->front);
View::set_global('is_admin', $this->template->_admin);
$classes[] = $this->template->_admin ? 'backend' : 'frontend';
$classes[] = ($this->template->front) ? 'front' : 'not-front';
$page_class = implode(' ', array_unique(array_map('trim', $classes)));
// Construct Head Section Page title
$this->_set_head_title();
// Allow module and theme developers to override
Module::event('template', $this);
// Set primary menu
$primary_menu = Menu::links('main-menu', array(
'class' => 'menus nav'
));
// Bind the generic page variables
$this->template->set('lang', I18n::$lang)
->set('page_id', $this->_page_id)
->set('page_class', $page_class)
->set('primary_menu', $primary_menu)
->set('title', $this->title)
->set('mission', $this->template->mission)
->set('content', $this->response->body())
->set('messages', Message::display())
->set('profiler', FALSE);
if (count($this->_tabs) > 0)
{
$this->template->tabs = View::factory('tabs')->set('tabs', $this->_tabs);
}
// And profiler if debug is true
if (Kohana::$environment !== Kohana::PRODUCTION AND $this->debug)
{
$this->template->profiler = View::factory('profiler/stats');
}
// And finally the profiler stats
$this->_set_profiler_stats();
// Set header content-type to response format with utf-8
$this->response->headers('Content-Type', $this->_response_format . '; charset=' . Kohana::$charset);
// Assign the template as the request response and render it
$this->response->body($this->template);
}
elseif ($this->_ajax)
{
// Set header content-type to response format with utf-8
$this->response->headers('Content-Type', $this->_response_format . '; charset=' . Kohana::$charset);
$output = $this->response->body();
if ($this->_response_format === 'application/json')
{
$output = JSON::encode($output);
}
$this->response->body($output);
}
elseif ($this->_internal)
{
// Set header content-type to response format with utf-8
$this->response->headers('Content-Type', $this->_response_format . '; charset=' . Kohana::$charset);
$output = $this->response->body();
$this->response->body($output);
}
if (isset($this->_benchmark))
{
// Stop the benchmark
Profiler::stop($this->_benchmark);
}
parent::after();
}Is frontpage?
booleanpublic function is_frontpage()
{
$uri = preg_replace("#(/p\d+)+$#uD", '', rtrim($this->request->uri(), '/'));
return (empty($uri) OR ($uri === $this->_config->front_page));
}Returns TRUE if the POST has a valid CSRF
Usage:
if ($this->valid_post('upload_photo')) { ... }
string|NULL
$submit
= NULL - Submit value [Optional]boolean - Return TRUE if it's valid $_POSTpublic function valid_post($submit = NULL)
{
if ( ! $this->request->is_post())
{
return FALSE;
}
if (Request::post_max_size_exceeded())
{
Message::error(__('Max file size of :max Bytes exceeded!',
array(':max' => Request::get_post_max_size())
));
return FALSE;
}
if ( ! is_null($submit) )
{
if ( ! isset($_POST[$submit]))
{
Message::error(__('This form has altered. Please try submitting it again.'));
return FALSE;
}
}
$_token = $this->request->post('_token');
$_action = $this->request->post('_action');
$has_csrf = ! empty($_token) AND ! empty($_action);
$valid_csrf = $has_csrf AND CSRF::valid($_token, $_action);
if ($has_csrf AND ! $valid_csrf)
{
// CSRF was submitted but expired
Message::error(__('This form has expired. Please try submitting it again.'));
return FALSE;
}
if (isset($_POST['_captcha']))
{
$captcha = $this->request->post('_captcha');
if (empty($captcha))
{
// CSRF was not entered
Message::error(__('The security code can\'t be empty.'));
return FALSE;
}
elseif ( ! Captcha::valid($captcha))
{
Message::error(__('The security answer was wrong.'));
return FALSE;
}
}
return $has_csrf AND $valid_csrf;
}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 responsevoidpublic function __construct(Request $request, Response $response)
{
// Assign the request to the controller
$this->request = $request;
// Assign a response to the controller
$this->response = $response;
}Add sidebar column class
This method is chainable.
protected function _set_column_class()
{
$sidebar_left = $this->template->sidebar_left;
$sidebar_right = $this->template->sidebar_right;
if ( ! empty($sidebar_left) AND ! empty($sidebar_right))
{
$this->template->column_class = 'main-both';
$this->template->main_column = 6;
}
else
{
if ( ! empty($sidebar_left))
{
$this->template->column_class = 'main-left';
$this->template->main_column = 9;
}
if ( ! empty($sidebar_right))
{
$this->template->column_class = 'main-right';
$this->template->main_column = 9;
}
}
return $this;
}Set default CSS
protected function _set_default_css()
{
Assets::css('bootstrap', 'media/css/bootstrap.min.css', NULL, array('weight' => -15));
Assets::css('font-awesome', 'media/css/font-awesome.min.css', array('weight' => -13));
Assets::css('default', 'media/css/default.css', NULL, array('weight' => 0));
Assets::css('style', 'media/css/style.css', array('default'), array('weight' => 1));
}Set default JavaScript
protected function _set_default_js()
{
Assets::js('bootstrap', 'media/js/bootstrap.min.js', array('jquery'), FALSE, array('weight' => 5));
// Google js only in production and not in admin section
if (Kohana::PRODUCTION === Kohana::$environment AND Theme::$is_admin === FALSE)
{
$ua = $this->_config->get('google_ua', NULL);
if ( ! is_null($ua))
{
Assets::google_stats($ua);
}
}
}Set the default meta links
Used configuration settings.
protected function _set_default_meta_links()
{
$meta = $this->_config->get('meta', array());
$links = Arr::get($meta, 'links');
if ($links)
{
foreach ($links as $url => $attributes)
{
Meta::links($url, $attributes);
}
}
}Set the default meta tags
Using configuration settings.
protected function _set_default_meta_tags()
{
$meta = $this->_config->get('meta', array());
$tags = Arr::get($meta, 'tags');
if ($tags)
{
foreach ($tags as $handle => $value)
{
$conditional = NULL;
if (is_array($value))
{
$conditional = Arr::get($value, 'conditional');
$value = Arr::get($value, 'value', '');
}
$attrs = array();
if (isset($conditional))
{
$attrs['conditional'] = $conditional;
}
Meta::tags($handle, $value, $attrs);
}
}
}Set the default server headers
protected function _set_default_server_headers()
{
$headers = $this->_config->get('headers', array());
$headers['X-Gleez-Version'] = 'Gleez CMS v ' . Gleez::VERSION . ' (' . Gleez::CODENAME . ')';
$xmlrpc = $this->_config->get('xmlrpc', NULL);
/** @var $xmlrpc string|NULL */
if ( ! is_null($xmlrpc))
{
$headers['X-Pingback'] = URL::site($xmlrpc, TRUE);
}
$this->_set_server_headers($headers);
}Set the page title
protected function _set_head_title()
{
if ($this->title)
{
$head_title = array(
strip_tags($this->title),
$this->template->site_name
);
}
else
{
$head_title = array(
$this->template->site_name
);
if ($this->template->site_slogan)
{
$head_title[] = $this->template->site_slogan;
}
}
$this->template->head_title = implode($this->title_separator, $head_title);
}Set the profiler stats into template.
protected function _set_profiler_stats()
{
$queries = 0;
if (Kohana::$profiling)
{
// DB queries
foreach (Profiler::groups() as $group => $benchmarks)
{
if (strpos($group, 'database') === 0)
{
$queries += count($benchmarks);
}
}
}
// Get the total memory and execution time
$total = array(
'{memory_usage}' => number_format((memory_get_peak_usage() - KOHANA_START_MEMORY) / 1024 / 1024, 2) . 'MB',
'{gleez_version}' => Gleez::VERSION,
'{execution_time}' => number_format(microtime(TRUE) - KOHANA_START_TIME, 3) . ' seconds',
'{included_files}' => count(get_included_files()),
'{database_queries}' => $queries
);
// Insert the totals into the response
$this->template = strtr((string) $this->template, $total);
}Set the server headers
array
$headers
required - An associative array of server headersprotected function _set_server_headers($headers)
{
if (is_array($headers) AND ! empty($headers))
{
$this->response->headers($headers);
}
}Add sidebars
This method is chainable.
protected function _set_sidebars()
{
if ($this->_sidebars !== FALSE)
{
$this->template->sidebar_left = $this->_widgets->render('left');
$this->template->sidebar_right = $this->_widgets->render('right');
}
return $this;
}