Конфигурационные файлы фреймворка

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

Все конфигурационные файлы фреймворка являются файлами PHP. Кроме редких исключений, конфигурационный файл представляет собой PHP-код возврата именованного массива параметров следующего вида:

<?php

return [
    'param_1' => 'value_1',
    'param_2' => 'value_2',
  ...
];

Эти файлы находятся в директории wa-config/.

apps.php

Файл apps.php содержит список установленных приложений и управляет «видимостью» этих приложений в бекенде.

Пример файла apps.php:

<?php

return [
    'contacts' => true,
    'stickies' => true,
    'guestbook' => true,
    'installer' => true
];

APP_ID установленных приложений являются ключами именованного массива. Значение true для ключа является инструкцией системе отображать иконку и название приложения в бекенде фреймворка.

Файл routing.php

Общесистемный файл маршрутизации распределяет адресное пространство фронтенда между приложениями.

Пример системного файла routing.php:

<?php

return [
    'site.ru' => [
        ['url' => 'blog*', 'app' => 'blog'],
        ['url' => 'shop*', 'app' => 'shop'],
        ['url' => 'guestbook/*', 'app' => 'guestbook'],
        ['url' => '*', 'app' => 'site'],
    ],
];
Подробнее о маршрутизации фронтенда см. раздел « Маршрутизация запросов на фронтенд».

db.php

Файл db.php хранит настройки подключения к базе данных.

Пример файла db.php:

<?php

return [
    'default' => [
        'type' => 'mysql',
        'host' => 'localhost',
        'user' => 'wafw',
        'password' => 'super-parol',
        'database' => 'wafw'
    ],
];

config.php

Файл config.php хранит некоторые системные настройки.

Пример файла config.php:

<?php

return [
    'debug' => true,
    'backend_url' => 'admin',
    'mod_rewrite' => true,
];

Список некоторых возможных параметров в файле config.php:

  • debug — допустимые значения: true / false. Включает / выключает отображение подробной информации об ошибках выполнения скриптов. Для разработки приложений рекомендуется установить этот параметр true.
  • backend_url — путь к бекенду от корня установки фреймворка. Значение по умолчанию: webasyst.
  • mod_rewrite — допустимые значения: true / false. Определяет, установлен ли на сервере mod_rewrite. Этот параметр определяется автоматически на этапе установки.
  • default_host_domain — домен по умолчанию, который должны использовать системные классы фреймворка в случаях, когда не удаётся автоматически определить текущий домен, на котором установлен фреймворк. Например, при выполнении CLI-контроллеров.
  • default_root_url — корневой URL по умолчанию, который должны использовать системные классы фреймворка в случаях, когда не удаётся автоматически определить корневой URL, на котором доступен фреймворк.
  • image_adapter — идентификатор механизма обработки изображений, выбранного в системных настройках.
  • trusted_proxies — массив IP-адресов прокси-серверов, используемых на хостинге, при обнаружении любого из которых в значении серверной переменной REMOTE_ADDR настоящий IP-адрес пользователя определяется альтернативными способами, например, из переменной HTTP_X_FORWARDED_FOR.
  • disable_mail_ssl_until — строка, поддерживаемая функцией strtotime(), для обозначения времени, до которого отключена проверка SSL-сертификатов для подключения к серверам электронной почты. Может использоваться для временного доступа к заведомо безопасному почтовому серверу с нарушенной настройкой сертификатов.

net.php

Файл net.php содержит параметры по умолчанию для подключения к удалённым ресурсам с использованием класса waNet.

Шаблон для составления файла net.php:

[
    'timeout'             => 15,
    'verify'              => true,
    'md5'                 => false,
    'log'                 => false,
    'proxy_host'          => null,
    'proxy_port'          => null,
    'proxy_user'          => null,
    'proxy_password'      => null,
    'interface'           => null,
    'priority'            => [
        'curl',
        'fopen',
        'socket',
    ],
    'ssl'                 => [
        'key'      => '',
        'password' => '',
        'cert'     => '',
    ],
];

В файле нужно оставить только те элементы массива, с помощью которых нужно переопределить стандартные значения, указанные в поле options класса waNet.

Описания элементов массива

  • timeout — период времени в секундах, в течение которого будет выполняться ожидание ответа.
  • verify — флаг проверки SSL-сертификата запрашиваемого ресурса.
  • md5 — флаг отправки заголовка Content-MD5.
  • log — имя лог-файла, в который должны сохраняться сообщения об ошибках.
  • proxy_host — имя хоста прокси-сервера.
  • proxy_port — номер порта для подключения к прокси-серверу.
  • proxy_user — имя пользователя для подключения к прокси-серверу.
  • proxy_password — пароль для подключения к прокси-серверу.
  • interface — имя используемого сетевого интерфейса для подключения через curl.
  • priority — массив для определения приоритета использования методов подключения к удалённому ресурсу; используется первый метод в указанном списке, который поддерживается запрашиваемым ресурсом.
  • ssl — параметры закрытого ключа SSL для подключения через curl:
    • key — имя файла с закрытым ключом
    • password — пароль для использования закрытого ключа
    • cert — имя файла с PEM-сертификатом