class DataObject extends AbstractObject (View source)

Traits

Constants

OBJECT_TYPE_FOLDER

OBJECT_TYPE_OBJECT

OBJECT_TYPE_VARIANT

OBJECT_CHILDREN_SORT_BY_DEFAULT

OBJECT_CHILDREN_SORT_BY_INDEX

Properties

protected AbstractDao $dao from AbstractModel
protected int $__dataVersionTimestamp from AbstractElement
static bool $doNotRestoreKeyAndPath from AbstractObject
static array $types possible types of a document from AbstractObject
int $o_id from AbstractObject
int $o_parentId from AbstractObject
AbstractObject $o_parent from AbstractObject
string $o_type from AbstractObject
string $o_key from AbstractObject
string $o_path from AbstractObject
int $o_index from AbstractObject
int $o_creationDate from AbstractObject
int $o_modificationDate from AbstractObject
int $o_userOwner from AbstractObject
int $o_userModification from AbstractObject
array $o_properties from AbstractObject
bool $o_hasChilds from AbstractObject
array $o_siblings Contains a list of sibling documents from AbstractObject
bool $o_hasSiblings Indicator if document has siblings or not from AbstractObject
Dependency[] $o_dependencies from AbstractObject
array $o_childs from AbstractObject
string $o_locked from AbstractObject
AdminStyle $o_elementAdminStyle from AbstractObject
string $o_childrenSortBy from AbstractObject

Methods

Dao
getDao()

No description

setDao($dao)

No description

getResource() deprecated

No description

initDao(null $key = null, bool $forceDetection = false)

No description

static string|null
locateDaoClass(string $modelClass)

No description

$this
setValues(array $data = [])

No description

$this
setValue($key, $value)

No description

array
__sleep()

No description

mixed
__call($method, $args)

No description

__clone()

No description

array
getObjectVars()

returns object values without the dao

array
__debugInfo()

No description

void
beginTransaction()

No description

void
commit()

No description

void
rollBack()

No description

void
configure()

No description

array
getValidTableColumns(string $table, bool $cache)

No description

void
resetValidTableColumnsCache(string $table)

No description

updateModificationInfos()

No description

mixed
getProperty(string $name, bool $asContainer = false)

Get specific property data or the property object itself ($asContainer=true) by its name, if the property doesn't exists return null

bool
hasProperty($name)

No description

removeProperty($name)

No description

string
getCacheTag()

get the cache tag for the element

array
getCacheTags(array $tags = [])

Get the cache tags for the element, resolve all dependencies to tag the cache entries This is necessary to update the cache if there is a change in an depended object

array
resolveDependencies()

Resolves the dependencies of the element and returns an array of them - Used by update()

$this
isLocked()

Returns true if the element is locked

array
getUserPermissions()

No description

bool
isAllowed(string $type)

This is used for user-permissions, pass a permission type (eg. list, view, save) an you know if the current user is allowed to perform the requested action

unlockPropagate()

No description

validatePathLength()

No description

bool
hasNoChilds()

Inverted hasChilds()

string
__toString()

No description

int
__getDataVersionTimestamp()

No description

__setDataVersionTimestamp(int $_dataVersionTimestamp)

No description

bool
__isBasedOnLatestData()

No description

mixed
getChilds() deprecated

No description

mixed
setChilds() deprecated

No description

mixed
hasChilds() deprecated

No description

static bool
getHideUnpublished()

No description

static 
setHideUnpublished($hidePublished)

No description

static bool
doHideUnpublished()

No description

static 
setGetInheritedValues($getInheritedValues)

No description

static bool
getGetInheritedValues()

No description

static bool
doGetInheritedValues(Concrete $object = null)

No description

static array
getTypes()

get possible types

getById($id, bool $force = false)

Static helper to get an object by the passed ID

static AbstractObject
getByPath(string $path, bool $force = false)

No description

static mixed
getList(array $config = [])

No description

static int
getTotalCount(array $config = [])

No description

static bool
typeMatch(AbstractObject $object)

No description

array
getChildren(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER], bool $unpublished = false)

No description

bool
hasChildren(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER])

No description

array
getSiblings(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER], bool $unpublished = false)

Get a list of the sibling documents

bool
hasSiblings(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER])

Returns true if the document has at least one sibling

string
getLocked()

Returns true if the element is locked

$this
setLocked(bool $o_locked)

No description

delete()

No description

$this
save()

No description

correctPath()

No description

update($isUpdate = null, $params = [])

No description

clearDependentCache(array $additionalTags = [])

No description

getDependencies()

No description

string
getFullPath()

No description

string
getRealPath()

No description

string
getRealFullPath()

No description

int
getId()

No description

int
getParentId()

No description

string
getType()

No description

string
getKey()

No description

string
getPath()

No description

int
getIndex()

No description

int
getCreationDate()

No description

int
getModificationDate()

No description

int
getUserOwner()

No description

int
getUserModification()

No description

$this
setId(int $o_id)

No description

$this
setParentId(int $o_parentId)

No description

$this
setType(string $o_type)

No description

$this
setKey(string $o_key)

No description

$this
setPath(string $o_path)

No description

$this
setIndex(int $o_index)

No description

setChildrenSortBy(string|null $childrenSortBy)

No description

$this
setCreationDate(int $o_creationDate)

No description

$this
setModificationDate(int $o_modificationDate)

No description

$this
setUserOwner(int $o_userOwner)

No description

$this
setUserModification(int $o_userModification)

No description

$this
setChildren(array $children)

No description

getParent()

No description

$this
setParent(AbstractObject $o_parent)

No description

array
getProperties()

No description

$this
setProperties(array $o_properties)

No description

$this
setProperty($name, $type, $data, bool $inherited = false, bool $inheritable = false)

No description

string
getChildrenSortBy()

No description

__wakeup()

No description

removeInheritedProperties()

No description

renewInheritedProperties()

No description

static bool
doNotRestoreKeyAndPath()

No description

static 
setDoNotRestoreKeyAndPath(bool $doNotRestoreKeyAndPath)

No description

mixed
get(string $fieldName, null $language = null)

No description

mixed
set(string $fieldName, $value, null $language = null)

No description

Details

Dao getDao()

Return Value

Dao

AbstractModel setDao($dao)

Parameters

$dao

Return Value

AbstractModel

AbstractDao getResource() deprecated

deprecated

Return Value

AbstractDao

initDao(null $key = null, bool $forceDetection = false)

Parameters

null $key
bool $forceDetection

Exceptions

Exception

static string|null locateDaoClass(string $modelClass)

Parameters

string $modelClass

Return Value

string|null

$this setValues(array $data = [])

Parameters

array $data

Return Value

$this

$this setValue($key, $value)

Parameters

$key
$value

Return Value

$this

array __sleep()

Return Value

array

mixed __call($method, $args)

Parameters

$method
$args

Return Value

mixed

Exceptions

Exception

__clone()

array getObjectVars()

returns object values without the dao

Return Value

array

array __debugInfo()

Return Value

array

void beginTransaction()

Return Value

void

void commit()

Return Value

void

void rollBack()

Return Value

void

void configure()

Return Value

void

array getValidTableColumns(string $table, bool $cache)

Parameters

string $table
bool $cache

Return Value

array

void resetValidTableColumnsCache(string $table)

Parameters

string $table

Return Value

void

protected updateModificationInfos()

mixed getProperty(string $name, bool $asContainer = false)

Get specific property data or the property object itself ($asContainer=true) by its name, if the property doesn't exists return null

Parameters

string $name
bool $asContainer

Return Value

mixed

bool hasProperty($name)

Parameters

$name

Return Value

bool

removeProperty($name)

Parameters

$name

string getCacheTag()

get the cache tag for the element

Return Value

string

array getCacheTags(array $tags = [])

Get the cache tags for the element, resolve all dependencies to tag the cache entries This is necessary to update the cache if there is a change in an depended object

Parameters

array $tags

Return Value

array

array resolveDependencies()

Resolves the dependencies of the element and returns an array of them - Used by update()

Return Value

array

$this isLocked()

Returns true if the element is locked

Return Value

$this

array getUserPermissions()

Return Value

array

bool isAllowed(string $type)

This is used for user-permissions, pass a permission type (eg. list, view, save) an you know if the current user is allowed to perform the requested action

Parameters

string $type

Return Value

bool

unlockPropagate()

protected validatePathLength()

bool hasNoChilds()

Inverted hasChilds()

Return Value

bool

string __toString()

Return Value

string

int __getDataVersionTimestamp()

Return Value

int

__setDataVersionTimestamp(int $_dataVersionTimestamp)

Parameters

int $_dataVersionTimestamp

bool __isBasedOnLatestData()

Return Value

bool

mixed getChilds() deprecated

deprecated

Return Value

mixed

mixed setChilds() deprecated

deprecated

Return Value

mixed

mixed hasChilds() deprecated

deprecated

Return Value

mixed

static bool getHideUnpublished()

Return Value

bool

static setHideUnpublished($hidePublished)

Parameters

$hidePublished

static bool doHideUnpublished()

Return Value

bool

static setGetInheritedValues($getInheritedValues)

Parameters

$getInheritedValues

static bool getGetInheritedValues()

Return Value

bool

static bool doGetInheritedValues(Concrete $object = null)

Parameters

Concrete $object

Return Value

bool

static array getTypes()

get possible types

Return Value

array

static ElementInterface getById($id, bool $force = false)

Static helper to get an object by the passed ID

Parameters

$id
bool $force

Return Value

ElementInterface $resource

static AbstractObject getByPath(string $path, bool $force = false)

Parameters

string $path
bool $force

Return Value

AbstractObject

static mixed getList(array $config = [])

Parameters

array $config

Return Value

mixed

Exceptions

Exception

static int getTotalCount(array $config = [])

Parameters

array $config

Return Value

int total count

static protected bool typeMatch(AbstractObject $object)

Parameters

AbstractObject $object

Return Value

bool

array getChildren(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER], bool $unpublished = false)

Parameters

array $objectTypes
bool $unpublished

Return Value

array

bool hasChildren(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER])

Parameters

array $objectTypes

Return Value

bool

array getSiblings(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER], bool $unpublished = false)

Get a list of the sibling documents

Parameters

array $objectTypes
bool $unpublished

Return Value

array

bool hasSiblings(array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER])

Returns true if the document has at least one sibling

Parameters

array $objectTypes

Return Value

bool

string getLocked()

Returns true if the element is locked

Return Value

string

$this setLocked(bool $o_locked)

Parameters

bool $o_locked

Return Value

$this

delete()

$this save()

Return Value

$this

Exceptions

Exception

correctPath()

protected update($isUpdate = null, $params = [])

Parameters

$isUpdate
$params

Exceptions

Exception

clearDependentCache(array $additionalTags = [])

Parameters

array $additionalTags

Dependency getDependencies()

Return Value

Dependency

string getFullPath()

Return Value

string

string getRealPath()

Return Value

string

string getRealFullPath()

Return Value

string

int getId()

Return Value

int $id

int getParentId()

Return Value

int

string getType()

Return Value

string

string getKey()

Return Value

string

string getPath()

Return Value

string

int getIndex()

Return Value

int

int getCreationDate()

Return Value

int

int getModificationDate()

Return Value

int

int getUserOwner()

Return Value

int

int getUserModification()

Return Value

int

$this setId(int $o_id)

Parameters

int $o_id

Return Value

$this

$this setParentId(int $o_parentId)

Parameters

int $o_parentId

Return Value

$this

$this setType(string $o_type)

Parameters

string $o_type

Return Value

$this

$this setKey(string $o_key)

Parameters

string $o_key

Return Value

$this

$this setPath(string $o_path)

Parameters

string $o_path

Return Value

$this

$this setIndex(int $o_index)

Parameters

int $o_index

Return Value

$this

setChildrenSortBy(string|null $childrenSortBy)

Parameters

string|null $childrenSortBy

$this setCreationDate(int $o_creationDate)

Parameters

int $o_creationDate

Return Value

$this

$this setModificationDate(int $o_modificationDate)

Parameters

int $o_modificationDate

Return Value

$this

$this setUserOwner(int $o_userOwner)

Parameters

int $o_userOwner

Return Value

$this

$this setUserModification(int $o_userModification)

Parameters

int $o_userModification

Return Value

$this

$this setChildren(array $children)

Parameters

array $children

Return Value

$this

AbstractObject getParent()

Return Value

AbstractObject

$this setParent(AbstractObject $o_parent)

Parameters

AbstractObject $o_parent

Return Value

$this

array getProperties()

Return Value

array

$this setProperties(array $o_properties)

Parameters

array $o_properties

Return Value

$this

$this setProperty($name, $type, $data, bool $inherited = false, bool $inheritable = false)

Parameters

$name
$type
$data
bool $inherited
bool $inheritable

Return Value

$this

AdminStyle getElementAdminStyle()

Return Value

AdminStyle

string getChildrenSortBy()

Return Value

string

__wakeup()

removeInheritedProperties()

renewInheritedProperties()

static bool doNotRestoreKeyAndPath()

Return Value

bool

static setDoNotRestoreKeyAndPath(bool $doNotRestoreKeyAndPath)

Parameters

bool $doNotRestoreKeyAndPath

mixed get(string $fieldName, null $language = null)

Parameters

string $fieldName
null $language

Return Value

mixed

mixed set(string $fieldName, $value, null $language = null)

Parameters

string $fieldName
$value
null $language

Return Value

mixed