Для получения экземпляра этого класса используйте вызов метода wa->getConfig()
, например:
wa->getConfig()->getName();
Методы
-
getAppConfigPath
Возвращает путь к указанному конфигурационному файлу приложения.
-
getApplication
Возвращает идентификатор приложения.
-
getAppPath
Возвращает путь к директории с файлами приложения.
-
getConfigPath
Возвращает путь к конфигурационному файлу приложения.
-
getInfo
Возвращает информацию о приложении из файла
lib/config/app.php
. -
getName
Возвращает наименование приложения из файла
lib/config/app.php
. -
getOption
Возвращает значения параметров конфигурации приложения.
-
getPluginInfo
Возвращает информацию об установленном плагине приложения.
-
getPluginPath
Возвращает путь к файлам с исходным кодом установленного плагина приложения.
-
getPlugins
Возвращает информацию об установленных плагинах приложения.
-
setCount
Устанавливает или удаляет значение индикатора, отображаемого рядом с иконкой приложения в главном меню бекенда.
public function getAppConfigPath ($name)
Возвращает путь к указанному конфигурационному файлу приложения в директории lib/config/
.
Параметры
-
$name
Имя файла.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getAppConfigPath('routing');
Результат
/var/www/wa-apps/blog/lib/config/routing.php
public function getApplication()
Возвращает идентификатор приложения.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getApplication();
Результат
blog
public function getAppPath ($path = null)
Возвращает путь к директории с файлами приложения.
Параметры
-
$path
Необязательный путь к поддиректории внутри
wa-apps/[app_id]/lib/
.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getAppPath('templates/');
Результат
/var/www/wa-apps/blog/templates/
public function getConfigPath ($name, $user_config = true, $app = null)
Возвращает путь к конфигурационному файлу приложения.
Параметры
-
$name
Имя конфигурационного файла, путь к которому нужно получить.
-
$user_config
Флаг, обозначающий необходимо ли получить путь к файлу в директории
wa-config/apps/[app_id]/
, предназначенной для хранения пользовательской конфигурации. Если указано значениеfalse
, метод вернет путь к файлу с указанным именем в директорииwa-apps/[app_id]/lib/config/
. -
$app
Идентификатор приложения, путь к конфигурационному файлу которого необходимо получить. Если не указано, то используется идентификатор текущего приложения.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getConfigPath('routing.php', false);
Результат
/var/www/wa-apps/blog/lib/config/routing.php
public function getInfo ($name = null)
Возвращает информацию о приложении из файла lib/config/app.php
.
Параметры
-
$name
Имя параметра, значение которого необходимо вернуть. Если не указано, метод возвращает ассоциативный массив значений всех параметров из конфигурационного файла.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getInfo('name');
Результат
Blog
public function getName()
Возвращает наименование приложения из файла lib/config/app.php
.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getName();
Результат
Blog
public function getOption ($name = null)
Возвращает значения параметров конфигурации приложения.
Параметры
-
$name
Идентификатор параметра конфигурации, значение которого необходимо вернуть.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getOption('posts_per_page');
Результат
10
public function getPluginInfo ($plugin_id)
Возвращает информацию об установленном плагине приложения.
Параметры
-
$plugin_id
Идентификатор плагина.
Пример
$app_config = wa()->getConfig()->getAppConfig('shop'); $app_config->getPluginInfo('migrate');
Результат
Array ( [name] => Переход на Shop-Script [description] => Перенос данных с других платформ электронной коммерции в Shop-Script [img] => wa-apps/shop/plugins/migrate/img/migrate.png [vendor] => webasyst [version] => 1.0.0 [importexport] => 1 [handlers] => Array ( ) [id] => migrate )
public function getPluginPath ($plugin_id)
Возвращает путь к файлам с исходным кодом установленного плагина приложения.
Параметры
-
$plugin_id
Идентификатор плагина.
Пример
$app_config = wa()->getConfig()->getAppConfig('shop'); $app_config->getPluginPath('migrate');
Результат
/var/www/wa-apps/shop/plugins/migrate
public function getPlugins()
Возвращает информацию об установленных плагинах приложения.
Пример
$app_config = wa()->getConfig()->getAppConfig('blog'); $app_config->getPlugins();
Результат
Array ( [yandexmarket] => Array ( [name] => Яндекс.Маркет [description] => Экспорт каталога товаров в формате YML [img] => wa-apps/shop/plugins/yandexmarket/img/yandexmarket.png [vendor] => webasyst [version] => 1.2.0 [importexport] => profiles [export_profile] => 1 [frontend] => 1 [handlers] => Array ( [backend_products] => backendProductsEvent [routing] => routing ) [id] => yandexmarket ) [migrate] => Array ( [name] => Переход на Shop-Script [description] => Перенос данных с других платформ электронной коммерции в Shop-Script [img] => wa-apps/shop/plugins/migrate/img/migrate.png [vendor] => webasyst [version] => 1.0.0 [importexport] => 1 [handlers] => Array ( ) [id] => migrate ) )
public function setCount ($n = null)
Устанавливает или удаляет значение индикатора, отображаемого рядом с иконкой приложения в главном меню бекенда.
Параметры
-
$n
Значение индикатора. Если передано пустое значение, значение индикатора очищается.
Пример
$app_config = wa()->getConfig()->getAppConfig('shop'); $app_config->setCount(100);