Amiro.CMS API Reference
 Amiro.Ru / Manual

Classes:
AMI_PluginState
Orphus
Loading search...

The AMI_PluginState class

• Introduction

Plugin options/rules API running in full CMS environment.

• Class synopsis

AMI_PluginState {
/* Methods */
// Adds plugin module option rule during plugin module rule displaying.
public addRule ( string $name, int $type, mixed $aOptions, mixed $defaultValue, [ $aCaptions = array() ] ) returns bool;
// Sets plugin module option set during plugin installation.
public setOption ( string $name, mixed $value ) returns bool;
}
Tags:
since 5.10.0

• Class Methods

// Adds plugin module option rule during plugin module rule displaying.
public addRule ( string $name, int $type, mixed $aOptions, mixed $defaultValue, [ $aCaptions = array() ] ) returns bool;
  • string $name
    Plugin module option name
  • int $type
    Plugin module rule type
    Possible values:
    RLT_BOOL, RLT_UINT, RLT_SINT, RLT_FLOAT, RLT_CHAR,
    RLT_TEXT, RLT_EMAIL, RLT_ENUM, RLT_ENUM_MULTI_ARRAY,
    RLT_DATE_PERIOD, RLT_DATE_PERIOD_POSITIVE, RLT_DATE_PERIOD_NEGATIVE,
    RLT_SPLITTER
  • mixed $aOptions
    Plugin module rule options
  • mixed $defaultValue
    Plugin module default rule value
  • array $aCaptions
    Custom rule values captions
Tags:
example example not found
example example not found
// Sets plugin module option set during plugin installation.
public setOption ( string $name, mixed $value ) returns bool;
  • string $name
    Optioon name
  • mixed $value
    Optioon value
See AMI::getPluginOption() to learn how to read plugin options.
Tags:
example example not found