.

IBlock Interface Reference

Interface for Blcoks. More...

Inheritance diagram for IBlock:
IRenderer BlockBase

List of all members.

Public Member Functions

  compare ($other)
  Compare this block to another.
  get_content ()
  Get content of block (HTML).
  get_index ()
  An index to sort blocks.
  get_name ()
  Name (used as CSS class).
  get_position ()
  One of LEFT, RIGHT, CONTENT etc.
  get_title ()
  Get title of block (heading).
  is_valid ()
  Returns true if this block is valid.
  set_content ($content)
  Set content of block (HTML).
  set_index ($index)
  Set index to sort blocks.
  set_name ($name)
  Sets Name (used as CSS class).
  set_position ($position)
  Set position.
  set_title ($title)
  Set title of block (heading).

Public Attributes

const  BOTTOM = 'BOTTOM'
const  CONTENT = 'CONTENT'
const  LEFT = 'LEFT'
const  RIGHT = 'RIGHT'
const  TOP = 'TOP'

Detailed Description

Interface for Blcoks.

If you are familiar with Drupal (http://drupal.org), the concept of blocks is not new to you. A block represents a snipppet of HTML that is grouped along with other blocks and placed in a location (left, right, too..) on a page.

Most common use is to build dynamic site bars or footers.

Author:
Gerd Riesselmann

Definition at line 15 of file iblock.cls.php.


Member Function Documentation

IBlock::compare ( other  ) 

Compare this block to another.

Returns:
int 0 if index of this is equal to other's index, -1 if this index is less than and +1 if it is more than other's index

Implemented in BlockBase.

IBlock::get_content (  ) 

Get content of block (HTML).

Returns:
string

Implemented in BlockBase.

IBlock::get_index (  ) 

An index to sort blocks.

Returns:
integer

Implemented in BlockBase.

IBlock::get_name (  ) 

Name (used as CSS class).

Returns:
string

Implemented in BlockBase.

IBlock::get_position (  ) 

One of LEFT, RIGHT, CONTENT etc.

..

Returns:
string

Implemented in BlockBase.

IBlock::get_title (  ) 

Get title of block (heading).

Returns:
string

Implemented in BlockBase.

IBlock::is_valid (  ) 

Returns true if this block is valid.

Returns:
boolean True if this block has content

Implemented in BlockBase.

IBlock::set_content ( content  ) 

Set content of block (HTML).

Parameters:
string 

Implemented in BlockBase.

IBlock::set_index ( index  ) 

Set index to sort blocks.

Parameters:
integer 

Implemented in BlockBase.

IBlock::set_name ( name  ) 

Sets Name (used as CSS class).

Parameters:
string 

Implemented in BlockBase.

IBlock::set_position ( position  ) 

Set position.

Parameters:
string 

Implemented in BlockBase.

IBlock::set_title ( title  ) 

Set title of block (heading).

Parameters:
string 

Implemented in BlockBase.


Member Data Documentation

Definition at line 19 of file iblock.cls.php.

Definition at line 20 of file iblock.cls.php.

const IBlock::LEFT = 'LEFT'

Definition at line 16 of file iblock.cls.php.

const IBlock::RIGHT = 'RIGHT'

Definition at line 17 of file iblock.cls.php.

const IBlock::TOP = 'TOP'

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


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