Modules

Controller_Admin_Path
extends Controller_Admin
extends Template
extends Gleez_Template
extends Controller
extends Kohana_Controller

Admin Path Controller

package
Gleez\Admin\Controller
author
Sandeep Sangamreddi - Gleez
copyright
© 2011-2013 Gleez Technologies
license
http://gleezcms.org/license

Class declared in MODPATH/gleez/classes/controller/admin/path.php on line 10.

Properties

public boolean $auto_render

Auto render template?

public boolean $debug

Turn debugging on?

public Request $request

Request that created the controller

public Response $response

The response that will be returned from controller

public string $site_name

The site name

public string $template

Page template

public string $title

The page title

public string $title_separator

The delimiter page header and site name

protected array $_accept_formats

List all supported formats for this controller (accept-type => path to format template)

protected boolean $_ajax

Is ajax request?

protected object $_auth

The Auth Object

protected array $_benchmark

Profiling

protected Kohana_Config $_config

The configuration settings

protected $_current_user

protected array $_desti

The destination url

protected Format $_format

An Format instance

protected boolean $_internal

is internal request?

protected string $_page_class

Current page class

protected string $_page_id

Current page id, defaults to controller name

protected array $_regions

The sidebar content

protected string $_response_format

Hold the response format for this request

protected boolean $_sidebars

Enable sidebars for this request? For example: add or edit page don't requires sidebars

protected array $_tabs

Tabs navigation

protected object $_widgets

The Widgets Object

protected array $redirect

The destination url

Methods

public action_add( ) (defined in Controller_Admin_Path)

Source Code

public function action_add()
{
	$this->title = __('Add Alias');
	$view = View::factory('admin/path/form')
                               ->bind('errors', $errors)
                               ->bind('post', $post)
                               ->set('url', URL::site(null, TRUE));

	$post = ORM::factory('path');

	if( $this->valid_post('path') )
	{
		try
		{
			$post->values($_POST)->save();

			Message::success(__('Alias: %name saved successful!', array('%name' => $post->source)));

			if ( ! $this->_internal)
				$this->request->redirect(Route::get('admin/path')->uri(array('action' => 'list')));

		}
                       catch (ORM_Validation_Exception $e)
		{
			$errors =  $e->errors('models');
		}
	}

	$this->response->body($view);
}

public action_delete( ) (defined in Controller_Admin_Path)

Source Code

public function action_delete()
{
	$id = (int) $this->request->param('id', 0);

	$path = ORM::factory('path', $id);

	if ( ! $path->loaded())
	{
		Message::error(__('Alias: doesn\'t exists!'));
		Kohana::$log->add(Log::ERROR, 'Attempt to access non-existent alias');

		if ( ! $this->_internal)
			$this->request->redirect(Route::get('admin/path')->uri( array('action' => 'list') ));
	}

	$this->title = __('Delete Alias :title', array(':title' => $path->source ));

	$view = View::factory('form/confirm')
			->set('action', Route::url('admin/path', array('action' => 'delete', 'id' => $path->id) ))
			->set('title', $path->alias);

	// If deletion is not desired, redirect to list
               if ( isset($_POST['no']) AND $this->valid_post() )
                       $this->request->redirect(Route::get('admin/path')->uri());

	// If deletion is confirmed
               if ( isset($_POST['yes']) AND $this->valid_post() )
               {
		try
		{
			$path->delete();
			Message::success(__('Alias: :name deleted successful!', array(':name' => $path->alias)));

			if ( ! $this->_internal)
				$this->request->redirect(Route::get('admin/path')->uri( array('action' => 'list') ));
		}
		catch (Exception $e)
		{
			Kohana::$log->add(Log::ERROR, 'Error occured deleting alias id: :id, :message',
						array(':id' => $path->id, ':message' => $e->getMessage()));
			Message::error('An error occured deleting alias, :path.',array(':path' => $path->alias));

			if ( ! $this->_internal)
				$this->request->redirect(Route::get('admin/path')->uri( array('action' => 'list') ));
		}
	}

	$this->response->body($view);
}

public action_edit( ) (defined in Controller_Admin_Path)

Source Code

public function action_edit()
{
	$id = (int) $this->request->param('id', 0);

	$post = ORM::factory('path', (int) $id);

	if( !$post->loaded() )
	{
		Message::error( __('Alias: doesn\'t exists!') );
		Kohana::$log->add(Log::ERROR, 'Attempt to access non-existent alias');

		if ( ! $this->_internal)
			$this->request->redirect(Route::get('admin/path')->uri(array('action' => 'list')));
	}


	$this->title = __('Edit Alias %name', array('%name' => $post->source));
	$view = View::factory('admin/path/form')->bind('errors', $errors)
                               ->bind('post', $post)
                               ->set('url', URL::site(null, TRUE));

	if ( $this->valid_post('path') )
	{
		try
		{
			$post->values($_POST)->save();

			Message::success(__('Alias: %name saved successful!', array('%name' => $post->source)));

			if ( ! $this->_internal)
				$this->request->redirect(Route::get('admin/path')->uri(array('action' => 'list')));

		}
		catch (ORM_Validation_Exception $e)
		{
			$errors = $e->errors();
		}
	}

	$this->response->body($view);
}

public action_list( ) (defined in Controller_Admin_Path)

Source Code

public function action_list()
{
	$this->title    = __('Path Aliases');
	$view           = View::factory('admin/path/list')
					->bind('pagination', $pagination)
					->bind('paths', $paths);

	$path       = ORM::factory('path');
	$total      = $path->count_all();

	if ($total == 0)
	{
		Kohana::$log->add(Log::INFO, 'No paths found');
		$this->response->body( View::factory('admin/path/none') );
		return;
	}

	$pagination = Pagination::factory(array(
		'current_page'   => array('source'=>'route', 'key'=>'page'),
		'total_items' => $total,
		'items_per_page' => 25,
		));

	$paths  = $path->order_by('source', 'ASC')->limit($pagination->items_per_page)
						  ->offset($pagination->offset)->find_all();

               $this->response->body($view);
}

public before( ) (defined in Controller_Admin_Path)

Loads the template View object, if it is direct request

Tags

Return Values

  • void

Source Code

public function before()
{
	ACL::Required('administer paths');
	parent::before();
}

final public action_skip( ) (defined in Controller_Admin)

Source Code

final public function action_skip()
{
	// Do nothing
}

public after( ) (defined in Controller_Admin)

If debugging is enabled, append profiler stats for non-production environments.

Return Values

  • void

Source Code

public function after()
{
	parent::after();
}

public index( ) (defined in Controller_Admin)

Source Code

public function index()
{
	$this->response->body( __('Welcome to admin') );
}

public is_frontpage( ) (defined in Gleez_Template)

Is frontpage?

Tags

Return Values

  • boolean

Source Code

public function is_frontpage()
{
	$uri = preg_replace("#(/p\d+)+$#uD", '', rtrim($this->request->uri(), '/'));

	return (empty($uri) OR ($uri === $this->_config->front_page));
}

public valid_post( [ string|NULL $submit = NULL ] ) (defined in Gleez_Template)

Returns TRUE if the POST has a valid CSRF

Usage:
if ($this->valid_post('upload_photo')) { ... }

Parameters

  • string|NULL $submit = NULL - Submit value [Optional]

Tags

Return Values

  • boolean - Return TRUE if it's valid $_POST

Source Code

public 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;
}

public __construct( Request $request , Response $response ) (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
  • Response $response required - The request's response

Return Values

  • void

Source Code

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

	// Assign a response to the controller
	$this->response = $response;
}

protected _set_column_class( ) (defined in Gleez_Template)

Add sidebar column class

This method is chainable.

Source Code

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;
}

protected _set_default_css( ) (defined in Gleez_Template)

Set default CSS

Tags

Source Code

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));
}

protected _set_default_js( ) (defined in Gleez_Template)

Set default JavaScript

Tags

Source Code

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.

Tags

Source Code

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);
		}
	}
}

protected _set_default_meta_tags( ) (defined in Gleez_Template)

Set the default meta tags

Using configuration settings.

Tags

Source Code

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);
		}
	}
}

protected _set_default_server_headers( ) (defined in Gleez_Template)

Set the default server headers

Source Code

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);
}

protected _set_head_title( ) (defined in Gleez_Template)

Set the page title

Source Code

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);
}

protected _set_profiler_stats( ) (defined in Gleez_Template)

Set the profiler stats into template.

Tags

Source Code

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);
}

protected _set_server_headers( array $headers ) (defined in Gleez_Template)

Set the server headers

Parameters

  • array $headers required - An associative array of server headers

Source Code

protected function _set_server_headers($headers)
{
	if (is_array($headers) AND ! empty($headers))
	{
		$this->response->headers($headers);
	}
}

protected _set_sidebars( ) (defined in Gleez_Template)

Add sidebars

This method is chainable.

Source Code

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;
}
Documentation comments powered by Disqus