PHP Class Pimcore\Model\Object\AbstractObject

Inheritance: extends Pimcore\Model\Element\AbstractElement

Mostra file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property	Type	Description
$doNotRestoreKeyAndPath
$o_childs	array
$o_creationDate	integer
$o_dependencies	Pimcore\Model\Dependency[]
$o_elementAdminStyle	Pimcore\Model\Element\AdminStyle
$o_hasChilds	boolean
$o_hasSiblings	boolean	Indicator if document has siblings or not
$o_id	integer
$o_index	integer
$o_key	string
$o_locked	string
$o_modificationDate	integer
$o_parent	self
$o_parentId	integer
$o_path	string
$o_properties	array
$o_siblings	array	Contains a list of sibling documents
$o_type	string
$o_userModification	integer
$o_userOwner	integer
$types	array	possible types of a document

Public Methods

Method	Description
__call ( $method, $args ) : mixed
__sleep ( )
__wakeup ( )
clearDependentCache ( array $additionalTags = [] )
correctPath ( )
delete ( ) : void
doGetInheritedValues ( Concrete $object = null ) : boolean
doHideUnpublished ( ) : boolean
doNotRestoreKeyAndPath ( ) : boolean
getById ( integer $id ) : static
getByPath ( string $path ) : self
getChildren ( array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER], boolean $unpublished = false ) : array
getCreationDate ( ) : integer
getDependencies ( ) : Dependency
getElementAdminStyle ( ) : Pimcore\Model\Element\AdminStyle
getFullPath ( ) : string
getGetInheritedValues ( ) : boolean
getHideUnpublished ( ) : boolean
getId ( ) : integer
getIndex ( ) : integer
getKey ( ) : string
getList ( array $config = [] ) : mixed
getLocked ( ) : string	Returns true if the element is locked
getModificationDate ( ) : integer
getParent ( ) : self
getParentId ( ) : integer
getPath ( ) : path
getProperties ( ) : Property[]
getRealFullPath ( ) : string
getRealPath ( ) : string
getSiblings ( array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER], boolean $unpublished = false ) : array	Get a list of the sibling documents
getTotalCount ( array $config = [] ) : total
getType ( ) : string
getTypes ( ) : array	get possible types
getUserModification ( ) : integer
getUserOwner ( ) : integer
hasChildren ( $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER] ) : boolean
hasSiblings ( array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER] ) : boolean	Returns true if the document has at least one sibling
removeInheritedProperties ( )
renewInheritedProperties ( )
save ( )
setChildren ( array $children )
setCreationDate ( integer $o_creationDate )
setDoNotRestoreKeyAndPath ( boolean $doNotRestoreKeyAndPath )
setGetInheritedValues ( $getInheritedValues ) : void
setHideUnpublished ( $hidePublished ) : void
setId ( integer $o_id )
setIndex ( integer $o_index )
setKey ( string $o_key )
setLocked ( boolean $o_locked )
setModificationDate ( integer $o_modificationDate )
setParent ( self $o_parent )
setParentId ( integer $o_parentId )
setPath ( string $o_path )
setProperties ( array $o_properties )
setProperty ( $name, $type, $data, boolean $inherited = false, boolean $inheritable = false )
setType ( string $o_type )
setUserModification ( integer $o_userModification )
setUserOwner ( integer $o_userOwner )

Protected Methods

Method	Description
update ( )

Method Details

__call() public method

public __call ( $method, $args ) : mixed
$method
$args
return	mixed

__sleep() public method

public __sleep ( )

__wakeup() public method

public __wakeup ( )

clearDependentCache() public method

public clearDependentCache ( array $additionalTags = [] )
$additionalTags	array

correctPath() public method

public correctPath ( )

delete() public method

public delete ( ) : void
return	void

doGetInheritedValues() public static method

public static doGetInheritedValues ( Concrete $object = null ) : boolean
$object	Concrete
return	boolean

doHideUnpublished() public static method

public static doHideUnpublished ( ) : boolean
return	boolean

doNotRestoreKeyAndPath() public static method

public static doNotRestoreKeyAndPath ( ) : boolean
return	boolean

getById() public static method

public static getById ( integer $id ) : static
$id	integer
return	static

getByPath() public static method

public static getByPath ( string $path ) : self
$path	string
return	self

getChildren() public method

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

getCreationDate() public method

public getCreationDate ( ) : integer
return	integer

getDependencies() public method

public getDependencies ( ) : Dependency
return	Pimcore\Model\Dependency

getElementAdminStyle() public method

public getElementAdminStyle ( ) : Pimcore\Model\Element\AdminStyle
return	Pimcore\Model\Element\AdminStyle

getFullPath() public method

public getFullPath ( ) : string
return	string

getGetInheritedValues() public static method

public static getGetInheritedValues ( ) : boolean
return	boolean

getHideUnpublished() public static method

public static getHideUnpublished ( ) : boolean
return	boolean

getId() public method

public getId ( ) : integer
return	integer

getIndex() public method

public getIndex ( ) : integer
return	integer

getKey() public method

public getKey ( ) : string
return	string

getList() public static method

public static getList ( array $config = [] ) : mixed
$config	array
return	mixed

getLocked() public method

Returns true if the element is locked

public getLocked ( ) : string
return	string

getModificationDate() public method

public getModificationDate ( ) : integer
return	integer

getParent() public method

public getParent ( ) : self
return	self

getParentId() public method

public getParentId ( ) : integer
return	integer

getPath() public method

public getPath ( ) : path
return	path

getProperties() public method

public getProperties ( ) : Property[]
return	Property[]

getRealFullPath() public method

public getRealFullPath ( ) : string
return	string

getRealPath() public method

public getRealPath ( ) : string
return	string

getSiblings() public method

Get a list of the sibling documents

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

getTotalCount() public static method

public static getTotalCount ( array $config = [] ) : total
$config	array
return	total	count

getType() public method

public getType ( ) : string
return	string

getTypes() public static method

get possible types

public static getTypes ( ) : array
return	array

getUserModification() public method

public getUserModification ( ) : integer
return	integer

getUserOwner() public method

public getUserOwner ( ) : integer
return	integer

hasChildren() public method

public hasChildren ( $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER] ) : boolean
return	boolean

hasSiblings() public method

Returns true if the document has at least one sibling

public hasSiblings ( array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER] ) : boolean
$objectTypes	array
return	boolean

removeInheritedProperties() public method

public removeInheritedProperties ( )

renewInheritedProperties() public method

public renewInheritedProperties ( )

save() public method

public save ( )

setChildren() public method

public setChildren ( array $children )
$children	array

setCreationDate() public method

public setCreationDate ( integer $o_creationDate )
$o_creationDate	integer

setDoNotRestoreKeyAndPath() public static method

public static setDoNotRestoreKeyAndPath ( boolean $doNotRestoreKeyAndPath )
$doNotRestoreKeyAndPath	boolean

setGetInheritedValues() public static method

public static setGetInheritedValues ( $getInheritedValues ) : void
$getInheritedValues
return	void

setHideUnpublished() public static method

public static setHideUnpublished ( $hidePublished ) : void
$hidePublished
return	void

setId() public method

public setId ( integer $o_id )
$o_id	integer

setIndex() public method

public setIndex ( integer $o_index )
$o_index	integer

setKey() public method

public setKey ( string $o_key )
$o_key	string

setLocked() public method

public setLocked ( boolean $o_locked )
$o_locked	boolean

setModificationDate() public method

public setModificationDate ( integer $o_modificationDate )
$o_modificationDate	integer

setParent() public method

public setParent ( self $o_parent )
$o_parent	self

setParentId() public method

public setParentId ( integer $o_parentId )
$o_parentId	integer

setPath() public method

public setPath ( string $o_path )
$o_path	string

setProperties() public method

public setProperties ( array $o_properties )
$o_properties	array

setProperty() public method

public setProperty ( $name, $type, $data, boolean $inherited = false, boolean $inheritable = false )
$name
$type
$data
$inherited	boolean
$inheritable	boolean

setType() public method

public setType ( string $o_type )
$o_type	string

setUserModification() public method

public setUserModification ( integer $o_userModification )
$o_userModification	integer

setUserOwner() public method

public setUserOwner ( integer $o_userOwner )
$o_userOwner	integer

update() protected method

protected update ( )

Property Details

$doNotRestoreKeyAndPath public_oe static_oe property

public static $doNotRestoreKeyAndPath

$o_childs public_oe property

public array $o_childs
return	array

$o_creationDate public_oe property

public int $o_creationDate
return	integer

$o_dependencies public_oe property

public Dependency[],Pimcore\Model $o_dependencies
return	Pimcore\Model\Dependency[]

$o_elementAdminStyle public_oe property

public AdminStyle,Pimcore\Model\Element $o_elementAdminStyle
return	Pimcore\Model\Element\AdminStyle

$o_hasChilds public_oe property

public bool $o_hasChilds
return	boolean

$o_hasSiblings public_oe property

Indicator if document has siblings or not

public bool $o_hasSiblings
return	boolean

$o_id public_oe property

public int $o_id
return	integer

$o_index public_oe property

public int $o_index
return	integer

$o_key public_oe property

public string $o_key
return	string

$o_locked public_oe property

public string $o_locked
return	string

$o_modificationDate public_oe property

public int $o_modificationDate
return	integer

$o_parent public_oe property

public self $o_parent
return	self

$o_parentId public_oe property

public int $o_parentId
return	integer

$o_path public_oe property

public string $o_path
return	string

$o_properties public_oe property

public array $o_properties
return	array

$o_siblings public_oe property

Contains a list of sibling documents

public array $o_siblings
return	array

$o_type public_oe property

public string $o_type
return	string

$o_userModification public_oe property

public int $o_userModification
return	integer

$o_userOwner public_oe property

public int $o_userOwner
return	integer

$types public_oe static_oe property

possible types of a document

public static array $types
return	array