Amiro.CMS API Reference
 Amiro.Ru / Manual

Orphus
Loading search...

The AmiSample_ListActionsAdm class

AMI_ModListActions
   |
   --AmiSample_ListActionsAdm

• Introduction

Sample module admin list action controller.

• Class synopsis

AmiSample_ListActionsAdm extends AMI_ModListActions {
/* Inherited Properties */
// Action event data
protected AMI_ModListActions::$aEvent;
/* Methods */
// Dispatches 'copy' action.
public dispatchCopy ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
public dispatchDelete ( mixed $name, $aEvent, mixed $handlerModId, mixed $srcModId ) returns void;
// 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.12.0
resource ami_sample/list_actions/controller/adm AMI::getResource('ami_sample/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.
public dispatchDelete ( mixed $name, $aEvent, mixed $handlerModId, mixed $srcModId ) returns void;

Overrides: AMI_ModListActions::dispatchDelete().

Tags:
version $Id: AmiSample_ListActionsAdm.php 61273 2013-08-07 10:47:54Z Leontiev Anton $
copyright Amiro.CMS. All rights reserved.
since 5.12.0
filesource Source Code for this file
// 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}]".