File Source for web_page.class.php

<?php
// *** Tangra (Application Framework and Tools for PHP)
// $Id$
//
/**
* Contains class Web_Page
*
* @package tangra_lib
* @subpackage web_site
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'web_site/web_ctrl.class.php');
/**
*
*/
require_once('web_page_view.class.php');
/**
*
*/
require_once('just_headers_view.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'exceptions/te_web_page_view_not_exists.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'exceptions/te_web_page_view_already_exists.class.php');
/**
* Class Web_Page represents the abstract concept of web page
*
* @package tangra_lib
* @subpackage web_site
*/
abstract class Web_Page extends Web_Ctrl {
/**
* Page name
*
* @var string
* @internal
*/
private $page_name;
/**
* Views for this page. Array of Web_Page_View
*
* @var array
* @internal
*/
private $views = array();
/**
* current URL of the page
*
* @var string
*/
private $page_url_name;
/**
* Constructor
*
* @param string $page_name
*/
function __construct($page_name) {
parent::__construct();
$this->set_page_name($page_name);
}
/**
* Initializing the page
*
* @param Web_Context $context
* @param Web_Site_Config $config
*/
public function _init(Web_Context $context, Web_Site_Config $config) {
$this->page_url_name = $this->capture_page_url_name($context, $config);
parent::_init($context, $config);
$this->export_uni_back();
}
/**
* Returns page name
*
* @return string
*/
public function get_page_name() {
return $this->page_name;
}
/**
* Returns page URL
*
* @return unknown
*/
public function get_page_url_name() {
return $this->page_url_name;
}
/**
* Sets page name
*
* @param string $page_name
* @throws Tangra_Exception
* @internal
* @throws Tangra_Exception
*/
private function set_page_name($page_name) {
if (ereg("^[a-z]{1}[a-z0-9_/\\]{0,100}$", $page_name)) {
$this->page_name = $page_name;
} else {
throw new Tangra_Exception('Invalid page name ($page_name). Must conform ^[a-z]{1}[a-z0-9_/\\]{1,100}[a-z0-9_]{1}$. Current value: '.$page_name);
}
}
/**
* Adds view
*
* @param Web_Page_View $page_view
* @throws TE_Web_Page_View_Already_Exists
*/
protected function add_view(Web_Page_View $page_view) {
if (!array_key_exists($page_view->get_name(), $this->views)) {
$this->views[$page_view->get_name()] = $page_view;
} else {
throw new TE_Web_Page_View_Already_Exists($page_view->get_name());
}
}
/**
* Returns view
*
* @param string $name Name of the view
* @return Web_Page_View
* @throws TE_Web_Page_View_Not_Exists
*/
protected function get_view($name = 'default') {
if (array_key_exists($name, $this->views)) {
$ret = $this->views[$name];
} else {
throw new TE_Web_Page_View_Not_Exists($name);
}
return $ret;
}
/**
* Captures current URL from context
*
* @return string
* @internal
*/
private function capture_page_url_name(Web_Context $context, Web_Site_Config $config) {
$et = false;
$script_name = $context->get_from_server('SCRIPT_NAME');
$relative_docroot = $config->get_document_root_relative();
$ret = substr($script_name, strlen($relative_docroot));
return $ret;
}
/**
* Creates and returns Just_Headers_View with redirect (Location: ) header
*
* If $target starts with "http" redirect will be with absolute URL, otherwise will be relative URL.
*
* Please note that $params_pairs will be merged with existing (if any) transit variables.
*
* @param stirng $target_location target page to redirect to. Example: 'admin/index.php'
* @param array $param_pairs key => value pairs of parameters that will be added to redirect. Example: array('confirmed' => 1)
* @throws Tangra_Exception
*/
protected function create_redirect_view($target_location, $param_pairs = array()) {
$target_location = trim($target_location);
if ($target_location) {
$redir_view = new Just_Headers_View();
$redir = $this->create_redirect_composer($target_location, $param_pairs);
$redir_view->add_http_header($redir->get_location());
} else {
throw new Tangra_Exception('$target is empty or invalid.');
}
return $redir_view;
}
/**
* Detects referer (if local) and exports it as _uni_back
*
* Useful for creating back links that work the same way as browser window but with _tm variable set correctly (if available).
* @internal
*/
private function export_uni_back() {
if (array_key_exists('HTTP_REFERER', $_SERVER)) {
$parsed_url = parse_url($_SERVER['HTTP_REFERER']);
$config = $this->get__config();
if ($parsed_url['host'] == $config->get_current_host()) {
// $lang_pos = strpos($parsed_url['path'], '_lang-');
// if ($lang_pos !== false) {
// $parsed_url['path'] = substr($parsed_url['path'], 0, $lang_pos -1);
// }
if (array_key_exists('query', $parsed_url)) {
if ($parsed_url['query']) {
$tm_pos = strpos($parsed_url['query'], '&_tm=');
if ($tm_pos !== false) {
$tm_full = substr($parsed_url['query'], $tm_pos, 37);
$parsed_url['query'] = str_replace($tm_full, '', $parsed_url['query']);
}
}
} else {
$parsed_url['query'] = '';
}
$this->export('_uni_back', $parsed_url['path'].($parsed_url['query'] ? '?'.$parsed_url['query'] :''));
}
}
}
/**
* End classes must implement this function and it must be used always for creating views (i.e. no new Some_View())
*
* @param string $name
*/
abstract public function create_view($name = 'default');
}

Source for file web_page.class.php