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

The AMI_ModState class

• Introduction

Module model.

• Class synopsis

AMI_ModState {
/* Methods */
// Returns module id.
public getModId ( ) returns string;
// Returns module option value.
public getOption ( string $name ) returns mixed;
// Returns true if module option is set and is true.
public issetAndTrueOption ( string $name ) returns bool;
// Returns module option presence.
public issetOption ( string $name ) returns bool;
// Returns state source module id.
protected getStateSourceModId ( ) returns string;
}

• Class Details

Used to flexible overriding module id/option source module id by children modules.
Will be described later. To create your own filter component action controller you should create the child for this class.

  Example:
Tags:
todo Describe usage
abstract
since 5.12.0

• Class Methods

// Returns module id.
public getModId ( ) returns string;
// Returns module option value.
public getOption ( string $name ) returns mixed;
  • string $name
    Module option name
// Returns true if module option is set and is true.
public issetAndTrueOption ( string $name ) returns bool;
  • string $name
    Module option name
// Returns module option presence.
public issetOption ( string $name ) returns bool;
  • string $name
    Module option name
// Returns state source module id.
protected getStateSourceModId ( ) returns string;
Will be describe later.
Tags:
todo Describe