NextDom\Model\Entity\EqLogic

Eqlogic

ORM\Table(name="eqLogic", uniqueConstraints={
ORM\UniqueConstraint(name="unique", columns={"name", "object_id"})}, indexes={
ORM\Index(name="eqTypeName", columns={"eqType_name"}),
ORM\Index(name="name", columns={"name"}), @ORM\Index(name="logical_id", columns={"logicalId"}),
ORM\Index(name="generic_type", columns={"generic_type"}),
ORM\Index(name="logica_id_eqTypeName", columns={"logicalId", "eqType_name"}),
ORM\Index(name="object_id", columns={"object_id"}),
ORM\Index(name="timeout", columns={"timeout"}),
ORM\Index(name="tags", columns={"tags"})
})
ORM\Entity

Synopsis

class EqLogic extends BaseEntity {

• // constants
• const CLASS_NAME = EqLogic::class;
• const DB_CLASS_NAME = '`eqLogic`';
• const TABLE_NAME = NextDomObj::EQLOGIC;
• const UIDDELIMITER = '__';
• // Inherited constants from BaseEntity
• const TABLE_NAME = '';
• // Inherited constants from BaseModel
• const TABLE_NAME = '';
• // members
• private static array $_templateArray = ;
• protected boolean $_debug = false;
• protected  $_object = NULL;
• protected boolean $_needRefreshWidget = false;
• protected boolean $_timeoutUpdated = false;
• protected boolean $_batteryUpdated = false;
• protected  $generic_type;
• protected  $eqType_name;
• protected  $isEnable;
• protected  $timeout;
• protected  $category;
• protected  $comment;
• protected  $tags;
• protected  $object_id;
• private array $_cmds = ;
• // Inherited members from BaseEntity
• protected  $id;
• // Inherited members from BaseModel
• protected bool $_changed;
• // methods
• public void __construct()
• public int getIsVisible()
• public $this setIsVisible()
• public int getOrder()
• public string getComment()
• public $this setComment()
• public mixed getCache()
• public void setCache()
• public string batteryWidget()
• public $this setConfiguration()
• public string getEqType_name()
• public $this setEqType_name()
• public JeeObject|null getObject()
• public $this setObject()
• public mixed getStatus()
• public $this setName()
• public string getLinkToConfiguration()
• public bool checkAndUpdateCmd()
• public bool isEnabled()
• public int getIsEnable()
• public $this setIsEnable()
• public array getCmd()
• public EqLogic copy()
• public $this save()
• public void emptyCacheWidget()
• public mixed getDisplay()
• public $this setDisplay()
• public void refreshWidget()
• public void batteryStatus()
• public string getHumanName()
• public void setStatus()
• public int|null getTimeout()
• public $this setTimeout()
• public bool hasOnlyEventOnlyCmd()
• public array|mixed toHtml()
• public array|string preToHtml()
• public bool hasRight()
• public mixed getTags()
• public $this setTags()
• public string getPrimaryCategory()
• public mixed getCategory()
• public $this setCategory()
• public mixed widgetPossibility()
• public string getGenericType()
• public $this setGenericType()
• public string getBackgroundColor()
• public mixed getAlert()
• public string postToHtml()
• public mixed getMaxCmdAlert()
• public bool getShowOnChild()
• public bool remove()
• public void displayDebug()
• public bool getDebug()
• public void setDebug()
• public void import()
• public array export()
• public array getCmdByGenericType()
• public mixed searchCmdByConfiguration()
• public array getLinkData()
• public string getImage()
• public array getUse()
• public array getUsedBy()
• public int getObject_id()
• public $this setObject_id()
• public array toArray()
• public $this castFromEqLogic()
• public array getAllAttributes()
• // Inherited methods from BaseEntity
• public int getId()
• public $this setId()
• // Inherited methods from BaseModel
• public bool getChanged()
• public $this setChanged()
• public void updateChangeState()
• public string getTableName()
• public void save()
• public void remove()
• // Inherited methods from NameEntity
• public abstract void updateChangeState()
• public string getName()
• public $this setName()
• // Inherited methods from LogicalIdEntity
• public abstract void updateChangeState()
• public string getLogicalId()
• public $this setLogicalId()
• // Inherited methods from IsVisibleEntity
• public abstract void updateChangeState()
• public mixed getIsVisible()
• public void isVisible()
• public $this setIsVisible()
• // Inherited methods from OrderEntity
• public abstract void updateChangeState()
• public int getOrder()
• public $this setOrder()
• // Inherited methods from RefreshEntity
• public void refresh()
• // Inherited methods from ConfigurationEntity
• public abstract void updateChangeState()
• public array|bool|mixed|null|string getConfiguration()
• public $this setConfiguration()
• public $this basicSetConfiguration()
• // Inherited methods from DisplayEntity
• public abstract void updateChangeState()
• public mixed getDisplay()
• public $this setDisplay()
• public $this basicSetDisplay()
}


Hierarchy

Extends

• NextDom\Model\Entity\Parents\BaseEntity

Uses

• NextDom\Model\Entity\Parents\NameEntity
• NextDom\Model\Entity\Parents\LogicalIdEntity
• NextDom\Model\Entity\Parents\IsVisibleEntity
• NextDom\Model\Entity\Parents\OrderEntity
• NextDom\Model\Entity\Parents\RefreshEntity
• NextDom\Model\Entity\Parents\ConfigurationEntity
• NextDom\Model\Entity\Parents\DisplayEntity

Tasks

Line	Task
1458+	: ???

Constants

Name	Value
CLASS_NAME	EqLogic::class
DB_CLASS_NAME	'`eqLogic`'
TABLE_NAME	NextDomObj::EQLOGIC
UIDDELIMITER	'__'
TABLE_NAME	''
TABLE_NAME	''

Members

private

• $_cmds
• $_templateArray

protected

• $_batteryUpdated
• $_changed — NextDom\Model\Entity\Parents\bool
• $_debug
• $_needRefreshWidget
• $_object
• $_timeoutUpdated
• $category — string
• $comment — string
• $configuration — string
• $display — string
• $eqType_name — string
• $generic_type — string
• $id — integer
• $isEnable — int
• $isVisible — boolean
• $logicalId — string
• $name — string
• $object_id — integer
• $order — integer
• $tags — string
• $timeout — integer

Methods

public

• __construct()
• batteryStatus() — Update battery status
• batteryWidget() — Get HTML code for battery widget
• castFromEqLogic() — Cast from a raw eqLogic
• checkAndUpdateCmd() — Check and update a command information
• copy() — Get copy of this eqLogic
• displayDebug() — Show debug message if in debug mode
• emptyCacheWidget() — Remove widget render in cache
• export() — Export eqLogic data in plain text array
• getAlert() — Get alert if presents
• getAllAttributes() — Get all attributes of the object (used for cast)
• getBackgroundColor() — Get widget background color
• getCache() — Get data in cache linked to the eqLogic
• getCategory() — Test if the object belongs to a category
• getCmd() — Get one or more commands of the object
• getCmdByGenericType() — Get command of the eqLogic by generic type
• getComment() — Get the comment attached to the eqLogic
• getDebug() — Get debug state
• getDisplay() — Get display parameters
• getEqType_name() — Get eqLogic type name (linked plugin)
• getGenericType() — Get generic type for simple eqLogic
• getHumanName() — Get HTML code for battery widget
• getImage() — Get linked image
• getIsEnable() — Get eqLogic enabled state
• getIsVisible() — Get visibility of the eqLogic 1 for visible, 0 for hidden
• getLinkData() — Get link data for graph representation
• getLinkToConfiguration() — Get configuration URL
• getMaxCmdAlert() — Get max command alter for this eqLogic
• getObject() — Get attached object
• getObject_id() — Get id of the attached object
• getOrder() — Get order used in eqLogic list
• getPrimaryCategory() — Get primary category
• getShowOnChild()
• getStatus() — Get status from cache
• getTags() — Get list of eqLogic tags
• getTimeout() — Get eqLogic timeout
• getUse() — Get list of usage in string (@TODO: ???)
• getUsedBy() — Get list of this eqLogic usage
• hasOnlyEventOnlyCmd()
• hasRight() — Test if user have right
• import() — Import eqLogic from a plain text array
• isEnabled() — Get eqLogic enable status
• postToHtml() — Store HTML view in cache
• preToHtml() — Prepare data for HTML view
• refreshWidget() — Refresh widget if change occurs since la render
• remove() — Remove from database
• save() — Save in database
• searchCmdByConfiguration() — Search cmd with a specific configuration
• setCache() — Store data in cache
• setCategory() — Define if the object belongs to a category
• setComment() — Set the comment attached to the eqLogic
• setConfiguration() — Set object specific configuration data
• setDebug() — Set debug state
• setDisplay() — Set a display parameters
• setEqType_name() — Set eqLogic type name (linked plugin)
• setGenericType() — Set generic type for simple EqLogic
• setIsEnable() — Set if the eqLogic is enabled
• setIsVisible() — Set the visibility of the eqLogic
• setName() — Set eqLogic name
• setObject() — Set attached object
• setObject_id() — Set attached room id
• setStatus()
• setTags() — Define list of eqLogics tags
• setTimeout() — Get eqLogic timeout
• toArray() — Get object data in array
• toHtml() — Get HTML code depends of the view
• widgetPossibility() — Get widget specific possibility

Inherited from NextDom\Model\Entity\Parents\BaseEntity

public

• getId()
• setId()

Inherited from NextDom\Model\Entity\Parents\BaseModel

public

• getChanged() — Get changed state
• getTableName()
• remove() — Remove the entity from the database
• save() — Save the entity in the database
• setChanged() — Set changed state
• updateChangeState() — Update change state if values are different

Inherited from NextDom\Model\Entity\Parents\NameEntity

public

• getName()
• setName()
• updateChangeState()

Inherited from NextDom\Model\Entity\Parents\LogicalIdEntity

public

• getLogicalId()
• setLogicalId()
• updateChangeState()

Inherited from NextDom\Model\Entity\Parents\IsVisibleEntity

public

• getIsVisible()
• isVisible()
• setIsVisible()
• updateChangeState()

Inherited from NextDom\Model\Entity\Parents\OrderEntity

public

• getOrder()
• setOrder()
• updateChangeState()

Inherited from NextDom\Model\Entity\Parents\RefreshEntity

public

• refresh() — Rafraichit les informations à partir de la base de données

Inherited from NextDom\Model\Entity\Parents\ConfigurationEntity

public

• basicSetConfiguration()
• getConfiguration()
• setConfiguration()
• updateChangeState()

Inherited from NextDom\Model\Entity\Parents\DisplayEntity

public

• basicSetDisplay() — Set display information by key
• getDisplay() — Get display information by key
• setDisplay() — Set display information by key
• updateChangeState()