PrintAbstract
abstract class PrintAbstract extends PageSnippet (View source)
Traits
Properties
| protected AbstractDao | $dao | from AbstractModel | |
| protected int | $__dataVersionTimestamp | from AbstractElement | |
| static array | $types | possible types of a document | from Document |
| static protected array | $pathCache | from Document | |
| int | $id | ID of the document | from Document |
| int | $parentId | ID of the parent document, on root document this is null | from Document |
| Document | $parent | The parent document. | from Document |
| string | $type | Type of the document as string (enum) Possible values: page,snippet,link,folder | from Document |
| string | $key | Filename/Key of the document | from Document |
| string | $path | Path to the document, not conaining the key (the full path of the parent document) | from Document |
| int | $index | Sorter index in the tree, can also be used for generating a navigation and so on | from Document |
| bool | $published | published or not | from Document |
| int | $creationDate | timestamp of creationdate | from Document |
| int | $modificationDate | timestamp of modificationdate | from Document |
| int | $userOwner | User-ID of the owner | from Document |
| int | $userModification | User-ID of the user last modified the document | from Document |
| $userPermissions | Permissions for the user which requested this document in editmode* | from Document | |
| Dependency | $dependencies | Dependencies for this document | from Document |
| array | $properties | List of Property, concerning the folder | from Document |
| array | $childs | Contains a list of child-documents | from Document |
| bool | $hasChilds | Indicator of document has childs or not. | from Document |
| array | $siblings | Contains a list of sibling documents | from Document |
| bool | $hasSiblings | Indicator if document has siblings or not | from Document |
| string | $locked | Check if the document is locked. | from Document |
| string | $module | from PageSnippet | |
| string | $controller | ||
| string | $action | from PageSnippet | |
| string | $template | from PageSnippet | |
| array | $elements | Contains all content-elements of the document | from PageSnippet |
| array | $versions | Contains all versions of the document | from PageSnippet |
| array | $scheduledTasks | Contains all scheduled tasks | from PageSnippet |
| null|int | $contentMasterDocumentId | from PageSnippet | |
| protected array | $inheritedElements | from PageSnippet | |
| bool | $legacy | from PageSnippet | |
| int | $lastGenerated | ||
| string | $lastGenerateMessage |
Methods
Get specific property data or the property object itself ($asContainer=true) by its name, if the property doesn't exists return null
Resolves dependencies and create tags for caching out of them
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
Add document type to the $types array. It defines additional document types available in Pimcore.
Static helper to get a Document by it's path
Static helper to get a Document by it's ID
Static helper to quickly create a new document
Clear the cache related to the document.
Get a list of the Childs (not recursivly)
Returns the full path of the document including the key (path+key)
Set id of the user last modified the document.
Set the document property.
returns true if document should be rendered with legacy stack
No description
Set raw data of an element (eg. for editmode)
Set an element with the given key/name
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
in AbstractModel at line 61
AbstractModel
setDao($dao)
in AbstractModel at line 73
AbstractDao
getResource()
deprecated
deprecated
in AbstractModel at line 84
initDao(null $key = null, bool $forceDetection = false)
in AbstractModel at line 137
static string|null
locateDaoClass(string $modelClass)
in AbstractModel at line 187
$this
setValues(array $data = [])
in AbstractModel at line 204
$this
setValue($key, $value)
in PageSnippet at line 588
array
__sleep()
in AbstractModel at line 242
mixed
__call($method, $args)
in AbstractModel at line 266
__clone()
in AbstractModel at line 276
array
getObjectVars()
returns object values without the dao
in AbstractModel at line 287
array
__debugInfo()
in AbstractModel at line 27
void
beginTransaction()
in AbstractModel at line 27
void
commit()
in AbstractModel at line 27
void
rollBack()
in AbstractModel at line 27
void
configure()
in AbstractModel at line 27
array
getValidTableColumns(string $table, bool $cache)
in AbstractModel at line 27
void
resetValidTableColumnsCache(string $table)
in AbstractElement at line 32
protected
updateModificationInfos()
in AbstractElement at line 63
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
in AbstractElement at line 82
bool
hasProperty($name)
in AbstractElement at line 92
removeProperty($name)
in AbstractElement at line 104
string
getCacheTag()
get the cache tag for the element
in PageSnippet at line 197
array
getCacheTags(array $tags = [])
Resolves dependencies and create tags for caching out of them
in PageSnippet at line 215
array
resolveDependencies()
in AbstractElement at line 153
$this
isLocked()
Returns true if the element is locked
in AbstractElement at line 166
array
getUserPermissions()
in AbstractElement at line 189
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
in AbstractElement at line 200
unlockPropagate()
in AbstractElement at line 219
bool
hasNoChilds()
Inverted hasChilds()
in AbstractElement at line 227
string
__toString()
in AbstractElement at line 235
int
__getDataVersionTimestamp()
in AbstractElement at line 243
__setDataVersionTimestamp(int $_dataVersionTimestamp)
mixed
getChilds()
deprecated
deprecated
mixed
setChilds()
deprecated
deprecated
mixed
hasChilds()
deprecated
deprecated
static
addDocumentType($type)
Add document type to the $types array. It defines additional document types available in Pimcore.
static bool
doHideUnpublished()
Checks if unpublished documents should be hidden.
static Document|Email|Folder|Hardlink|Link|Page|Printcontainer|Printpage|Snippet
getByPath(string $path, bool $force = false)
Static helper to get a Document by it's path
static ElementInterface
getById($id, bool $force = false)
Static helper to get a Document by it's ID
static Document
create(int $parentId, array $data = [], bool $save = true)
Static helper to quickly create a new document
static Listing
getList(array $config = [])
Returns the documents list instance.
in PageSnippet at line 91
protected
update()
clearDependentCache(array $additionalTags = [])
Clear the cache related to the document.
Dependency
getDependencies()
Returns the dependencies of the document
array
getChildren(bool $unpublished = false)
Get a list of the Childs (not recursivly)
array
getSiblings(bool $unpublished = false)
Get a list of the sibling documents
in PageSnippet at line 177
delete()
string
getFullPath()
Returns the full path of the document including the key (path+key)
$this
setCreationDate(int $creationDate)
Set the creation date of the document.
$this
setModificationDate(int $modificationDate)
Set the document modification date.
int
getUserModification()
Returns id of the user last modified the document.
$this
setUserModification(int $userModification)
Set id of the user last modified the document.
Document
setPublished(int $published)
Set the publish status of the document.
Document
setProperty(string $name, string $type, mixed $data, bool $inherited = false, bool $inheritable = true)
Set the document property.
in PageSnippet at line 609
bool
doRenderWithLegacyStack()
returns true if document should be rendered with legacy stack
in PageSnippet at line 129
null|Version
saveVersion(bool $setModificationDate = true, bool $callPluginHook = true)
in PageSnippet at line 237
string
getAction()
in PageSnippet at line 249
string
getController()
in PageSnippet at line 261
string
getTemplate()
in PageSnippet at line 271
$this
setAction(string $action)
in PageSnippet at line 283
$this
setController(string $controller)
in PageSnippet at line 295
$this
setTemplate(string $template)
in PageSnippet at line 307
$this
setModule($module)
in PageSnippet at line 317
string
getModule()
in PageSnippet at line 331
$this
setRawElement(string $name, string $type, string $data)
Set raw data of an element (eg. for editmode)
in PageSnippet at line 358
$this
setElement(string $name, string $data)
Set an element with the given key/name
in PageSnippet at line 370
$this
removeElement($name)
in PageSnippet at line 386
Tag
getElement(string $name)
Get an element with the given key/name