Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_Module_Adm class

AMI_Mod
   |
   --AMI_Module_Adm

• Introduction

Admin module action controller.

• Class synopsis

AMI_Module_Adm extends AMI_Mod {
/* Inherited Constants */
// Component opton specifying to init component directly on start
const AMI_Mod::INIT_ON_START =  0x01;
// Actions sign expiration time
/* Properties */
// Path to status message locales
protected string $statusMessagePath = '';
/* Inherited Properties */
// Components options
protected AMI_Mod::$aComponentsOptions = array();
/* Methods */
// Constructor.
public __construct ( $oRequest, $oResponse ) returns AMI_Module_Adm;
// Remove sticky flag if automatic option was set.
public handleRemoveStickyFlag ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Set data model item handler.
public handleSetDataModelItem ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
/* Inherited Methods */
// Constructor.
public AMI_Mod::__construct ( $oRequest, $oResponse ) returns AMI_Mod;
// Adds module component.
public AMI_Mod::addComponent ( $oComponent, [ string $serialId = null ], [ $aOptions = array() ] ) returns AMI_Mod;
// Adds module components by its types.
public AMI_Mod::addComponents ( $aComponents, [ $aOptions = array() ] ) returns AMI_Mod;
// Fires to dispatch module controller action.
public AMI_Mod::dispatch ( mixed $action ) returns void;
// Returns client locale path.
public AMI_Mod::getClientLocalePath ( ) returns string;
// Returns module id.
public AMI_Mod::getModId ( ) returns string;
// Returns module state object.
public AMI_Mod::getModState ( ) returns AMI_ModState;
// Called before initialization module component.
public AMI_Mod::init ( ) returns void;
// Called before module controller components initialization.
public AMI_Mod::initComponents ( ) returns void;
// Removes module components by its types.
public AMI_Mod::removeComponents ( $aTypes ) returns AMI_Mod;
// Set module id.
public AMI_Mod::setModId ( string $modId ) returns void;
// Destructor.
public AMI_Mod::__destruct ( ) returns void;
}
Tags:
abstract
since 5.14.4

• Class Properies

protected string $statusMessagePath

Path to status message locales

• Class Methods

// Constructor.
public __construct ( $oRequest, $oResponse ) returns AMI_Module_Adm;

Overrides: AMI_Mod::__construct().

Overridden in child classes as: AMI_CatModule_Adm::__construct().

// Remove sticky flag if automatic option was set.
public handleRemoveStickyFlag ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
  • string $name
    Event name
  • array $aEvent
    Event data
  • string $handlerModId
    Handler module id
  • string $srcModId
    Source module id
// Set data model item handler.
public handleSetDataModelItem ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
  • string $name
    Event name
  • array $aEvent
    Event data
  • string $handlerModId
    Handler module id
  • string $srcModId
    Source module id