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

The AmiClean_AmiSample_ListActionsAdm class

AMI_ModListActions
   |
   --Hyper_AmiClean_ListActionsAdm
      |
      --AmiClean_AmiSample_ListActionsAdm

• Introduction

AmiClean/AmiSample configuration admin list actions controller.

• Class synopsis

AmiClean_AmiSample_ListActionsAdm extends Hyper_AmiClean_ListActionsAdm {
/* Inherited Properties */
// Action event data
/* Methods */
// Dispatches 'copy' action.
public dispatchCopy ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Dispatches 'delete' action.
public dispatchDelete ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Dispatches 'inner' action.
public dispatchInner ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Dispatches 'rename' action.
public dispatchRename ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
/* Inherited Methods */
// 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_actions/controller/adm AMI::getResource('{$modId}_cat/list_actions/controller/adm')*

• Class Methods

// Dispatches 'copy' action.
public dispatchCopy ( 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.
Copies item and prepends '- ' string to the new 'nickname' field.
// Dispatches 'delete' action.
public dispatchDelete ( 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

Overrides: AMI_ModListActions::dispatchDelete().

Event handler.
Overridden item deletion. Denies deletion of item having id == 1.
// Dispatches 'inner' action.
public dispatchInner ( 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.
Displays three messages.
// Dispatches 'rename' action.
public dispatchRename ( 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}]".