Legacy_BlockProcedure Class Reference

Inheritance diagram for Legacy_BlockProcedure:

Public Member Functions
	__construct (&$block)
	prepare ()
	getId ()
	getName ()
	isEnableCache ()
	getCacheTime ()
	getTitle ()
	getTemplate ()
	getEntryIndex ()
	getWeight ()
	_hasVisibleOptionForm ()
	getOptionForm ()
Public Member Functions inherited from Legacy_AbstractBlockProcedure
&	getRenderTarget ()
	getRenderSystemName ()
&	_createRenderTarget ()
	isDisplay ()
&	createCacheInfo ()
	execute ()

Data Fields
	$_mBlock = null
	$mRender = null
Data Fields inherited from Legacy_AbstractBlockProcedure
	$mRender = null

Detailed Description

This class extends the base class to exchange of information with the controller. And, it has a XoopsBlock instance, and some public methods for the public side and the control panel side.

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

Constructor & Destructor Documentation

__construct()

__construct

(

&

$block

)

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

Member Function Documentation

_hasVisibleOptionForm()

_hasVisibleOptionForm

(

)

@breaf [Secret Agreement] Gets a value indicating whether the option form of this block needs the row to display the form.

Remarks

Only block management actions should use this method, and generally this method should not be replaced.

Reimplemented in Legacy_BlockProcedureAdapter.

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

getCacheTime()

getCacheTime

(

)

Return cache time

Returns

void

Reimplemented from Legacy_AbstractBlockProcedure.

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

getEntryIndex()

getEntryIndex

(

)

Gets a column index of this block.

Returns

void

Reimplemented from Legacy_AbstractBlockProcedure.

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

getId()

getId

(

)

Gets the ID number.

Returns

void

Reimplemented from Legacy_AbstractBlockProcedure.

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

getName()

getName

(

)

Gets the name of this block.

Returns

string

Reimplemented from Legacy_AbstractBlockProcedure.

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

getOptionForm()

getOptionForm

(

)

Gets rendered HTML buffer for the option form of the control panel.

Returns

string

Reimplemented in Legacy_BlockProcedureAdapter, and Stdcache_CacheclearBlock.

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

getTemplate()

getTemplate

(

)

Reimplemented from Legacy_AbstractBlockProcedure.

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

getTitle()

getTitle

(

)

Gets a title of this block.

Returns

string

Reimplemented from Legacy_AbstractBlockProcedure.

Reimplemented in Message_Block.

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

getWeight()

getWeight

(

)

Gets a weight of this block.

Returns

void

Reimplemented from Legacy_AbstractBlockProcedure.

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

isEnableCache()

isEnableCache

(

)

Gets a value indicating whether the block can be cached.

Returns

void

Reimplemented from Legacy_AbstractBlockProcedure.

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

prepare()

prepare

(

)

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

Returns

bool

Reimplemented from Legacy_AbstractBlockProcedure.

Reimplemented in Message_Block, and Stdcache_CacheclearBlock.

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

Field Documentation

$_mBlock

$_mBlock = null

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

$mRender

$mRender = null

Definition at line 175 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