waPlugin

Базовый класс плагина приложения

Содержание...

Класс waPlugin используется для создания плагинов к приложениям Webasyst. Основной класс плагина должен быть унаследован от базового класса waPlugin или его наследника, например, от класса shopPlugin в приложении Shop-Script.

Методы

protected function addCss ($url, $is_plugin = true)

Добавляет URL CSS-файла в список файлов, возвращаемых методом {$wa->css()}.

Параметры

Пример

//относительно корневой директории плагина
$this->addCss('css/backend.css');
//абсолютный
$this->addCss(wa()->getConfig()->getRootUrl(true).'wa-content/css/wa/design.css', false);

protected function addJs ($url, $is_plugin = true)

Добавляет URL JavaScript-файла в список файлов, возвращаемых методом {$wa->js()}.

Параметры

Пример

//относительно корневой директории плагина
$this->addJs('js/backend.js');
//абсолютный
$this->addJs(wa()->getConfig()->getRootUrl(true).'wa-content/js/jquery-wa/editor.js', false);

public function getId()

Возвращает ID плагина.

Пример

$plugin_id = wa('someapp')->getPlugin('myplugin')->getId();

public function getName()

Возвращает локализованное название плагина.

Пример

$plugin_name = wa('someapp')->getPlugin('myplugin')->getName();

public function getPluginStaticUrl ($absolute = false)

Возвращает URL корневой директории плагина.

Параметры

Пример

//относительный
$plugin_url = wa('someapp')->getPlugin('myplugin')->getPluginStaticUrl();
//абсолютный
$plugin_url = wa('someapp')->getPlugin('myplugin')->getPluginStaticUrl(true);

Результат

'/wa-apps/someapp/plugins/myplugin/'
'https://mydomain.ru/wa-apps/someapp/plugins/myplugin/'

public function getSettings ($name = null)

Возвращает информацию о настройках плагина, описанных в конфигурационном файле settings.php.

Параметры

Пример

//все настройки
wa('someapp')->getPlugin('myplugin')->getSettings()
//одна настройка
wa('someapp')->getPlugin('myplugin')->getSettings('some_setting')

public function getVersion()

Возвращает номер версии плагина. Информация о версии извлекается из конфигурационного файла plugin.php. Если в этом файле есть значение с ключом 'build', то к номеру версии добавляется точка со значением этого параметра.

Пример

$plugin_version = wa('someapp')->getPlpugin('myplugin')->getVersion();

Результат

//без 'build'
1.2.4
//с 'build'
1.2.4.382