The AmiClean_Webservice_ListFrn class

AMI_ModComponent
   |
   --AMI_ModList
      |
      --AMI_ModListAdm
         |
         --Hyper_AmiClean_ListAdm
            |
            --AmiClean_Webservice_ListFrn

• Introduction

AmiClean/Webservice front list component action controller.

• Class synopsis

AmiClean_Webservice_ListFrn extends Hyper_AmiClean_ListAdm {

/* Inherited Constants */

// Action type.

const AMI_ModListAdm::ACTION_ALL = 0x0F;

// Action type.

const AMI_ModListAdm::ACTION_COLUMN = 0x02;

// Action type.

const AMI_ModListAdm::ACTION_COMMON = 0x01;

// Action type.

const AMI_ModListAdm::ACTION_GROUP = 0x08;

// Action type.

const AMI_ModListAdm::ACTION_POSITION = 0x04;

// Action prefix specifying full environment requirement for action processing

const AMI_ModListAdm::REQUIRE_FULL_ENV = '!';

/* Inherited Properties */

// List columns from dependent tables

protected AMI_ModListAdm::$aJoinedColumns = array();

// List actions controller resource id

protected AMI_ModListAdm::$listActionsResId = 'list/actions';

// List group actions controller resource id

protected AMI_ModListAdm::$listGrpActionsResId = 'list/actions/group';

// View for list group actions

protected AMI_ModListAdm::$oGroupActionsView = null;

// Default list order

protected AMI_ModList::$aDefaultOrder = array( 'col' => 'id', 'dir' => 'asc' );

// Flag specifying to use model

protected AMI_ModComponent::$useModel = TRUE;

/* Methods */

// Updates generated image link modId.

public handleImageLink ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Adds cat header column.

public handleListLoad ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;

// Initialization.

public init ( ) returns AMI_ModListAdm;

// Initializes model.

protected initModel ( ) returns AMI_ModTable|null;

/* Inherited Methods */

// Returns model supported group actions.

public AMI_ModListAdm::getGroupActions ( ) returns array;

// Returns component view.

public AMI_ModListAdm::getView ( ) returns AMI_ModListView;

// Initialization.

public AMI_ModListAdm::init ( ) returns AMI_ModListAdm;

// Adds actions to the item list.

protected AMI_ModListAdm::addActions ( $aActions, [ string $column = '' ] ) returns AMI_ModListAdm;

// Adds separate column actions to the item list.

protected AMI_ModListAdm::addColActions ( $aActions, [ bool $valueDependend = false ] ) returns AMI_ModListAdm;

// Add model supported group actions.

protected AMI_ModListAdm::addGroupActions ( $aActions ) returns bool;

// Adds hidden action and registers a callback.

protected AMI_ModListAdm::addHiddenAction ( string $action ) returns AMI_ModListAdm;

// Adds joined columns to the list.

protected AMI_ModListAdm::addJoinedColumns ( $aColumns, string $alias ) returns AMI_ModListAdm;

// Discards previously added actions.

protected AMI_ModListAdm::dropActions ( int $type, [ $aActions = null ], [ bool $dropHandler = TRUE ] ) returns AMI_ModListAdm;

// Returns component type.

public AMI_ModList::getType ( ) returns string;

// Returns component view.

public AMI_ModList::getView ( ) returns AMI_ModListView;

// Initialization.

public AMI_ModList::init ( ) returns AMI_ModList;

// 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;

}

• Class Methods

// Updates generated image link modId.

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

// Adds cat header column.

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

// Initialization.

public init ( ) returns AMI_ModListAdm;

Overrides: AMI_ModListAdm::init().

// Initializes model.

protected initModel ( ) returns AMI_ModTable|null;

Overrides: AMI_ModComponent::initModel().