WidgetBlock Class Reference
[View]

A widget printing a named block upon actions retrieved from given item. More...

Inheritance diagram for WidgetBlock:

List of all members.

Public Member Functions
	__construct ($page_data, $position)
	render ($policy=self::NONE)
	Renders what should be rendered.
Static Public Member Functions
static	output ($page_data, $position= '')
	Output Blocks.
static	render_blocks ($arr_blocks, $position=false)
static	retrieve ($name, $page_data, $route_id= '', $position=false, $weight=false, $more_params=array())
	Retrieves named block and stores it in page data.
Public Attributes
	$page_data
	$position

---

Detailed Description

A widget printing a named block upon actions retrieved from given item.

Author:

Gerd Riesselmann

Definition at line 8 of file block.widget.php.

---

Constructor & Destructor Documentation

WidgetBlock::__construct	(	$	page_data,
		$	position
	)

Definition at line 67 of file block.widget.php.

                                                           {
                $this->position = $position;
                $this->page_data = $page_data;
        }

---

Member Function Documentation

static WidgetBlock::output	(	$	page_data,
		$	position = ''
	)			[static]

Output Blocks.

Parameters:

	PageData	$page_data
	string	$position

Returns:

string

Definition at line 62 of file block.widget.php.

                                                                  {
                $w = new WidgetBlock($page_data, $position);
                return $w->render();
        }

WidgetBlock::render

(

$

policy = self::NONE

)

Renders what should be rendered.

Parameters:

int

$policy Defines how to render, meaning depends on implementation

Returns:

string The rendered content

Implements IRenderer.

Definition at line 72 of file block.widget.php.

                                                   {
                $this->page_data->sort_blocks();
                $arr_blocks = $this->page_data->get_blocks($this->position);
                return self::render_blocks($arr_blocks, $this->position);       
        }

static WidgetBlock::render_blocks	(	$	arr_blocks,
		$	position = false
	)			[static]

Definition at line 48 of file block.widget.php.

                                                                             {
                $view = ViewFactory::create_view(IViewFactory::MESSAGE, 'widgets/blocks');
                $view->assign('blocks', $arr_blocks);
                $view->assign('position', $position);
                return $view->render();
        }

static WidgetBlock::retrieve	(	$	name,
		$	page_data,
		$	route_id = '',
		$	position = false,
		$	weight = false,
		$	more_params = array()
	)			[static]

Retrieves named block and stores it in page data.

Parameters:

	string	$name
	PageData	$page_data
	string	$route_id

Returns:

void

Definition at line 30 of file block.widget.php.

                                                                                                                                       {
                $params = array(
                        'name' => $name,
                        'route_id' => $route_id
                );
                $params = array_merge($more_params, $params);
                
                $result = array();
                EventSource::Instance()->invoke_event('block', $params, $result);
                
                if ($page_data) {
                        foreach($result as $block) {
                                $page_data->add_block($block, $position, $weight);      
                        }
                }
                return $result;
        }

---

Member Data Documentation

WidgetBlock::$page_data

Definition at line 20 of file block.widget.php.

WidgetBlock::$position

Definition at line 14 of file block.widget.php.

---

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

• gyro/core/view/widgets/block.widget.php