PHP Class Pimcore\Model\Document\Tag\Href

Inheritance: extends Pimcore\Model\Document\Tag
Datei anzeigen Open project: pimcore/pimcore

Public Properties

Property Type Description
$element mixed Contains the source object
$id integer ID of the source object
$subtype string ..)
$type string Type of the source object (document, asset, object)

Public Methods

Method Description
__sleep ( ) : array
checkValidity ( ) : boolean
frontend ( ) : string
getData ( ) : mixed
getDataEditmode ( ) : mixed Converts the data so it's suitable for the editmode
getElement ( ) : mixed Returns one of them: Document, Object, Asset
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
getFullPath ( ) : mixed Returns teh path of the linked element
getId ( ) : integer
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 ) : void
setId ( integer $id ) : Href
setSubtype ( string $subtype ) : Href

Private Methods

Method Description
setElement ( ) : void Sets the element by the data stored for the object

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

getElement() public method

Returns one of them: Document, Object, Asset
public getElement ( ) : 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

getFullPath() public method

Returns teh path of the linked element
public getFullPath ( ) : mixed
return mixed

getId() public method

public getId ( ) : integer
return integer

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 ) : void
$data mixed
return void

setId() public method

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

setSubtype() public method

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

Property Details

$element public_oe property

Contains the source object
public mixed $element
return mixed

$id public_oe property

ID of the source object
public int $id
return integer

$subtype public_oe property

..)
public string $subtype
return string

$type public_oe property

Type of the source object (document, asset, object)
public string $type
return string