API Documentation
\

\scenario

Summary

Methods
Properties
Constants
byId()
byString()
all()
allOrderedByGroupObjectName()
schedule()
listGroup()
byTrigger()
byGenericTrigger()
byElement()
byObjectId()
check()
control()
doIn()
cleanTable()
consystencyCheck()
byObjectNameGroupNameScenarioName()
toHumanReadable()
fromHumanReadable()
searchByUse()
searchByTrigger()
getTemplate()
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()
getRealTriggerValue()
setRealTriggerValue()
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
$_realTriggerValue
$_return
$_tags
$_do
$_changed
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

$order

$order :

Type

$description

$description :

Type

$configuration

$configuration :

Type

$_templateArray

$_templateArray :

Type

$_elements

$_elements :

Type

$_changeState

$_changeState :

Type

$_realTrigger

$_realTrigger :

Type

$_realTriggerValue

$_realTriggerValue :

Type

$_return

$_return :boolean

Type

boolean

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

allOrderedByGroupObjectName()

allOrderedByGroupObjectName(  $_asGroup = false): array<mixed,>

return all scenarios ordered by [group][objectName][scenarioName]

Parameters

$_asGroup

Returns

array<mixed,> —

array of scenario object

schedule()

schedule(): array<mixed,\scenario>

Returns

array<mixed,\scenario>

listGroup()

listGroup(string  $_group = null): array<mixed,\scenario>

Parameters

string $_group

Returns

array<mixed,\scenario>

byTrigger()

byTrigger(string  $_cmd_id,boolean  $_onlyEnable = true): array<mixed,\scenario>

Parameters

string $_cmd_id
boolean $_onlyEnable

Returns

array<mixed,\scenario>

byGenericTrigger()

byGenericTrigger(string  $_generic,object  $_object,boolean  $_onlyEnable = true): array<mixed,\scenario>

Parameters

string $_generic
object $_object
boolean $_onlyEnable

Returns

array<mixed,\scenario>

byElement()

byElement(string  $_element_id): \scenario

Parameters

string $_element_id

Returns

\scenario

byObjectId()

byObjectId(null|integer  $_object_id,boolean  $_onlyEnable = true,boolean  $_onlyVisible = false): array<mixed,\scenario>

Parameters

null|integer $_object_id
boolean $_onlyEnable
boolean $_onlyVisible

Returns

array<mixed,\scenario>

check()

check(null|object|string  $_event = null,boolean  $_forceSyncMode = false,null|string  $_generic = null,null|object  $_object = null,null|string  $_value = null,  $_options = null): void|true

Parameters

null|object|string $_event
boolean $_forceSyncMode
null|string $_generic
null|object $_object
null|string $_value
$_options

Returns

void|true

control()

control()

doIn()

doIn(array  $_options): void

Parameters

array $_options

cleanTable()

cleanTable()

consystencyCheck()

consystencyCheck(  $_needsReturn = false)

Parameters

$_needsReturn

byObjectNameGroupNameScenarioName()

byObjectNameGroupNameScenarioName(string  $_object_name,string  $_group_name,string  $_scenario_name): \scenario

Parameters

string $_object_name
string $_group_name
string $_scenario_name

Returns

\scenario

toHumanReadable()

toHumanReadable(object  $_input): string

Parameters

object $_input

Returns

string

fromHumanReadable()

fromHumanReadable(string|object|array  $_input): string|object|array

Parameters

string|object|array $_input

Returns

string|object|array —

return value will depends on $_input received

searchByUse()

searchByUse(array  $searchs): array

Parameters

array $searchs

Returns

array

searchByTrigger()

searchByTrigger(string  $_search,null|string  $_options = null,boolean  $_and = true): array<mixed,\scenario>

Parameters

string $_search
null|string $_options
boolean $_and

Returns

array<mixed,\scenario>

getTemplate()

getTemplate()

testTrigger()

testTrigger(string  $_event): boolean

Parameters

string $_event

Returns

boolean

launch()

launch(string  $_trigger = '',string  $_message = '',boolean  $_forceSyncMode = false,  $_options = null): boolean

Parameters

string $_trigger
string $_message
boolean $_forceSyncMode
$_options

Returns

boolean

execute()

execute(string  $_trigger = '',string  $_message = '')

Parameters

string $_trigger
string $_message

copy()

copy(string  $_name): \scenario

Parameters

string $_name

Returns

\scenario

toHtml()

toHtml(string  $_version): string

Parameters

string $_version

Returns

string

emptyCacheWidget()

emptyCacheWidget()

getIcon()

getIcon(boolean  $_only_class = false): string

Parameters

boolean $_only_class

Returns

string

getLinkToConfiguration()

getLinkToConfiguration()

preSave()

preSave()

Throws

\Exception

postInsert()

postInsert()

save()

save()

refresh()

refresh()

remove()

remove()

removeData()

removeData(string  $_key,boolean  $_private = false): boolean

Parameters

string $_key
boolean $_private

Returns

boolean

setData()

setData(string  $_key,string  $_value,boolean  $_private = false): true

Parameters

string $_key
string $_value
boolean $_private

Returns

true

getData()

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

Parameters

$_key
$_private
$_default

calculateScheduleDate()

calculateScheduleDate()

isDue()

isDue(): boolean

Returns

boolean

running()

running(): boolean

Returns

boolean

stop()

stop(): boolean

Throws

\Exception

Returns

boolean

getElement()

getElement()

export()

export(string  $_mode = 'text'): string|array

Parameters

string $_mode

accepted value: ['text'|'array']

Returns

string|array —

depending $_mode parameter

getObject()

getObject(): object

Returns

object

getHumanName()

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

Parameters

boolean $_complete
boolean $_noGroup
boolean $_tag
boolean $_prettify
boolean $_withoutScenarioName
$_object_name

Returns

string

hasRight()

hasRight(string  $_right,  $_user = null): boolean

Parameters

string $_right
$_user

Returns

boolean

persistLog()

persistLog(  $_partial = false)

Parameters

$_partial

toArray()

toArray()

getLinkData()

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

Parameters

array $_data
integer $_level
null|integer $_drill

Returns

array

getUse()

getUse()

getUsedBy()

getUsedBy(  $_array = false)

Parameters

$_array

clearLog()

clearLog()

resetRepeatIfStatus()

resetRepeatIfStatus()

getId()

getId(): integer

Returns

integer

getName()

getName(): string

Returns

string

getState()

getState()

getIsActive()

getIsActive(): boolean

Returns

boolean

getGroup()

getGroup()

getLastLaunch()

getLastLaunch()

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(string  $state)

Parameters

string $state

setLastLaunch()

setLastLaunch(string  $lastLaunch)

Parameters

string $lastLaunch

getMode()

getMode()

setMode()

setMode(mixed  $_mode): $this

Parameters

mixed $_mode

Returns

$this

getOrder()

getOrder()

setOrder()

setOrder(mixed  $_order): $this

Parameters

mixed $_order

Returns

$this

getSchedule()

getSchedule(): \string/object

Returns

\string/object

setSchedule()

setSchedule(array|string  $_schedule): $this

Parameters

array|string $_schedule

Returns

$this

getPID()

getPID()

setPID()

setPID(  $pid = '')

Parameters

$pid

getScenarioElement()

getScenarioElement()

setScenarioElement()

setScenarioElement(  $_scenarioElement)

Parameters

$_scenarioElement

getTrigger()

getTrigger()

setTrigger()

setTrigger(  $_trigger)

Parameters

$_trigger

getLog()

getLog(): string

Returns

string

setLog()

setLog(string  $log)

Parameters

string $log

getTimeout()

getTimeout(integer  $_default): integer

Parameters

integer $_default

Returns

integer

setTimeout()

setTimeout(  $_timeout): $this

Parameters

$_timeout

Returns

$this

getObject_id()

getObject_id(  $_default = null)

Parameters

$_default

getIsVisible()

getIsVisible(integer  $_default): integer

Parameters

integer $_default

Returns

integer

setObject_id()

setObject_id(mixed  $object_id = null): $this

Parameters

mixed $object_id

Returns

$this

setIsVisible()

setIsVisible(integer  $_isVisible): $this

Parameters

integer $_isVisible

Returns

$this

getDisplay()

getDisplay(string  $_key = '',string  $_default = ''): mixed

Parameters

string $_key
string $_default

Returns

mixed

setDisplay()

setDisplay(string  $_key,string  $_value): $this

Parameters

string $_key
string $_value

Returns

$this

getDescription()

getDescription(): string

Returns

string

setDescription()

setDescription(  $_description): $this

Parameters

$_description

Returns

$this

getConfiguration()

getConfiguration(string  $_key = '',string  $_default = ''): mixed

Parameters

string $_key
string $_default

Returns

mixed

setConfiguration()

setConfiguration(string  $_key,string  $_value): $this

Parameters

string $_key
string $_value

Returns

$this

getRealTrigger()

getRealTrigger(): string

Returns

string

setRealTrigger()

setRealTrigger(string  $_realTrigger): $this

Parameters

string $_realTrigger

Returns

$this

getRealTriggerValue()

getRealTriggerValue(): string

Returns

string

setRealTriggerValue()

setRealTriggerValue(string  $_realTriggerValue): $this

Parameters

string $_realTriggerValue

Returns

$this

getReturn()

getReturn(): boolean

getReturn

Returns

boolean

setReturn()

setReturn(boolean  $_return): $this

Parameters

boolean $_return

Returns

$this

getTags()

getTags(): array

getTags

Returns

array

setTags()

setTags(array  $_tags): $this

setTags

Parameters

array $_tags

Returns

$this

getDo()

getDo(): boolean

getDo

Returns

boolean

setDo()

setDo(boolean  $_do): $this

Parameters

boolean $_do

Returns

$this

getCache()

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

Parameters

$_key
$_default

setCache()

setCache(string  $_key,mixed  $_value = null)

Parameters

string $_key
mixed $_value

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed