API Documentation
\

\cmd

Summary

Methods
Properties
Constants
byId()
byIds()
all()
isHistorized()
allHistoryCmd()
byEqLogicId()
byLogicalId()
byGenericType()
searchConfiguration()
searchDisplay()
searchConfigurationEqLogic()
searchTemplate()
byEqLogicIdAndLogicalId()
byEqLogicIdAndGenericType()
byValue()
byTypeEqLogicNameCmdName()
byEqLogicIdCmdName()
byObjectNameEqLogicNameCmdName()
byObjectNameCmdName()
byTypeSubType()
cmdToHumanReadable()
humanReadableToCmd()
byString()
cmdToValue()
allType()
allSubType()
allUnite()
convertColor()
availableWidget()
returnState()
deadCmd()
cmdAlert()
timelineDisplay()
formatValue()
getLastValue()
dontRemoveCmd()
getTableName()
save()
refresh()
remove()
execute()
preExecCmd()
postExecCmd()
execCmd()
getWidgetTemplateCode()
toHtml()
event()
checkReturnState()
checkCmdAlert()
executeAlertCmdAction()
checkAlertLevel()
duringAlertLevel()
actionAlertLevel()
pushUrl()
generateAskResponseLink()
askResponse()
emptyHistory()
addHistoryValue()
getStatistique()
getTemporalAvg()
getTendance()
getCmdValue()
getHumanName()
getHistory()
getPluralityHistory()
widgetPossibility()
export()
getDirectUrlAccess()
checkAccessCode()
exportApi()
getLinkData()
getUsedBy()
getUse()
hasRight()
getId()
getName()
getGeneric_type()
setGeneric_type()
getType()
getSubType()
getEqType_name()
getEqLogic_id()
getIsHistorized()
getUnite()
getEqLogic()
setEqLogic()
getEventOnly()
setId()
setName()
setType()
setSubType()
setEqLogic_id()
setIsHistorized()
setUnite()
setEventOnly()
getTemplate()
setTemplate()
getConfiguration()
setConfiguration()
getDisplay()
setDisplay()
getAlert()
setAlert()
getCollectDate()
setCollectDate()
getValueDate()
setValueDate()
getValue()
setValue()
getIsVisible()
setIsVisible()
getOrder()
setOrder()
getLogicalId()
setLogicalId()
getEqType()
setEqType()
getCache()
setCache()
getChanged()
setChanged()
No public properties found
No constants found
No protected methods found
$id
$logicalId
$generic_type
$eqType
$name
$order
$type
$subType
$eqLogic_id
$isHistorized
$unite
$configuration
$template
$display
$value
$isVisible
$alert
$_collectDate
$_valueDate
$_eqLogic
$_needRefreshWidget
$_needRefreshAlert
$_changed
N/A
cast()
$_templateArray
N/A

Properties

$id

$id :

Type

$logicalId

$logicalId :

Type

$generic_type

$generic_type :

Type

$eqType

$eqType :

Type

$name

$name :

Type

$order

$order :

Type

$type

$type :

Type

$subType

$subType :

Type

$eqLogic_id

$eqLogic_id :

Type

$isHistorized

$isHistorized :

Type

$unite

$unite :

Type

$configuration

$configuration :

Type

$template

$template :

Type

$display

$display :

Type

$value

$value :

Type

$isVisible

$isVisible :

Type

$alert

$alert :

Type

$_collectDate

$_collectDate :

Type

$_valueDate

$_valueDate :

Type

$_eqLogic

$_eqLogic :

Type

$_needRefreshWidget

$_needRefreshWidget :

Type

$_needRefreshAlert

$_needRefreshAlert :

Type

$_changed

$_changed :

Type

$_templateArray

$_templateArray :

Type

Methods

byId()

byId(  $_id)

Parameters

$_id

byIds()

byIds(  $_ids)

Parameters

$_ids

all()

all()

isHistorized()

isHistorized(  $_state = true)

Parameters

$_state

allHistoryCmd()

allHistoryCmd()

byEqLogicId()

byEqLogicId(  $_eqLogic_id,   $_type = null,   $_visible = null,   $_eqLogic = null,   $_has_generic_type = null)

Parameters

$_eqLogic_id
$_type
$_visible
$_eqLogic
$_has_generic_type

byLogicalId()

byLogicalId(  $_logical_id,   $_type = null)

Parameters

$_logical_id
$_type

byGenericType()

byGenericType(  $_generic_type,   $_eqLogic_id = null,   $_one = false)

Parameters

$_generic_type
$_eqLogic_id
$_one

searchConfiguration()

searchConfiguration(  $_configuration,   $_eqType = null)

Parameters

$_configuration
$_eqType

searchDisplay()

searchDisplay(  $_display,   $_eqType = null)

Parameters

$_display
$_eqType

searchConfigurationEqLogic()

searchConfigurationEqLogic(  $_eqLogic_id,   $_configuration,   $_type = null)

Parameters

$_eqLogic_id
$_configuration
$_type

searchTemplate()

searchTemplate(  $_template,   $_eqType = null,   $_type = null,   $_subtype = null)

Parameters

$_template
$_eqType
$_type
$_subtype

byEqLogicIdAndLogicalId()

byEqLogicIdAndLogicalId(  $_eqLogic_id,   $_logicalId,   $_multiple = false,   $_type = null)

Parameters

$_eqLogic_id
$_logicalId
$_multiple
$_type

byEqLogicIdAndGenericType()

byEqLogicIdAndGenericType(  $_eqLogic_id,   $_generic_type,   $_multiple = false,   $_type = null)

Parameters

$_eqLogic_id
$_generic_type
$_multiple
$_type

byValue()

byValue(  $_value,   $_type = null,   $_onlyEnable = false)

Parameters

$_value
$_type
$_onlyEnable

byTypeEqLogicNameCmdName()

byTypeEqLogicNameCmdName(  $_eqType_name,   $_eqLogic_name,   $_cmd_name)

Parameters

$_eqType_name
$_eqLogic_name
$_cmd_name

byEqLogicIdCmdName()

byEqLogicIdCmdName(  $_eqLogic_id,   $_cmd_name)

Parameters

$_eqLogic_id
$_cmd_name

byObjectNameEqLogicNameCmdName()

byObjectNameEqLogicNameCmdName(  $_object_name,   $_eqLogic_name,   $_cmd_name)

Parameters

$_object_name
$_eqLogic_name
$_cmd_name

byObjectNameCmdName()

byObjectNameCmdName(  $_object_name,   $_cmd_name)

Parameters

$_object_name
$_cmd_name

byTypeSubType()

byTypeSubType(  $_type,   $_subType = '')

Parameters

$_type
$_subType

cmdToHumanReadable()

cmdToHumanReadable(  $_input)

Parameters

$_input

humanReadableToCmd()

humanReadableToCmd(  $_input)

Parameters

$_input

byString()

byString(  $_string)

Parameters

$_string

cmdToValue()

cmdToValue(  $_input,   $_quote = false)

Parameters

$_input
$_quote

allType()

allType()

allSubType()

allSubType(  $_type = '')

Parameters

$_type

allUnite()

allUnite()

convertColor()

convertColor(  $_color)

Parameters

$_color

availableWidget()

availableWidget(  $_version)

Parameters

$_version

returnState()

returnState(  $_options)

Parameters

$_options

deadCmd()

deadCmd()

cmdAlert()

cmdAlert(  $_options)

Parameters

$_options

timelineDisplay()

timelineDisplay(  $_event)

Parameters

$_event

formatValue()

formatValue(  $_value,   $_quote = false)

Parameters

$_value
$_quote

getLastValue()

getLastValue()

dontRemoveCmd()

dontRemoveCmd()

getTableName()

getTableName()

save()

save(  $_direct = false)

Parameters

$_direct

refresh()

refresh()

remove()

remove()

execute()

execute(  $_options = array())

Parameters

$_options

preExecCmd()

preExecCmd(  $_values = array())

Parameters

$_values

postExecCmd()

postExecCmd(  $_values = array())

Parameters

$_values

execCmd()

execCmd(\type  $_options = null, \type  $_sendNodeJsEvent = false, \type  $_quote = false) : \command

Parameters

\type $_options
\type $_sendNodeJsEvent
\type $_quote

Throws

\Exception

Returns

\command —

result

getWidgetTemplateCode()

getWidgetTemplateCode(  $_version = 'dashboard')

Parameters

$_version

toHtml()

toHtml(  $_version = 'dashboard',   $_options = '')

Parameters

$_version
$_options

event()

event(  $_value,   $_datetime = null,   $_loop = 1)

Parameters

$_value
$_datetime
$_loop

checkReturnState()

checkReturnState(  $_value)

Parameters

$_value

checkCmdAlert()

checkCmdAlert(  $_value)

Parameters

$_value

executeAlertCmdAction()

executeAlertCmdAction()

checkAlertLevel()

checkAlertLevel(  $_value,   $_allowDuring = true,   $_checkLevel = 'none')

Parameters

$_value
$_allowDuring
$_checkLevel

duringAlertLevel()

duringAlertLevel(  $_options)

Parameters

$_options

actionAlertLevel()

actionAlertLevel(  $_level,   $_value)

Parameters

$_level
$_value

pushUrl()

pushUrl(  $_value)

Parameters

$_value

generateAskResponseLink()

generateAskResponseLink(  $_response,   $_plugin = 'core',   $_network = 'external')

Parameters

$_response
$_plugin
$_network

askResponse()

askResponse(  $_response)

Parameters

$_response

emptyHistory()

emptyHistory(  $_date = '')

Parameters

$_date

addHistoryValue()

addHistoryValue(  $_value,   $_datetime = '')

Parameters

$_value
$_datetime

getStatistique()

getStatistique(  $_startTime,   $_endTime)

Parameters

$_startTime
$_endTime

getTemporalAvg()

getTemporalAvg(  $_startTime,   $_endTime)

Parameters

$_startTime
$_endTime

getTendance()

getTendance(  $_startTime,   $_endTime)

Parameters

$_startTime
$_endTime

getCmdValue()

getCmdValue()

getHumanName()

getHumanName(  $_tag = false,   $_prettify = false)

Parameters

$_tag
$_prettify

getHistory()

getHistory(  $_dateStart = null,   $_dateEnd = null,   $_groupingType = null)

Parameters

$_dateStart
$_dateEnd
$_groupingType

getPluralityHistory()

getPluralityHistory(  $_dateStart = null,   $_dateEnd = null,   $_period = 'day',   $_offset)

Parameters

$_dateStart
$_dateEnd
$_period
$_offset

widgetPossibility()

widgetPossibility(  $_key = '',   $_default = true)

Parameters

$_key
$_default

export()

export()

getDirectUrlAccess()

getDirectUrlAccess()

checkAccessCode()

checkAccessCode(  $_code)

Parameters

$_code

exportApi()

exportApi()

getLinkData()

getLinkData(  $_data = array('node' => array(), 'link' => array()),   $_level,   $_drill = null)

Parameters

$_data
$_level
$_drill

getUsedBy()

getUsedBy(  $_array = false)

Parameters

$_array

getUse()

getUse()

hasRight()

hasRight(  $_user = null)

Parameters

$_user

getId()

getId()

getName()

getName()

getGeneric_type()

getGeneric_type()

setGeneric_type()

setGeneric_type(  $_generic_type)

Parameters

$_generic_type

getType()

getType()

getSubType()

getSubType()

getEqType_name()

getEqType_name()

getEqLogic_id()

getEqLogic_id()

getIsHistorized()

getIsHistorized()

getUnite()

getUnite()

getEqLogic()

getEqLogic()

setEqLogic()

setEqLogic(  $_eqLogic)

Parameters

$_eqLogic

getEventOnly()

getEventOnly()

setId()

setId(  $_id = '')

Parameters

$_id

setName()

setName(  $_name) : $this

Parameters

$_name

Returns

$this

setType()

setType(  $_type)

Parameters

$_type

setSubType()

setSubType(  $_subType)

Parameters

$_subType

setEqLogic_id()

setEqLogic_id(  $_eqLogic_id)

Parameters

$_eqLogic_id

setIsHistorized()

setIsHistorized(  $_isHistorized)

Parameters

$_isHistorized

setUnite()

setUnite(  $_unite)

Parameters

$_unite

setEventOnly()

setEventOnly(  $eventOnly)

Parameters

$eventOnly

getTemplate()

getTemplate(  $_key = '',   $_default = '')

Parameters

$_key
$_default

setTemplate()

setTemplate(  $_key,   $_value)

Parameters

$_key
$_value

getConfiguration()

getConfiguration(  $_key = '',   $_default = '')

Parameters

$_key
$_default

setConfiguration()

setConfiguration(  $_key,   $_value)

Parameters

$_key
$_value

getDisplay()

getDisplay(  $_key = '',   $_default = '')

Parameters

$_key
$_default

setDisplay()

setDisplay(  $_key,   $_value)

Parameters

$_key
$_value

getAlert()

getAlert(  $_key = '',   $_default = '')

Parameters

$_key
$_default

setAlert()

setAlert(  $_key,   $_value)

Parameters

$_key
$_value

getCollectDate()

getCollectDate()

setCollectDate()

setCollectDate(  $_collectDate)

Parameters

$_collectDate

getValueDate()

getValueDate()

setValueDate()

setValueDate(  $_valueDate)

Parameters

$_valueDate

getValue()

getValue()

setValue()

setValue(  $_value)

Parameters

$_value

getIsVisible()

getIsVisible()

setIsVisible()

setIsVisible(  $isVisible)

Parameters

$isVisible

getOrder()

getOrder()

setOrder()

setOrder(  $order)

Parameters

$order

getLogicalId()

getLogicalId()

setLogicalId()

setLogicalId(  $_logicalId)

Parameters

$_logicalId

getEqType()

getEqType()

setEqType()

setEqType(  $_eqType)

Parameters

$_eqType

getCache()

getCache(  $_key = '',   $_default = '')

Parameters

$_key
$_default

setCache()

setCache(  $_key,   $_value = null)

Parameters

$_key
$_value

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed

cast()

cast(  $_inputs,   $_eqLogic = null)

Parameters

$_inputs
$_eqLogic