The AmiSample_FormAdm class

AMI_ModComponent
   |
   --AMI_ModForm
      |
      --AMI_ModFormAdm
         |
         --AmiSample_FormAdm

• Introduction

Sample module admin form component action controller.

• Class synopsis

AmiSample_FormAdm extends AMI_ModFormAdm {

/* Inherited Constants */

// Flag specified that save is failed.

const AMI_ModForm::SAVE_FAILED = 0;

// Flag specified that save is succeed.

const AMI_ModForm::SAVE_SUCCEED = 1;

/* Inherited Properties */

// Array of actions processed by form

protected AMI_ModForm::$aActions = array('display', 'edit', 'save', 'show');

// File factory resource id

protected AMI_ModForm::$fileFactoryResId = 'env/file';

// Table item model

protected AMI_ModForm::$oItem;

// Flag specifying to use model

protected AMI_ModComponent::$useModel = TRUE;

/* Methods */

// Save action dispatcher.

protected _save ( &$aEvent ) returns void;

/* Inherited Methods */

// Display action handler.

public AMI_ModForm::dispatchDisplay ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Edit action handler.

public AMI_ModForm::dispatchEdit ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Save action handler.

public AMI_ModForm::dispatchSave ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Show action handler.

public AMI_ModForm::dispatchShow ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Returns component type.

public AMI_ModForm::getType ( ) returns string;

// Returns component view.

public AMI_ModForm::getView ( ) returns AMI_ModFormView;

// Initialization.

public AMI_ModForm::init ( ) returns AMI_ModForm;

// Returns true if component needs to be started always in full environment.

public AMI_ModForm::isFullEnv ( ) returns bool;

// Save action dispatcher.

public AMI_ModForm::_save ( &$aEvent ) returns void;

// Returns module file storage path.

protected AMI_ModForm::getFileStoragePath ( ) returns string;

// Returns uploaded file codes.

protected AMI_ModForm::getUploadedFileCodes ( ) returns array;

// Do something when data is not saved and exception is called.

protected AMI_ModForm::onSaveException ( $aEvent ) returns array;

// Edit action dispatcher.

protected AMI_ModForm::_edit ( &$aEvent ) returns void;

// Returns true if component needs to be started always in full environment.

public AMI_ModComponent::isFullEnv ( ) returns bool;

// Sets module id.

public AMI_ModComponent::setModId ( string $modId ) returns AMI_ModComponent;

// Returns module id.

protected AMI_ModComponent::getModId ( ) returns string;

// Returns serial id.

protected AMI_ModComponent::getSerialId ( ) returns string;

// Initializes model.

protected AMI_ModComponent::initModel ( ) returns AMI_ModTable|null;

}

Tags:

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

• Class Methods

// Save action dispatcher.

protected _save ( &$aEvent ) returns void;

array &$aEvent
Event data

Overrides: AMI_ModForm::_save().