\eqLogic

Summary

Methods

Properties

Constants

getAllTags()
byId()
all()
byObjectId()
byLogicalId()
byType()
byCategorie()
byTypeAndSearchConfiguration()
byTypeAndSearhConfiguration()
searchByString()
searchConfiguration()
listByTypeAndCmdType()
listByObjectAndCmdType()
allType()
checkAlive()
byTimeout()
byObjectNameEqLogicName()
toHumanReadable()
fromHumanReadable()
byString()
clearCacheWidget()
generateHtmlTable()
batteryWidget()
checkAndUpdateCmd()
copy()
getTableName()
hasOnlyEventOnlyCmd()
preToHtml()
toHtml()
postToHtml()
emptyCacheWidget()
getAlert()
getMaxCmdAlert()
getShowOnChild()
remove()
save()
refresh()
getLinkToConfiguration()
getHumanName()
getPrimaryCategory()
displayDebug()
batteryStatus()
refreshWidget()
hasRight()
migrateEqlogic()
import()
export()
widgetPossibility()
toArray()
getImage()
getLinkData()
getUse()
getUsedBy()
deadCmdGeneric()
getUsage()
getId()
getName()
getLogicalId()
getObject_id()
getObject()
setObject()
getEqType_name()
getIsVisible()
getIsEnable()
getCmd()
getCmdByGenericType()
searchCmdByConfiguration()
setId()
setName()
setLogicalId()
setObject_id()
setEqType_name()
setIsVisible()
setIsEnable()
getConfiguration()
setConfiguration()
getDisplay()
setDisplay()
getTimeout()
setTimeout()
getCategory()
setCategory()
getGenericType()
setGenericType()
getComment()
setComment()
getTags()
setTags()
getDebug()
setDebug()
getOrder()
setOrder()
getCache()
setCache()
getStatus()
setStatus()
getChanged()
setChanged()

No public properties found

UIDDELIMITER

No protected methods found

$id
$name
$logicalId
$generic_type
$object_id
$eqType_name
$isVisible
$isEnable
$configuration
$timeout
$category
$display
$order
$comment
$tags
$_debug
$_object
$_needRefreshWidget
$_timeoutUpdated
$_batteryUpdated
$_changed
$_cmds
$_templateArray

N/A

cast()

No private properties found

N/A

Constants

UIDDELIMITER

UIDDELIMITER ='__'

Properties

$id

$id :

Type

$name

$name :

Type

$logicalId

$logicalId :

Type

$generic_type

$generic_type :

Type

$object_id

$object_id :

Type

$eqType_name

$eqType_name :

Type

$isVisible

$isVisible :

Type

$isEnable

$isEnable :

Type

$configuration

$configuration :

Type

$timeout

$timeout :

Type

$category

$category :

Type

$display

$display :

Type

$order

$order :

Type

$comment

$comment :

Type

$tags

$tags :

Type

$_debug

$_debug :

Type

$_object

$_object :

Type

$_needRefreshWidget

$_needRefreshWidget :

Type

$_timeoutUpdated

$_timeoutUpdated :

Type

$_batteryUpdated

$_batteryUpdated :

Type

$_changed

$_changed :

Type

$_cmds

$_cmds :

Type

$_templateArray

$_templateArray :

Type

Methods

getAllTags()

getAllTags()

byId()

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

Parameters

integer|string

$_id

Returns

void|\eqLogic —

void if $_id is not valid else the eqLogic

all()

all(  $_onlyEnable = false)

Parameters

$_onlyEnable

byObjectId()

byObjectId(  $_object_id,  $_onlyEnable = true,  $_onlyVisible = false,  $_eqType_name = null,  $_logicalId = null,  $_orderByName = false,  $_onlyHasCmds = false)

Parameters

	$_object_id
	$_onlyEnable
	$_onlyVisible
	$_eqType_name
	$_logicalId
	$_orderByName
	$_onlyHasCmds

byLogicalId()

byLogicalId(string  $_logicalId,string  $_eqType_name,boolean  $_multiple = false): \eqLogic|array<mixed,\eqLogic>

Parameters

string	$_logicalId
string	$_eqType_name	the plugin class name
boolean	$_multiple	default value=false

Returns

\eqLogic|array<mixed,\eqLogic> —

eqLogic if $_multiple is false else eqLogic[]

byType()

byType(string  $_eqType_name,boolean  $_onlyEnable = false): array<mixed,\eqLogic>

Parameters

string	$_eqType_name	the plugin class name
boolean	$_onlyEnable

Returns

array<mixed,\eqLogic>

byCategorie()

byCategorie(  $_category)

Parameters

$_category

byTypeAndSearchConfiguration()

byTypeAndSearchConfiguration(  $_eqType_name,  $_configuration)

Parameters

	$_eqType_name
	$_configuration

byTypeAndSearhConfiguration()

byTypeAndSearhConfiguration(  $_eqType_name,  $_configuration)

Parameters

	$_eqType_name
	$_configuration

searchByString()

searchByString(  $_search)

Parameters

$_search

searchConfiguration()

searchConfiguration(  $_configuration,  $_eqType_name = null)

Parameters

	$_configuration
	$_eqType_name

listByTypeAndCmdType()

listByTypeAndCmdType(  $_eqType_name,  $_typeCmd,  $subTypeCmd = '')

Parameters

	$_eqType_name
	$_typeCmd
	$subTypeCmd

listByObjectAndCmdType()

listByObjectAndCmdType(  $_object_id,  $_typeCmd,  $subTypeCmd = '')

Parameters

	$_object_id
	$_typeCmd
	$subTypeCmd

allType()

allType()

checkAlive()

checkAlive()

byTimeout()

byTimeout(  $_timeout,  $_onlyEnable = false)

Parameters

	$_timeout
	$_onlyEnable

byObjectNameEqLogicName()

byObjectNameEqLogicName(  $_object_name,  $_eqLogic_name)

Parameters

	$_object_name
	$_eqLogic_name

toHumanReadable()

toHumanReadable(  $_input)

Parameters

$_input

fromHumanReadable()

fromHumanReadable(  $_input)

Parameters

$_input

byString()

byString(string  $_string): \eqLogic

byString

Parameters

string

$_string

Returns

\eqLogic

clearCacheWidget()

clearCacheWidget()

generateHtmlTable()

generateHtmlTable(  $_nbLine,  $_nbColumn,  $_options = array())

Parameters

	$_nbLine
	$_nbColumn
	$_options

batteryWidget()

batteryWidget(  $_version = 'dashboard')

Parameters

$_version

checkAndUpdateCmd()

checkAndUpdateCmd(  $_logicalId,  $_value,  $_updateTime = null)

Parameters

	$_logicalId
	$_value
	$_updateTime

copy()

copy(  $_name)

Parameters

$_name

getTableName()

getTableName()

hasOnlyEventOnlyCmd()

hasOnlyEventOnlyCmd()

preToHtml()

preToHtml(  $_version = 'dashboard',  $_default = array(),  $_noCache = false)

Parameters

	$_version
	$_default
	$_noCache

toHtml()

toHtml(  $_version = 'dashboard')

Parameters

$_version

postToHtml()

postToHtml(  $_version,  $_html)

Parameters

	$_version
	$_html

emptyCacheWidget()

emptyCacheWidget()

getAlert()

getAlert()

getMaxCmdAlert()

getMaxCmdAlert()

getShowOnChild()

getShowOnChild()

remove()

remove()

save()

save(  $_direct = false)

Parameters

$_direct

refresh()

refresh()

getLinkToConfiguration()

getLinkToConfiguration()

getHumanName()

getHumanName(  $_tag = false,  $_prettify = false)

Parameters

	$_tag
	$_prettify

getPrimaryCategory()

getPrimaryCategory()

displayDebug()

displayDebug(  $_message)

Parameters

$_message

batteryStatus()

batteryStatus(  $_pourcent = '',  $_datetime = '')

Parameters

	$_pourcent
	$_datetime

refreshWidget()

refreshWidget()

hasRight()

hasRight(  $_right,  $_user = null)

Parameters

	$_right
	$_user

migrateEqlogic()

migrateEqlogic(  $_sourceId,  $_targetId,  $_mode = 'replace')

Parameters

	$_sourceId
	$_targetId
	$_mode

import()

import(  $_configuration,  $_dontRemove = false)

Parameters

	$_configuration
	$_dontRemove

export()

export(  $_withCmd = true)

Parameters

$_withCmd

widgetPossibility()

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

Parameters

	$_key
	$_default

toArray()

toArray()

getImage()

getImage()

getLinkData()

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

Parameters

	$_data
	$_level
	$_drill

getUse()

getUse()

getUsedBy()

getUsedBy(  $_array = false)

Parameters

$_array

deadCmdGeneric()

deadCmdGeneric(  $_plugin_id)

Parameters

$_plugin_id

getUsage()

getUsage()

getId()

getId(): integer

Returns

integer

getName()

getName(): string

Returns

string

getLogicalId()

getLogicalId(): string

Returns

string

getObject_id()

getObject_id(): integer

Returns

integer

getObject()

getObject(): \jeeObject

Returns

\jeeObject

setObject()

setObject(\jeeObject  $_object): $this

Parameters

\jeeObject

$_object

Returns

$this

getEqType_name()

getEqType_name(): string

Returns

string

getIsVisible()

getIsVisible(integer  $_default): integer

Parameters

integer

$_default

Returns

integer

getIsEnable()

getIsEnable(integer  $_default): integer

Parameters

integer

$_default

Returns

integer

getCmd()

getCmd(string  $_type = null,string  $_logicalId = null,boolean  $_visible = null,boolean  $_multiple = false): \cmd|array<mixed,\cmd>

get one or multiple cmd of the eqLogic

Parameters

string	$_type	['action'\|'info']
string	$_logicalId
boolean	$_visible
boolean	$_multiple

Returns

\cmd|array<mixed,\cmd>

getCmdByGenericType()

getCmdByGenericType(string  $_type = null,string  $_generic_type = null,boolean  $_visible = null,boolean  $_multiple = false): \cmd|array<mixed,\cmd>

get one or multiple cmd of the eqLogic

Parameters

string	$_type	['action'\|'info']
string	$_generic_type
boolean	$_visible
boolean	$_multiple

Returns

\cmd|array<mixed,\cmd>

searchCmdByConfiguration()

searchCmdByConfiguration(string  $_configuration,string  $_type = null): array<mixed,\cmd>

Parameters

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

Returns

array<mixed,\cmd>

setId()

setId(  $_id)

Parameters

$_id

setName()

setName(  $_name)

Parameters

$_name

setLogicalId()

setLogicalId(  $_logicalId)

Parameters

$_logicalId

setObject_id()

setObject_id(  $object_id = null)

Parameters

$object_id

setEqType_name()

setEqType_name(  $eqType_name)

Parameters

$eqType_name

setIsVisible()

setIsVisible(  $_isVisible)

Parameters

$_isVisible

setIsEnable()

setIsEnable(  $_isEnable)

Parameters

$_isEnable

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

getTimeout()

getTimeout(  $_default = null)

Parameters

$_default

setTimeout()

setTimeout(  $_timeout)

Parameters

$_timeout

getCategory()

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

Parameters

	$_key
	$_default

setCategory()

setCategory(  $_key,  $_value)

Parameters

	$_key
	$_value

getGenericType()

getGenericType()

setGenericType()

setGenericType(  $_generic_type)

Parameters

$_generic_type

getComment()

getComment()

setComment()

setComment(  $_comment)

Parameters

$_comment

getTags()

getTags()

setTags()

setTags(  $_tags)

Parameters

$_tags

getDebug()

getDebug()

setDebug()

setDebug(  $_debug)

Parameters

$_debug

getOrder()

getOrder(): integer

Returns

integer

setOrder()

setOrder(  $_order)

Parameters

$_order

getCache()

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

Parameters

	$_key
	$_default

setCache()

setCache(  $_key,  $_value = null)

Parameters

	$_key
	$_value

getStatus()

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

Parameters

	$_key
	$_default

setStatus()

setStatus(  $_key,  $_value = null)

Parameters

	$_key
	$_value

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed

cast()

cast(  $_inputs)

Parameters

$_inputs