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

The AmiFake_AmiroPayDrvExample_Meta class

AMI_Hyper_Meta
   |
   --AMI_HyperConfig_Meta
      |
      --AmiFake_AmiroPayDrvExample_Meta

• Introduction

AmiFake/AmiroPayDrvExample configuration metadata.

• Class synopsis

AmiFake_AmiroPayDrvExample_Meta extends AMI_HyperConfig_Meta {
/* Inherited Constants */
// Caption flag.
// Caption flag.
/* Properties */
// Array having locales as keys and meta data as values
protected array $aInfo = array( 'en' => array( 'description' => 'Example driver', 'author' => '<a href="http://amirocms.com" target="_blank">amirocms.com</a>' ),'ru'=>array('description'=>'Пример драйвера','author'=>'<a href="http://www.amiro.ru" target="_blank">www.amiro.ru</a>'));
// Array having locales as keys and captions as values
protected array $aTitle = array( 'en' => 'Example driver', 'ru' => 'Пример драйвера' );
// Flag specifying that hypermodule configs can have only one instance per config
protected bool $isSingleInstance = TRUE;
// Version
protected string $version = '1.4';
/* Inherited Properties */
// Array containing captions struct
// Flag specifies possibility of local PHP-code generation
// Flag specifying that hypermodule configs has one common data source
// Exact configuration instance modId
// Array of hypermodule meta data
/* Methods */
// Retrurns allowed installation/uninstallation modes.
public getAllowedModes ( [ string $type = '' ] ) returns array;
/* Inherited Methods */
// Returns true if local PHP-code can be generated for.
public AMI_HyperConfig_Meta::canGenCode ( ) returns bool;
// Returns fixed module Id for configuration instance if set.
public AMI_HyperConfig_Meta::getInstanceId ( ) returns string;
// Returns TRUE if configuration has one common data source.
// Returns true if instance can be edited in modules manager.
public AMI_HyperConfig_Meta::isEditable ( ) returns bool;
// Retrurns allowed installation/uninstallation modes.
public AMI_Hyper_Meta::getAllowedModes ( [ string $type = '' ] ) returns array;
// Returns hypermodule meta data.
public AMI_Hyper_Meta::getData ( [ string $key = null ] ) returns string;
// Returns hypermodule info.
public AMI_Hyper_Meta::getInfo ( string $locale ) returns string;
// Returns hypermodule / config title.
public AMI_Hyper_Meta::getTitle ( string $locale ) returns string;
// Returns hypermodule version.
public AMI_Hyper_Meta::getVersion ( ) returns string;
// Returns hypermodule instantiate flag value.
public AMI_Hyper_Meta::isSingleInstance ( ) returns bool;
// Set hypermodule meta data.
public AMI_Hyper_Meta::setData ( string $key, mixed $value ) returns void;
}
Tags:
since 6.0.2

• Class Properies

protected array $aInfo

Array having locales as keys and meta data as values

protected array $aTitle

Array having locales as keys and captions as values

protected bool $isSingleInstance

Flag specifying that hypermodule configs can have only one instance per config

protected string $version

Version

• Class Methods

// Retrurns allowed installation/uninstallation modes.
public getAllowedModes ( [ string $type = '' ] ) returns array;
  • string $type
    Possible values: 'install' / 'uninstall' / '' (all)