Class lispa\amos\chat\AmosChat

All Classes | Properties | Methods | Events

Inheritance	lispa\amos\chat\AmosChat » lispa\amos\core\module\AmosModule » lispa\amos\core\module\BaseAmosModule » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object
Implements	lispa\amos\core\module\ModuleInterface, yii\base\BootstrapInterface, yii\base\Configurable

Class AmosChat

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$CONFIG_FOLDER	string	Module config folder	lispa\amos\chat\AmosChat
$aliases	array	List of path aliases to be defined.	yii\base\Module
$amosUniqueId	string		lispa\amos\core\module\BaseAmosModule
$assistanceUserId	integer	- User Id of the assistance user to open a conversation on click on WidgetIconChatAssistance	lispa\amos\chat\AmosChat
$basePath	string	The root directory of the module.	yii\base\Module
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$components	array	The list of the component definitions or the loaded component instances (ID => definition or instance).	yii\di\ServiceLocator
$controllerConsoleNamespace	string	Console namespace	lispa\amos\chat\AmosChat
$controllerMap	array	Mapping from controller ID to controller configurations.	yii\base\Module
$controllerNamespace	string	Default controller namespace	lispa\amos\chat\AmosChat
$controllerPath	string	The directory that contains the controller classes.	yii\base\Module
$db	yii\db\Connection\|array\|string	The DB connection object or the application component ID of the DB connection.	lispa\amos\chat\AmosChat
$defaultEmailSender	string	Default e-mail sender if the server allow only sender with the same domain	lispa\amos\chat\AmosChat
$defaultListViews	array	This set the default views in lists	lispa\amos\core\module\AmosModule
$defaultRoute	string	The default route of this module.	yii\base\Module
$emailMessageContentAllowedTag	string		lispa\amos\chat\AmosChat
$enableForwardMessage	boolean	Used to enable the forwarding of messages.	lispa\amos\chat\AmosChat
$enableVideoconference	boolean		lispa\amos\chat\AmosChat
$formRedactorButtons	array	List of all Redactor visible buttons in message form	lispa\amos\chat\AmosChat
$i18nDirPath	string		lispa\amos\core\module\AmosModule
$id	string	An ID that uniquely identifies this module among other modules which have the same parent.	yii\base\Module
$immediateNotificationForce	boolean	Force notification sending to the message receiver	lispa\amos\chat\AmosChat
$layout	string\|boolean	The layout that should be applied for views within this module.	lispa\amos\chat\AmosChat
$layoutPath	string	The root directory of layout files.	yii\base\Module
$modelMap	array		lispa\amos\core\module\AmosModule
$module	yii\base\Module	The parent module of this module.	yii\base\Module
$modules	array	The modules (indexed by their IDs).	yii\base\Module
$name	string	Module name	lispa\amos\chat\AmosChat
$onlyNetworkUsers	boolean		lispa\amos\chat\AmosChat
$params	array	Custom module parameters (name => value).	yii\base\Module
$rbacEnabled	boolean		lispa\amos\core\module\BaseAmosModule
$subjectOfimmediateNotification	string	Default subject for emails of "immediate notification force".	lispa\amos\chat\AmosChat
$uniqueId	string	The unique ID of the module.	yii\base\Module
$userIdForwardMessage	\lispa\amos\chat\(array)	Integer $userIdForwardMessage It's required to enable the function of forwarding message, it contain the list of user to which forward the messages	lispa\amos\chat\AmosChat
$version	string	The version of this module.	yii\base\Module
$viewPath	string	The root directory of view files.	yii\base\Module
$widgetGraphics			lispa\amos\chat\AmosChat
$widgetIcons			lispa\amos\chat\AmosChat

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Module
__get()	Getter magic method.	yii\di\ServiceLocator
__isset()	Checks if a property value is null.	yii\di\ServiceLocator
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
afterAction()	This method is invoked right after an action within this module is executed.	yii\base\Module
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeAction()	This method is invoked right before an action within this module is executed.	yii\base\Module
beginCreateNewSessionKey()	This method return the session key that must be used to add in session the url from the user have started the content creation.	lispa\amos\core\module\AmosModule
beginCreateNewSessionKeyDateTime()	This method return the session key that must be used to add in session the url date and time creation from the user have started the content creation.	lispa\amos\core\module\AmosModule
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
bootstrap()	Bootstrap method to be called during application bootstrap stage.	lispa\amos\chat\AmosChat
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\Object
clear()	Removes the component from the locator.	yii\di\ServiceLocator
createController()	Creates a controller instance based on the given route.	yii\base\Module
createControllerByID()	Creates a controller based on the given controller ID.	yii\base\Module
createModel()		lispa\amos\core\module\AmosModule
defineModelClasses()	Merges the default and user defined model classes Also let's the developer to set new ones with the parameter being those the ones with most preference.	lispa\amos\core\module\AmosModule
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
get()	Returns the component instance with the specified ID.	yii\di\ServiceLocator
getAmosUniqueId()		lispa\amos\core\module\BaseAmosModule
getBasePath()	Returns the root directory of the module.	yii\base\Module
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getComponents()	Returns the list of the component definitions or the loaded component instances.	yii\di\ServiceLocator
getControllerPath()	Returns the directory that contains the controller classes according to $controllerNamespace.	yii\base\Module
getI18nDirPath()		lispa\amos\core\module\AmosModule
getInstance()	Returns the currently requested instance of this module class.	yii\base\Module
getLayoutPath()	Returns the directory that contains layout view files for this module.	yii\base\Module
getModule()	Retrieves the child module of the specified ID.	yii\base\Module
getModuleName()		lispa\amos\chat\AmosChat
getModules()	Returns the sub-modules in this module.	yii\base\Module
getRbacEnabled()		lispa\amos\core\module\BaseAmosModule
getUniqueId()	Returns an ID that uniquely identifies this module among all modules within the current application.	yii\base\Module
getVersion()	Returns current module version.	yii\base\Module
getViewPath()	Returns the directory that contains the view files for this module.	yii\base\Module
getWidgetGraphics()		lispa\amos\chat\AmosChat
getWidgetIcons()		lispa\amos\chat\AmosChat
has()	Returns a value indicating whether the locator has the specified component definition or has instantiated the component.	yii\di\ServiceLocator
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasModule()	Checks whether the child module of the specified ID exists.	yii\base\Module
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes amos messaggi privati module.	lispa\amos\chat\AmosChat
instance()	Return an instance of module	lispa\amos\core\module\AmosModule
model()	Get defined className of model	lispa\amos\core\module\AmosModule
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
runAction()	Runs a controller action specified by a route.	yii\base\Module
set()	Registers a component definition with this locator.	yii\di\ServiceLocator
setAliases()	Defines path aliases.	yii\base\Module
setBasePath()	Sets the root directory of the module.	yii\base\Module
setComponents()	Registers a set of component definitions in this locator.	yii\di\ServiceLocator
setInstance()	Sets the currently requested instance of this module class.	yii\base\Module
setLayoutPath()	Sets the directory that contains the layout files.	yii\base\Module
setModule()	Adds a sub-module to this module.	yii\base\Module
setModules()	Registers sub-modules in the current module.	yii\base\Module
setRbacEnabled()		lispa\amos\core\module\BaseAmosModule
setVersion()	Sets current module version.	yii\base\Module
setViewPath()	Sets the directory that contains the view files.	yii\base\Module
t()		lispa\amos\core\module\BaseAmosModule
tHtml()	Metodo da usare per tutte le traduzioni che non fanno parte di attributi dei tag html (es. Non si può usare nell'attributo "title" del tag "a")	lispa\amos\core\module\BaseAmosModule
tOld()	Metodo vecchio stile com'era nei plugin prima di introdurre le traduzioni a db.	lispa\amos\core\module\BaseAmosModule
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
defaultVersion()	Returns default module version.	yii\base\Module
getDefaultModels()		lispa\amos\chat\AmosChat

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised after executing a controller action.	yii\base\Module
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised before executing a controller action.	yii\base\Module

Property Details

$CONFIG_FOLDER public static property

Module config folder

public static string $CONFIG_FOLDER = 'config'

$assistanceUserId public property

User Id of the assistance user to open a conversation on click on WidgetIconChatAssistance

public integer $assistanceUserId = 1

$controllerConsoleNamespace public property

Console namespace

public string $controllerConsoleNamespace = 'lispa\amos\chat\console'

$controllerNamespace public property

Default controller namespace

public string $controllerNamespace = 'lispa\amos\chat\controllers'

$db public property

The DB connection object or the application component ID of the DB connection.

public yii\db\Connection|array|string $db = 'db'

$defaultEmailSender public property

Default e-mail sender if the server allow only sender with the same domain

public string $defaultEmailSender = null

$emailMessageContentAllowedTag public property

public string $emailMessageContentAllowedTag = 'p,div'

$enableForwardMessage public property

Used to enable the forwarding of messages. It's required to insert an array of user_id in the variable $userIdForwardMessage

public boolean $enableForwardMessage = false

$enableVideoconference public property

public boolean $enableVideoconference = false

$formRedactorButtons public property

List of all Redactor visible buttons in message form

public array $formRedactorButtons = ['image']

$immediateNotificationForce public property

Force notification sending to the message receiver

public boolean $immediateNotificationForce = true

$layout public property

The layout that should be applied for views within this module. This refers to a view name relative to $layoutPath. If this is not set, it means the layout value of the parent module will be taken. If this is false, layout will be disabled within this module.

public string|boolean $layout = 'main'

$name public property

Module name

public string $name = 'Messaggi Privati'

$onlyNetworkUsers public property

public boolean $onlyNetworkUsers = true

$subjectOfimmediateNotification public property

Default subject for emails of "immediate notification force". If in the module settings override the value, you detach translation system

public string $subjectOfimmediateNotification = 'default'

$userIdForwardMessage public property

Integer $userIdForwardMessage It's required to enable the function of forwarding message, it contain the list of user to which forward the messages

public \lispa\amos\chat\(array) $userIdForwardMessage = []

$widgetGraphics public read-only property

public void getWidgetGraphics ( )

$widgetIcons public read-only property

public void getWidgetIcons ( )

Method Details

bootstrap() public method

Bootstrap method to be called during application bootstrap stage.

public void bootstrap ( $app )
$app	yii\base\Application	The application currently running

getDefaultModels() protected method

protected array getDefaultModels ( )

getModuleName() public static method

public static string getModuleName ( )

getWidgetGraphics() public method

public void getWidgetGraphics ( )

getWidgetIcons() public method

public void getWidgetIcons ( )

init() public method

Initializes amos messaggi privati module.

This method will initialize the $db property to make sure it refers to a valid DB connection.

public void init ( )
throws	yii\base\InvalidConfigException	if $db is invalid.