PHP Класс Pimcore\Model\Document\PageSnippet

Наследование: extends Pimcore\Model\Document
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$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)

Свойство Тип Описание
$inheritedElements array

Открытые методы

Метод Описание
__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 )

Защищенные методы

Метод Описание
update ( ) : void

Описание методов

__sleep() публичный Метод

public __sleep ( )

delete() публичный Метод

См. также: Document::delete
public delete ( ) : void
Результат void

getAction() публичный Метод

public getAction ( ) : string
Результат string

getCacheTags() публичный Метод

Resolves dependencies and create tags for caching out of them
public getCacheTags ( $tags = [] ) : array
Результат array

getContentMasterDocument() публичный Метод

public getContentMasterDocument ( ) : Document
Результат Pimcore\Model\Document

getContentMasterDocumentId() публичный Метод

public getContentMasterDocumentId ( ) : integer | null
Результат integer | null

getController() публичный Метод

public getController ( ) : string
Результат string

getElement() публичный Метод

Get an element with the given key/name
public getElement ( string $name ) : Tag
$name string
Результат Tag

getElements() публичный Метод

public getElements ( ) : array
Результат array

getHref() публичный Метод

См. также: Document::getFullPath
public getHref ( ) : string
Результат string

getModule() публичный Метод

public getModule ( ) : string
Результат string

getScheduledTasks() публичный Метод

public getScheduledTasks ( ) : the
Результат the $scheduledTasks

getTemplate() публичный Метод

public getTemplate ( ) : string
Результат string

getVersions() публичный Метод

public getVersions ( ) : array
Результат array

hasElement() публичный Метод

public hasElement ( $name ) : boolean
$name
Результат boolean

removeElement() публичный Метод

public removeElement ( $name )
$name

resolveDependencies() публичный Метод

См. также: Document::resolveDependencies
public resolveDependencies ( ) : array
Результат array

saveScheduledTasks() публичный Метод

public saveScheduledTasks ( )

saveVersion() публичный Метод

public saveVersion ( boolean $setModificationDate = true, boolean $callPluginHook = true ) : null | Version
$setModificationDate boolean
$callPluginHook boolean
Результат null | Pimcore\Model\Version

setAction() публичный Метод

public setAction ( string $action )
$action string

setContentMasterDocument() публичный Метод

public setContentMasterDocument ( $document )
$document

setContentMasterDocumentId() публичный Метод

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

setController() публичный Метод

public setController ( string $controller )
$controller string

setElement() публичный Метод

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

setElements() публичный Метод

public setElements ( array $elements )
$elements array

setModule() публичный Метод

public setModule ( $module )
$module

setRawElement() публичный Метод

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 setScheduledTasks ( $scheduledTasks )
$scheduledTasks

setTemplate() публичный Метод

public setTemplate ( string $template )
$template string

setVersions() публичный Метод

public setVersions ( array $versions )
$versions array

update() защищенный Метод

См. также: Document::update
protected update ( ) : void
Результат void

Описание свойств

$action публичное свойство

public string $action
Результат string

$contentMasterDocumentId публичное свойство

public null|int $contentMasterDocumentId
Результат null | integer

$controller публичное свойство

public string $controller
Результат string

$elements публичное свойство

Contains all content-elements of the document
public array $elements
Результат array

$inheritedElements защищенное свойство

protected array $inheritedElements
Результат array

$module публичное свойство

public string $module
Результат string

$scheduledTasks публичное свойство

Contains all scheduled tasks
public array $scheduledTasks
Результат array

$template публичное свойство

public string $template
Результат string

$versions публичное свойство

Contains all versions of the document
public array $versions
Результат array