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

The AMI_ModCatsFrn class

AMI_ModComponent
   |
   --AMI_ModList
      |
      --AMI_ModCatsFrn

• Introduction

Module front cats body type action controller.

• Class synopsis

AMI_ModCatsFrn extends AMI_ModList {
/* Properties */
// Calculated cache expiration time
protected static int $cacheExpireTime;
// Category ids to collect subitems
protected array $aCatIds = array();
// Subitems list model
/* Inherited Properties */
// Default list order
protected AMI_ModList::$aDefaultOrder = array( 'col' => 'id', 'dir' => 'asc' );
// Flag specifying to use model
protected AMI_ModComponent::$useModel = TRUE;
/* Methods */
// Returns component expiration time.
public getCacheExpireTime ( ) returns int;
// Returns component type.
public getType ( ) returns string;
// Handles list recordset.
public handleListRecordsetLoaded ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Prepare subitems.
public handleSubitems ( string $name, $aEvent, string $handlerModId, string $srcModId ) returns array;
// Initialization.
public init ( ) returns AMI_ModCatsFrn;
// Displays all subitems (subitems per each category).
protected displayAllSubitems ( &$aEvent ) returns void;
// Displays limited subitems per each category.
protected displayLimitedSubitems ( &$aEvent, int $subitems ) returns void;
// Initializes model.
protected initModel ( ) returns AMI_ModTable;
/* Inherited Methods */
// 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.8

• Class Properies

protected static int $cacheExpireTime

Calculated cache expiration time

protected array $aCatIds

Category ids to collect subitems

protected AMI_ModTableList $oSubitems

Subitems list model

• Class Methods

// Returns component expiration time.
public getCacheExpireTime ( ) returns int;
// Returns component type.
public getType ( ) returns string;

Overrides: AMI_ModList::getType().

Overridden in child classes as: Hyper_AmiMultifeeds_StickyCatsFrn::getType().

// Handles list recordset.
public handleListRecordsetLoaded ( 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
Collects all items ids.
// Prepare subitems.
public handleSubitems ( 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
// Initialization.
public init ( ) returns AMI_ModCatsFrn;

Overrides: AMI_ModList::init().

Overridden in child classes as: Hyper_AmiMultifeeds_StickyCatsFrn::init().

// Displays all subitems (subitems per each category).
protected displayAllSubitems ( &$aEvent ) returns void;
  • array &$aEvent
    Event
// Displays limited subitems per each category.
protected displayLimitedSubitems ( &$aEvent, int $subitems ) returns void;
  • array &$aEvent
    Event
  • int $subitems
    Subitems limit
// Initializes model.
protected initModel ( ) returns AMI_ModTable;