Class Horde_Block

Description

The abstract Horde_Block:: class represents a single block within the Blocks framework.

$Horde: framework/Block/Block.php,v 1.33.10.11 2009/06/20 23:16:42 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Block/Block.php (line 18)


	
			
Variable Summary
 mixed $updateable
 string $_app
 integer $_col
 array $_params
 integer $_row
Method Summary
 static array getParams ()
 Horde_Block Horde_Block ([array|boolean $params = array()], [integer $row = null], [integer $col = null])
 void buildTree ( &$tree, [ $indent = 0], [ $parent = null])
 string getApp ()
 string getContent ()
 string getTitle ()
 void _buildTree ( &$tree, [ $indent = 0], [ $parent = null])
 string _content ()
 array _params ()
 string _title ()
Variables
mixed $updateable = false (line 23)

Whether this block has changing content.

string $_app (line 53)

Application that this block originated from.

integer $_col (line 46)

The Block column.

  • since: Horde 3.2
array $_params = array() (line 30)

Block specific parameters.

integer $_row (line 38)

The Block row.

  • since: Horde 3.2
Methods
static getParams (line 99)

Returns any settable parameters for this block. This is a static method. It does *not* reference $this->_params; that is for runtime parameters (the choices made from these options).

  • return: The block's configurable parameters.
static array getParams ()
Constructor Horde_Block (line 63)

Constructor.

Horde_Block Horde_Block ([array|boolean $params = array()], [integer $row = null], [integer $col = null])
  • array|boolean $params: Any parameters the block needs. If false, the default parameter will be used.
  • integer $row: The block row. @since Horde 3.2.
  • integer $col: The block column. @since Horde 3.2.
buildTree (line 183)
void buildTree ( &$tree, [ $indent = 0], [ $parent = null])
  • &$tree
  • $indent
  • $parent
getApp (line 85)

Returns the application that this block belongs to.

  • return: The application name.
string getApp ()
getContent (line 161)

Returns the content for this block.

This function handles the changing of current application as needed so code is executed in the scope of the application the block originated from.

  • return: The block's content.
string getContent ()
getTitle (line 130)

Returns the text to go in the title of this block.

This function handles the changing of current application as needed so code is executed in the scope of the application the block originated from.

  • return: The block's title.
string getTitle ()
_buildTree (line 244)

Returns this block's content.

  • abstract:
void _buildTree ( &$tree, [ $indent = 0], [ $parent = null])
  • &$tree
  • $indent
  • $parent
_content (line 234)

Returns this block's content.

  • return: The block's content.
  • abstract:
string _content ()
_params (line 222)

Returns the parameters needed by block.

  • return: The block's parameters.
  • abstract:
array _params ()
_title (line 210)

Returns the title to go in this block.

  • return: The block title.
  • abstract:
string _title ()

Documentation generated on Sun, 30 Jan 2011 05:15:32 +0000 by phpDocumentor 1.4.3