\scenario

Summary

Methods
Properties
Constants
byId()
all()
schedule()
listGroup()
byTrigger()
byElement()
byObjectId()
check()
doIn()
cleanTable()
consystencyCheck()
byObjectNameGroupNameScenarioName()
toHumanReadable()
fromHumanReadable()
searchByUse()
getTemplate()
shareOnMarket()
getFromMarket()
removeFromMarket()
listMarketObject()
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()
getId()
getName()
getState()
getIsActive()
getGroup()
getLastLaunch()
setId()
setName()
setIsActive()
setGroup()
setState()
setLastLaunch()
getType()
setType()
getMode()
setMode()
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()
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
$description
$configuration
$type
$_templateArray
$_elements
$_changeState
$_realTrigger
$_return
$_tags
$_do
N/A

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

$description

$description : 

Type

$configuration

$configuration : 

Type

$type

$type : 

Type

$_templateArray

$_templateArray : 

Type

$_elements

$_elements : 

Type

$_changeState

$_changeState : 

Type

$_realTrigger

$_realTrigger : 

Type

$_return

$_return : 

Type

$_tags

$_tags : 

Type

$_do

$_do : 

Type

Methods

byId()

byId(integer  $_id) : \scenario

Renvoie un objet scenario

Parameters

integer $_id

id du scenario voulu

Returns

\scenario

object scenario

all()

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

Renvoie tous les objets scenario

Parameters

$_group
$_type

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) : \type

Parameters

\type $_cmd_id

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

doIn()

doIn(array  $_options) : \type

Parameters

array $_options

Returns

\type

cleanTable()

cleanTable() 

consystencyCheck()

consystencyCheck() 

byObjectNameGroupNameScenarioName()

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

Parameters

object $_object_name
\type $_group_name
\type $_scenario_name

Returns

\type

toHumanReadable()

toHumanReadable(object  $_input) : string

Parameters

object $_input

Returns

string

fromHumanReadable()

fromHumanReadable(\type  $_input) : \type

Parameters

\type $_input

Returns

\type

searchByUse()

searchByUse(\type  $searchs) : \type

Parameters

\type $searchs

Returns

\type

getTemplate()

getTemplate(\type  $_template = '') : \type

Parameters

\type $_template

Returns

\type

shareOnMarket()

shareOnMarket(  $market) 

Parameters

$market

getFromMarket()

getFromMarket(\type  $market, \type  $_path) 

Parameters

\type $market
\type $_path

Throws

\Exception

removeFromMarket()

removeFromMarket(  $market) 

Parameters

$market

listMarketObject()

listMarketObject() 

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) : string

Parameters

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

Returns

string

hasRight()

hasRight(\type  $_right) : boolean

Parameters

\type $_right

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

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(integer  $id) : $this

Parameters

integer $id

Returns

$this

setName()

setName(\type  $name) : $this

Parameters

\type $name

Returns

$this

setIsActive()

setIsActive(\type  $isActive) : $this

Parameters

\type $isActive

Returns

$this

setGroup()

setGroup(\type  $group) : $this

Parameters

\type $group

Returns

$this

setState()

setState(\type  $state) 

Parameters

\type $state

setLastLaunch()

setLastLaunch(\type  $lastLaunch) 

Parameters

\type $lastLaunch

getType()

getType() : \type

Returns

\type

setType()

setType(\type  $type) : $this

Parameters

\type $type

Returns

$this

getMode()

getMode() : \type

Returns

\type

setMode()

setMode(\type  $mode) : $this

Parameters

\type $mode

Returns

$this

getSchedule()

getSchedule() : \string/object

Returns

\string/object

setSchedule()

setSchedule(\type  $schedule) : $this

Parameters

\type $schedule

Returns

$this

getPID()

getPID() : \type

Returns

\type

setPID()

setPID(\type  $pid = '') 

Parameters

\type $pid

getScenarioElement()

getScenarioElement() : \type

Returns

\type

setScenarioElement()

setScenarioElement(\type  $scenarioElement) : $this

Parameters

\type $scenarioElement

Returns

$this

getTrigger()

getTrigger() : \type

Returns

\type

setTrigger()

setTrigger(\type  $trigger) : $this

Parameters

\type $trigger

Returns

$this

getLog()

getLog() : \type

Returns

\type

setLog()

setLog(\type  $log) 

Parameters

\type $log

getTimeout()

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

Parameters

\type $_default

Returns

\type

setTimeout()

setTimeout(string  $timeout) : $this

Parameters

string $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(\type  $isVisible) : $this

Parameters

\type $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(\type  $description) : $this

Parameters

\type $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