File Source for web_page

<?php
// *** Tangra (Application Framework and Tools for PHP)
// $Id$
//
/**
* Contains class Web_Page_View
*
* @package tangra_lib
* @subpackage web_site
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'web_site/tple_exports.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'web_site/web_page/web_page.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'exceptions/te_key_not_exists.class.php');
/**
* View for Web_page
*
* @package tangra_lib
* @subpackage web_site
*/
abstract class Web_Page_View extends Tangra_Class {
/**
* Web_Page holder
*
* @var Web_Page
* @internal
*/
private $page;
/**
* HTTP headers array
*
* @var array
* @internal
*/
private $http_headers = array();
/**
* TPLE_Exports holder
*
* @var TPLE_Exports
*/
private $exports;
/**
* Name of the view
*
* @var string
*/
private $name;
/**
* Holds additional CSSes that will be exported to template
*
* @var array
*/
private $additional_csses = array();
/**
* Holds additional Javascript files that will be exported to template
*
* @var array
*/
private $additional_jses;
/**
* Constructor
*
* @param Web_Page $page Page tha view is for
* @param string $name Name of the view
*/
function __construct(Web_Page $page, $name = 'default') {
$this->page = $page;
$this->set_name($name);
$this->init_exports();
}
protected function init_exports() {
$this->exports = new TPLE_Exports;
}
/**
* Returns page object
*
*/
public function get_page() {
return $this->page;
}
/**
* Returns view name
*
* @return string
*/
public function get_name() {
return $this->name;
}
/**
* Returns exports object
*
* @return TPLE_Exports
*/
public function get__exports() {
return $this->exports;
}
/**
* Returns page HTML
*
*/
abstract public function &fetch_content();
/**
* Shows page HTML
*
*/
public function show() {
foreach($this->http_headers as $h) {
header($h);
}
$this->exports->add_pair('_additional_csses', $this->get_additional_csses());
$this->exports->add_pair('_additional_jses', $this->get_additional_jses());
print($this->fetch_content());
}
/**
* Sets TPLE exports
*
* @param TPLE_exports $exports
*/
public function set_exports(TPLE_exports $exports) {
$this->exports = $exports;
}
/**
* Adds exports
*
* @param TPLE_exports $exports
*/
public function add_exports(TPLE_exports $exports) {
$this->exports->merge($exports);
}
/**
* Returns value of exported pair.
*
* If $forgiving is set to false will throw exception TE_Key_Not_Exists if such key does not exist.
* If $forgiving is set to true will return NULL if such key does not exist.
*
* @param string $key
* @param boolean $forgiving
* @return mixed
* @see Web_Page_View::set_exported_value()
*/
public function get_exported_value($key, $forgiving = true) {
$ret = $this->exports->get_pair_value($key, $forgiving);
return $ret;
}
/**
* Changes the value of exported pair.
*
* If $create_if_not_exists is set to true this function will create export pair if it does not exist.
* If $create_if_not_exists is set to false exception will be thrown if pair does not exist.
*
* The purpose of methods set_exported_value and get_exported_value is to give chance to the view class to format values.
* For example, if Page object exported 'total' => 0.54, view object can use number_format() function to change
* the appearance of the value (first it will get value with $var = get_exported_value('some_key'), then will
* set_exported_value('some_key', number_format($var, 2, ','))).
*
* @param string $key
* @param mixed $value
* @param boolean $create_if_not_exists
* @throws TE_Key_Not_Exists
*/
public function set_exported_value($key, $value, $create_if_not_exist = false) {
if ($this->exports->key_exists($key, true)) {
$this->exports->update_pair_value($key, $value);
} else {
if ($create_if_not_exist) {
$this->exports->add_pair($key, $value);
} else {
throw new TE_Key_Not_Exists('Key not exists: '.$key);
}
}
}
/**
* Adds HTTP header
*
* @param unknown_type $http_header
*/
public function add_http_header($http_header) {
array_push($this->http_headers, $http_header);
}
/**
* Return HTTP headers
*
* @return array
*/
public function get_http_headers() {
return $this->http_headers;
}
public function add_css($path_to_css_file) {
$this->additional_csses[$path_to_css_file] = $path_to_css_file;
}
public function get_additional_csses() {
return $this->additional_csses;
}
public function add_js($path_to_js_file) {
$this->additional_jses[$path_to_js_file] = $path_to_js_file;
}
public function get_additional_jses() {
return $this->additional_jses;
}
/**
* Adds value key-value pair exports
*
* @param string $key
* @param string $value
*/
public function export($key, $value) {
$this->exports->add_pair($key, $value);
}
/**
* Sets name of the view
*
* @param string $name
* @internal
*/
private function set_name($name) {
if (ereg("^[a-z]{1}[a-z0-9_]{1,100}$", $name)) {
$this->name = $name;
} else {
throw new Tangra_Exception('Invalid view name ($page_name). Must conform ^[a-z]{1}[a-z0-9_]{1,100}$. Current value: '.$name);
}
}
/**
* Sets page object
*
* @param Web_Page $page
*/
private function set_page($page) {
$this->page = $page;
}
}

Source for file web_page_view.class.php