• Home
• Pimcore
• Model
• Document

PHP Class Pimcore\Model\Document

Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property	Type	Description
$childs	array	Contains a list of child-documents
$creationDate	integer	timestamp of creationdate
$dependencies	Dependency	Dependencies for this document
$hasChilds	boolean	Indicator of document has childs or not.
$hasSiblings	boolean	Indicator if document has siblings or not
$id	integer	ID of the document
$index	integer	Sorter index in the tree, can also be used for generating a navigation and so on
$key	string	Filename/Key of the document
$locked	string	Check if the document is locked.
$modificationDate	integer	timestamp of modificationdate
$parent	Document	The parent document.
$parentId	integer	ID of the parent document, on root document this is null
$path	string	Path to the document, not conaining the key (the full path of the parent document)
$properties	array	List of Property, concerning the folder
$published	boolean	published or not
$siblings	array	Contains a list of sibling documents
$type	string	Type of the document as string (enum) Possible values: page,snippet,link,folder
$types	array	possible types of a document
$userModification	integer	User-ID of the user last modified the document
$userOwner	integer	User-ID of the owner
$userPermissions		Permissions for the user which requested this document in editmode*

Public Methods

Method	Description
__sleep ( )
__wakeup ( )
addDocumentType ( $type )	Add document type to the $types array. It defines additional document types available in Pimcore.
clearDependentCache ( array $additionalTags = [] ) : void	Clear the cache related to the document.
correctPath ( ) : void	Validate the document path.
create ( integer $parentId, array $data = [], $save = true ) : Document	Static helper to quickly create a new document
delete ( ) : void	Deletes the document
doHideUnpublished ( ) : boolean	Checks if unpublished documents should be hidden.
getById ( integer $id ) : Document | Email | Folder | Hardlink | Link | Page | Printcontainer | Printpage | Snippet | Newsletter	Static helper to get a Document by it's ID
getByPath ( string $path ) : Document | Email | Folder | Hardlink | Link | Page | Printcontainer | Printpage | Snippet	Static helper to get a Document by it's path
getChildren ( $unpublished = false ) : array	Get a list of the Childs (not recursivly)
getCreationDate ( ) : integer	Returns the document creation date.
getDependencies ( ) : Dependency	Returns the dependencies of the document
getFullPath ( ) : string	Returns the full path of the document including the key (path+key)
getId ( ) : integer	Returns the document id.
getIndex ( ) : integer	Returns the document index.
getKey ( ) : string	Returns the document key.
getList ( array $config = [] ) : Listing	Returns the documents list instance.
getLocked ( ) : string	Returns true if the element is locked
getModificationDate ( ) : integer	Return the document modification date.
getParent ( ) : Document	Returns the parent document instance.
getParentId ( ) : integer	Returns the id of the parent document.
getPath ( ) : string	Returns the document path.
getProperties ( ) : Property[]	Get a list of properties (including the inherited)
getPublished ( ) : boolean	Checks if the document is published.
getRealFullPath ( ) : string	Returns the full real path of the document.
getRealPath ( ) : string	Returns the real document path.
getSiblings ( boolean $unpublished = false ) : array	Get a list of the sibling documents
getTotalCount ( array $config = [] ) : integer	Get total count of documents.
getType ( ) : string	Returns the document type.
getTypes ( ) : string	get possible types
getUserModification ( ) : integer	Returns id of the user last modified the document.
getUserOwner ( ) : integer	Returns the id of the owner user.
hasChildren ( ) : boolean	Returns true if the document has at least one child
hasSiblings ( ) : boolean	Returns true if the document has at least one sibling
isPublished ( ) : boolean	Checks if the document is published.
removeInheritedProperties ( ) : void	Removes all inherited properties.
renewInheritedProperties ( ) : void	Renews all inherited properties.
save ( ) : Document	Save the document.
saveIndex ( integer $index ) : void	Update the document index.
setChildren ( $children ) : array	set the children of the document
setCreationDate ( integer $creationDate ) : Document	Set the creation date of the document.
setHideUnpublished ( boolean $flag )	Set true if want to hide documents.
setId ( integer $id ) : Document	Set the id of the document.
setIndex ( integer $index ) : Document	Set the document index.
setKey ( integer $key ) : Document	Set the document key.
setLocked ( $locked ) : Document	Mark the document as locked.
setModificationDate ( integer $modificationDate ) : Document	Set the document modification date.
setParent ( Document $parent ) : Document	Set the parent document instance.
setParentId ( integer $parentId ) : Document	Set the parent id of the document.
setPath ( string $path ) : Document	Set the document path.
setProperties ( array $properties ) : Document	Set document properties.
setProperty ( string $name, string $type, mixed $data, boolean $inherited = false, boolean $inheritable = true ) : Document	Set the document property.
setPublished ( integer $published ) : Document	Set the publish status of the document.
setType ( integer $type ) : Document	Set the document type.
setUserModification ( integer $userModification ) : Document	Set id of the user last modified the document.
setUserOwner ( integer $userOwner ) : Document	Set the id of the owner user.

Protected Methods

Method	Description
prepareFrontendPath ( $path ) : mixed
update ( )

Method Details

Property Details