API Documentation
\

\jeeObject

Summary

Methods
Properties
Constants
byId()
byName()
all()
rootObject()
buildTree()
fullData()
searchConfiguration()
deadCmd()
checkSummaryUpdate()
getGlobalSummary()
getGlobalHtmlSummary()
createSummaryToVirtual()
getTableName()
checkTreeConsistency()
preSave()
save()
getChild()
getChilds()
getEqLogic()
getEqLogicBySummary()
getScenario()
preRemove()
remove()
getFather()
parentNumber()
getHumanName()
cleanSummary()
getSummary()
getHtmlSummary()
getLinkData()
getUse()
getImgLink()
toArray()
getId()
getName()
getFather_id()
getIsVisible()
setId()
setName()
setFather_id()
setIsVisible()
getPosition()
setPosition()
getConfiguration()
setConfiguration()
getDisplay()
setDisplay()
getCache()
setCache()
getImage()
setImage()
getChanged()
setChanged()
No public properties found
No constants found
No protected methods found
$id
$name
$father_id
$isVisible
$position
$configuration
$display
$image
$_child
$_changed
$_summaryChanged
N/A
No private methods found
No private properties found
N/A

Properties

$id

$id :

Type

$name

$name :

Type

$father_id

$father_id :

Type

$isVisible

$isVisible :

Type

$position

$position :

Type

$configuration

$configuration :

Type

$display

$display :

Type

$image

$image :

Type

$_child

$_child :

Type

$_changed

$_changed :

Type

$_summaryChanged

$_summaryChanged :

Type

Methods

byId()

byId(  $_id)

Parameters

$_id

byName()

byName(  $_name)

Parameters

$_name

all()

all(  $_onlyVisible = false)

Parameters

$_onlyVisible

rootObject()

rootObject(  $_all = false,   $_onlyVisible = false)

Parameters

$_all
$_onlyVisible

buildTree()

buildTree(  $_object = null,   $_visible = true)

Parameters

$_object
$_visible

fullData()

fullData(  $_restrict = array())

Parameters

$_restrict

searchConfiguration()

searchConfiguration(  $_search)

Parameters

$_search

deadCmd()

deadCmd()

checkSummaryUpdate()

checkSummaryUpdate(  $_cmd_id)

Parameters

$_cmd_id

getGlobalSummary()

getGlobalSummary(  $_key)

Parameters

$_key

getGlobalHtmlSummary()

getGlobalHtmlSummary(  $_version = 'dashboard')

Parameters

$_version

createSummaryToVirtual()

createSummaryToVirtual(  $_key = '')

Parameters

$_key

getTableName()

getTableName()

checkTreeConsistency()

checkTreeConsistency(  $_fathers = array())

Parameters

$_fathers

preSave()

preSave()

save()

save(  $_direct = false)

Parameters

$_direct

getChild()

getChild(  $_visible = true)

Parameters

$_visible

getChilds()

getChilds()

getEqLogic()

getEqLogic(  $_onlyEnable = true,   $_onlyVisible = false,   $_eqType_name = null,   $_logicalId = null,   $_searchOnchild = false)

Parameters

$_onlyEnable
$_onlyVisible
$_eqType_name
$_logicalId
$_searchOnchild

getEqLogicBySummary()

getEqLogicBySummary(  $_summary = '',   $_onlyEnable = true,   $_onlyVisible = false,   $_eqType_name = null,   $_logicalId = null)

Parameters

$_summary
$_onlyEnable
$_onlyVisible
$_eqType_name
$_logicalId

getScenario()

getScenario(  $_onlyEnable = true,   $_onlyVisible = false)

Parameters

$_onlyEnable
$_onlyVisible

preRemove()

preRemove()

remove()

remove()

getFather()

getFather()

parentNumber()

parentNumber()

getHumanName()

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

Parameters

$_tag
$_prettify

cleanSummary()

cleanSummary()

getSummary()

getSummary(  $_key = '',   $_raw = false)

Parameters

$_key
$_raw

getHtmlSummary()

getHtmlSummary(  $_version = 'dashboard')

Parameters

$_version

getLinkData()

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

Parameters

$_data
$_level
$_drill

getUse()

getUse()

getImgLink()

getImgLink()

toArray()

toArray()

getId()

getId()

getName()

getName()

getFather_id()

getFather_id(  $_default = null)

Parameters

$_default

getIsVisible()

getIsVisible(  $_default = null)

Parameters

$_default

setId()

setId(  $_id)

Parameters

$_id

setName()

setName(  $_name)

Parameters

$_name

setFather_id()

setFather_id(  $_father_id = null)

Parameters

$_father_id

setIsVisible()

setIsVisible(  $_isVisible)

Parameters

$_isVisible

getPosition()

getPosition(  $_default = null)

Parameters

$_default

setPosition()

setPosition(  $_position)

Parameters

$_position

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

getCache()

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

Parameters

$_key
$_default

setCache()

setCache(  $_key,   $_value = null)

Parameters

$_key
$_value

getImage()

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

Parameters

$_key
$_default

setImage()

setImage(  $_key,   $_value)

Parameters

$_key
$_value

getChanged()

getChanged()

setChanged()

setChanged(  $_changed)

Parameters

$_changed