PHP Class Pimcore\Model\Document\Tag

Inheritance: extends Pimcore\Model\AbstractModel, implements Pimcore\Model\Document\Tag\TagInterface

Mostra file Open project: pimcore/pimcore Class Usage Examples

Protected Properties

Property	Type	Description
$controller	Pimcore\Controller\Action
$documentId	integer	Element belongs to the ID of the document
$editmode	boolean	In Editmode or not
$inherited	boolean
$name	string
$options	array	..
$realName	string	Contains the real name of the editable without the prefixes and suffixes which are generated automatically by blocks and areablocks
$view	Pimcore\View

Public Methods

Method	Description
__sleep ( ) : void	Returns only the properties which should be serialized
__toString ( ) : string	direct output to the frontend
admin ( ) : string
buildTagName ( $type, $name, null $document = null ) : string
checkValidity ( ) : boolean
factory ( $type, $name, $documentId, null $config = null, null $controller = null, null $view = null, null $editmode = null ) : mixed
getCacheTags ( $ownerDocument, array $tags = [] ) : array
getController ( ) : Pimcore\Controller\Action
getDataForResource ( )
getDocumentId ( ) : integer
getEditmode ( ) : boolean
getForWebserviceExport ( $document = null, mixed $params = [] ) : array	Returns the current tag's data for web service export
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], $idMapper = null ) : Pimcore\Model\Webservice\Data\Document\Element	Receives a standard class object from webservice import and fills the current tag's data
getInherited ( ) : boolean
getName ( ) : string
getOptions ( ) : array
getRealName ( ) : string
getValue ( ) : mixed
getView ( ) : View
resolveDependencies ( )	This is a dummy and is mostly implemented by relation types
setController ( Pimcore\Controller\Action $controller )
setDocumentId ( integer $id )
setEditmode ( boolean $editmode )
setInherited ( $inherited )
setName ( string $name )
setOptions ( array $options )
setRealName ( string $realName )
setView ( View $view )

Method Details

__sleep() public method

Returns only the properties which should be serialized

public __sleep ( ) : void
return	void

__toString() public method

direct output to the frontend

public __toString ( ) : string
return	string

admin() public method

public admin ( ) : string
return	string

buildTagName() public static method

public static buildTagName ( $type, $name, null $document = null ) : string
$type
$name
$document	null
return	string

checkValidity() public method

public checkValidity ( ) : boolean
return	boolean

factory() public static method

public static factory ( $type, $name, $documentId, null $config = null, null $controller = null, null $view = null, null $editmode = null ) : mixed
$type
$name
$documentId
$config	null
$controller	null
$view	null
$editmode	null
return	mixed

getCacheTags() public method

public getCacheTags ( $ownerDocument, array $tags = [] ) : array
$ownerDocument
$tags	array
return	array

getController() public method

public getController ( ) : Pimcore\Controller\Action
return	Pimcore\Controller\Action

getDataForResource() public method

public getDataForResource ( )

getDocumentId() public method

public getDocumentId ( ) : integer
return	integer

getEditmode() public method

public getEditmode ( ) : boolean
return	boolean

getForWebserviceExport() public method

Returns the current tag's data for web service export

public getForWebserviceExport ( $document = null, mixed $params = [] ) : array
$params	mixed
return	array

getFromWebserviceImport() public method

Receives a standard class object from webservice import and fills the current tag's data

public getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], $idMapper = null ) : Pimcore\Model\Webservice\Data\Document\Element
$wsElement	Pimcore\Model\Webservice\Data\Document\Element
$params	mixed
return	Pimcore\Model\Webservice\Data\Document\Element

getInherited() public method

public getInherited ( ) : boolean
return	boolean

getName() public method

public getName ( ) : string
return	string

getOptions() public method

public getOptions ( ) : array
return	array

getRealName() public method

public getRealName ( ) : string
return	string

getValue() public method

public getValue ( ) : mixed
return	mixed

getView() public method

public getView ( ) : View
return	Pimcore\View

resolveDependencies() public method

This is a dummy and is mostly implemented by relation types

public resolveDependencies ( )

setController() public method

public setController ( Pimcore\Controller\Action $controller )
$controller	Pimcore\Controller\Action

setDocumentId() public method

public setDocumentId ( integer $id )
$id	integer

setEditmode() public method

public setEditmode ( boolean $editmode )
$editmode	boolean

setInherited() public method

public setInherited ( $inherited )
$inherited

setName() public method

public setName ( string $name )
$name	string

setOptions() public method

public setOptions ( array $options )
$options	array

setRealName() public method

public setRealName ( string $realName )
$realName	string

setView() public method

public setView ( View $view )
$view	Pimcore\View

Property Details

$controller protected_oe property

protected Action,Pimcore\Controller $controller
return	Pimcore\Controller\Action

$documentId protected_oe property

Element belongs to the ID of the document

protected int $documentId
return	integer

$editmode protected_oe property

In Editmode or not

protected bool $editmode
return	boolean

$inherited protected_oe property

protected bool $inherited
return	boolean

$name protected_oe property

protected string $name
return	string

$options protected_oe property

protected array $options
return	array

$realName protected_oe property

Contains the real name of the editable without the prefixes and suffixes which are generated automatically by blocks and areablocks

protected string $realName
return	string

$view protected_oe property

protected View,Pimcore $view
return	Pimcore\View