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

The AMI_Module_Frn class

AMI_Mod
   |
   --AMI_Module_Frn

• Introduction

Front module action controller.

• Class synopsis

AMI_Module_Frn extends AMI_Mod {
/* Inherited Constants */
// Component opton specifying to init component directly on start
const AMI_Mod::INIT_ON_START =  0x01;
// Actions sign expiration time
/* Properties */
// Default module component
protected string $defaultBodyType = 'items';
// Flag specifying to discard init() method running in children.
protected bool $discardChildInit = FALSE;
// Force body type
protected string $forceBodyType = '';
/* Inherited Properties */
// Components options
protected AMI_Mod::$aComponentsOptions = array();
// Path to status message locales
protected AMI_Mod::$statusMessagePath = '';
/* Methods */
// Constructor.
public __construct ( $oRequest, $oResponse ) returns AMI_Module_Frn;
// Destructor.
public __destruct ( ) returns void;
// Used to disable search engine indexing by adding meta tag 'robots' with 'noindex,follow' value.
public disablePageIndexing ( ) returns AMI_Module_Frn;
// Used to force enable search engine indexing for page.
public forcePageIndexing ( [ bool $index = TRUE ] ) returns AMI_Module_Frn;
// Returns client locale path.
public getClientLocalePath ( ) returns string;
// Returns specblock content.
public getSpecblock ( [ string $postfix = '' ] ) returns string;
// Initializes module.
public init ( ) returns AMI_Module_Frn;
// Sets force page size.
public setForcePageSize ( int $size ) returns void;
// Sets force body type for search engine indexing options checking.
protected forceBodyType ( string $bodyType ) returns AMI_Module_Frn;
// Returns specblock component.
protected getSpecblockComponent ( [ string $postfix = '' ] ) returns AMI_ModComponent|null;
// Cache initialization.
protected initCache ( ) returns AMI_Module_Frn;
// Returns true if module specblock requested.
protected isSpecblock ( ) returns bool;
// Sets a module default body type.
protected setDefaultBodyType ( string $bodyType ) returns void;
/* Inherited Methods */
// Constructor.
public AMI_Mod::__construct ( $oRequest, $oResponse ) returns AMI_Mod;
// Adds module component.
public AMI_Mod::addComponent ( $oComponent, [ string $serialId = null ], [ $aOptions = array() ] ) returns AMI_Mod;
// Adds module components by its types.
public AMI_Mod::addComponents ( $aComponents, [ $aOptions = array() ] ) returns AMI_Mod;
// Fires to dispatch module controller action.
public AMI_Mod::dispatch ( mixed $action ) returns void;
// Returns client locale path.
public AMI_Mod::getClientLocalePath ( ) returns string;
// Returns module id.
public AMI_Mod::getModId ( ) returns string;
// Returns module state object.
public AMI_Mod::getModState ( ) returns AMI_ModState;
// Called before initialization module component.
public AMI_Mod::init ( ) returns void;
// Called before module controller components initialization.
public AMI_Mod::initComponents ( ) returns void;
// Removes module components by its types.
public AMI_Mod::removeComponents ( $aTypes ) returns AMI_Mod;
// Set module id.
public AMI_Mod::setModId ( string $modId ) returns void;
// Destructor.
public AMI_Mod::__destruct ( ) returns void;
}
Tags:
abstract
since 5.14.8

• Class Properies

protected string $defaultBodyType

Default module component

protected bool $discardChildInit

Flag specifying to discard init() method running in children.

protected string $forceBodyType

Force body type

• Class Methods

// Constructor.
public __construct ( $oRequest, $oResponse ) returns AMI_Module_Frn;

Overrides: AMI_Mod::__construct().

Overridden in child classes as: AmiClean_Sape_Frn::__construct(), AmiClean_Trustlink_Frn::__construct(), AmiClean_AmiSample_Frn::__construct(), AmiMultifeeds_Photoalbum_Frn::__construct().

Tags:
todo Add bodytype to registry to be used in extensions???
// Destructor.
public __destruct ( ) returns void;

Overrides: AMI_Mod::__destruct().

Tags:
since 6.0.2
// Used to disable search engine indexing by adding meta tag 'robots' with 'noindex,follow' value.
public disablePageIndexing ( ) returns AMI_Module_Frn;
// Used to force enable search engine indexing for page.
public forcePageIndexing ( [ bool $index = TRUE ] ) returns AMI_Module_Frn;
  • bool $index
    Indexing flag
// Returns client locale path.
public getClientLocalePath ( ) returns string;
// Returns specblock content.
public getSpecblock ( [ string $postfix = '' ] ) returns string;
  • string $postfix
    Name postfix
// Initializes module.
public init ( ) returns AMI_Module_Frn;

Overrides: AMI_Mod::init().

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

// Sets force page size.
public setForcePageSize ( int $size ) returns void;
  • int $size
    Page size
SEO hack for forum and ext_discussion.
// Sets force body type for search engine indexing options checking.
protected forceBodyType ( string $bodyType ) returns AMI_Module_Frn;
  • string $bodyType
    Page body type
// Returns specblock component.
protected getSpecblockComponent ( [ string $postfix = '' ] ) returns AMI_ModComponent|null;
  • string $postfix
    Name postfix
// Cache initialization.
protected initCache ( ) returns AMI_Module_Frn;
Tags:
since 7.0.0
// Returns true if module specblock requested.
protected isSpecblock ( ) returns bool;
// Sets a module default body type.
protected setDefaultBodyType ( string $bodyType ) returns void;
  • string $bodyType
    Default bodytype