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

The AmiClean_AmiSample_ListGroupActionsAdm class

AMI_ModListActions
   |
   --AMI_ModListGroupActions
      |
      --Hyper_AmiClean_ListGroupActionsAdm
         |
         --AmiClean_AmiSample_ListGroupActionsAdm

• Introduction

AmiClean/AmiSample configuration admin list group actions controller.

• Class synopsis

AmiClean_AmiSample_ListGroupActionsAdm extends Hyper_AmiClean_ListGroupActionsAdm {
/* Inherited Properties */
// Action event data
/* Methods */
// Dispatches 'delete' group action.
public dispatchGrpDelete ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Dispatches 'rename' group action.
public dispatchGrpRename ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
/* Inherited Methods */
// Returns requested ids list as array.
protected AMI_ModListGroupActions::getRequestIds ( ) returns array;
// Dispatches 'delete' action.
public AMI_ModListActions::dispatchDelete ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Dispatches 'public' action.
public AMI_ModListActions::dispatchPublic ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Dispatches 'unpublic' action.
public AMI_ModListActions::dispatchUnPublic ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Refreshes list view.
public AMI_ModListActions::refreshView ( ) returns void;
// Stores action event data for posterior usage.
public AMI_ModListActions::setActionData ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Changes one field of table item & save it.
protected AMI_ModListActions::changeItemFlag ( string $id, string $flag, string $value ) returns AMI_ModTableItem;
// Returns corresponding table item model.
protected AMI_ModListActions::getItem ( string $id, [ $aFields = array('*') ] ) returns AMI_ModTableItem;
// Returns 'id' parameter from request.
protected AMI_ModListActions::getRequestId ( ) returns string;
}
Tags:
since 5.14.4
resource {$modId}/list_group_actions/controller/adm AMI::getResource('{$modId}_cat/list_group_actions/controller/adm')*

• Class Methods

// Dispatches 'delete' group action.
public dispatchGrpDelete ( 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
// Dispatches 'rename' group action.
public dispatchGrpRename ( 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
Event handler.
Renames 'nickname' field to "[{$nickname}]".