\scenario

Summary

Methods

Properties

Constants

byId()
byString()
all()
schedule()
listGroup()
byTrigger()
byElement()
byObjectId()
check()
control()
doIn()
cleanTable()
consystencyCheck()
byObjectNameGroupNameScenarioName()
toHumanReadable()
fromHumanReadable()
searchByUse()
getTemplate()
timelineDisplay()
testTrigger()
launch()
execute()
copy()
toHtml()
emptyCacheWidget()
getIcon()
getLinkToConfiguration()
preSave()
postInsert()
save()
refresh()
remove()
removeData()
setData()
getData()
calculateScheduleDate()
isDue()
running()
stop()
getElement()
export()
getObject()
getHumanName()
hasRight()
persistLog()
toArray()
getLinkData()
getUse()
getUsedBy()
clearLog()
resetRepeatIfStatus()
getId()
getName()
getState()
getIsActive()
getGroup()
getLastLaunch()
setId()
setName()
setIsActive()
setGroup()
setState()
setLastLaunch()
getMode()
setMode()
getOrder()
setOrder()
getSchedule()
setSchedule()
getPID()
setPID()
getScenarioElement()
setScenarioElement()
getTrigger()
setTrigger()
getLog()
setLog()
getTimeout()
setTimeout()
getObject_id()
getIsVisible()
setObject_id()
setIsVisible()
getDisplay()
setDisplay()
getDescription()
setDescription()
getConfiguration()
setConfiguration()
getRealTrigger()
setRealTrigger()
getReturn()
setReturn()
getTags()
setTags()
getDo()
setDo()
getCache()
setCache()
getChanged()
setChanged()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$id
$name
$isActive
$group
$mode
$schedule
$scenarioElement
$trigger
$_log
$timeout
$object_id
$isVisible
$display
$order
$description
$configuration
$_templateArray
$_elements
$_changeState
$_realTrigger
$_return
$_tags
$_do
$_changed

N/A

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

Properties

$id

$id :

Type

$name

$name :

Type

$isActive

$isActive :

Type

$group

$group :

Type

$mode

$mode :

Type

$schedule

$schedule :

Type

$scenarioElement

$scenarioElement :

Type

$trigger

$trigger :

Type

$_log

$_log :

Type

$timeout

$timeout :

Type

$object_id

$object_id :

Type

$isVisible

$isVisible :

Type

$display

$display :

Type

$order

$order :

Type

$description

$description :

Type

$configuration

$configuration :

Type

$_templateArray

$_templateArray :

Type

$_elements

$_elements :

Type

$_changeState

$_changeState :

Type

$_realTrigger

$_realTrigger :

Type

$_return

$_return :

Type

$_tags

$_tags :

Type

$_do

$_do :

Type

$_changed

$_changed :

Type

Methods

byId()

byId(integer  $_id) : \scenario

Renvoie un objet scenario

Parameters

integer

$_id

id du scenario voulu

Returns

\scenario —

object scenario

byString()

byString(  $_string)

Parameters

$_string

all()

all(  $_group = '') : array<mixed,>

Renvoie tous les objets scenario

Parameters

$_group

Returns

array<mixed,> —

scenario object scenario

schedule()

schedule() : \type

Returns

\type

listGroup()

listGroup(\type  $_group = null) : \type

Parameters

\type

$_group

Returns

\type

byTrigger()

byTrigger(\type  $_cmd_id,   $_onlyEnable = true) : \type

Parameters

\type	$_cmd_id
	$_onlyEnable

Returns

\type

byElement()

byElement(\type  $_element_id) : \type

Parameters

\type

$_element_id

Returns

\type

byObjectId()

byObjectId(\type  $_object_id, \type  $_onlyEnable = true, \type  $_onlyVisible = false) : \type

Parameters

\type	$_object_id
\type	$_onlyEnable
\type	$_onlyVisible

Returns

\type

check()

check(\type  $_event = null, \type  $_forceSyncMode = false) : boolean

Parameters

\type	$_event
\type	$_forceSyncMode

Returns

boolean

control()

control()

doIn()

doIn(array  $_options) : \type

Parameters

array

$_options

Returns

\type

cleanTable()

cleanTable()

consystencyCheck()

consystencyCheck(  $_needsReturn = false)

Parameters

$_needsReturn

byObjectNameGroupNameScenarioName()

byObjectNameGroupNameScenarioName(object  $_object_name, \type  $_group_name, \type  $_scenario_name) : \type

Parameters

object	$_object_name
\type	$_group_name
\type	$_scenario_name

Returns

\type

static

Inherited from: \scenario

Tags

name	toHumanReadable()

fromHumanReadable()

fromHumanReadable(\type  $_input) : \type

Parameters

\type

$_input

Returns

\type

searchByUse()

searchByUse(\type  $searchs) : \type

Parameters

\type

$searchs

Returns

\type

getTemplate()

getTemplate() : \type

Returns

\type

timelineDisplay()

timelineDisplay(  $_event)

Parameters

$_event

testTrigger()

testTrigger(\type  $_event) : boolean

Parameters

\type

$_event

Returns

boolean

launch()

launch(\type  $_trigger = '', \type  $_message = '', \type  $_forceSyncMode = false) : boolean

Parameters

\type	$_trigger
\type	$_message
\type	$_forceSyncMode

Returns

boolean

execute()

execute(\type  $_trigger = '', \type  $_message = '') : \type

Parameters

\type	$_trigger
\type	$_message

Returns

\type

copy()

copy(\type  $_name) : \scenario

Parameters

\type

$_name

Returns

\scenario

toHtml()

toHtml(\type  $_version) : string

Parameters

\type

$_version

Returns

string

emptyCacheWidget()

emptyCacheWidget()

getIcon()

getIcon(\type  $_only_class = false) : string

Parameters

\type

$_only_class

Returns

string

getLinkToConfiguration()

getLinkToConfiguration() : \type

Returns

\type

preSave()

preSave()

Throws

\Exception

postInsert()

postInsert()

save()

save()

refresh()

refresh()

remove()

remove() : \type

Returns

\type

removeData()

removeData(\type  $_key, \type  $_private = false) : boolean

Parameters

\type	$_key
\type	$_private

Returns

boolean

setData()

setData(\type  $_key, \type  $_value, boolean  $_private = false) : boolean

Parameters

\type	$_key
\type	$_value
boolean	$_private

Returns

boolean

getData()

getData(  $_key,   $_private = false,   $_default = '')

Parameters

	$_key
	$_private
	$_default

calculateScheduleDate()

calculateScheduleDate() : \type

Returns

\type

isDue()

isDue() : boolean

Returns

boolean

running()

running() : boolean

Returns

boolean

stop()

stop() : boolean

Throws

\Exception

Returns

boolean

getElement()

getElement() : \type

Returns

\type

export()

export(\type  $_mode = 'text') : \type

Parameters

\type

$_mode

Returns

\type

getObject()

getObject() : object

Returns

object

getHumanName()

getHumanName(\type  $_complete = false, \type  $_noGroup = false, \type  $_tag = false, \type  $_prettify = false, \type  $_withoutScenarioName = false,   $_object_name = true) : string

Parameters

\type	$_complete
\type	$_noGroup
\type	$_tag
\type	$_prettify
\type	$_withoutScenarioName
	$_object_name

Returns

string

hasRight()

hasRight(\type  $_right,   $_user = null) : boolean

Parameters

\type	$_right
	$_user

Returns

boolean

persistLog()

persistLog(\type  $_partial = false) : \type

Parameters

\type

$_partial

Returns

\type

toArray()

toArray() : \type

Returns

\type

getLinkData()

getLinkData(\type  $_data = array('node' => array(), 'link' => array()), \type  $_level, \type  $_drill = null) : string

Parameters

\type	$_data
\type	$_level
\type	$_drill

Returns

string

getUse()

getUse() : \type

Returns

\type

getUsedBy()

getUsedBy(array  $_array = false) : \type

Parameters

array

$_array

Returns

\type

clearLog()

clearLog()

resetRepeatIfStatus()

resetRepeatIfStatus()

getId()

getId() : integer

Returns

integer

getName()

getName() : string

Returns

string

getState()

getState() : \type

Returns

\type

getIsActive()

getIsActive() : boolean

Returns

boolean

getGroup()

getGroup() : \type

Returns

\type

getLastLaunch()

getLastLaunch() : \type

Returns

\type

setId()

setId(  $_id) : $this

Parameters

$_id

Returns

$this

setName()

setName(  $_name) : $this

Parameters

$_name

Returns

$this

setIsActive()

setIsActive(  $_isActive) : $this

Parameters

$_isActive

Returns

$this

setGroup()

setGroup(  $_group) : $this

Parameters

$_group

Returns

$this

setState()

setState(\type  $state)

Parameters

\type

$state

setLastLaunch()

setLastLaunch(\type  $lastLaunch)

Parameters

\type

$lastLaunch

getMode()

getMode()

setMode()

setMode(  $_mode) : $this

Parameters

$_mode

Returns

$this

getOrder()

getOrder() : \type

Returns

\type

setOrder()

setOrder(  $_order) : $this

Parameters

$_order

Returns

$this

getSchedule()

getSchedule() : \string/object

Returns

\string/object

setSchedule()

setSchedule(  $_schedule) : $this

Parameters

$_schedule

Returns

$this

getPID()

getPID() : \type

Returns

\type

setPID()

setPID(\type  $pid = '')

Parameters

\type

$pid

getScenarioElement()

getScenarioElement() : \type

Returns

\type

setScenarioElement()

setScenarioElement(  $_scenarioElement) : $this

Parameters

$_scenarioElement

Returns

$this

getTrigger()

getTrigger() : \type

Returns

\type

setTrigger()

setTrigger(  $_trigger) : $this

Parameters

$_trigger

Returns

$this

getLog()

getLog() : \type

Returns

\type

setLog()

setLog(\type  $log)

Parameters

\type

$log

getTimeout()

getTimeout(\type  $_default) : \type

Parameters

\type

$_default

Returns

\type

setTimeout()

setTimeout(  $_timeout) : $this

Parameters

$_timeout

Returns

$this

getObject_id()

getObject_id(\type  $_default = null) : \type

Parameters

\type

$_default

Returns

\type

getIsVisible()

getIsVisible(\type  $_default) : \type

Parameters

\type

$_default

Returns

\type

setObject_id()

setObject_id(\type  $object_id = null) : $this

Parameters

\type

$object_id

Returns

$this

setIsVisible()

setIsVisible(  $_isVisible) : $this

Parameters

$_isVisible

Returns

$this

getDisplay()

getDisplay(\type  $_key = '', \type  $_default = '') : \type

Parameters

\type	$_key
\type	$_default

Returns

\type

setDisplay()

setDisplay(\type  $_key, \type  $_value) : $this

Parameters

\type	$_key
\type	$_value

Returns

$this

getDescription()

getDescription() : \type

Returns

\type

setDescription()

setDescription(  $_description) : $this

Parameters

$_description

Returns

$this

getConfiguration()

getConfiguration(\type  $_key = '', \type  $_default = '') : \type

Parameters

\type	$_key
\type	$_default

Returns

\type

setConfiguration()

setConfiguration(\type  $_key, \type  $_value) : $this

Parameters

\type	$_key
\type	$_value

Returns

$this

getRealTrigger()

getRealTrigger() : \type

Returns

\type

setRealTrigger()

setRealTrigger(\type  $_realTrigger) : $this

Parameters

\type

$_realTrigger

Returns

$this

getReturn()

getReturn() : \type

Returns

\type

setReturn()

setReturn(\type  $_return) : $this

Parameters

\type

$_return

Returns

$this

getTags()

getTags() : \type

Returns

\type

setTags()

setTags(\type  $_tags) : $this

Parameters

\type

$_tags

Returns

$this

getDo()

getDo() : \type

Returns

\type

setDo()

setDo(\type  $_do) : $this

Parameters

\type

$_do

Returns

$this

getCache()

getCache(\type  $_key = '', \type  $_default = '') : \type

Parameters

\type	$_key
\type	$_default

Returns

\type

setCache()

setCache(\type  $_key, \type  $_value = null)

Parameters

\type	$_key
\type	$_value

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed