Block
extends WidgetParseTarget
in package
Simple "dummy" representation of a block in order to get widget contents This class might later be used as a doctrine entity
Tags
Table of Contents
Properties
- $content : array<string|int, mixed>
- Block content per language
- $id : int
- Block ID
- $localeCodes : array<string|int, mixed>
- List of locale codes ordered by translation fallback order per Cx instance
- $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
- $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
- Creates a new block entity used for WidgetParseTarget
- __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
- getComponentController() : SystemComponent
- Returns the component controller for this component
- getContent() : string
- Returns this block's content. Required WidgetParseTarget getter
- getId() : int
- Returns this block's ID
- getKeyAsString() : string
- Returns this entity's key
- getTranslatedFieldValue() : mixed
- Returns the value of a translatable field using fallback mechanisms
- getWidgetContent() : Sigma
- Returns the content for a widget
- getWidgetContentAttributeName() : string
- Returns the name of the attribute which contains content that may contain a widget
- initializeValidators() : mixed
- Set $this->validators
- isVirtual() : bool
- Returns the virtuality of the entity
- setVirtual() : mixed
- Set the virtuality of the entity
- validate() : mixed
- getContentTemplateForWidget() : Sigma
- Returns the template in which the widget can be used
- 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
Properties
$content
Block content per language
protected
array<string|int, mixed>
$content
$id
Block ID
protected
int
$id
$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
$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
$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
Return values
mixed —Return value of the method to call
__construct()
Creates a new block entity used for WidgetParseTarget
public
__construct(int $blockId) : mixed
Parameters
- $blockId : int
-
Block ID
__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
__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
getComponentController()
Returns the component controller for this component
public
getComponentController() : SystemComponent
Return values
SystemComponentgetContent()
Returns this block's content. Required WidgetParseTarget getter
public
getContent(int $langId) : string
Parameters
- $langId : int
-
Internal language/locale ID
Return values
string —Block content
getId()
Returns this block's ID
public
getId() : int
Return values
int —Block ID
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
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
getWidgetContent()
Returns the content for a widget
public
getWidgetContent(string $widgetName, Theme $theme, Page $page, mixed $channel) : Sigma
Parameters
- $widgetName : string
- $theme : Theme
-
Theme which is parsed
- $page : Page
-
Page which is parsed
- $channel : mixed
Return values
Sigma —Widget content
getWidgetContentAttributeName()
Returns the name of the attribute which contains content that may contain a widget
public
getWidgetContentAttributeName(string $widgetName) : string
Parameters
- $widgetName : string
Return values
string —Attribute name
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
isVirtual()
Returns the virtuality of the entity
public
isVirtual() : bool
Return values
bool —TRUE if the entity is virtual, otherwise FALSE
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
getContentTemplateForWidget()
Returns the template in which the widget can be used
protected
getContentTemplateForWidget(string $widgetName, int $langId, Page $page, string $channel) : Sigma
Parameters
- $widgetName : string
-
Name of the Widget to get template for
- $langId : int
-
Language ID
- $page : Page
-
Current page
- $channel : string
-
Current channel
Return values
Sigma —Template which may contain the widget
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