Contentserv PHP API

CSDashboardTileParameter
in package

This class is part of the Dashboard module. It is used to read a certain parameter from the tile.

Tags
since

CS16.0

access

public

Table of Contents

$_oTileParameterRecord  : mixed
getAppName()  : string
This method is used to return the app name of the tile parameter.
getID()  : int
This method is used to get an id of tile parameter.
getName()  : string
This method is used to return the name of the tile parameter.
getParameter()  : CSDashboardTileParameter
This method is used to get an existing tile parameter.
getScreenName()  : string
This method is used to return the screen name of the tile parameter.
getValue()  : string
This method is used to return the value of the tile parameter.
setName()  : mixed
This method is used to update the name of the tile parameter.

Properties

Methods

getAppName()

This method is used to return the app name of the tile parameter.

public getAppName() : string
Tags
Return values
string —

getID()

This method is used to get an id of tile parameter.

public getID() : int
Tags
Return values
int —

CSDashboardTileParameterID

getName()

This method is used to return the name of the tile parameter.

public getName() : string
Tags
Return values
string —

getParameter()

This method is used to get an existing tile parameter.

public static getParameter(int $iDashboardTileParameterId) : CSDashboardTileParameter
Parameters
$iDashboardTileParameterId : int

the id of the tile parameter

Tags
throws
Exception

if no matching parameter is found in the database

Return values
CSDashboardTileParameter —

a object of the requested tile parameter

getScreenName()

This method is used to return the screen name of the tile parameter.

public getScreenName() : string
Tags
Return values
string —

getValue()

This method is used to return the value of the tile parameter.

public getValue([bool $bGetTranslatedValue = true ]) : string
Parameters
$bGetTranslatedValue : bool = true

if true parameter value is returned with translated value.

Tags
Return values
string —

setName()

This method is used to update the name of the tile parameter.

public setName(mixed $aTileParameterName) : mixed
Parameters
$aTileParameterName : mixed
Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results