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

The AMI_ModComponent class

• Introduction

Module component action controller abstraction.

• Class synopsis

AMI_ModComponent implements AMI_iModComponent {
/* Properties */
// Flag specifying to use model
protected bool $useModel = TRUE;
/* Methods */
// Returns true if component needs to be started always in full environment.
public isFullEnv ( ) returns bool;
// Sets module id.
public setModId ( string $modId ) returns AMI_ModComponent;
// Returns module id.
protected getModId ( ) returns string;
// Returns serial id.
protected getSerialId ( ) returns string;
// Initializes model.
protected initModel ( ) returns AMI_ModTable|null;
}
Tags:
abstract
since 5.12.0

• Class Properies

protected bool $useModel

Flag specifying to use model

• Class Methods

// Returns true if component needs to be started always in full environment.
public isFullEnv ( ) returns bool;
// Sets module id.
public setModId ( string $modId ) returns AMI_ModComponent;
  • string $modId
    Module id

Implementation of: AMI_iModComponent::setModId().

// Returns module id.
protected getModId ( ) returns string;
// Returns serial id.
protected getSerialId ( ) returns string;
// Initializes model.
protected initModel ( ) returns AMI_ModTable|null;