\scenarioExpression

Summary

Methods

Properties

Constants

byId()
all()
byscenarioSubElementId()
searchExpression()
byElement()
getExpressionOptions()
humanAction()
randText()
scenario()
eqEnable()
average()
averageBetween()
max()
color_gradient()
maxBetween()
wait()
min()
minBetween()
median()
avg()
tendance()
lastStateDuration()
stateChanges()
stateChangesBetween()
duration()
durationBetween()
lastBetween()
statistics()
statisticsBetween()
variable()
stateDuration()
lastChangeStateDuration()
odd()
lastScenarioExecution()
collectDate()
valueDate()
lastCommunication()
value()
randomColor()
trigger()
triggerValue()
round()
time_op()
time_between()
time_diff()
time()
formatTime()
name()
getRequestTags()
tag()
setTags()
createAndExec()
checkBackground()
execute()
save()
remove()
getAllId()
copy()
emptyOptions()
resetRepeatIfStatus()
export()
getId()
setId()
getType()
setType()
getScenarioSubElement_id()
getSubElement()
setScenarioSubElement_id()
getSubtype()
setSubtype()
getExpression()
setExpression()
getOptions()
setOptions()
getOrder()
setOrder()
setLog()
getChanged()
setChanged()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$id
$scenarioSubElement_id
$type
$subtype
$expression
$options
$order
$_changed

N/A

File: scenarioExpression.class.php
Package: Default
Class hierarchy: \scenarioExpression

Properties

$id

$id :

Type

$scenarioSubElement_id

$scenarioSubElement_id :

Type

$type

$type :

Type

$subtype

$subtype :

Type

$expression

$expression :

Type

$options

$options :

Type

$order

$order :

Type

$_changed

$_changed :

Type

Methods

byId()

byId(  $_id)

Parameters

$_id

all()

all()

byscenarioSubElementId()

byscenarioSubElementId(  $_scenarioSubElementId)

Parameters

$_scenarioSubElementId

searchExpression()

searchExpression(  $_expression,   $_options = null,   $_and = true)

Parameters

	$_expression
	$_options
	$_and

byElement()

byElement(  $_element_id)

Parameters

$_element_id

getExpressionOptions()

getExpressionOptions(  $_expression,   $_options)

Parameters

	$_expression
	$_options

humanAction()

humanAction(  $_action)

Parameters

$_action

randText()

randText(  $_sValue)

Parameters

$_sValue

scenario()

scenario(  $_scenario)

Parameters

$_scenario

eqEnable()

eqEnable(  $_eqLogic_id)

Parameters

$_eqLogic_id

average()

average(  $_cmd_id,   $_period = '1 hour')

Parameters

	$_cmd_id
	$_period

averageBetween()

averageBetween(  $_cmd_id,   $_startDate,   $_endDate)

Parameters

	$_cmd_id
	$_startDate
	$_endDate

max()

max(  $_cmd_id,   $_period = '1 hour')

Parameters

	$_cmd_id
	$_period

color_gradient()

color_gradient(  $_from_color,   $_to_color,   $_min,   $_max,   $_value)

Parameters

	$_from_color
	$_to_color
	$_min
	$_max
	$_value

maxBetween()

maxBetween(  $_cmd_id,   $_startDate,   $_endDate)

Parameters

	$_cmd_id
	$_startDate
	$_endDate

wait()

wait(  $_condition,   $_timeout = 7200)

Parameters

	$_condition
	$_timeout

min()

min(  $_cmd_id,   $_period = '1 hour')

Parameters

	$_cmd_id
	$_period

minBetween()

minBetween(  $_cmd_id,   $_startDate,   $_endDate)

Parameters

	$_cmd_id
	$_startDate
	$_endDate

median()

median()

avg()

avg()

tendance()

tendance(  $_cmd_id,   $_period = '1 hour',   $_threshold = '')

Parameters

	$_cmd_id
	$_period
	$_threshold

lastStateDuration()

lastStateDuration(  $_cmd_id,   $_value = null)

Parameters

	$_cmd_id
	$_value

stateChanges()

stateChanges(  $_cmd_id,   $_value = null,   $_period = '1 hour')

Parameters

	$_cmd_id
	$_value
	$_period

stateChangesBetween()

stateChangesBetween(  $_cmd_id,   $_value,   $_startDate,   $_endDate = null)

Parameters

	$_cmd_id
	$_value
	$_startDate
	$_endDate

duration()

duration(  $_cmd_id,   $_value,   $_period = '1 hour')

Parameters

	$_cmd_id
	$_value
	$_period

durationBetween()

durationBetween(  $_cmd_id,   $_value,   $_startDate,   $_endDate)

Parameters

	$_cmd_id
	$_value
	$_startDate
	$_endDate

lastBetween()

lastBetween(  $_cmd_id,   $_startDate,   $_endDate)

Parameters

	$_cmd_id
	$_startDate
	$_endDate

statistics()

statistics(  $_cmd_id,   $_calc,   $_period = '1 hour')

Parameters

	$_cmd_id
	$_calc
	$_period

statisticsBetween()

statisticsBetween(  $_cmd_id,   $_calc,   $_startDate,   $_endDate)

Parameters

	$_cmd_id
	$_calc
	$_startDate
	$_endDate

variable()

variable(  $_name,   $_default = '')

Parameters

	$_name
	$_default

stateDuration()

stateDuration(  $_cmd_id,   $_value = null)

Parameters

	$_cmd_id
	$_value

lastChangeStateDuration()

lastChangeStateDuration(  $_cmd_id,   $_value)

Parameters

	$_cmd_id
	$_value

odd()

odd(  $_value)

Parameters

$_value

lastScenarioExecution()

lastScenarioExecution(  $_scenario_id)

Parameters

$_scenario_id

collectDate()

collectDate(  $_cmd_id,   $_format = 'Y-m-d H:i:s')

Parameters

	$_cmd_id
	$_format

valueDate()

valueDate(  $_cmd_id,   $_format = 'Y-m-d H:i:s')

Parameters

	$_cmd_id
	$_format

lastCommunication()

lastCommunication(  $_eqLogic_id,   $_format = 'Y-m-d H:i:s')

Parameters

	$_eqLogic_id
	$_format

value()

value(  $_cmd_id)

Parameters

$_cmd_id

randomColor()

randomColor(  $_rangeLower,   $_rangeHighter)

Parameters

	$_rangeLower
	$_rangeHighter

trigger()

trigger(  $_name = '',   $_scenario = null)

Parameters

	$_name
	$_scenario

triggerValue()

triggerValue(  $_scenario = null)

Parameters

$_scenario

round()

round(  $_value,   $_decimal)

Parameters

	$_value
	$_decimal

time_op()

time_op(  $_time,   $_value)

Parameters

	$_time
	$_value

time_between()

time_between(  $_time,   $_start,   $_end)

Parameters

	$_time
	$_start
	$_end

time_diff()

time_diff(  $_date1,   $_date2,   $_format = 'd')

Parameters

	$_date1
	$_date2
	$_format

time()

time(  $_value)

Parameters

$_value

formatTime()

formatTime(  $_time)

Parameters

$_time

name()

name(  $_type,   $_cmd_id)

Parameters

	$_type
	$_cmd_id

getRequestTags()

getRequestTags(  $_expression)

Parameters

$_expression

tag()

tag(  $_scenario = null,   $_name,   $_default = '')

Parameters

	$_scenario
	$_name
	$_default

setTags()

setTags(  $_expression,   $_scenario = null,   $_quote = false,   $_nbCall)

Parameters

	$_expression
	$_scenario
	$_quote
	$_nbCall

createAndExec()

createAndExec(  $_type,   $_cmd,   $_options = null)

Parameters

	$_type
	$_cmd
	$_options

checkBackground()

checkBackground()

execute()

execute(  $scenario = null)

Parameters

$scenario

save()

save()

remove()

remove()

getAllId()

getAllId()

copy()

copy(  $_scenarioSubElement_id)

Parameters

$_scenarioSubElement_id

emptyOptions()

emptyOptions()

resetRepeatIfStatus()

resetRepeatIfStatus()

export()

export()

getId()

getId()

setId()

setId(  $_id)

Parameters

$_id

getType()

getType()

setType()

setType(  $_type)

Parameters

$_type

getScenarioSubElement_id()

getScenarioSubElement_id()

getSubElement()

getSubElement()

setScenarioSubElement_id()

setScenarioSubElement_id(  $_scenarioSubElement_id)

Parameters

$_scenarioSubElement_id

getSubtype()

getSubtype()

setSubtype()

setSubtype(  $_subtype)

Parameters

$_subtype

getExpression()

getExpression()

setExpression()

setExpression(  $_expression)

Parameters

$_expression

getOptions()

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

Parameters

	$_key
	$_default

setOptions()

setOptions(  $_key,   $_value)

Parameters

	$_key
	$_value

getOrder()

getOrder()

setOrder()

setOrder(  $_order)

Parameters

$_order

setLog()

setLog(  $_scenario,   $log)

Parameters

	$_scenario
	$log

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed