Метод getDocumentRoot класса \Bitrix\Main\Application возвращает путь к корневой директории вашего сайта. Это позволяет быстро и просто получить доступ к файлам и ресурсам, без необходимости прописывать жесткие пути. Особенно удобно при большом количестве модулей или при работе с несколькими средами — разработческой, демо и продакшен.
Вот как это работает:
\Bitrix\Main\Loader::getDocumentRoot();Пример результата: /home/bitrix/ext_www/site.ru
Преимущество очевидно: код становится чистым и легким в поддержке. Больше не нужно заморачиваться с вычислением абсолютных путей и создавать хаос в коде.
Еще одним явным преимуществом является одинаковый формат возвращаемого значения. Поясним: при использовании $_SERVER['DOCUMENT_ROOT'] значение может быть как со слешем на конце /home/bitrix/www/, так и без /home/bitrix/www из-за этого для корректной работы кода приходится делать проверки есть слеш на конце или нет или добавлять функцию rtrim() и т.д.. При использовании же указанного выше метода этого делать не требуется.
Если вы еще не используете этот метод, советуем попробовать. Это на самом деле улучшает разработку на Bitrix, и вы точно оцените удобство и простоту, которую он приносит.
Какие еще полезные методы вы знаете? Делитесь ими в комментариях , будет интересно узнать, что-то новое.