TemplatedBlock Class Reference

A block that renders itself from a template. More...

Inheritance diagram for TemplatedBlock:

List of all members.

Public Member Functions
	__construct ($name, $title, $template, $index=1000, $position=self::LEFT)
	Constructor.
	get_content ()
	Get content of block (HTML).
	render ($policy=self::NONE)
	Renders what should be rendered.
Protected Member Functions
	configure_view ($view)
	Configure the view.
	create_view ($template)
	Create and configure the view.
Protected Attributes
	$template = ''
	$view_is_rendered = false

---

Detailed Description

A block that renders itself from a template.

The block instance is available as $block within the template. So you may change title or name like this:

 $block->set_title('New title');
 $block->set_name('newname');

Author:

Gerd Riesselmann

Definition at line 16 of file templated.block.cls.php.

---

Constructor & Destructor Documentation

TemplatedBlock::__construct	(	$	name,
		$	title,
		$	template,
		$	index = 1000,
		$	position = self::LEFT
	)

Constructor.

Parameters:

	string	$name The name of this block. Used as class, too
	string	$title The title of the block. Displayed as heading, e.g.
	string	$template The template to render
	integer	$index The block's index. A block with lowest index will be displayed first
	enum	$position Where the block is to be displayed.

Reimplemented from BlockBase.

Definition at line 29 of file templated.block.cls.php.

                                                                                                   {
                parent::__construct($name, $title, '', $index, $position);
                $this->template = $template;
        }

---

Member Function Documentation

TemplatedBlock::configure_view

(

$

view

)

[protected]

Configure the view.

Parameters:

IView

$view

Reimplemented in TemplatedParameterizedBlock.

Definition at line 52 of file templated.block.cls.php.

                                                 {
                // to be overloaded
        }

TemplatedBlock::create_view

(

$

template

)

[protected]

Create and configure the view.

Parameters:

string

$template The template

Returns:

IView

Definition at line 40 of file templated.block.cls.php.

                                                  {
                $view = ViewFactory::create_view(IViewFactory::MESSAGE, $template, $page_data);
                $view->assign('block', $this);
                $this->configure_view($view);                                   
                return $view;
        }

TemplatedBlock::get_content

(

)

Get content of block (HTML).

Returns:

string

Reimplemented from BlockBase.

Definition at line 61 of file templated.block.cls.php.

                                      {
                if (!$this->view_is_rendered) {
                        $this->view_is_rendered = true;
                        $view = $this->create_view($this->template);
                        $this->set_content($view->render());
                }
                return parent::get_content();
        }

TemplatedBlock::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

Reimplemented from BlockBase.

Definition at line 76 of file templated.block.cls.php.

                                                   {
                if (!$this->view_is_rendered) {
                        $this->get_content();
                }               
                return parent::render($policy);
        }               

---

Member Data Documentation

TemplatedBlock::$template = '' [protected]

Definition at line 18 of file templated.block.cls.php.

TemplatedBlock::$view_is_rendered = false [protected]

Definition at line 17 of file templated.block.cls.php.

---

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

• contributions/page.blocks/controller/base/templated.block.cls.php