PageData Class Reference
[Controller]

Collects data used to render a page and to be exchange between different parts of the application. More...

Inheritance diagram for PageData:

Public Member Functions
	__clone ()
	__construct ($cache_manager, $get, $post)
	Constructor.
	add_block ($block, $position=false, $weight=false)
	Add a block.
	add_render_decorator_class ($dec)
	Add a render decorator to overload default render behaviour.
	error ($msg)
	Set error.
	get_blocks ($position=false)
	Get blocks for given position.
	get_cache_manager ()
	Returns cache manager.
	get_get ()
	Return GET data.
	get_pathstack ()
	Returns path stack.
	get_post ()
	Return POST data.
	get_render_decorators ($route)
	Returns array of render decorators to overload default render behaviour.
	has_post_data ()
	Returns true if data has been posted.
	message ($msg)
	Set (success) message.
	raw_request_body ()
	Returns the raw data send along with a request (for POST, PUT, DELETE).
	set_cache_manager ($cache_manager)
	Set cache manager.
	set_path ($path)
	Set current url path.
	sort_blocks ()
	Sort blocks.
	successful ()
	Returns true, if page call was successfull, false otherwise (CONTROLLER_NOTFOUND et al).
Public Attributes
	$blocks = array()
	$breadcrumb
	$content = ''
	$head
	$in_history = true
	$page_template
	Page template.
	$pathstack = null
	$router = null
	$status
	$status_code = CONTROLLER_OK
Protected Attributes
	$cache_manager = null
	$render_decorator_classes = array()

Detailed Description

Collects data used to render a page and to be exchange between different parts of the application.

One instance of PageData is passed around in all steps of the rendering process.

Author:: Gerd Riesselmann

Definition at line 12 of file pagedata.cls.php.

Constructor & Destructor Documentation

PageData::__construct	(	$	cache_manager,
		$	get,
		$	post
	)

Constructor.

Parameters:

	ICacheManager	$cache_manager
	array	$get Usually $_GET
	array	$post Usually $_POST

Reimplemented in ConsolePageData.

Definition at line 103 of file pagedata.cls.php.

00103                                                                  {
00104                 $this->page_template = Config::get_value(Config::PAGE_TEMPLATE);
00105                 $this->status = Status::restore();
00106                 $this->head = new HeadData();
00107                 //if (empty($this->status)) {
00108                 //      $this->status = new Status();
00109                 //}
00110                 if (empty($cache_manager)) { $cache_manager = new NoCacheCacheManager(); } 
00111                 $this->set_cache_manager($cache_manager);
00112                 $this->pathstack = new PathStack();
00113                 
00114                 // GET array
00115                 $tmp = Arr::force($get);
00116                 array_walk_recursive($tmp, array($this, 'trim_array_content'));
00117                 // No path param, since this defines url
00118                 unset($tmp[Config::get_value(Config::QUERY_PARAM_PATH_INVOKED)]);
00119                 $this->get = new TracedArray($tmp);
00120                 
00121                 // POST array
00122                 $tmp = Arr::force($post);
00123                 array_walk_recursive($tmp, array($this, 'trim_array_content'));
00124                 $this->post = new TracedArray($this->preprocess_post($tmp));
00125         }

Member Function Documentation

PageData::__clone ( )

Definition at line 127 of file pagedata.cls.php.

00127                                   {
00128                 // Force a copy of this->object, otherwise
00129                 // it will point to same object.
00130                 $this->cache_manager = clone($this->cache_manager);
00131                 $this->get = clone($this->get);
00132                 $this->post = clone($this->post);
00133                 $this->head = clone($this->head);
00134                 $this->pathstack = clone($this->pathstack);
00135                 if ($this->status) {
00136                         $this->status = clone($this->status);
00137                 }        
00138     }

PageData::add_block	(	$	block,
		$	position = `false`,
		$	weight = `false`
	)

Add a block.

Parameters:

BlockBase

$block

Definition at line 323 of file pagedata.cls.php.

00323                                                                               {
00324                 if ($block->is_valid()) {
00325                         if (!empty($position)) {
00326                                 $block->set_position($position);
00327                         }
00328                         if (!empty($weight)) {
00329                                 $block->set_index($weight);
00330                         }
00331                         $this->blocks[] = $block;
00332                 }
00333         }

PageData::add_render_decorator_class ( $ dec )

Add a render decorator to overload default render behaviour.

Parameters:

string

$dec Class name of render decorator

Definition at line 282 of file pagedata.cls.php.

00282                                                          {
00283                 $this->render_decorator_classes[] = $dec;
00284         }

PageData::error ( $ msg )

Set error.

Parameters:

Status|string

$msg Error or error message

Definition at line 365 of file pagedata.cls.php.

00365                                     {
00366                 if (empty($this->status)) {
00367                         $this->status = new Status();
00368                 }
00369                 if ($msg instanceof Status) {
00370                         $this->status->merge($msg);
00371                 }
00372                 else {
00373                         $this->status->append($msg);
00374                 }
00375         }

PageData::get_blocks ( $ position = false )

Get blocks for given position.

Parameters:

string

$position Pass FALSE to retrieve all blocks

Definition at line 349 of file pagedata.cls.php.

00349                                                       {
00350                 $ret = array();
00351                 foreach ($this->blocks as $block) {
00352                         if ($position && $position != $block->get_position()) {
00353                                 continue;
00354                         }
00355                         $ret[] = $block;
00356                 }               
00357                 return $ret;
00358         }

PageData::get_cache_manager ( )

Returns cache manager.

Returns:: ICacheManager

Definition at line 261 of file pagedata.cls.php.

00261                                             {
00262                 return $this->cache_manager;
00263         }

PageData::get_get ( )

Return GET data.

Returns:: TracedArray

Definition at line 232 of file pagedata.cls.php.

00232                                   {
00233                 return $this->get;
00234         }

PageData::get_pathstack ( )

Returns path stack.

Returns:: Pathstack

Definition at line 314 of file pagedata.cls.php.

00314                                         {
00315                 return $this->pathstack;
00316         }

PageData::get_post ( )

Return POST data.

Returns:: TracedArray

Definition at line 223 of file pagedata.cls.php.

00223                                    {
00224                 return $this->post;
00225         }

PageData::get_render_decorators ( $ route )

Returns array of render decorators to overload default render behaviour.

Parameters:

IDispatcher

Dispatcher

Returns:: array Array of IRenderDecorators

Definition at line 292 of file pagedata.cls.php.

00292                                                       {
00293                 $ret = array();
00294                 foreach($this->render_decorator_classes as $class) {
00295                         $ret[] = new $class($route);
00296                 }
00297                 return $ret;
00298         }

PageData::has_post_data ( )

Returns true if data has been posted.

Returns:: bool

Definition at line 241 of file pagedata.cls.php.

00241                                         {
00242                 return $this->post->count() > 0;
00243         }

PageData::message ( $ msg )

Set (success) message.

Parameters:

Message|string

$msg Message instance or message

Definition at line 382 of file pagedata.cls.php.

00382                                       {
00383                 if ($msg instanceof Message) {
00384                         $this->status = $msg;
00385                 }
00386                 else {
00387                         $this->status = new Message(strval($msg));
00388                 }
00389         }

PageData::raw_request_body ( )

Returns the raw data send along with a request (for POST, PUT, DELETE).

Returns:: string

Definition at line 250 of file pagedata.cls.php.

00250                                            {
00251                 //$ret = Arr::get_item($GLOBALS, 'HTTP_RAW_POST_DATA', '');
00252                 $ret = trim(file_get_contents('php://input'));
00253                 return $ret;
00254         }

PageData::set_cache_manager ( $ cache_manager )

Set cache manager.

Parameters:

ICacheManager

$cache_manager

Definition at line 270 of file pagedata.cls.php.

00270                                                           {
00271                 if (!empty($cache_manager)) {
00272                         $this->cache_manager = $cache_manager;
00273                         $this->cache_manager->initialize($this);
00274                 }
00275         }

PageData::set_path ( $ path )

Set current url path.

Parameters:

strin

$path

Definition at line 305 of file pagedata.cls.php.

00305                                         {
00306                 $this->pathstack->set_path($path);
00307         }

PageData::sort_blocks ( )

Sort blocks.

Definition at line 338 of file pagedata.cls.php.

00338                                       {
00339                 if (function_exists('gyro_block_sort')) {
00340                         usort($this->blocks, 'gyro_block_sort');
00341                 }               
00342         }

PageData::successful ( )

Returns true, if page call was successfull, false otherwise (CONTROLLER_NOTFOUND et al).

Returns:: bool

Definition at line 396 of file pagedata.cls.php.

00396                                      {
00397                 return empty($this->status_code) || $this->status_code == CONTROLLER_OK;
00398         }

Member Data Documentation

PageData::$blocks = array()

Definition at line 54 of file pagedata.cls.php.

PageData::$breadcrumb

Definition at line 30 of file pagedata.cls.php.

PageData::$cache_manager = null [protected]

Definition at line 84 of file pagedata.cls.php.

PageData::$content = ''

Definition at line 18 of file pagedata.cls.php.

PageData::$head

Definition at line 24 of file pagedata.cls.php.

PageData::$in_history = true

Definition at line 60 of file pagedata.cls.php.

PageData::$page_template

Page template.

Definition at line 94 of file pagedata.cls.php.

PageData::$pathstack = null

Definition at line 48 of file pagedata.cls.php.

PageData::$render_decorator_classes = array() [protected]

Definition at line 90 of file pagedata.cls.php.

PageData::$router = null

Definition at line 66 of file pagedata.cls.php.

PageData::$status

Definition at line 36 of file pagedata.cls.php.

PageData::$status_code = CONTROLLER_OK

Definition at line 42 of file pagedata.cls.php.

The documentation for this class was generated from the following file:

gyro/core/controller/base/pagedata.cls.php

PageData Class Reference [Controller]

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

PageData Class Reference
[Controller]