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

The AMI_ModListAdmCommon class

AMI_ModComponent
   |
   --AMI_ModList
      |
      --AMI_ModListAdm
         |
         --AMI_ModListAdmCommon

• Introduction

Common module admin list component action controller.

• Class synopsis

AMI_ModListAdmCommon extends AMI_ModListAdm {
/* Inherited Constants */
// Action type.
const AMI_ModListAdm::ACTION_ALL =  0x0F;
// Action type.
// Action type.
// Action type.
// Action type.
// Action prefix specifying full environment requirement for action processing
/* 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
// Default list order
protected AMI_ModList::$aDefaultOrder = array( 'col' => 'id', 'dir' => 'asc' );
// Flag specifying to use model
protected AMI_ModComponent::$useModel = TRUE;
/* Methods */
// Initialization.
public init ( ) returns AMI_ModListAdmCommon;
/* Inherited Methods */
// Returns component view.
// 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.
// 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;
}
Tags:
abstract
since 5.14.4