PHP Class Pimcore\Model\Element\AbstractElement

Inheritance: extends Pimcore\Model\AbstractModel, implements Pimcore\Model\Element\ElementInterface
Show file Open project: pimcore/pimcore Class Usage Examples

Public Methods

Method Description
__toString ( ) : string
getCacheTag ( ) : string get the cache tag for the element
getCacheTags ( array $tags = [] ) : array 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
getProperty ( string $name, boolean $asContainer = false ) : mixed Get specific property data or the property object itself ($asContainer=true) by its name, if the property doesn't exists return null
getUserPermissions ( ) : array
hasNoChilds ( ) : boolean Inverted hasChilds()
hasProperty ( $name ) : boolean
isAllowed ( string $type ) : boolean 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
isLocked ( ) : boolean Returns true if the element is locked
removeProperty ( $name )
resolveDependencies ( ) : array Resolves the dependencies of the element and returns an array of them - Used by update()
unlockPropagate ( )

Method Details

__toString() public method

public __toString ( ) : string
return string

getCacheTag() public method

get the cache tag for the element
public getCacheTag ( ) : string
return string

getCacheTags() public method

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
public getCacheTags ( array $tags = [] ) : array
$tags array
return array

getProperty() public method

Get specific property data or the property object itself ($asContainer=true) by its name, if the property doesn't exists return null
public getProperty ( string $name, boolean $asContainer = false ) : mixed
$name string
$asContainer boolean
return mixed

getUserPermissions() public method

public getUserPermissions ( ) : array
return array

hasNoChilds() public method

Inverted hasChilds()
public hasNoChilds ( ) : boolean
return boolean

hasProperty() public method

public hasProperty ( $name ) : boolean
$name
return boolean

isAllowed() public method

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
public isAllowed ( string $type ) : boolean
$type string
return boolean

isLocked() public method

Returns true if the element is locked
public isLocked ( ) : boolean
return boolean

removeProperty() public method

public removeProperty ( $name )
$name

resolveDependencies() public method

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

unlockPropagate() public method

public unlockPropagate ( )