PHP Class Pimcore\Model\Document\Link

Inheritance: extends Pimcore\Model\Document
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$direct string Contains the direct link as plain text
$href string path of the link
$internal integer Contains the ID of the internal ID
$internalType string Contains the type of the internal ID
$linktype string Type of the link (internal/direct)
$object Pimcore\Model\Document | Pimcore\Model\Asset Contains object of linked Document|Asset
$type string static type of this object

Public Methods

Method Description
__sleep ( )
getAccesskey ( ) : string getProperty method should be used instead
getAnchor ( ) : string getProperty method should be used instead
getCacheTags ( $tags = [] ) : array Resolves dependencies and create tags for caching out of them
getDirect ( ) : string Returns the direct link (eg. http://www.pimcore.org/test)
getHref ( ) : string Returns the plain text path of the link
getHtml ( ) : string returns the ready-use html for this link
getInternal ( ) : integer Returns the id of the internal document|asset which is linked
getInternalType ( ) : string
getLink ( ) : string Returns the path of the link including the anchor and parameters
getLinktype ( ) : string Returns the type of the link (internal/direct)
getName ( ) : string getProperty method should be used instead
getObject ( ) : Document | Asset
getParameters ( ) : string getProperty method should be used instead
getRel ( ) : string getProperty method should be used instead
getTabindex ( ) : string getProperty method should be used instead
getTarget ( ) : string getProperty method should be used instead
getTitle ( ) : string
resolveDependencies ( ) : array
setAccesskey ( $accesskey )
setAnchor ( $anchor )
setDirect ( string $direct )
setInternal ( integer $internal )
setInternalType ( string $type )
setLinktype ( string $linktype )
setName ( string $name ) setProperty method should be used instead
setObject ( $object )
setObjectFromId ( ) : Asset | Document
setParameters ( $parameters )
setRel ( $rel )
setTabindex ( $tabindex )
setTarget ( string $target ) : string setProperty method should be used instead
setTitle ( $title )

Method Details

__sleep() public method

public __sleep ( )

getAccesskey() public method

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

getAnchor() public method

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

getCacheTags() public method

Resolves dependencies and create tags for caching out of them
public getCacheTags ( $tags = [] ) : array
return array

getDirect() public method

Returns the direct link (eg. http://www.pimcore.org/test)
public getDirect ( ) : string
return string

getHref() public method

Returns the plain text path of the link
public getHref ( ) : string
return string

getHtml() public method

returns the ready-use html for this link
public getHtml ( ) : string
return string

getInternal() public method

Returns the id of the internal document|asset which is linked
public getInternal ( ) : integer
return integer

getInternalType() public method

public getInternalType ( ) : string
return string

getLinktype() public method

Returns the type of the link (internal/direct)
public getLinktype ( ) : string
return string

getName() public method

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

getObject() public method

public getObject ( ) : Document | Asset
return Pimcore\Model\Document | Pimcore\Model\Asset

getParameters() public method

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

getRel() public method

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

getTabindex() public method

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

getTarget() public method

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

getTitle() public method

public getTitle ( ) : string
return string

resolveDependencies() public method

See also: Document::resolveDependencies
public resolveDependencies ( ) : array
return array

setAccesskey() public method

public setAccesskey ( $accesskey )
$accesskey

setAnchor() public method

public setAnchor ( $anchor )
$anchor

setDirect() public method

public setDirect ( string $direct )
$direct string

setInternal() public method

public setInternal ( integer $internal )
$internal integer

setInternalType() public method

public setInternalType ( string $type )
$type string

setLinktype() public method

public setLinktype ( string $linktype )
$linktype string

setName() public method

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

setObject() public method

public setObject ( $object )

setObjectFromId() public method

public setObjectFromId ( ) : Asset | Document
return Pimcore\Model\Asset | Pimcore\Model\Document

setParameters() public method

public setParameters ( $parameters )
$parameters

setRel() public method

public setRel ( $rel )
$rel

setTabindex() public method

public setTabindex ( $tabindex )
$tabindex

setTarget() public method

setProperty method should be used instead
Deprecation:
public setTarget ( string $target ) : string
$target string
return string

setTitle() public method

public setTitle ( $title )
$title

Property Details

$direct public property

Contains the direct link as plain text
public string $direct
return string

$href public property

path of the link
public string $href
return string

$internal public property

Contains the ID of the internal ID
public int $internal
return integer

$internalType public property

Contains the type of the internal ID
public string $internalType
return string

$linktype public property

Type of the link (internal/direct)
public string $linktype
return string

$object public property

Contains object of linked Document|Asset
public Document,Pimcore\Model|Asset,Pimcore\Model $object
return Pimcore\Model\Document | Pimcore\Model\Asset

$type public property

static type of this object
public string $type
return string