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

The AMI_ModRules class

• Introduction

Module rules callbacks.

• Class synopsis

AMI_ModRules {
/* Constants */
const AMI_ModRules::CORRECT =  'correctvalue';
const AMI_ModRules::GET_ALL =  'getallvalues';
const AMI_ModRules::GET_VAL =  'getvalue';
const AMI_ModRules::SET_VAL =  'apply';
/* Properties */
// Categories list
protected array $aCategories = null;
// Module Id
protected string $modId = null;
// Module instance
protected AMI_Mod $oModInstance = null;
/* Methods */
// Constructor.
public __construct ( ) returns AMI_ModRules;
// Clean off module instance.
public cleanup ( ) returns void;
// Handler for ##modId##:correctStopArgNames callback.
public correctStopArgNames ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
// Returns module id.
public getModId ( ) returns string;
// Handler for ##modId##:getOptionsModCB callback.
public getOptionsModCB ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
// Handler for ##modId##:ruleExtensionsCB callback.
public ruleExtensionsCB ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
// Handler for ##modId##:setImagesWatermark callback.
public setImagesWatermark ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
}
Tags:
abstract

• Class Constants

CORRECT
GET_ALL
GET_VAL
SET_VAL

• Class Properies

protected array $aCategories

Categories list

protected string $modId

Module Id

protected AMI_Mod $oModInstance

Module instance

• Class Methods

// Constructor.
public __construct ( ) returns AMI_ModRules;
// Clean off module instance.
public cleanup ( ) returns void;
// Handler for ##modId##:correctStopArgNames callback.
public correctStopArgNames ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
  • mixed $callbackData
    Data for callback
  • mixed &$optionsData
    Options data
  • string $callbackMode
    Callback mode
  • mixed &$result
    Result data
  • array &$aData
    Data
// Returns module id.
public getModId ( ) returns string;
// Handler for ##modId##:getOptionsModCB callback.
public getOptionsModCB ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
  • mixed $callbackData
    Data for callback
  • mixed &$optionsData
    Options data
  • string $callbackMode
    Callback mode
  • mixed &$result
    Result data
  • array &$aData
    Data
// Handler for ##modId##:ruleExtensionsCB callback.
public ruleExtensionsCB ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
  • mixed $callbackData
    Data for callback
  • mixed &$optionsData
    Options data
  • string $callbackMode
    Callback mode
  • mixed &$result
    Result data
  • array &$aData
    Data
// Handler for ##modId##:setImagesWatermark callback.
public setImagesWatermark ( mixed $callbackData, mixed &$optionsData, string $callbackMode, mixed &$result, &$aData ) returns bool;
  • mixed $callbackData
    Data for callback
  • mixed &$optionsData
    Options data
  • string $callbackMode
    Callback mode
  • mixed &$result
    Result data
  • array &$aData
    Data
Tags:
todo Move to the photoalbums rules class