\cmd

Summary

Methods

Properties

Constants

byId()
byIds()
all()
isHistorized()
allHistoryCmd()
byEqLogicId()
byLogicalId()
byGenericType()
searchByString()
searchConfiguration()
searchDisplay()
searchConfigurationEqLogic()
searchTemplate()
byEqLogicIdAndLogicalId()
byEqLogicIdAndGenericType()
byGenericTypeObjectId()
byValue()
byTypeEqLogicNameCmdName()
byEqLogicIdCmdName()
byObjectNameEqLogicNameCmdName()
byObjectNameCmdName()
byTypeSubType()
cmdToHumanReadable()
humanReadableToCmd()
byString()
cmdToValue()
allType()
allSubType()
allUnite()
convertColor()
availableWidget()
getSelectOptionsByTypeAndSubtype()
returnState()
deadCmd()
cmdAlert()
formatValue()
getLastValue()
dontRemoveCmd()
getTableName()
save()
refresh()
remove()
execute()
preExecCmd()
postExecCmd()
isAlreadyInStateAllow()
alreadyInState()
execCmd()
getWidgetsSelectOptions()
getGenericTypeSelectOptions()
getWidgetHelp()
cleanWidgetCode()
getWidgetTemplateCode()
autoValueArray()
toHtml()
event()
checkReturnState()
checkCmdAlert()
executeAlertCmdAction()
checkAlertLevel()
duringAlertLevel()
actionAlertLevel()
pushUrl()
computeInfluxData()
getInflux()
pushInflux()
dropInfluxDatabase()
dropInflux()
historyInfluxAll()
sendHistoryInflux()
historyInflux()
generateAskResponseLink()
askResponse()
emptyHistory()
addHistoryValue()
getStatistique()
getTemporalAvg()
getTendance()
getCmdValue()
getHumanName()
getHistory()
getLastHistory()
getOldest()
getPluralityHistory()
widgetPossibility()
migrateCmd()
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()
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
$_templateArray
$_unite_conversion

N/A

cast()
pre_postExecCmd()
autoValueFormat()

No private properties found

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 :\eqLogic

Type

\eqLogic

$_needRefreshWidget

$_needRefreshWidget :

Type

$_needRefreshAlert

$_needRefreshAlert :

Type

$_changed

$_changed :boolean

Type

boolean

$_templateArray

$_templateArray :

Type

$_unite_conversion

$_unite_conversion :

Type

Methods

byId()

byId(integer|string  $_id): void|\cmd

Parameters

integer|string

$_id

the id of the command

Returns

void|\cmd —

void if $_id is not valid else the cmd

byIds()

byIds(\array<string|\int>  $_ids): void|\array<cmd>

Parameters

\array

$_ids

Returns

void|\array —

void if $_ids is not valid else an array of cmd

all()

all(): \array<cmd>

Returns

\array

isHistorized()

isHistorized(  $_state = true)

Parameters

$_state

allHistoryCmd()

allHistoryCmd()

byEqLogicId()

byEqLogicId(integer|\array<int>  $_eqLogic_id,string  $_type = null,boolean  $_visible = null,\eqLogic  $_eqLogic = null,boolean  $_has_generic_type = null): \array<cmd>

Parameters

integer\|\array	$_eqLogic_id
string	$_type	['action'\|'info']
boolean	$_visible
\eqLogic	$_eqLogic
boolean	$_has_generic_type

Returns

\array

byLogicalId()

byLogicalId(string  $_logical_id,string  $_type = null): \array<cmd>

Parameters

string	$_logical_id
string	$_type	['action'\|'info']

Returns

\array

byGenericType()

byGenericType(string|\array<string>  $_generic_type,integer  $_eqLogic_id = null,boolean  $_one = false): \cmd|\array<cmd>

Parameters

string\|\array	$_generic_type
integer	$_eqLogic_id
boolean	$_one

Returns

\cmd|\array —

first cmd if $_one is true otherwise an array of all cmd

searchByString()

searchByString(string  $_search): \array<cmd>

Search a command on eqType, logicalId, generic_type or name

Parameters

string

$_search

the needle

Returns

\array

searchConfiguration()

searchConfiguration(string|\array<string>  $_configuration,string  $_eqType = null): \array<cmd>

Parameters

string\|\array	$_configuration
string	$_eqType

Returns

\array

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,  $_eqLogic = null)

Parameters

	$_eqLogic_id
	$_logicalId
	$_multiple
	$_type
	$_eqLogic

byEqLogicIdAndGenericType()

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

Parameters

	$_eqLogic_id
	$_generic_type
	$_multiple
	$_type
	$_eqLogic

byGenericTypeObjectId()

byGenericTypeObjectId(  $_generic_type,  $_object_id = null,  $_type = null)

Parameters

	$_generic_type
	$_object_id
	$_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

getSelectOptionsByTypeAndSubtype()

getSelectOptionsByTypeAndSubtype(  $_type = false,  $_subtype = false,  $_version = 'dashboard',  $_availWidgets = false)

Parameters

	$_type
	$_subtype
	$_version
	$_availWidgets

returnState()

returnState(  $_options)

Parameters

$_options

deadCmd()

deadCmd()

cmdAlert()

cmdAlert(  $_options)

Parameters

$_options

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

isAlreadyInStateAllow()

isAlreadyInStateAllow()

alreadyInState()

alreadyInState(  $_options)

Parameters

$_options

execCmd()

execCmd(null|string  $_options = null,boolean  $_sendNodeJsEvent = false,boolean  $_quote = false): void|string

Parameters

null\|string	$_options
boolean	$_sendNodeJsEvent
boolean	$_quote

Throws

\Exception

Returns

void|string

getWidgetsSelectOptions()

getWidgetsSelectOptions(  $_version = 'dashboard',  $_availWidgets = false)

Parameters

	$_version
	$_availWidgets

getGenericTypeSelectOptions()

getGenericTypeSelectOptions()

getWidgetHelp()

getWidgetHelp(  $_version = 'dashboard',  $_widgetName = '')

Parameters

	$_version
	$_widgetName

cleanWidgetCode()

cleanWidgetCode(  $_template)

Parameters

$_template

getWidgetTemplateCode()

getWidgetTemplateCode(  $_version = 'dashboard',  $_clean = true,  $_widgetName = '')

Parameters

	$_version
	$_clean
	$_widgetName

autoValueArray()

autoValueArray(  $_value,  $_decimal = 99,  $_unit = '',  $_space = False)

Parameters

	$_value
	$_decimal
	$_unit
	$_space

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

computeInfluxData()

computeInfluxData(  $_value,  $_timestamp = '')

Parameters

	$_value
	$_timestamp

getInflux()

getInflux(  $_cmdId = null)

Parameters

$_cmdId

pushInflux()

pushInflux(  $_value = null)

Parameters

$_value

dropInfluxDatabase()

dropInfluxDatabase()

dropInflux()

dropInflux()

historyInfluxAll()

historyInfluxAll()

sendHistoryInflux()

sendHistoryInflux(  $_params)

Parameters

$_params

historyInflux()

historyInflux(  $_type = '')

Parameters

$_type

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,  $_addFirstPreviousValue = false)

Parameters

	$_dateStart
	$_dateEnd
	$_groupingType
	$_addFirstPreviousValue

getLastHistory()

getLastHistory(  $_time,  $_previous = true)

Parameters

	$_time
	$_previous

getOldest()

getOldest()

getPluralityHistory()

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

Parameters

	$_dateStart
	$_dateEnd
	$_period
	$_offset

widgetPossibility()

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

Parameters

	$_key
	$_default

migrateCmd()

migrateCmd(  $_sourceId,  $_targetId)

Parameters

	$_sourceId
	$_targetId

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  $_eqLogic)

Parameters

\eqLogic

$_eqLogic

getEventOnly()

getEventOnly()

setId()

setId(  $_id = '')

Parameters

$_id

setName()

setName(string  $_name): $this

Parameters

string

$_name

Returns

$this

setType()

setType(string  $_type)

Parameters

string

$_type

setSubType()

setSubType(string  $_subType)

Parameters

string

$_subType

setEqLogic_id()

setEqLogic_id(  $_eqLogic_id)

Parameters

$_eqLogic_id

setIsHistorized()

setIsHistorized(  $_isHistorized)

Parameters

$_isHistorized

setUnite()

setUnite(  $_unite)

Parameters

$_unite

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(boolean  $_changed)

Parameters

boolean

$_changed

cast()

cast(  $_inputs,  $_eqLogic = null)

Parameters

	$_inputs
	$_eqLogic

pre_postExecCmd()

pre_postExecCmd(  $_values = array(),  $_type = 'jeedomPreExecCmd')

Parameters

	$_values
	$_type

autoValueFormat()

autoValueFormat(  $_value,  $_mod = 1000,  $_maxdiv = 10)

Parameters

	$_value
	$_mod
	$_maxdiv