The AmiSample_Adm class

AMI_Mod
   |
   --AmiSample_Adm

• Introduction

Sample module admin action controller.

• Class synopsis

AmiSample_Adm extends AMI_Mod {

/* Inherited Constants */

// Component opton specifying to init component directly on start

const AMI_Mod::INIT_ON_START = 0x01;

/* Inherited Properties */

// Components options

protected AMI_Mod::$aComponentsOptions = array();

// Path to status message locales

protected AMI_Mod::$statusMessagePath = '';

/* Methods */

// Constructor.

public __construct ( $oRequest, $oResponse ) returns AmiSample_Adm;

// Returns client locale path.

public getClientLocalePath ( ) returns string;

// Replaces the status message with a new one.

public handleAddStatusMessage ( 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:

since	5.12.0
resource	ami_sample/module/controller/adm AMI::getResource('ami_sample/module/controller/adm')

• Class Methods

// Constructor.

public __construct ( $oRequest, $oResponse ) returns AmiSample_Adm;

AMI_Request $oRequest
Request object
AMI_Response $oResponse
Response object

Overrides: AMI_Mod::__construct().

Our sample module has three common components: list filter, list and form.

// Returns client locale path.

public getClientLocalePath ( ) returns string;

Overrides: AMI_Mod::getClientLocalePath().

// Replaces the status message with a new one.

public handleAddStatusMessage ( 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