NextDom\Model\Entity\Cmd

Cmd

ORM\Table(name="cmd", uniqueConstraints={
ORM\UniqueConstraint(name="unique", columns={"eqLogic_id", "name"})}, indexes={
ORM\Index(name="isHistorized", columns={"isHistorized"}),
ORM\Index(name="type", columns={"type"}),
ORM\Index(name="name", columns={"name"}),
ORM\Index(name="subtype", columns={"subType"}),
ORM\Index(name="eqLogic_id", columns={"eqLogic_id"}),
ORM\Index(name="value", columns={"value"}),
ORM\Index(name="order", columns={"order"}),
ORM\Index(name="logicalID", columns={"logicalId"}),
ORM\Index(name="logicalId_eqLogicID", columns={"eqLogic_id", "logicalId"}),
ORM\Index(name="genericType_eqLogicID", columns={"eqLogic_id", "generic_type"})
})
ORM\Entity

Synopsis

class Cmd extends BaseEntity {

• // constants
• const TABLE_NAME = NextDomObj::CMD;
• // Inherited constants from BaseEntity
• const TABLE_NAME = '';
• // Inherited constants from BaseModel
• const TABLE_NAME = '';
• // members
• private static array $_templateArray = ;
• public string $_collectDate = '';
• public string $_valueDate = '';
• public  $_eqLogic = NULL;
• public  $_needRefreshWidget;
• public  $_needRefreshAlert;
• protected  $eqType;
• protected  $generic_type;
• protected  $template;
• protected integer $isHistorized = 0;
• protected  $subType;
• protected  $unite;
• protected  $value = NULL;
• protected  $html;
• protected  $alert;
• protected EqLogic $eqLogic_id;
• // Inherited members from BaseEntity
• protected  $id;
• // Inherited members from BaseModel
• protected bool $_changed;
• // methods
• public static void duringAlertLevel()
• public bool isType()
• public EqLogic getEqLogic()
• public $this setEqLogic()
• public mixed execCmd()
• public array|bool|mixed|null|string getCache()
• public string getCollectDate()
• public $this setCollectDate()
• public string getHumanName()
• public $this setName()
• public bool isSubType()
• public $this setConfiguration()
• public void preExecCmd()
• public float|mixed|string formatValue()
• public bool execute()
• public void postExecCmd()
• public string getValue()
• public $this setValue()
• public bool save()
• public mixed getEqLogic_Id()
• public EqLogic|null getEqLogicId()
• public $this setEqLogic_id()
• public $this setEqLogicId()
• public string getEqType()
• public $this setEqType()
• public $this setDisplay()
• public string getGeneric_type()
• public $this setGeneric_type()
• public bool isHistorized()
• public string getIsHistorized()
• public $this setIsHistorized()
• public int|string checkAlertLevel()
• public array|bool|mixed|null|string getAlert()
• public $this setAlert()
• public void actionAlertLevel()
• public $this setCache()
• public string getUnite()
• public $this setUnite()
• public void event()
• public string getValueDate()
• public $this setValueDate()
• public void addHistoryValue()
• public void checkReturnState()
• public void checkCmdAlert()
• public void executeAlertCmdAction()
• public void pushUrl()
• public void influxDb()
• public string getEqType_name()
• public $this setOrder()
• public $this setIsVisible()
• public array|bool|mixed|null|string getHtml()
• public $this setHtml()
• public array|bool|mixed|null|string getWidgetTemplateCode()
• public array|bool|mixed|null|string getTemplate()
• public $this setTemplate()
• public int getEventOnly()
• public void setEventOnly()
• public bool dontRemoveCmd()
• public bool remove()
• public array|mixed|null emptyHistory()
• public mixed|string toHtml()
• public Cmd|bool getCmdValue()
• private void addDataForInfoCmdRender()
• public array getStatistique()
• public float|int getTendance()
• private void addDataForOthersCmdRender()
• public array|bool|mixed|null|string getLastValue()
• public string generateAskResponseLink()
• public bool askResponse()
• public array|float|int|null getTemporalAvg()
• public array getHistory()
• public array|mixed|null getPluralityHistory()
• public array|bool|mixed widgetPossibility()
• public array export()
• public string getDirectUrlAccess()
• public bool checkAccessCode()
• public array exportApi()
• public array|null getLinkData()
• public array getUsedBy()
• public array getUse()
• public bool hasRight()
• public $this castFromCmd()
• public void getSubType()
• public void setSubType()
• 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 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 TypeEntity
• public abstract void updateChangeState()
• public string getType()
• public $this setType()
• public void isType()
• // Inherited methods from NameEntity
• public abstract void updateChangeState()
• public string getName()
• public $this setName()
• public $this basicSetName()
• // 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\LogicalIdEntity
• NextDom\Model\Entity\Parents\IsVisibleEntity
• NextDom\Model\Entity\Parents\OrderEntity
• NextDom\Model\Entity\Parents\RefreshEntity
• NextDom\Model\Entity\Parents\TypeEntity
• NextDom\Model\Entity\Parents\NameEntity
• NextDom\Model\Entity\Parents\ConfigurationEntity
• NextDom\Model\Entity\Parents\DisplayEntity

Constants

Name	Value
TABLE_NAME	NextDomObj::CMD
TABLE_NAME	''
TABLE_NAME	''

Members

private

• $_templateArray

protected

• $_changed — NextDom\Model\Entity\Parents\bool
• $alert — string
• $configuration — string
• $display — string
• $eqLogic_id — NextDom\Model\Entity\EqLogic
• $eqType — string
• $generic_type — string
• $html — string
• $id — integer
• $isHistorized — string
• $isVisible — boolean
• $logicalId — string
• $name — string
• $order — integer
• $subType — string
• $template — string
• $type — string
• $unite — string
• $value — string

public

• $_collectDate
• $_eqLogic
• $_needRefreshAlert
• $_needRefreshWidget
• $_valueDate

Methods

private

• addDataForInfoCmdRender()
• addDataForOthersCmdRender()

public

• actionAlertLevel()
• addHistoryValue()
• askResponse()
• castFromCmd() — Cast this object from a source command
• checkAccessCode()
• checkAlertLevel()
• checkCmdAlert()
• checkReturnState()
• dontRemoveCmd()
• duringAlertLevel()
• emptyHistory()
• event()
• execCmd()
• execute() — Execute command overrided by plugins
• executeAlertCmdAction()
• export()
• exportApi()
• formatValue()
• generateAskResponseLink()
• getAlert()
• getAllAttributes() — Get all attributes of the Cmd class
• getCache()
• getCmdValue()
• getCollectDate()
• getDirectUrlAccess()
• getEqLogic()
• getEqLogicId()
• getEqLogic_Id()
• getEqType()
• getEqType_name()
• getEventOnly()
• getGeneric_type()
• getHistory()
• getHtml()
• getHumanName()
• getIsHistorized()
• getLastValue()
• getLinkData()
• getPluralityHistory()
• getStatistique()
• getSubType()
• getTemplate()
• getTemporalAvg()
• getTendance()
• getUnite()
• getUse()
• getUsedBy()
• getValue()
• getValueDate()
• getWidgetTemplateCode() — TODO: Déplacer dans CmdManager ???
• hasRight() — Check if user have right to execute the action.
• influxDb()
• isHistorized() — Get historic command status
• isSubType() — Test sub type of the command
• isType() — Test type of the command
• postExecCmd() — Executed after execution
• preExecCmd() — Execute before command execution
• pushUrl()
• remove()
• save()
• setAlert()
• setCache()
• setCollectDate()
• setConfiguration() — Save configuration
• setDisplay()
• setEqLogic()
• setEqLogicId()
• setEqLogic_id()
• setEqType()
• setEventOnly()
• setGeneric_type()
• setHtml()
• setIsHistorized()
• setIsVisible()
• setName()
• setOrder()
• setSubType()
• setTemplate()
• setUnite()
• setValue()
• setValueDate()
• toHtml()
• widgetPossibility()

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\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\TypeEntity

public

• getType()
• isType()
• setType()
• updateChangeState()

Inherited from NextDom\Model\Entity\Parents\NameEntity

public

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

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