SystemComponent
extends SystemComponent
in package
implements
Proxy
DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR
Table of Contents
Interfaces
- Proxy
Constants
- TYPE_CORE = 'core'
- TYPE_CORE_MODULE = 'core_module'
- TYPE_MODULE = 'module'
Properties
- $__cloner__ : Closure
- $__initializer__ : Closure
- $__isInitialized__ : bool
- $lazyPropertiesDefaults : array<string|int, mixed>
- $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.
- $id : int
- Unique ID
- $name : string
- Component name
- $type : enum
- Component type
Methods
- __call() : mixed
- {@inheritDoc}
- __clone() : mixed
- __construct() : mixed
- __get() : mixed
- {@inheritDoc}
- __getCloner() : mixed
- {@inheritDoc}
- __getInitializer() : mixed
- {@inheritDoc}
- __getLazyProperties() : mixed
- {@inheritDoc}
- __isInitialized() : mixed
- {@inheritDoc}
- __load() : mixed
- Forces initialization of the proxy
- __setCloner() : mixed
- {@inheritDoc}
- __setInitialized() : mixed
- {@inheritDoc}
- __setInitializer() : mixed
- {@inheritDoc}
- __sleep() : array<string|int, mixed>
- __toString() : mixed
- {@inheritDoc}
- __wakeup() : mixed
- getBaseNamespaceForType() : string
- Returns the namespace for a component type
- getComponentController() : mixed
- {@inheritDoc}
- getDirectory() : string
- Returns the absolute path to this component's location in the file system
- getEntityClasses() : array<string|int, mixed>
- Returns a list of entity classes for this component
- getId() : int
- Get id
- getKeyAsString() : string
- Returns this entity's key
- getName() : string
- Get name
- getNamespace() : string
- Returns the base namespace for this component
- getPathForType() : string
- Returns the type folder (relative to document root)
- getTranslatedFieldValue() : mixed
- {@inheritDoc}
- getType() : enum
- Get type
- initializeValidators() : mixed
- {@inheritDoc}
- isActive() : bool
- Checks if the component is active and in the list of legal components (license)
- isVirtual() : mixed
- {@inheritDoc}
- setName() : mixed
- Set name
- setType() : mixed
- Set type
- setVirtual() : mixed
- {@inheritDoc}
- validate() : mixed
- {@inheritDoc}
- 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_CORE
public
mixed
TYPE_CORE
= 'core'
TYPE_CORE_MODULE
public
mixed
TYPE_CORE_MODULE
= 'core_module'
TYPE_MODULE
public
mixed
TYPE_MODULE
= 'module'
Properties
$__cloner__
public
Closure
$__cloner__
the callback responsible of loading properties that need to be copied in the cloned object
Tags
$__initializer__
public
Closure
$__initializer__
the callback responsible for loading properties in the proxy object. This callback is called with three parameters, being respectively the proxy object to be initialized, the method that triggered the initialization process and an array of ordered parameters that were passed to that method.
Tags
$__isInitialized__
public
bool
$__isInitialized__
= false
flag indicating if this object was already initialized
Tags
$lazyPropertiesDefaults
public
static array<string|int, mixed>
$lazyPropertiesDefaults
= array()
properties to be lazy loaded, with keys being the property names and values being their default values
Tags
$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.
$id
Unique ID
private
int
$id
$name
Component name
private
string
$name
$type
Component type
private
enum
$type
Methods
__call()
{@inheritDoc}
public
__call(mixed $methodName, mixed $arguments) : mixed
Parameters
- $methodName : mixed
- $arguments : mixed
__clone()
public
__clone() : mixed
__construct()
public
__construct([Closure $initializer = null ][, Closure $cloner = null ]) : mixed
Parameters
- $initializer : Closure = null
- $cloner : Closure = null
__get()
{@inheritDoc}
public
__get(string $name) : mixed
Parameters
- $name : string
__getCloner()
{@inheritDoc}
public
__getCloner() : mixed
Tags
__getInitializer()
{@inheritDoc}
public
__getInitializer() : mixed
Tags
__getLazyProperties()
{@inheritDoc}
public
__getLazyProperties() : mixed
Tags
__isInitialized()
{@inheritDoc}
public
__isInitialized() : mixed
Tags
__load()
Forces initialization of the proxy
public
__load() : mixed
__setCloner()
{@inheritDoc}
public
__setCloner([Closure $cloner = null ]) : mixed
Parameters
- $cloner : Closure = null
Tags
__setInitialized()
{@inheritDoc}
public
__setInitialized(mixed $initialized) : mixed
Parameters
- $initialized : mixed
Tags
__setInitializer()
{@inheritDoc}
public
__setInitializer([Closure $initializer = null ]) : mixed
Parameters
- $initializer : Closure = null
Tags
__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>__toString()
{@inheritDoc}
public
__toString() : mixed
__wakeup()
public
__wakeup() : mixed
getBaseNamespaceForType()
Returns the namespace for a component type
public
static getBaseNamespaceForType(string $type) : string
Parameters
- $type : string
-
Component type name
Tags
Return values
string —Namespace
getComponentController()
{@inheritDoc}
public
getComponentController() : mixed
getDirectory()
Returns the absolute path to this component's location in the file system
public
getDirectory([mixed $allowCustomizing = true ][, mixed $relative = false ]) : string
Parameters
- $allowCustomizing : mixed = true
-
(optional) Set to false if you want to ignore customizings
- $relative : mixed = false
-
(optional) If set to true, the path relative to Cloudrexx main dir is returned, default false
Return values
string —Path for this component
getEntityClasses()
Returns a list of entity classes for this component
public
getEntityClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of class names
getId()
Get id
public
getId() : int
Return values
int —$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
getName()
Get name
public
getName() : string
Return values
string —$name
getNamespace()
Returns the base namespace for this component
public
getNamespace() : string
Return values
string —Namespace
getPathForType()
Returns the type folder (relative to document root)
public
static getPathForType(string $type) : string
Parameters
- $type : string
-
Component type name
Tags
Return values
string —Component type folder relative to document root
getTranslatedFieldValue()
{@inheritDoc}
public
getTranslatedFieldValue(mixed $fieldName) : mixed
Parameters
- $fieldName : mixed
getType()
Get type
public
getType() : enum
Return values
enum —$type
initializeValidators()
{@inheritDoc}
public
initializeValidators() : mixed
isActive()
Checks if the component is active and in the list of legal components (license)
public
isActive() : bool
Return values
bool —True if the component is active and legal, false otherwise
isVirtual()
{@inheritDoc}
public
isVirtual() : mixed
setName()
Set name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
setType()
Set type
public
setType(mixed $type) : mixed
Parameters
- $type : mixed
setVirtual()
{@inheritDoc}
public
setVirtual(mixed $virtual) : mixed
Parameters
- $virtual : mixed
validate()
{@inheritDoc}
public
validate() : mixed
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