Documentation

Node extends Node
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>
$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.
$children  : Collection
$id  : int
$instance  : mixed
$instanceCounter  : mixed
$lft  : int
$lvl  : int
$pages  : Collection
$parent  : Node
$rgt  : int

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
addChild()  : Node
Add children
addChildren()  : mixed
Add children
addPage()  : mixed
Add a page
addParsedChild()  : mixed
copy()  : Node
Creates a copy of this node including its pages
getChildren()  : Collection
Get children
getComponentController()  : mixed
{@inheritDoc}
getId()  : int
Get id
getKeyAsString()  : string
Returns this entity's key
getLft()  : int
Get lft
getLvl()  : int
Get lvl
getPage()  : Page
Get a certain Page
getPages()  : Collection
Get pages
getPagesByLang()  : mixed
getParent()  : Node
Get parent
getRgt()  : int
Get rgt
getTranslatedFieldValue()  : mixed
{@inheritDoc}
getUniqueIdentifier()  : string
Returns an unique identifier that is usable even if no id is set yet.
hasAccessByUserId()  : bool
Check whether the current user has access to this node.
initializeValidators()  : mixed
{@inheritDoc}
isChildOf()  : bool
Check if this node is a child (direct or indirect) of node $parent
isVirtual()  : mixed
{@inheritDoc}
removeChild()  : mixed
Remove children
removePage()  : mixed
Remove pages
serialize()  : mixed
setId()  : mixed
Set id
setLft()  : mixed
Set lft
setLvl()  : mixed
Set lvl
setParent()  : mixed
Set parent
setRgt()  : mixed
Set rgt
setVirtual()  : mixed
{@inheritDoc}
translatePage()  : mixed
Creates a translated page in this node
unserialize()  : mixed
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

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

$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

$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.

$instanceCounter

private static mixed $instanceCounter = 0

Methods

__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

copy()

Creates a copy of this node including its pages

public copy([mixed $recursive = false ][, Node $newParent = NULL ][, mixed &$nodePosition = 0 ][, mixed $addCopySuffix = false ]) : Node
Parameters
$recursive : mixed = false

(optional) Whether copy all children to the new node or not, default false

$newParent : Node = NULL

(optional) New parent node for the copy, default is parent of this

$nodePosition : mixed = 0

Node position

$addCopySuffix : mixed = false

Add the suffix '(Copy)' to the page title if true otherwise not

Return values
Node —

Copy of this node

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

getPages()

Get pages

public getPages([mixed $inactive_langs = false ][, mixed $aliases = false ]) : Collection
Parameters
$inactive_langs : mixed = false
$aliases : mixed = false
Return values
Collection —

$pages

hasAccessByUserId()

Check whether the current user has access to this node.

public hasAccessByUserId([mixed $frontend = true ]) : bool
Parameters
$frontend : mixed = true

whether front- or backend. defaults to frontend

Return values
bool

isChildOf()

Check if this node is a child (direct or indirect) of node $parent

public isChildOf(mixed $parent) : bool
Parameters
$parent : mixed

Node to check if its the parent of this instance of

Return values
bool —

Whether this instance is a child of $parent. Whereas $parent is not required to be a direct parent of this instance.

translatePage()

Creates a translated page in this node

public translatePage(mixed $activate, mixed $targetLang) : mixed
Parameters
$activate : mixed

whether the new page should be activated

$targetLang : mixed

target language id

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

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


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results