PHP Class Pimcore\Model\Document\PageSnippet

Inheritance: extends Pimcore\Model\Document
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$action string
$contentMasterDocumentId null | integer
$controller string
$elements array Contains all content-elements of the document
$module string
$scheduledTasks array Contains all scheduled tasks
$template string
$versions array Contains all versions of the document

Protected Properties

Property Type Description
$inheritedElements array

Public Methods

Method Description
__sleep ( )
delete ( ) : void
getAction ( ) : string
getCacheTags ( $tags = [] ) : array Resolves dependencies and create tags for caching out of them
getContentMasterDocument ( ) : Document
getContentMasterDocumentId ( ) : integer | null
getController ( ) : string
getElement ( string $name ) : Tag Get an element with the given key/name
getElements ( ) : array
getHref ( ) : string
getModule ( ) : string
getScheduledTasks ( ) : the
getTemplate ( ) : string
getVersions ( ) : array
hasElement ( $name ) : boolean
removeElement ( $name )
resolveDependencies ( ) : array
saveScheduledTasks ( )
saveVersion ( boolean $setModificationDate = true, boolean $callPluginHook = true ) : null | Version
setAction ( string $action )
setContentMasterDocument ( $document )
setContentMasterDocumentId ( integer | null $contentMasterDocumentId )
setController ( string $controller )
setElement ( string $name, string $data ) Set an element with the given key/name
setElements ( array $elements )
setModule ( $module )
setRawElement ( string $name, string $type, string $data ) Set raw data of an element (eg. for editmode)
setScheduledTasks ( $scheduledTasks )
setTemplate ( string $template )
setVersions ( array $versions )

Protected Methods

Method Description
update ( ) : void

Method Details

__sleep() public method

public __sleep ( )

delete() public method

See also: Document::delete
public delete ( ) : void
return void

getAction() public method

public getAction ( ) : string
return string

getCacheTags() public method

Resolves dependencies and create tags for caching out of them
public getCacheTags ( $tags = [] ) : array
return array

getContentMasterDocument() public method

public getContentMasterDocument ( ) : Document
return Pimcore\Model\Document

getContentMasterDocumentId() public method

public getContentMasterDocumentId ( ) : integer | null
return integer | null

getController() public method

public getController ( ) : string
return string

getElement() public method

Get an element with the given key/name
public getElement ( string $name ) : Tag
$name string
return Tag

getElements() public method

public getElements ( ) : array
return array

getHref() public method

See also: Document::getFullPath
public getHref ( ) : string
return string

getModule() public method

public getModule ( ) : string
return string

getScheduledTasks() public method

public getScheduledTasks ( ) : the
return the $scheduledTasks

getTemplate() public method

public getTemplate ( ) : string
return string

getVersions() public method

public getVersions ( ) : array
return array

hasElement() public method

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

removeElement() public method

public removeElement ( $name )
$name

resolveDependencies() public method

See also: Document::resolveDependencies
public resolveDependencies ( ) : array
return array

saveScheduledTasks() public method

public saveScheduledTasks ( )

saveVersion() public method

public saveVersion ( boolean $setModificationDate = true, boolean $callPluginHook = true ) : null | Version
$setModificationDate boolean
$callPluginHook boolean
return null | Pimcore\Model\Version

setAction() public method

public setAction ( string $action )
$action string

setContentMasterDocument() public method

public setContentMasterDocument ( $document )
$document

setContentMasterDocumentId() public method

public setContentMasterDocumentId ( integer | null $contentMasterDocumentId )
$contentMasterDocumentId integer | null

setController() public method

public setController ( string $controller )
$controller string

setElement() public method

Set an element with the given key/name
public setElement ( string $name, string $data )
$name string
$data string

setElements() public method

public setElements ( array $elements )
$elements array

setModule() public method

public setModule ( $module )
$module

setRawElement() public method

Set raw data of an element (eg. for editmode)
public setRawElement ( string $name, string $type, string $data )
$name string
$type string
$data string

setScheduledTasks() public method

public setScheduledTasks ( $scheduledTasks )
$scheduledTasks

setTemplate() public method

public setTemplate ( string $template )
$template string

setVersions() public method

public setVersions ( array $versions )
$versions array

update() protected method

See also: Document::update
protected update ( ) : void
return void

Property Details

$action public property

public string $action
return string

$contentMasterDocumentId public property

public null|int $contentMasterDocumentId
return null | integer

$controller public property

public string $controller
return string

$elements public property

Contains all content-elements of the document
public array $elements
return array

$inheritedElements protected property

protected array $inheritedElements
return array

$module public property

public string $module
return string

$scheduledTasks public property

Contains all scheduled tasks
public array $scheduledTasks
return array

$template public property

public string $template
return string

$versions public property

Contains all versions of the document
public array $versions
return array