PHP Class Pimcore\Model\Document\Page

Inheritance: extends PageSnippet
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$description string Contains the description of the page (meta-description)
$metaData array
$personas string comma separated IDs of personas
$prettyUrl string
$title string Contains the title of the page (meta-title)
$type string Static type of the document
$usePersona integer

Public Methods

Method Description
__sleep ( )
delete ( )
getDescription ( ) : string
getElement ( string $name ) : Tag
getFullPath ( )
getKeywords ( ) : string
getMetaData ( ) : array
getName ( ) : string getProperty method should be used instead
getPersonaElementName ( $name ) : string
getPersonaElementPrefix ( null $personaId = null ) : null | string
getPersonas ( ) : string
getPrettyUrl ( ) : string
getTitle ( ) : string
getUsePersona ( ) : integer
setDescription ( string $description )
setElement ( string $name, string $data )
setKeywords ( string $keywords )
setMetaData ( $metaData )
setName ( string $name ) setProperty method should be used instead
setPersonas ( string $personas )
setPrettyUrl ( $prettyUrl )
setTitle ( string $title )
setUsePersona ( integer $usePersona )

Protected Methods

Method Description
update ( )

Method Details

__sleep() public method

public __sleep ( )

delete() public method

public delete ( )

getDescription() public method

public getDescription ( ) : string
return string

getElement() public method

public getElement ( string $name ) : Tag
$name string
return Tag

getFullPath() public method

public getFullPath ( )

getKeywords() public method

Deprecation:
public getKeywords ( ) : string
return string

getMetaData() public method

public getMetaData ( ) : array
return array

getName() public method

getProperty method should be used instead
Deprecation:
public getName ( ) : string
return string

getPersonaElementName() public method

public getPersonaElementName ( $name ) : string
$name
return string

getPersonaElementPrefix() public method

public getPersonaElementPrefix ( null $personaId = null ) : null | string
$personaId null
return null | string

getPersonas() public method

public getPersonas ( ) : string
return string

getPrettyUrl() public method

public getPrettyUrl ( ) : string
return string

getTitle() public method

public getTitle ( ) : string
return string

getUsePersona() public method

public getUsePersona ( ) : integer
return integer

setDescription() public method

public setDescription ( string $description )
$description string

setElement() public method

public setElement ( string $name, string $data )
$name string
$data string

setKeywords() public method

Deprecation:
public setKeywords ( string $keywords )
$keywords string

setMetaData() public method

public setMetaData ( $metaData )
$metaData

setName() public method

setProperty method should be used instead
Deprecation:
public setName ( string $name )
$name string

setPersonas() public method

public setPersonas ( string $personas )
$personas string

setPrettyUrl() public method

public setPrettyUrl ( $prettyUrl )
$prettyUrl

setTitle() public method

public setTitle ( string $title )
$title string

setUsePersona() public method

public setUsePersona ( integer $usePersona )
$usePersona integer

update() protected method

protected update ( )

Property Details

$description public property

Contains the description of the page (meta-description)
public string $description
return string

$metaData public property

public array $metaData
return array

$personas public property

comma separated IDs of personas
public string $personas
return string

$prettyUrl public property

public string $prettyUrl
return string

$title public property

Contains the title of the page (meta-title)
public string $title
return string

$type public property

Static type of the document
public string $type
return string

$usePersona public property

public int $usePersona
return integer