Widget
extends EntityBase
in package
Represents a template widget
Tags
Table of Contents
Constants
- 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
- $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
- $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
- 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
- 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.
- 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
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- 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
Constants
TYPE_BLOCK
public
string
TYPE_BLOCK
= 'block'
Widget is a block that can be parsed
TYPE_CALLBACK
public
string
TYPE_CALLBACK
= 'callback'
Widget is a placeholder that has params and triggers a callback
TYPE_PLACEHOLDER
public
string
TYPE_PLACEHOLDER
= 'placeholder'
Widget is a simple placeholder
Properties
$component
Component which registered this widget
protected
SystemComponentController
$component
$customParseTarget
Custom parse target to use for sub-widgets
protected
WidgetParseTarget
$customParseTarget
= null
$localeCodes
List of locale codes ordered by translation fallback order per Cx instance
protected
static array<string|int, mixed>
$localeCodes
= array()
Array in the form: array(<instanceId> => array(<localeCode>, ...))
Tags
$name
Name of this widget
protected
string
$name
$nestingCount
Counts the nesting level of __call()
protected
static int
$nestingCount
= 0
$stringRepresentationBlank
Whether blank string representations are valid
protected
bool
$stringRepresentationBlank
= false
Whether blank string representations are valid
Tags
$stringRepresentationFields
List of fields that should be available in the string representation
protected
array<string|int, mixed>
$stringRepresentationFields
= array()
List of field names
Tags
$stringRepresentationFormat
Sprintf format for the string representation
protected
string
$stringRepresentationFormat
= ''
Sprintf format string
Tags
$triggerEvents
protected
bool
$triggerEvents
= true
Whether to trigger events
$type
Whether this widget represents a template block, placeholder or callback
protected
string
$type
$validators
Initialize this array as follows: array( 'columName' => Zend_Validate )
protected
array<string|int, mixed>
$validators
= array()
$virtual
Defines if an entity is virtual and therefore not persistable.
protected
bool
$virtual
= false
Defaults to FALSE - not virtual.
Methods
__call()
Route methods like getName(), getType(), getDirectory(), etc.
public
__call(string $methodName, array<string|int, mixed> $arguments) : mixed
Parameters
- $methodName : string
-
Name of method to call
- $arguments : array<string|int, mixed>
-
List of arguments for the method to call
Tags
Attributes
- #[ReturnTypeWillChange]
Return values
mixed —Return value of the method to call
__construct()
Instanciates a new widget
public
__construct(SystemComponentController $component, string $name[, string $type = self::TYPE_PLACEHOLDER ][, bool $triggerEvents = true ]) : mixed
Parameters
- $component : SystemComponentController
-
Component registering this widget
- $name : string
-
Name of this widget
- $type : string = self::TYPE_PLACEHOLDER
-
(optional) Whether this widget represents a template placeholder, block or callback, default: placeholder
- $triggerEvents : bool = true
__get()
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.
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
Attributes
- #[ReturnTypeWillChange]
__toString()
Returns this entity's identifying value
public
__toString() : string
By default this returns the same as getKeyAsString(), but this method might get overridden by subclasses.
Return values
string —Identifying value for this entity
clearCache()
Clears all cache files for this Widget (if any)
public
abstract clearCache() : mixed
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetCustomParseTarget()
Returns this widget's custom parse target
public
getCustomParseTarget() : WidgetParseTarget
Return values
WidgetParseTarget —Widget parse target
getKeyAsString()
Returns this entity's key
public
final getKeyAsString([string $separator = '/' ]) : string
If this entity has a composite key, the fields are separated by $separator.
Parameters
- $separator : string = '/'
-
(optional) Separator for composite key fields, default "/"
Return values
string —Entity key as string
getName()
Returns the name of this widget
public
getName() : string
Return values
string —Name of this widget
getRegisteringComponent()
Returns the component which registered this widget
public
getRegisteringComponent() : SystemComponentController
Return values
SystemComponentController —Registering component
getTranslatedFieldValue()
Returns the value of a translatable field using fallback mechanisms
public
getTranslatedFieldValue(string $fieldName) : mixed
If the field is not translatable its value is returned anyway. Tries to return the value in the following locales (if non-empty):
- Current locale
- Default locale
- All other locales
Parameters
- $fieldName : string
-
Name of a translatable field
getType()
Returns whether this widget represents a template placeholder, block or callback
public
getType() : string
Return values
string —$type Whether this widget represents a template placeholder, block or callback
hasCustomParseTarget()
Tells whether this widget has a custom parse target
public
hasCustomParseTarget() : bool
Return values
bool —True if this widget has a custom parse target
initializeValidators()
Set $this->validators
public
initializeValidators() : mixed
Validators can be found in lib/FRAMEWORK/Validator.class.php These will be executed if validate() is called
internalParse()
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.
public
abstract internalParse(HTML_Template_Sigma $template, Reponse $response, string $targetComponent, string $targetEntity, string $targetId[, array<string|int, mixed> $params = array() ]) : string
Parameters
- $template : HTML_Template_Sigma
-
Template to parse this widget into
- $response : Reponse
-
Current response object
- $targetComponent : string
-
Parse target component name
- $targetEntity : string
-
Parse target entity name
- $targetId : string
-
Parse target entity ID
- $params : array<string|int, mixed> = array()
-
(optional) List of params for widgets of type 'callback'
Return values
string —Replacement for widgets without content, NULL otherwise
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
parse()
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)
public
parse(HTML_Template_Sigma $template, Reponse $response, string $targetComponent, string $targetEntity, string $targetId[, mixed $arguments = array() ][, array<string|int, mixed> $excludedWidgets = array() ]) : mixed
Parameters
- $template : HTML_Template_Sigma
-
Template to parse this widget into
- $response : Reponse
-
Current response object
- $targetComponent : string
-
Parse target component name
- $targetEntity : string
-
Parse target entity name
- $targetId : string
-
Parse target entity ID
- $arguments : mixed = array()
- $excludedWidgets : array<string|int, mixed> = array()
-
(optional) List of widget names that shall not be parsed
setCustomParseTarget()
Sets this widget's parse target
public
setCustomParseTarget(WidgetParseTarget $parseTarget) : mixed
Parameters
- $parseTarget : WidgetParseTarget
-
Widget parse target for subwidgets
setVirtual()
Set the virtuality of the entity
public
setVirtual(bool $virtual) : mixed
Parameters
- $virtual : bool
-
TRUE to set the entity as virtual or otherwise to FALSE
validate()
public
validate() : mixed
Tags
getFallbackLocaleCodes()
Returns a list of all locale codes ordered by fallback order
protected
getFallbackLocaleCodes() : array<string|int, mixed>
- First entry is the current locale
- Second entry is the default locale (if different from current, it's omitted otherwise)
- Then all other locales follow (in no particular order)
Tags
Return values
array<string|int, mixed> —List of locale codes
getStringRepresentationBlank()
Whether blank string representations are valid
protected
getStringRepresentationBlank() : bool
Return values
bool —Whether blank string representations are valid
getStringRepresentationFields()
Returns a list of fields available in the string representation
protected
getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of field names
getStringRepresentationFormat()
Returns the sprintf() format for the string representation
protected
getStringRepresentationFormat() : string
Return values
string —sprintf() format string