API Documentation
\

\eqLogic

Summary

Methods
Properties
Constants
getAllTags()
byId()
all()
byEqRealId()
byObjectId()
byLogicalId()
byType()
byCategorie()
byTypeAndSearhConfiguration()
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()
import()
export()
widgetPossibility()
toArray()
getImage()
getLinkData()
getUse()
getUsedBy()
deadCmdGeneric()
getId()
getName()
getLogicalId()
getObject_id()
getObject()
setObject()
getEqType_name()
getIsVisible()
getIsEnable()
getCmd()
getCmdByGenericType()
searchCmdByConfiguration()
getEqReal_id()
getEqReal()
setId()
setName()
setLogicalId()
setObject_id()
setEqType_name()
setEqReal_id()
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
$eqReal_id
$isVisible
$isEnable
$configuration
$timeout
$category
$display
$order
$comment
$tags
$_debug
$_object
$_needRefreshWidget
$_timeoutUpdated
$_batteryUpdated
$_changed
N/A
cast()
$_templateArray
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

$eqReal_id

$eqReal_id :

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

$_templateArray

$_templateArray :

Type

Methods

getAllTags()

getAllTags()

byId()

byId(  $_id)

Parameters

$_id

all()

all(  $_onlyEnable = false)

Parameters

$_onlyEnable

byEqRealId()

byEqRealId(  $_eqReal_id)

Parameters

$_eqReal_id

byObjectId()

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

Parameters

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

byLogicalId()

byLogicalId(  $_logicalId,   $_eqType_name,   $_multiple = false)

Parameters

$_logicalId
$_eqType_name
$_multiple

byType()

byType(  $_eqType_name,   $_onlyEnable = false)

Parameters

$_eqType_name
$_onlyEnable

byCategorie()

byCategorie(  $_category)

Parameters

$_category

byTypeAndSearhConfiguration()

byTypeAndSearhConfiguration(  $_eqType_name,   $_configuration)

Parameters

$_eqType_name
$_configuration

searchConfiguration()

searchConfiguration(  $_configuration,   $_type = null)

Parameters

$_configuration
$_type

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)

Parameters

$_string

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

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

getId()

getId()

getName()

getName()

getLogicalId()

getLogicalId()

getObject_id()

getObject_id()

getObject()

getObject()

setObject()

setObject(  $_object)

Parameters

$_object

getEqType_name()

getEqType_name()

getIsVisible()

getIsVisible(  $_default)

Parameters

$_default

getIsEnable()

getIsEnable(  $_default)

Parameters

$_default

getCmd()

getCmd(  $_type = null,   $_logicalId = null,   $_visible = null,   $_multiple = false)

Parameters

$_type
$_logicalId
$_visible
$_multiple

getCmdByGenericType()

getCmdByGenericType(  $_type = null,   $_generic_type = null,   $_visible = null,   $_multiple = false)

Parameters

$_type
$_generic_type
$_visible
$_multiple

searchCmdByConfiguration()

searchCmdByConfiguration(  $_configuration,   $_type = null)

Parameters

$_configuration
$_type

getEqReal_id()

getEqReal_id(  $_default = null)

Parameters

$_default

getEqReal()

getEqReal()

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

setEqReal_id()

setEqReal_id(  $_eqReal_id)

Parameters

$_eqReal_id

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()

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