Домашний каталог приложения: варианты конфигурации

Расширенные примеры определения корневого каталога

Ниже приведены подробные примеры с кодом и выводом, демонстрирующие различные подходы к получению домашнего каталога приложения.

Пример 1: Использование __DIR__ и dirname для навигации по структуре

Предположим, структура проекта:

project/
  public/
    index.php
  src/
    Core/
      App.php
  config/
    app.php

В файле public/index.php:

<?php
define('APP_ROOT', dirname(__DIR__));
echo "Корень проекта: " . APP_ROOT;

// Подключение файла из папки config
require APP_ROOT . '/config/app.php';
?>

Вывод при запуске через веб-сервер:

Корень проекта: /var/www/project

Пояснение: __DIR__ в index.php равен /var/www/project/public, вызов dirname(__DIR__) возвращает родительский каталог, что и является корнем.

Пример 2: Определение корня через realpath при работе с симлинками

Предположим, что папка project является символической ссылкой на /data/app/releases/v2. Файл bootstrap.php:

<?php
$baseDir = dirname(__FILE__);
echo "Директория bootstrap.php через __FILE__: $baseDir\n";
$realDir = realpath($baseDir);
echo "Реальный путь bootstrap.php через realpath: $realDir\n";
$appRoot = dirname($realDir, 2);  // поднимаемся на два уровня
echo "Корень приложения (через realpath): $appRoot\n";
?>

Результат выполнения:

Директория bootstrap.php через __FILE__: /var/www/current/app
Реальный путь bootstrap.php через realpath: /data/app/releases/v2/app
Корень приложения (через realpath): /data/app/releases/v2

Пояснение: realpath() разрешает символические ссылки, что может быть полезно для точного определения физического расположения, но если требуется сохранить символическую ссылку, следует использовать __FILE__ без realpath.

Пример 3: Загрузка корневого пути из .env файла с помощью phpdotenv

Файл .env в корне проекта:

APP_ROOT=/var/www/project

Файл config/load.php:

<?php
require __DIR__ . '/../vendor/autoload.php';

use Dotenv\Dotenv;

$dotenv = Dotenv::createImmutable(__DIR__ . '/..');
$dotenv->load();

define('APP_ROOT', $_ENV['APP_ROOT']);
echo "Корень из .env: " . APP_ROOT . "\n";

// Проверка существования директории
if (!is_dir(APP_ROOT)) {
    echo "Ошибка: указанный корень не существует.\n";
    exit(1);
}
?>

Вывод:

Корень из .env: /var/www/project

Пояснение: использование .env позволяет централизованно задать корень для всех сред (локальной, тестовой, продакшн). При отсутствии файла .env следует предусмотреть значение по умолчанию.

Пример 4: Автоматическое определение корня через Composer и автозагрузку

В файле composer.json можно указать пространства имён, привязанные к src/, а корень определить через автозагрузчик.

// composer.json
{
    "autoload": {
        "psr-4": {
            "App\\": "src/"
        }
    }
}

В файле public/index.php:

<?php
require __DIR__ . '/../vendor/autoload.php';

// Получаем путь к директории vendor как отправную точку
$vendorDir = dirname(__DIR__) . '/vendor';
define('APP_ROOT', dirname($vendorDir));
echo "Корень (через vendor): " . APP_ROOT . "\n";

// Альтернативно: через ReflectionClass для класса Composer\Autoload\ClassLoader
$ref = new ReflectionClass('Composer\\Autoload\\ClassLoader');
$appRoot = dirname(dirname($ref->getFileName()));
echo "Корень (через Reflection): " . $appRoot . "\n";
?>

Результат:

Корень (через vendor): /var/www/project
Корень (через Reflection): /var/www/project

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

Пример 5: Определение корня в CLI-сценариях и универсальная функция

Файл bin/console (CLI скрипт):

#!/usr/bin/env php
<?php
// Функция для определения корня
function getAppRoot(): string {
    // 1 пробуем из переменной окружения
    $root = getenv('APP_ROOT');
    if ($root !== false) return $root;
    
    // 2 пробуем DOCUMENT_ROOT
    if (isset($_SERVER['DOCUMENT_ROOT'])) {
        return $_SERVER['DOCUMENT_ROOT'];
    }
    
    // 3 определяем через __DIR__ (скрипт находится в bin/)
    return dirname(__DIR__);
}

define('APP_ROOT', getAppRoot());
echo "Корень приложения (CLI): " . APP_ROOT . "\n";
?>

Запуск:

php bin/console

Вывод (если APP_ROOT не задан):

Корень приложения (CLI): /var/www/project

Пояснение: функция проверяет несколько источников, начиная с переменной окружения, затем веб-переменную и, наконец, использует __DIR__. Это обеспечивает совместимость как с CLI, так и с веб-окружением.