Documentation

Sync extends Sync
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>
$active  : bool
$apiKey  : string
$changes  : Collection
$dataAccess  : DataAccess
$hostEntities  : 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()
$oldHostEntities  : mixed
$originChanges  : Collection
$relations  : Collection
$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
$toUri  : string
$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
__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
addChange()  : mixed
Add change
addHostEntity()  : mixed
Add hostEntity
addOriginChange()  : Sync
Add originChanges
addRelation()  : mixed
Add relation
calculateRelations()  : mixed
getActive()  : bool
Get active
getApiKey()  : string
Get apiKey
getChanges()  : Collection
Get changes
getComponentController()  : mixed
{@inheritDoc}
getDataAccess()  : DataAccess
Get dataAccess
getHostEntities()  : Collection
Get hostEntities
getHostEntitiesIncludingLegacy()  : mixed
getId()  : int
Get id
getKeyAsString()  : string
Returns this entity's key
getOriginChanges()  : Collection
Get originChanges
getRelatedHosts()  : mixed
getRelations()  : Collection
Get relations
getToUri()  : string
Get toUri
getTranslatedFieldValue()  : mixed
{@inheritDoc}
initializeValidators()  : mixed
{@inheritDoc}
isVirtual()  : mixed
{@inheritDoc}
removeChange()  : mixed
Remove changes
removeHostEntity()  : mixed
Remove hostEntities
removeOriginChange()  : mixed
Remove originChanges
removeRelation()  : mixed
Remove relations
setActive()  : mixed
Set active
setApiKey()  : mixed
Set apiKey
setChanges()  : mixed
Set Changes
setDataAccess()  : mixed
Set dataAccess
setHostEntities()  : mixed
Set hostEntities
setOldHostEntitiesIncludingLegacy()  : mixed
setRelations()  : mixed
Set Relations
setTempActive()  : mixed
setToUri()  : mixed
Set toUri
setVirtual()  : mixed
{@inheritDoc}
validate()  : mixed
{@inheritDoc}
calculateChangeset()  : mixed
calculateContent()  : mixed
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getOldHostEntitiesIncludingLegacy()  : mixed
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
isEntityInHostEntity()  : mixed
makeLinkAbsolute()  : mixed

Properties

$__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
see
Proxy::__setInitializer

$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
see
Proxy::__getLazyProperties

$hostEntities

protected Collection $hostEntities

$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
see
getFallbackLocaleCodes()

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$oldHostEntities

protected mixed $oldHostEntities = array()

$originChanges

protected Collection $originChanges

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$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

__construct()

public __construct([Closure $initializer = null ][, Closure $cloner = null ]) : mixed
Parameters
$initializer : Closure = null
$cloner : Closure = null

__getLazyProperties()

{@inheritDoc}

public __getLazyProperties() : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

static

__setCloner()

{@inheritDoc}

public __setCloner([Closure $cloner = null ]) : mixed
Parameters
$cloner : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitialized()

{@inheritDoc}

public __setInitialized(mixed $initialized) : mixed
Parameters
$initialized : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitializer()

{@inheritDoc}

public __setInitializer([Closure $initializer = null ]) : mixed
Parameters
$initializer : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

calculateRelations()

public calculateRelations(mixed $spooler, mixed $eventType, mixed $entityClassName, mixed $entityIndexData, mixed $entity) : mixed
Parameters
$spooler : mixed
$eventType : mixed
$entityClassName : mixed
$entityIndexData : mixed
$entity : mixed

getHostEntitiesIncludingLegacy()

public getHostEntitiesIncludingLegacy([mixed $cache = true ][, mixed $host = '' ]) : mixed
Parameters
$cache : mixed = true
$host : mixed = ''

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

calculateChangeset()

protected calculateChangeset(mixed $spooler, mixed $eventType, mixed $entityClassName, mixed $entityIndexData, mixed $entity, mixed $changeCondition) : mixed
Parameters
$spooler : mixed
$eventType : mixed
$entityClassName : mixed
$entityIndexData : mixed
$entity : mixed
$changeCondition : mixed

calculateContent()

protected calculateContent(mixed $change) : mixed
Parameters
$change : 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
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getOldHostEntitiesIncludingLegacy()

protected getOldHostEntitiesIncludingLegacy() : mixed

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

isEntityInHostEntity()

protected isEntityInHostEntity(mixed $entityIndexData, mixed $hostEntity) : mixed
Parameters
$entityIndexData : mixed
$hostEntity : mixed

makeLinkAbsolute()

protected makeLinkAbsolute(mixed $input[, mixed $simpleField = false ]) : mixed
Parameters
$input : mixed
$simpleField : mixed = false 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results