The AmiClean_AmiSample_Meta class

AMI_Hyper_Meta
   |
   --AMI_HyperConfig_Meta
      |
      --AmiClean_AmiSample_Meta

• Introduction

AmiClean/AmiSample configuration metadata.

• Class synopsis

AmiClean_AmiSample_Meta extends AMI_HyperConfig_Meta {

/* Inherited 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 = array( '' => array( 'header' => array( 'obligatory' => TRUE, 'type' => self::CAPTION_TYPE_STRING, 'locales' => array( 'en' => array( 'name' => 'Top header', 'caption' => 'SAMPLE MODULE', ),'ru'=>array('name'=>'Название (в шапке)','caption'=>'ПРИМЕР МОДУЛЯ',),),),'menu_group'=>array('obligatory'=>FALSE,'type'=>self::CAPTION_TYPE_STRING,'locales'=>array('en'=>array('name'=>'Group menu caption','caption'=>'Sample Module Group',),'ru'=>array('name'=>'Заголовок группы в меню','caption'=>'Группа примера модуля',))),'menu'=>array('obligatory'=>TRUE,'type'=>self::CAPTION_TYPE_STRING,'locales'=>array('en'=>array('name'=>'Menu caption','caption'=>'Sample Module',),'ru'=>array('name'=>'Заголовок для меню','caption'=>'Пример модуля',),),),'description'=>array('obligatory'=>FALSE,'type'=>self::CAPTION_TYPE_TEXT,'locales'=>array('en'=>array('name'=>'Admin interface start page module description','caption'=>'Sample instance of AmiClean base hypermodule / AmieSample configuration',),'ru'=>array('name'=>'Описание модуля для стартовой страницы интерфейса администратора','caption'=>'Пример экземпляра модуля конфигурации AmiSample базового гипермодуля AmiClean',),),),'specblock'=>array('obligatory'=>TRUE,'type'=>self::CAPTION_TYPE_STRING,'locales'=>array('en'=>array('name'=>'First specblock caption for Site Manager','caption'=>'First specblock',),'ru'=>array('name'=>'Название первого спецблока для менеджера сайта','caption'=>'Первый спецблок',),),),'specblock:custom'=>array('obligatory'=>TRUE,'type'=>self::CAPTION_TYPE_STRING,'locales'=>array('en'=>array('name'=>'Second specblock caption for Site Manager','caption'=>'Second specblock',),'ru'=>array('name'=>'Название второго спецблока для менеджера сайта','caption'=>'Второй спецблок',),),),),);

// Array having locales as keys and meta data as values

protected array $aInfo = array( 'en' => array( 'description' => 'Sample AmiClean base hypermodule configuration', 'author' => '<a href="http://www.amirocms.com" target="_blank">Amiro.CMS</a>' ),'ru'=>array('description'=>'Тестовая конфигурация базового гипермодуля AmiClean','author'=>'<a href="http://www.amiro.ru" target="_blank">Amiro.CMS</a>'));

// Array having locales as keys and captions as values

protected array $aTitle = array( 'en' => 'Sample module', 'ru' => 'Тестовый модуль' );

// Version

protected string $version = '1.1';

/* Inherited Properties */

// Flag specifies possibility of local PHP-code generation

protected AMI_HyperConfig_Meta::$canGenCode = TRUE;

// Flag specifying that hypermodule configs has one common data source

protected AMI_HyperConfig_Meta::$hasCommonDataSource = FALSE;

// Exact configuration instance modId

protected AMI_HyperConfig_Meta::$instanceId = null;

// Array of hypermodule meta data

protected AMI_Hyper_Meta::$aData;

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

protected AMI_Hyper_Meta::$isSingleInstance = FALSE;

/* 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.

public AMI_HyperConfig_Meta::hasCommonDataSource ( ) returns bool;

// 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

5.14.4

• Class Properies

protected array $aCaptions: Array containing captions struct

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 string $version: Version