blueshoes php application framework and cms            applications_cms
[ class tree: applications_cms ] [ index: applications_cms ] [ all elements ]

Class: Bs_Cms_Block

Source Location: /applications/cms/Bs_Cms_Block.class.php

Class Overview




Variables

Methods


Child classes:

Inherited Variables

Inherited Methods


Class Details

[line 10]


[ Top ]


Class Variables

$blockFullPath =

[line 40]

absolute path to the block file.


Type:   mixed


[ Top ]

$blockJunks =

[line 35]

the blockName parsed into its junks.



Tags:

var:  (hash)

Type:   array


[ Top ]

$blockName =

[line 29]

the name of the block. like "title1.1.de.textType.block.php"


Type:   mixed


[ Top ]

$Bs_HeadCollector =

[line 18]

instance of Bs_HeadCollector.



Tags:

access:  public



[ Top ]

$data = array()

[line 55]



Tags:

access:  public

Type:   array


[ Top ]

$user =  'user'

[line 48]

'user' or 'admin'. default is 'user'.



Tags:

access:  public

Type:   string


[ Top ]

$xmlProps =

[line 24]

the props that were in the <bs:something x="y"> tag. keys are in uppercase.


Type:   mixed


[ Top ]

$_failed =  FALSE

[line 60]


Type:   mixed


[ Top ]

$_failedReason =

[line 61]


Type:   mixed


[ Top ]

$_xPath =

[line 58]


Type:   mixed


[ Top ]



Class Methods


constructor Bs_Cms_Block [line 112]

Bs_Cms_Block Bs_Cms_Block( [mixed $xmlProps = NULL], [mixed $blockName = NULL], [mixed $blockJunks = NULL], [mixed $blockFullPath = NULL])

constructor.



[ Top ]

method bs_fia_getHints [line 495]

void bs_fia_getHints( mixed $fiaAgent)

CALLBACK Funtion of Bs_FormItAble

Return the hints used to built the form




[ Top ]

method bs_fia_loadHints [line 503]

void bs_fia_loadHints( [mixed $fiaAgent = null])



[ Top ]

method edit [line 148]

string edit( [object $objToEdit = NULL], [string $mode = 'edit'], [string $addTodoInfo = ''])



Tags:

return:  (html code)
access:  public


Overridden in child classes as:

Bs_Cms_BlockChart::edit()
Bs_Cms_BlockNav::edit()
Bs_Cms_BlockNews::edit()

Parameters:

object   $objToEdit  
string   $mode   (default is 'edit')
string   $addTodoInfo   (string that's added into the form, can be used for hidden fields.)

[ Top ]

method initByFullPath [line 122]

void initByFullPath( mixed $blockFullPath, [mixed $xmlProps = NULL], [mixed $blockName = NULL], [mixed $blockJunks = NULL])

inits the object by the given full path to the block file.



Tags:

access:  public


[ Top ]

method isEditable [line 182]

bool isEditable( )



Tags:

access:  public


[ Top ]

method load [line 277]

void load( )



Overridden in child classes as:

Bs_Cms_BlockChart::load()
Bs_Cms_BlockDsn::load()
Bs_Cms_BlockTable::load()

[ Top ]

method loadFromIni [line 287]

void loadFromIni( )



[ Top ]

method loadFromXml [line 325]

void loadFromXml( )



[ Top ]

method render [line 136]

void render( )



Overridden in child classes as:

Bs_Cms_BlockChart::render()
Bs_Cms_BlockDsn::render()
makes no sense to render this block. so it returns an empty string.
Bs_Cms_BlockFaq::render()
Bs_Cms_BlockHtml::render()
renders the block.
Bs_Cms_BlockImage::render()
Bs_Cms_BlockMeta::render()
renders the block.
Bs_Cms_BlockNav::render()
Bs_Cms_BlockNews::render()
Bs_Cms_BlockTable::render()
renders the block.
Bs_Cms_BlockTextType::render()
render the block.

[ Top ]

method store [line 458]

void store( )



Overridden in child classes as:

Bs_Cms_BlockChart::store()
Bs_Cms_BlockTable::store()

[ Top ]

method _generateXmlHelper [line 443]

void _generateXmlHelper( mixed $keys)



[ Top ]

method _loadFromIni [line 321]


method _loadFromXml [line 423]


method _loadFromXmlHelper [line 428]

void _loadFromXmlHelper( mixed $keys)



[ Top ]


Documentation generated on Mon, 29 Dec 2003 21:08:09 +0100 by phpDocumentor 1.2.3