Конфигурация¶

Загрузка дополнительных файлов конфигурации¶

Если ваше приложение имеет множество параметров конфигурации, может быть полезно разделить конфигурацию на несколько файлов. После создания каждого из файлов в вашем каталоге config/, вы можете загрузить их в bootstrap.php:

use Cake\Core\Configure;
use Cake\Core\Configure\Engine\PhpConfig;

Configure::config('default', new PhpConfig());
Configure::load('app', 'default', false);
Configure::load('other_config', 'default');

Вы также можете использовать дополнительные файлы конфигурации для обеспечения переопределения среды. Каждый файл, загруженный после app.php, может переопределять ранее объявленные значения, позволяющие настраивать конфигурацию для среды разработки или промежуточного уровня.

Общая конфигурация¶

Ниже приведено описание переменных и их влияние на приложение CakePHP.

debug

Изменяет вывод отладки CakePHP. false = Режим производства. Не отображаются сообщения об ошибках, ошибки или предупреждения. true = показаны ошибки и предупреждения.

App.namespace

Пространство имён для поиска классов приложений.

Примечание

При изменении пространства имён в вашей конфигурации, вам также понадобится обновить файл composer.json, чтобы использовать это пространство имён. Кроме того, создайте новый автозагрузчик, запустив php composer.phar dumpautoload.

App.baseUrl

Не раскомментируйте это определение, если не планируете использовать Apache mod_rewrite с CakePHP. Не забудьте также удалить файлы .htaccess.

App.base

Базовый каталог, в котором находится приложение. Если false, то он будет обнаружен автоматически. Если не false, убедитесь, что ваша строка начинается с / и не заканчивается символом /. Например, /basedir является допустимым App.base. В противном случае AuthComponent не будет работать должным образом.

App.encoding

Определите, какую кодировку использует ваше приложение. Эта кодировка используется для генерации кодировки в макете и кодирования объектов. Она должна соответствовать значениям кодировки, указанным для вашей базы данных.

App.webroot

Каталог webroot.

App.wwwRoot

Путь к webroot.

App.fullBaseUrl

Полноценное доменное имя (включая протокол) к корню вашего приложения. Это используется при создании абсолютных URL-адресов. По умолчанию это значение генерируется с использованием среды $_SERVER. Однако вы должны определить его вручную для оптимизации производительности или если вас беспокоят люди, манипулирующие заголовком Host. В контексте CLI (из оболочек) fullBaseUrl не может быть прочитан из $_SERVER, так как нет веб-сервера. Вам нужно указать его самостоятельно, если вам нужно создать URL-адреса из оболочки (например, при отправке писем).

App.imageBaseUrl

Веб-путь к каталогу общих изображений в webroot. Если вы используете CDN, вы должны установить это значение для местоположения CDN.

App.cssBaseUrl

Веб-путь к каталогу общих css в webroot. Если вы используете CDN, вы должны установить это значение для местоположения CDN.

App.jsBaseUrl

Веб-путь к каталогу общих js в webroot. Если вы используете CDN, вы должны установить это значение для местоположения CDN.

App.paths

Настроить пути для ресурсов, не связанных с классом. Поддерживает разделы plugins, templates, locales, которые позволяют определять пути для плагинов, просматривать шаблоны и файлы локали соответственно.

Security.salt

Случайная строка, используемая в хешировании. Это значение также используется в качестве соли HMAC при выполнении симметричного шифрования.

Asset.timestamp

Добавляет временную метку, которая является временем последнего изменения конкретного файла в конце URL-адресов файлов ресурсов (CSS, JavaScript, изображений) при использовании правильных помощников. Допустимые значения:

• (bool) false - Не делает ничего (по умолчанию)

• (bool) true - Добавляет метку времени, когда debug является true

• (string) „force“ - Всегда добавляет метку времени.

Настройка базы данных¶

См. раздел Настройка БД для получения информации о настройке соединений с базой данных.

Конфигурация кэширования¶

См. раздел Настройка кэширования для получения информации о настройке кэширования.

Конфигурация ошибок и исключений¶

См. раздел Ошибки и настройка исключений для получения информации о настройке ошибок и обработчиков исключений.

Конфигурация логирования¶

См. раздел Logging Configuration для получения информации о настройке ведения журнала в CakePHP.

Настройка электронной почты¶

См. раздел Настройка эл. почты для получения информации о настройке пресетов электронной почты в CakePHP.

Настройка сеанса(сессии)¶

См. раздел Настройка сессии для получения информации о настройке обработки сеанса в CakePHP.

Конфигурация маршрутизации¶

См. раздел Настройка маршрутизации для получения дополнительной информации о настройке маршрутизации и создании маршрутов для вашего приложения.

Плагин, Шаблон просмотра и локальные пути¶

Поскольку плагины, шаблоны представлений и локали не являются классами, у них не может быть настроен автозагрузчик. CakePHP предоставляет три параметра Configure для настройки дополнительных путей для этих ресурсов. В вашем config/app.php вы можете установить эти переменные:

return [
    // Дополнительная конфигурация
    'App' => [
        'paths' => [
            'plugins' => [
                ROOT . DS . 'plugins' . DS,
                '/path/to/other/plugins/'
            ],
            'templates' => [
                APP . 'Template' . DS,
                APP . 'Template2' . DS
            ],
            'locales' => [
                APP . 'Locale' . DS
            ]
        ]
    ]
];

Пути должны заканчиваться разделителем каталогов, иначе они не будут работать должным образом.

Запись данных конфигурации¶

static Cake\Core\Configure::write($key, $value)¶

Используйте write() для хранения данных в конфигурации приложения:

Configure::write('Company.name','Pizza, Inc.');
Configure::write('Company.slogan','Pizza for your body and soul');

Вышеприведённый пример также может быть записан одним вызовом:

Configure::write('Company', [
    'name' => 'Pizza, Inc.',
    'slogan' => 'Pizza for your body and soul'
]);

Вы можете использовать Configure::write('debug', $bool) для переключения между режимами отладки и производства на лету. Это особенно удобно для взаимодействия JSON, где отладочная информация может вызвать проблемы с анализом.

Чтение данных конфигурации¶

static Cake\Core\Configure::read($key = null, $default = null)¶

Используется для чтения данных конфигурации из приложения. Если ключ предоставляется, данные возвращаются. Используя наши вышеизложенные примеры из write(), мы можем прочитать возвращаемые данные:

// Возвращает 'Pizza Inc.'
Configure::read('Company.name');

// Возвращает 'Pizza for your body and soul'
Configure::read('Company.slogan');

Configure::read('Company');
// Возвращает:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

// Возвращает 'fallback' как Company.nope не определен.
Configure::read('Company.nope', 'fallback');

Если $key оставлено в null, все значения в Configure будут возвращены.

static Cake\Core\Configure::readOrFail($key)¶

Читает данные конфигурации так же, как Cake\Core\Configure::read, но ожидает найти пару ключ/значение. Если запрошенная пара не существует, будет выброшено RuntimeException:

Configure::readOrFail('Company.name');    // Принесёт: 'Pizza, Inc.'
Configure::readOrFail('Company.geolocation');  // Бросает исключение

Configure::readOrFail('Company');

// Принесёт:
['name' => 'Pizza, Inc.', 'slogan' => 'Pizza for your body and soul'];

Проверка наличия определенных данных конфигурации¶

static Cake\Core\Configure::check($key)¶

Используется для проверки наличия ключа/пути и имеет ненулевое значение:

$exists = Configure::check('Company.name');

Удаление данных конфигурации¶

static Cake\Core\Configure::delete($key)¶

Используется для удаления информации из конфигурации приложения:

Configure::delete('Company.name');

Чтение и удаление данных конфигурации¶

static Cake\Core\Configure::consume($key)¶

Прочтите и удалите ключ из Configure. Это полезно, если вы хотите объединить чтение и удаление значений в одной операции.

Загрузка файлов конфигурации¶

static Cake\Core\Configure::load($key, $config = 'default', $merge = true)¶

После того, как вы подключили конфигурационный движок к Configure, вы можете загрузить файлы конфигурации:

// Загрузите файл my_file.php с помощью объекта 'default', движка.
Configure::load('my_file', 'default');

Загруженные файлы конфигурации объединяют свои данные с существующей конфигурацией времени выполнения в Configure. Это позволяет вам перезаписывать и добавлять новые значения в существующую конфигурацию времени выполнения. Установив $merge в true, значения не будут перезаписывать существующую конфигурацию.

Создание или изменение файлов конфигурации¶

static Cake\Core\Configure::dump($key, $config = 'default', $keys = [])¶

Сбрасывает все или некоторые данные в Configure в файл или систему хранения, поддерживаемые механизмом конфигурации. Формат сериализации определяется механизмом конфигурации, прикрепленным в виде $config. Например, если „по умолчанию“ движком является Cake\Core\Configure\Engine\PhpConfig, сгенерированный файл будет файлом конфигурации PHP, загружаемым с помощью Cake\Core\Configure\Engine\PhpConfig.

Учитывая, что движок „по умолчанию“ является экземпляром PhpConfig, сохраните все данные в Configure в файле my_config.php:

Configure::dump('my_config', 'default');

Сохранять только конфигурацию обработки ошибок:

Configure::dump('error', 'default', ['Error', 'Exception']);

Configure::dump() можно использовать для изменения или перезаписывания файлов конфигурации, которые читаются с помощью Configure::load().

Сохранение конфигурации времени выполнения¶

static Cake\Core\Configure::store($name, $cacheConfig = 'default', $data = null)¶

Вы также можете сохранять значения конфигурации времени выполнения для использования в будущем запросе. Поскольку configure только запоминает значения для текущего запроса, вам необходимо сохранить любую измененную конфигурационную информацию, если вы хотите использовать ее в последующих запросах:

// Сохраните текущую конфигурацию в ключе 'user_1234' в кеше 'default'.
Configure::store('user_1234', 'default');

Сохранённые данные конфигурации сохраняются в конфигурации именованного кеша. Для получения дополнительной информации о кешировании см. документацию по кешированию Кэширование.

Восстановление конфигурации времени выполнения¶

static Cake\Core\Configure::restore($name, $cacheConfig = 'default')¶

Как только вы сохраните конфигурацию во время выполнения, вам, вероятно, потребуется восстановить её, чтобы вы снова могли получить к ней доступ. Configure::restore() именно это и делает:

// Восстановить конфигурацию времени выполнения из кеша.
Configure::restore('user_1234', 'default');

При восстановлении информации о конфигурации важно восстановить её с помощью того же ключа и конфигурации кэша, которая использовалась для её хранения. Восстановленная информация объединяется поверх существующей конфигурации времени выполнения.

Конфигурационные двигатели¶

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

• JsonConfig

• IniConfig

• PhpConfig

По умолчанию ваше приложение будет использовать PhpConfig.

Application::bootstrap()¶

В дополнение к config/bootstrap.php, который должен использоваться для настройки проблем низкого уровня вашего приложения, вы также можете использовать хук-метод Application::bootstrap() для загрузки/инициализации плагинов, и присоединить глобальных слушателей событий:

// в src/Application.php
namespace App;

use Cake\Core\Plugin;
use Cake\Http\BaseApplication;

class Application extends BaseApplication
{
    public function bootstrap()
    {
        // Вызовите родителя для `require_once` config/bootstrap.php
        parent::bootstrap();

        Plugin::load('MyPlugin', ['bootstrap' => true, 'routes' => true]);
    }
}

Загрузка плагинов/событий в Application::bootstrap() делает Controller Integration Testing проще, поскольку события и маршруты будут переработаны для каждого метода тестирования.