File Source for web_ctrl.class.php

<?php
/**
* Contains class Web_Page
*
* @package tangra_lib
* @subpackage web_site
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'web_site/web_context.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'web_site/web_site_config.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'web_site/redirect_composer_local.class.php');
/**
* Web_Ctrl is base class for Web_Page and Ajax_Ctrl.
*
* All objects that will be ran by site object must inherit it.
*
* @package tangra_lib
* @subpackage web_site
*/
abstract class Web_Ctrl extends Tangra_Class {
const TRANSIT_VARS_PREFIX = '_transit_';
/**
* Web_Site_Config holder
*
* @var Web_Site_Config
* @internal
*/
protected $_config;
/**
* TPLE_Exports holder
*
* @var TPLE_Exports
* @internal
*/
protected $_exports;
/**
* Web_Context holder
*
* @var Web_Context
* @internal
*/
private $_context;
/**
* Holds variables that are added as transit
*
* @var array
* @internal
*/
private $_transit_vars = array();
/**
* Constructor
*
*/
function __construct() {
$this->_exports = new TPLE_Exports();
$this->init_transit_vars();
}
/**
* Initializing the page
*
* @param Web_Context $context
* @param Web_Site_Config $config
*/
public function _init(Web_Context $context, Web_Site_Config $config) {
$this->set_context($context);
$this->set_config($config);
$this->capture_transit_vars();
$this->init();
$this->capture_transit_vars();
}
/**
* Place for user code for initialization.
* Must throw exception (TE_Page_Failed_To_Init) if init fails.
* On failure run() method will not be executed.
* Put in init() all code that:
* - checks for availability of resources
* - it is not essential for concrete page functionality
* Init method is useful for base page classes - if you have some functionality that
* is common for all (most) pages in your site - put it here and then inherit that base
* page class. Don't forget to call parent::init() if you overload it
*
*/
protected function init() {
}
/**
* Sets context
*
* @param Web_Context $context
* @internal
*/
private function set_context(Web_Context $context) {
$this->_context = $context;
}
/**
* Returns reference to context
*
* @return Web_Context
*/
public function get__context() {
return $this->_context;
}
/**
* Return exports object
*
* @return TPLE_Exports
*/
public function get__exports() {
return $this->_exports;
}
/**
* Adds value key-value pair exports
*
* @param string $key
* @param string $value
*/
public function export($key, $value) {
$this->_exports->add_pair($key, $value);
}
/**
* Adds exports. This is bulk version of export()
*
* @param TPLE_exports $exports
*/
public function add_exports(TPLE_exports $exports) {
$this->_exports->merge($exports);
}
/**
* Sets $_config
*
* @param Web_Site_Config $config
* @internal
*/
private function set_config(Web_Site_Config $config) {
$this->_config = $config;
}
/**
* Returns current web site configuration object.
*
* @return Web_Site_Config Current $WSC
*/
public function get__config() {
return $this->_config;
}
public function add_transit_var($var_name, $var_value = NULL) {
if (ereg("^[a-z]{1}[a-z0-9_]{1,40}$", $var_name)) {
if (!array_key_exists($var_name, $this->_transit_vars)) {
$this->_transit_vars[$var_name] = (string) $var_value;
} else {
throw new Tangra_Exception('Transit variable '.$var_name.' already exist.');
}
} else {
throw new Tangra_Exception('Invalid name for transit variable: '.$var_name);
}
}
public function set_transit_var_value($var_name, $var_value) {
if (array_key_exists($var_name, $this->_transit_vars)) {
$this->_transit_vars[$var_name] = (string) $var_value;
} else {
throw new Tangra_Exception('Transit variable "'.$var_name.'" not exist.');
}
}
public function get_transit_var($var_name, $forgiving = false) {
$ret = false;
if (array_key_exists($var_name, $this->_transit_vars)) {
$ret = $this->_transit_vars[$var_name];
} else {
if (!$forgiving) {
throw new Tangra_Exception('Transit variable "'.$var_name.'" not exist.');
}
}
return $ret;
}
public function get_transit_vars() {
return $this->_transit_vars;
}
public function capture_transit_vars() {
foreach($this->_transit_vars as $var_name => $var_value) {
$context = $this->get__context();
if ($context->exists_in_get(Web_Page::TRANSIT_VARS_PREFIX.$var_name)) {
$this->set_transit_var_value($var_name, urldecode($context->get_from_get(Web_Ctrl::TRANSIT_VARS_PREFIX.$var_name)));
} elseif($context->exists_in_post(Web_Page::TRANSIT_VARS_PREFIX.$var_name)) {
$this->set_transit_var_value($var_name, urldecode($context->get_from_post(Web_Ctrl::TRANSIT_VARS_PREFIX.$var_name)));
}
}
}
public function set_transit_vars_as_output_rewrite_vars() {
$_transit_vars_prepared = $this->prepare_transit_vars();
foreach($_transit_vars_prepared as $var_name => $var_value) {
output_add_rewrite_var($var_name, $var_value);
}
}
public function remove_transit_var($var_name) {
if (array_key_exists($var_name, $this->_transit_vars)) {
unset($this->_transit_vars[$var_name]);
}
}
protected function prepare_transit_vars() {
$ret = array();
foreach($this->_transit_vars as $var_name => $var_value) {
if ($var_value != NULL) {
$ret[Web_Page::TRANSIT_VARS_PREFIX.$var_name] = $var_value;
}
}
return $ret;
}
protected function create_redirect_composer($target_location, $param_pairs = array()) {
if (strtolower(substr($target_location, 0, 4)) != 'http') {
$_transit_vars_prepared = $this->prepare_transit_vars();
$param_pairs_all = array_merge($param_pairs, $_transit_vars_prepared);
$redir = new Redirect_Composer_Local($this->get__context(), $target_location, $param_pairs_all);
} else {
$redir = new Redirect_Composer($target_location, $param_pairs);
}
return $redir;
}
/**
* Runs the controller
*
* @return Web_Page_View
*/
public function _run() {
$view = $this->run();
$_transit_vars_prepared = $this->prepare_transit_vars();
$view->set_exported_value('_transit_vars', $_transit_vars_prepared, true);
$this->set_transit_vars_as_output_rewrite_vars();
return $view;
}
/**
* Here is the place to add your transit vars
*
* This method will be called by __constructor automatically. It is provided for convenience (i.e. otherwise you have to add transit vars in __constructor which means that you have to overload it, find the correct declaration, etc.)
*
* Example:
* <code>
* <?php
* protected function init_transit_vars() {
* add_transit_var('category');
* }
* ?>
* </code>
*
*/
protected function init_transit_vars() {
}
/**
* Put your main page functionalty in run() (if not otherwise specified like for example for WED pages)
*
* Must return instance of Web_Page_View
*/
abstract public function run();
}

Source for file web_ctrl.class.php