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

The AMI_HyperConfig_Meta class

AMI_Hyper_Meta
   |
   --AMI_HyperConfig_Meta

• Introduction

Hypermodule config metadata.

• Class synopsis

AMI_HyperConfig_Meta extends AMI_Hyper_Meta {
/* Constants */
// Caption flag.
const AMI_HyperConfig_Meta::CAPTION_TYPE_STRING =  0;
// Caption flag.
const AMI_HyperConfig_Meta::CAPTION_TYPE_TEXT =  1;
/* Properties */
// Array containing captions struct
protected array $aCaptions;
// Flag specifies possibility of local PHP-code generation
protected bool $canGenCode = TRUE;
// Flag specifying that hypermodule configs has one common data source
protected bool $hasCommonDataSource = FALSE;
// Exact configuration instance modId
protected string $instanceId = null;
/* Inherited Properties */
// Array of hypermodule meta data
// Array having locales as keys and meta data as values
// Array having locales as keys and titles as values
// Flag specifying that hypermodule configs can have only one instance per config
// Version
protected AMI_Hyper_Meta::$version = '';
/* Methods */
// Returns true if local PHP-code can be generated for.
public canGenCode ( ) returns bool;
// Returns fixed module Id for configuration instance if set.
public getInstanceId ( ) returns string;
// Returns TRUE if configuration has one common data source.
public hasCommonDataSource ( ) returns bool;
// Returns true if instance can be edited in modules manager.
public isEditable ( ) returns bool;
/* Inherited Methods */
// 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:
abstract
since 6.0.2

• Class Constants

CAPTION_TYPE_STRING

Caption flag.

CAPTION_TYPE_TEXT

Caption flag.

• Class Properies

protected array $aCaptions

Array containing captions struct

protected bool $canGenCode

Flag specifies possibility of local PHP-code generation

protected bool $hasCommonDataSource

Flag specifying that hypermodule configs has one common data source

protected string $instanceId

Exact configuration instance modId

• Class Methods

// Returns true if local PHP-code can be generated for.
public canGenCode ( ) returns bool;
Tags:
since 6.0.2
// Returns fixed module Id for configuration instance if set.
public getInstanceId ( ) returns string;
// Returns TRUE if configuration has one common data source.
public hasCommonDataSource ( ) returns bool;
// Returns true if instance can be edited in modules manager.
public isEditable ( ) returns bool;