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

The AmiClean_Sape_Meta class

AMI_Hyper_Meta
   |
   --AMI_HyperConfig_Meta
      |
      --AmiClean_Sape_Meta

• Introduction

AmiClean/Sape configuration metadata.

• Class synopsis

AmiClean_Sape_Meta extends AMI_HyperConfig_Meta {
/* Inherited Constants */
// Caption flag.
// Caption flag.
/* Properties */
// Array containing captions struct
protected array $aCaptions = array( '' => array( 'menu' => array( 'obligatory' => TRUE, 'type' => self::CAPTION_TYPE_STRING, 'locales' => array( 'en' => array( 'name' => 'Menu caption', 'caption' => 'SAPE.RU', ),'ru'=>array('name'=>'Заголовок для меню','caption'=>'Отображение ссылок с SAPE.RU',),),),'specblock'=>array('obligatory'=>TRUE,'type'=>self::CAPTION_TYPE_STRING,'locales'=>array('en'=>array('name'=>'Specblock caption for Site Manager','caption'=>'SAPE.RU',),'ru'=>array('name'=>'Название спецблока для менеджера сайта','caption'=>'SAPE.RU',),),),),);
// Array having locales as keys and meta data as values
protected array $aInfo = array( 'en' => array( 'description' => 'SAPE.RU link exchanger', 'author' => '<a href="http://www.amirocms.com" target="_blank">Amiro.CMS</a>' ),'ru'=>array('description'=>'Плагин предназначен для отображения ссылок, предоставляемых интернет-сервисом SAPE.RU. ВНИМАНИЕ! Все действия по установке программного кода, которые описаны на сайте sape.ru выполнять не нужно. Требуется только правильно сконфигурировать данный плагин. После установки плагина, в менеджере сайта появиться специальный блок "Отображение ссылок с SAPE.RU".','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' => 'SAPE.RU link exchanger', 'ru' => 'Отображение ссылок с SAPE.RU' );
// Only one instance per config allowed
protected bool $isSingleInstance = TRUE;
// Version
protected string $version = '1.0';
/* Inherited Properties */
// 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
/* 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 7.0.0

• 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 bool $isSingleInstance

Only one instance per config allowed

protected string $version

Version