PHP Class Pimcore\Model\Document\Tag\Renderlet

Inheritance: extends Pimcore\Model\Document\Tag
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$id integer Contains the ID of the linked object
$o Contains the object
$subtype string Contains the subtype
$type string Contains the type

Public Methods

Method Description
__sleep ( ) : array
checkValidity ( ) : boolean
frontend ( ) : string
getData ( ) : mixed
getDataEditmode ( ) : mixed Converts the data so it's suitable for the editmode
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
getId ( ) : integer
getO ( ) : Asset | Document | Pimcore\Model\Object
getObjectType ( $object = null ) : void get correct type of object as string
getSubtype ( ) : string
getType ( ) : string
isEmpty ( ) : boolean
load ( ) : void this method is called by Document\Service::loadAllDocumentFields() to load all lazy loading fields
resolveDependencies ( ) : array
rewriteIds ( array $idMapping ) : void Rewrites id from source to target, $idMapping contains array( "document" => array( SOURCE_ID => TARGET_ID, SOURCE_ID => TARGET_ID ), "object" => array(.
setDataFromEditmode ( mixed $data ) : void
setDataFromResource ( mixed $data )
setElement ( ) : void Sets the element by the data stored for the object
setId ( integer $id ) : Renderlet
setO ( Asset | Document | Pimcore\Model\Object $o ) : Renderlet
setSubtype ( string $subtype ) : Renderlet

Method Details

__sleep() public method

public __sleep ( ) : array
return array

checkValidity() public method

public checkValidity ( ) : boolean
return boolean

frontend() public method

See also: Document\Tag\TagInterface::frontend
public frontend ( ) : string
return string

getData() public method

See also: Document\Tag\TagInterface::getData
public getData ( ) : mixed
return mixed

getDataEditmode() public method

Converts the data so it's suitable for the editmode
public getDataEditmode ( ) : mixed
return mixed

getFromWebserviceImport() public method

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

getId() public method

public getId ( ) : integer
return integer

getO() public method

public getO ( ) : Asset | Document | Pimcore\Model\Object
return Pimcore\Model\Asset | Pimcore\Model\Document | Pimcore\Model\Object

getObjectType() public method

get correct type of object as string
public getObjectType ( $object = null ) : void
return void

getSubtype() public method

public getSubtype ( ) : string
return string

getType() public method

See also: Document\Tag\TagInterface::getType
public getType ( ) : string
return string

isEmpty() public method

public isEmpty ( ) : boolean
return boolean

load() public method

this method is called by Document\Service::loadAllDocumentFields() to load all lazy loading fields
public load ( ) : void
return void

resolveDependencies() public method

public resolveDependencies ( ) : array
return array

rewriteIds() public method

..), "asset" => array(...) )
public rewriteIds ( array $idMapping ) : void
$idMapping array
return void

setDataFromEditmode() public method

See also: Document\Tag\TagInterface::setDataFromEditmode
public setDataFromEditmode ( mixed $data ) : void
$data mixed
return void

setDataFromResource() public method

See also: Document\Tag\TagInterface::setDataFromResource
public setDataFromResource ( mixed $data )
$data mixed

setElement() public method

Sets the element by the data stored for the object
public setElement ( ) : void
return void

setId() public method

public setId ( integer $id ) : Renderlet
$id integer
return Renderlet

setO() public method

public setO ( Asset | Document | Pimcore\Model\Object $o ) : Renderlet
$o Pimcore\Model\Asset | Pimcore\Model\Document | Pimcore\Model\Object
return Renderlet

setSubtype() public method

public setSubtype ( string $subtype ) : Renderlet
$subtype string
return Renderlet

Property Details

$id public property

Contains the ID of the linked object
public int $id
return integer

$o public property

Contains the object
public $o

$subtype public property

Contains the subtype
public string $subtype
return string

$type public property

Contains the type
public string $type
return string