Legacy_AbstractBlockProcedure Class Reference

Inheritance diagram for Legacy_AbstractBlockProcedure:

Public Member Functions
	prepare ()
&	getRenderTarget ()
	getRenderSystemName ()
&	_createRenderTarget ()
	getId ()
	getName ()
	isEnableCache ()
	getCacheTime ()
	getTitle ()
	getTemplate ()
	getEntryIndex ()
	getWeight ()
	isDisplay ()
&	createCacheInfo ()
	execute ()

Data Fields
	$mRender = null

Detailed Description

The class for blocks which has interfaces to exchange information with the controller. The sub-class must implement these interfaces with helper functions, to be called back by the controller.

Definition at line 21 of file Legacy_BlockProcedure.class.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Definition at line 28 of file Legacy_BlockProcedure.class.php.

Member Function Documentation

_createRenderTarget()

& _createRenderTarget

(

)

Creates an instance of the render buffer, and set it to the property. This is a helper function for sub-classes. @access protected

Definition at line 69 of file Legacy_BlockProcedure.class.php.

createCacheInfo()

& createCacheInfo

(

)

Definition at line 148 of file Legacy_BlockProcedure.class.php.

execute()

execute

(

)

Reimplemented in Legacy_AdminBlockPhp, and Legacy_AdminBlockServer.

Definition at line 155 of file Legacy_BlockProcedure.class.php.

getCacheTime()

getCacheTime

(

)

Return cache time

Returns

void

Reimplemented in Legacy_BlockProcedure.

Definition at line 105 of file Legacy_BlockProcedure.class.php.

getEntryIndex()

getEntryIndex

(

)

Gets a column index of this block.

Returns

void

Reimplemented in Legacy_AdminActionSearch, Legacy_AdminBlockComments, Legacy_AdminBlockLogInfo, Legacy_AdminBlockMenu, Legacy_AdminBlockOnline, Legacy_AdminBlockOverview, Legacy_AdminBlockPhp, Legacy_AdminBlockServer, Legacy_AdminBlockWaiting, Legacy_AdminSideMenu, and Legacy_BlockProcedure.

Definition at line 127 of file Legacy_BlockProcedure.class.php.

getId()

getId

(

)

Gets the ID number.

Returns

void

Reimplemented in Legacy_BlockProcedure.

Definition at line 81 of file Legacy_BlockProcedure.class.php.

getName()

getName

(

)

Gets the name of this block.

Returns

string

Reimplemented in Legacy_AdminActionSearch, Legacy_AdminBlockComments, Legacy_AdminBlockLogInfo, Legacy_AdminBlockMenu, Legacy_AdminBlockOnline, Legacy_AdminBlockOverview, Legacy_AdminBlockPhp, Legacy_AdminBlockServer, Legacy_AdminBlockWaiting, Legacy_AdminSideMenu, and Legacy_BlockProcedure.

Definition at line 89 of file Legacy_BlockProcedure.class.php.

getRenderSystemName()

getRenderSystemName

(

)

Gets a name of the dependence render-system.

Returns

string

Reimplemented in Legacy_AdminActionSearch, Legacy_AdminBlockComments, Legacy_AdminBlockLogInfo, Legacy_AdminBlockOnline, Legacy_AdminBlockOverview, Legacy_AdminBlockPhp, Legacy_AdminBlockServer, and Legacy_AdminBlockWaiting.

Definition at line 58 of file Legacy_BlockProcedure.class.php.

getRenderTarget()

& getRenderTarget

(

)

Definition at line 45 of file Legacy_BlockProcedure.class.php.

getTemplate()

getTemplate

(

)

Definition at line 119 of file Legacy_BlockProcedure.class.php.

getTitle()

getTitle

(

)

Gets a title of this block.

Returns

string

Reimplemented in Legacy_AdminActionSearch, Legacy_AdminBlockComments, Legacy_AdminBlockLogInfo, Legacy_AdminBlockMenu, Legacy_AdminBlockOnline, Legacy_AdminBlockOverview, Legacy_AdminBlockPhp, Legacy_AdminBlockServer, Legacy_AdminBlockWaiting, Legacy_AdminSideMenu, Legacy_BlockProcedure, and Message_Block.

Definition at line 113 of file Legacy_BlockProcedure.class.php.

getWeight()

getWeight

(

)

Gets a weight of this block.

Returns

void

Reimplemented in Legacy_BlockProcedure.

Definition at line 135 of file Legacy_BlockProcedure.class.php.

isDisplay()

isDisplay

(

)

Gets a value indicating whether this block needs to display its content.

Returns

bool

Reimplemented in Legacy_BlockProcedureAdapter, Message_Block, and Stdcache_CacheclearBlock.

Definition at line 143 of file Legacy_BlockProcedure.class.php.

isEnableCache()

isEnableCache

(

)

Gets a value indicating whether the block can be cached.

Returns

void

Reimplemented in Legacy_AdminActionSearch, Legacy_AdminBlockComments, Legacy_AdminBlockLogInfo, Legacy_AdminBlockMenu, Legacy_AdminBlockOnline, Legacy_AdminBlockOverview, Legacy_AdminBlockPhp, Legacy_AdminBlockServer, Legacy_AdminBlockWaiting, Legacy_AdminSideMenu, and Legacy_BlockProcedure.

Definition at line 97 of file Legacy_BlockProcedure.class.php.

prepare()

prepare

(

)

Preparation. If it's in exception case, returns false.

Returns

bool

Reimplemented in Legacy_BlockProcedure, Message_Block, and Stdcache_CacheclearBlock.

Definition at line 36 of file Legacy_BlockProcedure.class.php.

Field Documentation

$mRender

$mRender = null

Definition at line 26 of file Legacy_BlockProcedure.class.php.

---

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

• html/modules/legacy/kernel/Legacy_BlockProcedure.class.php