Documentation

RandomEsiWidget extends EsiWidget

in package

• cloudrexx
• coremodules
• widget

Represents a template widget that contains randomized content

Tags

copyright

CLOUDREXX CMS - Cloudrexx AG Thun

author

Michael Ritter michael.ritter@cloudrexx.com

subpackage

coremodules_widget

version

1.0.0

Table of Contents

Constants

ESI_VAR_ID_AUTOCONF  : mixed = -1

This will just make a most-of-the-time-working setup and should not be used on production without checking first.

ESI_VAR_ID_CHANNEL  : mixed = 8

ESI_VAR_ID_COUNTRY  : mixed = 64

ESI_VAR_ID_CURRENCY  : mixed = 32

ESI_VAR_ID_LOCALE  : mixed = 2

ESI_VAR_ID_PAGE  : mixed = 1

ESI_VAR_ID_PATH  : mixed = 128

ESI_VAR_ID_QUERY  : mixed = 256

ESI_VAR_ID_THEME  : mixed = 4

ESI_VAR_ID_USER  : mixed = 16

ESI_VAR_NAME_CHANNEL  : mixed = 'channel'

ESI_VAR_NAME_COUNTRY  : mixed = 'country'

ESI_VAR_NAME_CURRENCY  : mixed = 'currency'

ESI_VAR_NAME_LOCALE  : mixed = 'locale'

ESI_VAR_NAME_PAGE  : mixed = 'page'

ESI_VAR_NAME_PATH  : mixed = 'path'

ESI_VAR_NAME_QUERY  : mixed = 'query'

ESI_VAR_NAME_THEME  : mixed = 'theme'

ESI_VAR_NAME_USER  : mixed = 'user'

TYPE_BLOCK  : string = 'block'

TYPE_CALLBACK  : string = 'callback'

TYPE_PLACEHOLDER  : string = 'placeholder'

Properties

$component  : SystemComponentController

Component which registered this widget

$customParseTarget  : WidgetParseTarget

Custom parse target to use for sub-widgets

$esiVariables  : int

ESI variables configured to be sent for this Widget

$jsonAdapterName  : mixed

$jsonMethodName  : mixed

$jsonParams  : mixed

$localeCodes  : array<string|int, mixed>

List of locale codes ordered by translation fallback order per Cx instance

$name  : string

Name of this widget

$nestingCount  : int

Counts the nesting level of __call()

$stringRepresentationBlank  : bool

Whether blank string representations are valid

$stringRepresentationFields  : array<string|int, mixed>

List of fields that should be available in the string representation

$stringRepresentationFormat  : string

Sprintf format for the string representation

$triggerEvents  : bool

$type  : string

Whether this widget represents a template block, placeholder or callback

$uniqueRepetitionCount  : int

$validators  : array<string|int, mixed>

Initialize this array as follows: array( 'columName' => Zend_Validate )

$virtual  : bool

Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed

Route methods like getName(), getType(), getDirectory(), etc.

__construct()  : mixed

Instanciates a new widget

__get()  : mixed

This is an ugly solution to allow $this->cx to be available in all entity classes Since the entity's constructor is not called when an entity is loaded from DB this cannot be assigned there.

__toString()  : string

Returns this entity's identifying value

clearCache()  : mixed

Clears all cache files for this Widget (if any)

getComponentController()  : SystemComponent

Returns the component controller for this component

getCustomParseTarget()  : WidgetParseTarget

Returns this widget's custom parse target

getEsiVariables()  : int

Returns the ESI variables configured to be send for this Widget Return value is a combination of othered constants

getJsonAdapterName()  : string

Returns the name of the JsonAdapter to call

getJsonMethodName()  : string

Returns the name of the JsonAdapter method to call

getKeyAsString()  : string

Returns this entity's key

getName()  : string

Returns the name of this widget

getRegisteringComponent()  : SystemComponentController

Returns the component which registered this widget

getTranslatedFieldValue()  : mixed

Returns the value of a translatable field using fallback mechanisms

getType()  : string

Returns whether this widget represents a template placeholder, block or callback

getUniqueRepetitionCount()  : int

Returns the number of unique repetitions of this widget

hasCustomParseTarget()  : bool

Tells whether this widget has a custom parse target

initializeValidators()  : mixed

Set $this->validators

internalParse()  : string

Really parses this widget into $template If this Widget has no content, the replacement can simply be returned as string. Otherwise the replacement must be done in $template.

isEsiVariableActive()  : mixed

Tells wheter the given ESI variable is configured to be sent for this Widget

isVirtual()  : bool

Returns the virtuality of the entity

parse()  : mixed

Parses this widget into $template Depending on the type, the passed params and return value are different: TYPE_CALLBACK: $params are the callback's params $excludeWidgets is always empty return value is the content of this widget TYPE_PLACEHOLDER: $params are always empty $excludedWidgets is the list of Widgets we already recursed through return value is the content of this widget TYPE_BLOCK $params are always empty $excludedWidgets is the list of Widgets we already recursed through return value is empty string (/unused)

setCustomParseTarget()  : mixed

Sets this widget's parse target

setEsiVariable()  : mixed

Sets the ESI variable as active

setEsiVariables()  : mixed

Sets the ESI variables configured to be sent for this widget Simple setter, see getEsiVariables() for format definition

setUniqueRepetitionCount()  : mixed

Sets the number of unique repetitions of this widget

setVirtual()  : mixed

Set the virtuality of the entity

unsetEsiVariable()  : mixed

Sets the ESI variable as inactive

validate()  : mixed

getEsiParams()  : array<string|int, mixed>

Returns the params for the JsonAdapter call If you add an ESI variable core_module Cache needs to be updated as well: - Controller\CacheLib (multiple times) - Model\Entity\ReverseProxyCloudrexx::globDrop()

getFallbackLocaleCodes()  : array<string|int, mixed>

Returns a list of all locale codes ordered by fallback order

getStringRepresentationBlank()  : bool

Whether blank string representations are valid

getStringRepresentationFields()  : array<string|int, mixed>

Returns a list of fields available in the string representation

getStringRepresentationFormat()  : string

Returns the sprintf() format for the string representation