Contentserv PHP API

CSOpenSearchButton
in package

Defines Button objects to be used in opensearch

Tags
since

CS19.4

Table of Contents

__construct()  : mixed
CSOpenSearchButton constructor.
getAreaIndex()  : int
Gets the button append mode
getButtonDefinition()  : array<string|int, mixed>
It returns an array with button definition
getButtonIndex()  : int
Gets the button index position
getIcon()  : string
Gets the button icon
getName()  : string
Gets the button name
getOnClickJs()  : string
Gets the button JS code onclick action
getTooltip()  : string
Gets the button tooltip
setAreaIndex()  : void
Sets the area index position
setButtonIndex()  : void
Sets the button index position
setIcon()  : void
Sets the button icon
setName()  : void
Sets the button name
setOnClickJs()  : void
Sets the button JS code
setTooltip()  : void
Sets the button tooltip

Methods

__construct()

CSOpenSearchButton constructor.

public __construct(string $sName, string $sOnClickJs[, string $sIcon = '' ][, string $sToolTip = '' ], int $iButtonIndex, int $iAreaIndex) : mixed

Instantiates a new object with the given parameters

Parameters
$sName : string

Button name

$sOnClickJs : string

JS code to be executed on click event

$sIcon : string = ''

The icon for the button

$sToolTip : string = ''

The tooltip text

$iButtonIndex : int

Button index position

$iAreaIndex : int

Area index position

Tags
Return values
mixed —

getAreaIndex()

Gets the button append mode

public getAreaIndex() : int
Tags
Return values
int —

getButtonDefinition()

It returns an array with button definition

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

getButtonIndex()

Gets the button index position

public getButtonIndex() : int
Tags
Return values
int —

getIcon()

Gets the button icon

public getIcon() : string
Tags
Return values
string —

getName()

Gets the button name

public getName() : string
Tags
Return values
string —

getOnClickJs()

Gets the button JS code onclick action

public getOnClickJs() : string
Tags
Return values
string —

getTooltip()

Gets the button tooltip

public getTooltip() : string
Tags
Return values
string —

setAreaIndex()

Sets the area index position

public setAreaIndex(int $iAreaIndex) : void
Parameters
$iAreaIndex : int
Tags
Return values
void —

setButtonIndex()

Sets the button index position

public setButtonIndex(int $iButtonIndex) : void
Parameters
$iButtonIndex : int
Tags
Return values
void —

setIcon()

Sets the button icon

public setIcon(string $sIcon) : void
Parameters
$sIcon : string
Tags
Return values
void —

setName()

Sets the button name

public setName(string $sName) : void
Parameters
$sName : string
Tags
Return values
void —

setOnClickJs()

Sets the button JS code

public setOnClickJs(string $sOnClickJs) : void
Parameters
$sOnClickJs : string
Tags
Return values
void —

setTooltip()

Sets the button tooltip

public setTooltip(string $sTooltip) : void
Parameters
$sTooltip : string
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results