Property | Type | Description | |
---|---|---|---|
$doNotRestoreKeyAndPath | |||
$o_childs | array | ||
$o_creationDate | integer | ||
$o_dependencies | |||
$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 |
Method | Description | |
---|---|---|
__call ( $method, $args ) : mixed | ||
__sleep ( ) | ||
__wakeup ( ) | ||
clearDependentCache ( array $additionalTags = [] ) | ||
correctPath ( ) | ||
delete ( ) : void | ||
doGetInheritedValues ( |
||
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 ( ) : |
||
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 ) |
Method | Description | |
---|---|---|
update ( ) |
public clearDependentCache ( array $additionalTags = [] ) | ||
$additionalTags | array |
public static doGetInheritedValues ( |
||
$object | ||
return | boolean |
public static doHideUnpublished ( ) : boolean | ||
return | boolean |
public static doNotRestoreKeyAndPath ( ) : boolean | ||
return | boolean |
public getDependencies ( ) : |
||
return |
public getElementAdminStyle ( ) : Pimcore\Model\Element\AdminStyle | ||
return | Pimcore\Model\Element\AdminStyle |
public static getGetInheritedValues ( ) : boolean | ||
return | boolean |
public static getHideUnpublished ( ) : boolean | ||
return | boolean |
public static getTotalCount ( array $config = [] ) : total | ||
$config | array | |
return | total | count |
public hasChildren ( $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER] ) : boolean | ||
return | boolean |
public hasSiblings ( array $objectTypes = [self::OBJECT_TYPE_OBJECT, self::OBJECT_TYPE_FOLDER] ) : boolean | ||
$objectTypes | array | |
return | boolean |
public setCreationDate ( integer $o_creationDate ) | ||
$o_creationDate | integer |
public static setDoNotRestoreKeyAndPath ( boolean $doNotRestoreKeyAndPath ) | ||
$doNotRestoreKeyAndPath | boolean |
public static setGetInheritedValues ( $getInheritedValues ) : void | ||
$getInheritedValues | ||
return | void |
public static setHideUnpublished ( $hidePublished ) : void | ||
$hidePublished | ||
return | void |
public setModificationDate ( integer $o_modificationDate ) | ||
$o_modificationDate | integer |
public setProperty ( $name, $type, $data, boolean $inherited = false, boolean $inheritable = false ) | ||
$name | ||
$type | ||
$data | ||
$inherited | boolean | |
$inheritable | boolean |
public setUserModification ( integer $o_userModification ) | ||
$o_userModification | integer |
public Dependency[],Pimcore\Model $o_dependencies | ||
return |
public AdminStyle,Pimcore\Model\Element $o_elementAdminStyle | ||
return | Pimcore\Model\Element\AdminStyle |
public bool $o_hasSiblings | ||
return | boolean |
public array $o_siblings | ||
return | array |