Contentserv PHP API

CSOpenSearchLinkComponent
in package

Defines a new plain object to store data for the open search link.

Tags
since

CS16.0.0

Table of Contents

TYPE_DOWNLOAD  = 3
TYPE_HTML  = 2
TYPE_LINK  = 1
__construct()  : mixed
CSOpenSearchLink constructor.
getAdditionalData()  : array<string|int, mixed>
Returns the additional data of the current CSOpenSearchLinkComponent object.
getContent()  : string
Returns the stored content of the current CSOpenSearchLinkComponent object.
getIcon()  : string
Returns the defined icon name, path or URL of the link component.
getID()  : int|string
Returns the stored identifier of the link.
getIndex()  : int
Gets the link index position
getLabel()  : string
Returns the stored label of the current CSOpenSearchLinkComponent object.
getType()  : int
Return the component type.
setAdditionalData()  : void
Sets the additionalData for the current CSOpenSearchLinkComponent object.
setContent()  : mixed
Sets the content for the current CSOpenSearchLinkComponent object.
setIcon()  : void
Defines the icon name or path / url of the link component.
setIndex()  : void
Sets the link index position
setLabel()  : mixed
Sets the label for the current CSOpenSearchLinkComponent object.

Constants

Methods

__construct()

CSOpenSearchLink constructor.

public __construct(int|string $mIdentifier, int $iType) : mixed
Parameters
$mIdentifier : int|string
$iType : int

The different link types. (See TYPE_* constants)

Tags
Return values
mixed —

getAdditionalData()

Returns the additional data of the current CSOpenSearchLinkComponent object.

public getAdditionalData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

the additional data of the current CSOpenSearchLinkComponent object.

getContent()

Returns the stored content of the current CSOpenSearchLinkComponent object.

public getContent() : string
Tags
Return values
string —

getIcon()

Returns the defined icon name, path or URL of the link component.

public getIcon() : string
Tags
Return values
string —

getID()

Returns the stored identifier of the link.

public getID() : int|string
Tags
Return values
int|string —

with the identifier.

getLabel()

Returns the stored label of the current CSOpenSearchLinkComponent object.

public getLabel() : string
Tags
Return values
string —

setAdditionalData()

Sets the additionalData for the current CSOpenSearchLinkComponent object.

public setAdditionalData(array<string|int, mixed> $aData) : void
Parameters
$aData : array<string|int, mixed>

The additional data which is to be set for the action button

Tags
Return values
void —

setContent()

Sets the content for the current CSOpenSearchLinkComponent object.

public setContent(string $sContent) : mixed
Parameters
$sContent : string
Tags
Return values
mixed —

setIcon()

Defines the icon name or path / url of the link component.

public setIcon(string $sIcon) : void
Parameters
$sIcon : string

The icon name or path / url of the link component

Tags
Return values
void —

setIndex()

Sets the link index position

public setIndex(int $iIndex) : void
Parameters
$iIndex : int
Tags
Return values
void —

setLabel()

Sets the label for the current CSOpenSearchLinkComponent object.

public setLabel(string $sLabel) : mixed
Parameters
$sLabel : string
Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results