Change
extends Change
in package
implements
Proxy
DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR
Table of Contents
Interfaces
- Proxy
Properties
- $__cloner__ : Closure
- $__initializer__ : Closure
- $__isInitialized__ : bool
- $lazyPropertiesDefaults : array<string|int, mixed>
- $condition : string
- $contents : array<string|int, mixed>
- $entity : EntityBase
- $entityIndexData : array<string|int, mixed>
- $eventType : string
- $hosts : Collection
- $id : int
- $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()
- $originEntityIndexData : array<string|int, mixed>
- $originSync : Sync
- $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
- $sync : Sync
- $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
- {@inheritDoc}
- __clone() : mixed
- __construct() : mixed
- Create a new change object
- __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
- addHost() : mixed
- Adds a related Host object
- getComponentController() : mixed
- {@inheritDoc}
- getCondition() : string
- Gets condition
- getContents() : array<string|int, mixed>
- Gets request contents
- getEntity() : EntityBase
- Gets related entity
- getEntityIndexData() : array<string|int, mixed>
- Gets related entity's index data
- getEventType() : string
- Gets event type
- getHosts() : array<string|int, mixed>
- Gets related Host objects
- getId() : int
- Gets ID
- getKeyAsString() : string
- Returns this entity's key
- getOriginEntityIndexData() : array<string|int, mixed>
- Gets origin entity's index data
- getOriginSync() : Sync
- Gets origin sync object
- getSync() : Sync
- Gets related sync object
- getTranslatedFieldValue() : mixed
- {@inheritDoc}
- initializeValidators() : mixed
- {@inheritDoc}
- isVirtual() : mixed
- {@inheritDoc}
- removeHost() : mixed
- Removes a related Host object
- setCondition() : mixed
- Sets condition
- setContents() : mixed
- Sets request contents
- setEntity() : mixed
- Sets related entity
- setEntityIndexData() : mixed
- Sets related entity's index data
- setEventType() : mixed
- Sets event type
- setHosts() : mixed
- Sets related Host objects
- setId() : mixed
- Sets ID
- setMode() : bool
- Sets change mode
- setOriginEntityIndexData() : mixed
- Sets origin entity's index data
- setOriginSync() : mixed
- Sets origin sync object
- setSync() : mixed
- Sets related sync object
- 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
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
$condition
protected
string
$condition
One of "delete", "forward", "both"
$contents
protected
array<string|int, mixed>
$contents
= array()
Field=>value type array
$entity
protected
EntityBase
$entity
= null
$entityIndexData
protected
array<string|int, mixed>
$entityIndexData
$eventType
protected
string
$eventType
One of "delete", "put", "post"
$hosts
protected
Collection
$hosts
$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
$originEntityIndexData
protected
array<string|int, mixed>
$originEntityIndexData
$originSync
protected
Sync
$originSync
$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
$sync
protected
Sync
$sync
$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()
{@inheritDoc}
public
__call(mixed $methodName, mixed $arguments) : mixed
Parameters
- $methodName : mixed
- $arguments : mixed
__clone()
public
__clone() : mixed
__construct()
Create a new change object
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
addHost()
Adds a related Host object
public
addHost(mixed $host) : mixed
Parameters
- $host : mixed
-
New Host
getComponentController()
{@inheritDoc}
public
getComponentController() : mixed
getCondition()
Gets condition
public
getCondition() : string
Return values
string —One of "delete", "forward", "both"
getContents()
Gets request contents
public
getContents() : array<string|int, mixed>
Return values
array<string|int, mixed> —Field=>value type array
getEntity()
Gets related entity
public
getEntity() : EntityBase
Return values
EntityBase —Related entity
getEntityIndexData()
Gets related entity's index data
public
getEntityIndexData() : array<string|int, mixed>
Return values
array<string|int, mixed> —Entity index data
getEventType()
Gets event type
public
getEventType() : string
Return values
string —One of "delete", "put", "post"
getHosts()
Gets related Host objects
public
getHosts() : array<string|int, mixed>
Return values
array<string|int, mixed> —Related Hosts
getId()
Gets 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
getOriginEntityIndexData()
Gets origin entity's index data
public
getOriginEntityIndexData() : array<string|int, mixed>
Return values
array<string|int, mixed> —Origin entity's index data
getOriginSync()
Gets origin sync object
public
getOriginSync() : Sync
Return values
Sync —Origin sync
getSync()
Gets related sync object
public
getSync() : Sync
Return values
Sync —Related sync
getTranslatedFieldValue()
{@inheritDoc}
public
getTranslatedFieldValue(mixed $fieldName) : mixed
Parameters
- $fieldName : mixed
initializeValidators()
{@inheritDoc}
public
initializeValidators() : mixed
isVirtual()
{@inheritDoc}
public
isVirtual() : mixed
removeHost()
Removes a related Host object
public
removeHost(mixed $host) : mixed
Parameters
- $host : mixed
-
Host to remove
setCondition()
Sets condition
public
setCondition(mixed $condition) : mixed
Parameters
- $condition : mixed
-
One of "delete", "forward", "both"
setContents()
Sets request contents
public
setContents(mixed $contents) : mixed
Parameters
- $contents : mixed
-
Field=>value type array
setEntity()
Sets related entity
public
setEntity(mixed $entity) : mixed
Parameters
- $entity : mixed
-
New entity
setEntityIndexData()
Sets related entity's index data
public
setEntityIndexData(mixed $entityIndexData) : mixed
Parameters
- $entityIndexData : mixed
-
Entity index data
setEventType()
Sets event type
public
setEventType(mixed $eventType) : mixed
Parameters
- $eventType : mixed
-
One of "delete", "put", "post"
setHosts()
Sets related Host objects
public
setHosts(mixed $hosts) : mixed
Parameters
- $hosts : mixed
-
New Hosts
setId()
Sets ID
public
setId(mixed $id) : mixed
Parameters
- $id : mixed
-
New ID
setMode()
Sets change mode
public
setMode(mixed $hostEventType) : bool
Parameters
- $hostEventType : mixed
-
Either "forward" or "delete"
Return values
bool —Wheter this change is to be applied in this mode or not
setOriginEntityIndexData()
Sets origin entity's index data
public
setOriginEntityIndexData(mixed $originEntityIndexData) : mixed
Parameters
- $originEntityIndexData : mixed
-
Origin entity's index data
setOriginSync()
Sets origin sync object
public
setOriginSync(mixed $originSync) : mixed
Parameters
- $originSync : mixed
-
New sync
setSync()
Sets related sync object
public
setSync(mixed $sync) : mixed
Parameters
- $sync : mixed
-
New sync
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