Abstract Class lispa\amos\core\module\AmosModule

All Classes | Properties | Methods | Events
Inheritancelispa\amos\core\module\AmosModule » lispa\amos\core\module\BaseAmosModule » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object
Implementslispa\amos\core\module\ModuleInterface, yii\base\Configurable
Subclasseslispa\amos\admin\AmosAdmin, lispa\amos\attachments\FileModule, lispa\amos\chat\AmosChat, lispa\amos\comments\AmosComments, lispa\amos\community\AmosCommunity, lispa\amos\comuni\AmosComuni, lispa\amos\cwh\AmosCwh, lispa\amos\dashboard\AmosDashboard, lispa\amos\discussioni\AmosDiscussioni, lispa\amos\documenti\AmosDocumenti, lispa\amos\een\AmosEen, lispa\amos\emailmanager\AmosEmail, lispa\amos\events\AmosEvents, lispa\amos\faq\AmosFaq, lispa\amos\favorites\AmosFavorites, lispa\amos\inforeq\AmosInforeq, lispa\amos\invitations\Module, lispa\amos\layout\Module, lispa\amos\mobile\bridge\Module, lispa\amos\mobile\bridge\modules\v1\V1, lispa\amos\myactivities\AmosMyActivities, lispa\amos\news\AmosNews, lispa\amos\notificationmanager\AmosNotify, lispa\amos\organizzazioni\Module, lispa\amos\partnershipprofiles\Module, lispa\amos\privileges\AmosPrivileges, lispa\amos\projectmanagement\Module, lispa\amos\report\AmosReport, lispa\amos\risultati\AmosRisultati, lispa\amos\seo\AmosSeo, lispa\amos\slideshow\AmosSlideshow, lispa\amos\socialauth\Module, lispa\amos\sondaggi\AmosSondaggi, lispa\amos\tag\AmosTag, lispa\amos\translation\AmosTranslation, lispa\amos\videoconference\AmosVideoconference

Class AmosModule

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$aliases array List of path aliases to be defined. yii\base\Module
$amosUniqueId string lispa\amos\core\module\AmosModule
$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
$controllerMap array Mapping from controller ID to controller configurations. yii\base\Module
$controllerNamespace string The namespace that controller classes are in. yii\base\Module
$controllerPath string The directory that contains the controller classes. yii\base\Module
$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
$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
$layout string|boolean The layout that should be applied for views within this module. yii\base\Module
$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
$params array Custom module parameters (name => value). yii\base\Module
$rbacEnabled boolean lispa\amos\core\module\BaseAmosModule
$uniqueId string The unique ID of the module. yii\base\Module
$version string The version of this module. yii\base\Module
$viewPath string The root directory of view files. yii\base\Module
$widgetGraphics lispa\amos\core\module\ModuleInterface
$widgetIcons lispa\amos\core\module\ModuleInterface

Public Methods

Hide inherited methods

MethodDescriptionDefined 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
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\AmosModule
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\core\module\ModuleInterface
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\core\module\ModuleInterface
getWidgetIcons() lispa\amos\core\module\ModuleInterface
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 the module. lispa\amos\core\module\AmosModule
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

MethodDescriptionDefined By
defaultVersion() Returns default module version. yii\base\Module
getDefaultModels() Get default model classes lispa\amos\core\module\AmosModule

Events

Hide inherited events

EventTypeDescriptionDefined 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

$amosUniqueId public read-only property
public string getAmosUniqueId ( )
$defaultListViews public property

This set the default views in lists

public array $defaultListViews = ['grid']
$i18nDirPath public read-only property
public string getI18nDirPath ( )
$modelMap public property
public array $modelMap = []

Method Details

beginCreateNewSessionKey() public static method

This method return the session key that must be used to add in session the url from the user have started the content creation.

public static string beginCreateNewSessionKey ( )
beginCreateNewSessionKeyDateTime() public static method

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.

public static string beginCreateNewSessionKeyDateTime ( )
createModel() public method

public object createModel ( $name )
$name string
throws yii\base\InvalidConfigException
defineModelClasses() public method

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.

public void defineModelClasses ( $modelClasses = [] )
$modelClasses array
getAmosUniqueId() public method

public string getAmosUniqueId ( )
getDefaultModels() protected abstract method

Get default model classes

protected abstract void getDefaultModels ( )
getI18nDirPath() public method

public string getI18nDirPath ( )
throws ReflectionException
init() public method

Initializes the module.

This method is called after the module is created and initialized with property values given in configuration. The default implementation will initialize $controllerNamespace if it is not set.

If you override this method, please make sure you call the parent implementation.

public void init ( )
instance() public static method

Return an instance of module

public static lispa\amos\core\module\AmosModule instance ( )
model() public method

Get defined className of model

Returns an string or array compatible with the Yii::createObject method.

public string|array model ( $name )
$name string