Dms_State_Value_Bot_Unregister
extends Bot_Controller
in package
Dms_State_Value_Bot_Unregister
Tags
Table of Contents
- $_color : string
- Bot module color
- $_fields : array<string|int, mixed>
- Bot module fields
- $_oBot_Module : Bot_Module_Model
- Bot module object
- $_oObject : _Model
- Entity object
- available() : mixed
- Check available
- execute() : mixed
- Execute business logic
- getBotModules() : array<string|int, mixed>
- Get bot modules
- getBotTab() : object
- Get bot tab
- getColor() : string
- Get bot module color
- getFields() : array<string|int, mixed>
- Get bot module fields
- notify() : self
- Notify bot
- setBotModule() : self
- Set bot module
- setObject() : self
- Set object
Properties
$_color
Bot module color
protected
string
$_color
= '#2dc3e8'
$_fields
Bot module fields
protected
array<string|int, mixed>
$_fields
= array()
$_oBot_Module
Bot module object
protected
Bot_Module_Model
$_oBot_Module
= \NULL
$_oObject
Entity object
protected
_Model
$_oObject
= \NULL
Methods
available()
Check available
public
available() : mixed
Return values
mixed —execute()
Execute business logic
public
execute() : mixed
Return values
mixed —getBotModules()
Get bot modules
public
static getBotModules(int $module_id, int $type, int $entity_id) : array<string|int, mixed>
Parameters
- $module_id : int
-
module id
- $type : int
-
entity type
- $entity_id : int
-
entity id
Return values
array<string|int, mixed> —getBotTab()
Get bot tab
public
static getBotTab(mixed $oModule, int $entity_id, int $type) : object
Parameters
- $oModule : mixed
- $entity_id : int
-
entity id
- $type : int
-
entity type
Return values
object —getColor()
Get bot module color
public
getColor() : string
Return values
string —getFields()
Get bot module fields
public
getFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —notify()
Notify bot
public
static notify(int $module_id, int $type, int $entity_id, object $object) : self
Parameters
- $module_id : int
-
module id
- $type : int
-
entity type
- $entity_id : int
-
entity id
- $object : object
-
object
Return values
self —setBotModule()
Set bot module
public
setBotModule(string $oBot_Module) : self
Parameters
- $oBot_Module : string
-
Bot_Module_Model
Return values
self —setObject()
Set object
public
setObject(string $oObject) : self
Parameters
- $oObject : string
-
_Model