class Block extends Tag (View source)

Properties

array $indices Contains an array of indices, which represent the order of the elements in the block
integer $current Current step of the block while iteration
string[] $suffixes

Methods

Dao
getDao()

No description

setDao($dao)

No description

getResource() deprecated

No description

initDao(null $key = null, bool $forceDetection = false)

No description

$this
setValues(array $data = array())

No description

$this
setValue($key, $value)

No description

array
__sleep()

Returns only the properties which should be serialized

from Tag
mixed
__call($method, $args)

No description

void
__clone()

No description

array
getObjectVars()

returns object values without the dao

void
beginTransaction()

No description

void
commit()

No description

void
rollBack()

No description

void
configure()

No description

array
getValidTableColumns(string $table, bool $cache)

No description

void
resetValidTableColumnsCache(string $table)

No description

static mixed
factory($type, $name, $documentId, null $config = null, null $controller = null, null $view = null, null $editmode = null)

No description

from Tag
string
admin()

No description

mixed
getValue()

No description

from Tag
string
getName()

No description

from Tag
$this
setName(string $name)

No description

from Tag
$this
setDocumentId(integer $id)

No description

from Tag
integer
getDocumentId()

No description

from Tag
array
getOptions()

No description

from Tag
$this
setOptions(array $options)

No description

$this
setController(Action $controller)

No description

from Tag
getController()

No description

from Tag
$this
setView(View $view)

No description

from Tag
View
getView()

No description

from Tag
string
getRealName()

No description

from Tag
setRealName(string $realName)

No description

from Tag
string
__toString()

direct output to the frontend

from Tag
boolean
getEditmode()

No description

from Tag
$this
setEditmode(boolean $editmode)

No description

from Tag
$this
getDataForResource()

No description

from Tag
array
getCacheTags($ownerDocument, array $tags = array())

No description

from Tag
resolveDependencies()

This is a dummy and is mostly implemented by relation types

from Tag
getFromWebserviceImport($wsElement, $document = null, $params = array(), $idMapper = null)

No description

array
getForWebserviceExport($document = null, $params = array())

Returns the current tag's data for web service export

from Tag
bool
checkValidity()

No description

from Tag
$this
setInherited($inherited)

No description

from Tag
boolean
getInherited()

No description

from Tag
static string
buildTagName($type, $name, null $document = null)

No description

from Tag
string
getType()

No description

mixed
getData()

No description

string
frontend()

No description

string
setDataFromResource(mixed $data)

No description

void
setDataFromEditmode(mixed $data)

No description

$this
setDefault()

No description

boolean
loop()

Loops through the block

boolean
enumerate() deprecated

Alias for loop

$this
start()

Is executed at the beginning of the loop and setup some general settings

void
end()

Is executed at the end of the loop and removes the settings set in start()

blockConstruct()

No description

blockDestruct()

No description

void
blockStart()

Is called evertime a new iteration starts (new entry of the block while looping)

void
blockEnd()

Is called evertime a new iteration ends (new entry of the block while looping)

void
outputEditmode(string $v)

Sends data to the output stream

void
setupStaticEnvironment()

Setup some settings that are needed for blocks

integer
getCount()

Return the amount of block elements

integer
getCurrent()

Return current iteration step

integer
getCurrentIndex()

Return current index

void
__wakeup()

If object was serialized, set the counter back to 0

bool
isEmpty()

No description

Item[]
getElements()

No description

Details

at line line 24
Dao getDao()

Return Value

Dao

AbstractModel setDao($dao)

Parameters

$dao

Return Value

AbstractModel

AbstractDao getResource() deprecated

deprecated

Return Value

AbstractDao

initDao(null $key = null, bool $forceDetection = false)

Parameters

null $key
bool $forceDetection

Exceptions

Exception

$this setValues(array $data = array())

Parameters

array $data

Return Value

$this

$this setValue($key, $value)

Parameters

$key
$value

Return Value

$this

in Tag at line line 273
array __sleep()

Returns only the properties which should be serialized

Return Value

array

mixed __call($method, $args)

Parameters

$method
$args

Return Value

mixed

Exceptions

Exception

void __clone()

Return Value

void

array getObjectVars()

returns object values without the dao

Return Value

array

void beginTransaction()

Return Value

void

void commit()

Return Value

void

void rollBack()

Return Value

void

void configure()

Return Value

void

array getValidTableColumns(string $table, bool $cache)

Parameters

string $table
bool $cache

Return Value

array

void resetValidTableColumnsCache(string $table)

Parameters

string $table

Return Value

void

in Tag at line line 89
static mixed factory($type, $name, $documentId, null $config = null, null $controller = null, null $view = null, null $editmode = null)

Parameters

$type
$name
$documentId
null $config
null $controller
null $view
null $editmode

Return Value

mixed

at line line 67
string admin()

Return Value

string

See also

Document\Tag\TagInterface::admin

in Tag at line line 152
mixed getValue()

Return Value

mixed

in Tag at line line 160
string getName()

Return Value

string

in Tag at line line 169
$this setName(string $name)

Parameters

string $name

Return Value

$this

in Tag at line line 180
$this setDocumentId(integer $id)

Parameters

integer $id

Return Value

$this

in Tag at line line 190
integer getDocumentId()

Return Value

integer

in Tag at line line 198
array getOptions()

Return Value

array

at line line 341
$this setOptions(array $options)

Parameters

array $options

Return Value

$this

in Tag at line line 218
$this setController(Action $controller)

Parameters

Action $controller

Return Value

$this

in Tag at line line 228
Action getController()

Return Value

Action

in Tag at line line 237
$this setView(View $view)

Parameters

View $view

Return Value

$this

in Tag at line line 247
View getView()

Return Value

View

in Tag at line line 255
string getRealName()

Return Value

string

in Tag at line line 263
setRealName(string $realName)

Parameters

string $realName

in Tag at line line 293
string __toString()

direct output to the frontend

Return Value

string

in Tag at line line 322
boolean getEditmode()

Return Value

boolean

in Tag at line line 331
$this setEditmode(boolean $editmode)

Parameters

boolean $editmode

Return Value

$this

in Tag at line line 341
$this getDataForResource()

Return Value

$this

in Tag at line line 353
array getCacheTags($ownerDocument, array $tags = array())

Parameters

$ownerDocument
array $tags

Return Value

array

in Tag at line line 361
resolveDependencies()

This is a dummy and is mostly implemented by relation types

at line line 406
Element getFromWebserviceImport($wsElement, $document = null, $params = array(), $idMapper = null)

Parameters

$wsElement
$document
$params
$idMapper

Return Value

Element

Exceptions

Exception

in Tag at line line 387
array getForWebserviceExport($document = null, $params = array())

Returns the current tag's data for web service export

Parameters

$document
$params

Return Value

array

in Tag at line line 416
bool checkValidity()

Return Value

bool

in Tag at line line 425
$this setInherited($inherited)

Parameters

$inherited

Return Value

$this

in Tag at line line 435
boolean getInherited()

Return Value

boolean

in Tag at line line 448
static string buildTagName($type, $name, null $document = null)

Parameters

$type
$name
null $document

Return Value

string

Exceptions

Exception
Zend_Exception

at line line 50
string getType()

Return Value

string

See also

Document\Tag\TagInterface::getType

at line line 59
mixed getData()

Return Value

mixed

See also

Document\Tag\TagInterface::getData

at line line 75
string frontend()

Return Value

string

See also

Document\Tag\TagInterface::frontend

at line line 86
string setDataFromResource(mixed $data)

Parameters

mixed $data

Return Value

string

See also

Document\Tag\TagInterface::setDataFromResource

at line line 98
void setDataFromEditmode(mixed $data)

Parameters

mixed $data

Return Value

void

See also

Document\Tag\TagInterface::setDataFromEditmode

at line line 108
$this setDefault()

Return Value

$this

at line line 123
boolean loop()

Loops through the block

Return Value

boolean

at line line 165
boolean enumerate() deprecated

deprecated

Alias for loop

Return Value

boolean

See also

loop()

at line line 175
$this start()

Is executed at the beginning of the loop and setup some general settings

Return Value

$this

at line line 226
void end()

Is executed at the end of the loop and removes the settings set in start()

Return Value

void

at line line 244
blockConstruct()

at line line 256
blockDestruct()

at line line 268
void blockStart()

Is called evertime a new iteration starts (new entry of the block while looping)

Return Value

void

at line line 288
void blockEnd()

Is called evertime a new iteration ends (new entry of the block while looping)

Return Value

void

at line line 299
void outputEditmode(string $v)

Sends data to the output stream

Parameters

string $v

Return Value

void

at line line 311
void setupStaticEnvironment()

Setup some settings that are needed for blocks

Return Value

void

at line line 357
integer getCount()

Return the amount of block elements

Return Value

integer

at line line 367
integer getCurrent()

Return current iteration step

Return Value

integer

at line line 377
integer getCurrentIndex()

Return current index

Return Value

integer

at line line 387
void __wakeup()

If object was serialized, set the counter back to 0

Return Value

void

at line line 395
bool isEmpty()

Return Value

bool

at line line 420
Item[] getElements()

Return Value

Item[]