Функция include PHP – расширяем возможности своего ресурса
От автора: многие «чайники», впервые окунувшись «с ушами» в изучение веб-программирования, наивно тешат себя надеждой, что любой разрабатываемый ресурс поместится на одной странице. Но это не так: современный сайт состоит из десятков страниц, связанных между собой. Все файлы проекта можно сравнить с вагонами поезда. При необходимости можно убрать лишний, а при нехватке – удлинить «программный» состав еще на один. Для «сцепки» файлов используется функция include PHP.
Зачем нужен прицеп?
Ну, чтобы можно было больше загрузить и перевезти. По такому же принципу поступают и в PHP: если нужно «нагрузить» на свой сайт контента или функционала, то придется «прицеплять» еще один вагон (точнее, файл), и в нем размещать дополнительный груз. При этом в качестве прицепного устройства выступает функция include().
С ее помощью можно легко изменять структуру веб-проекта путем замены одного файла на другой. На таком принципе базируется все современное сайтостроение. Каждая составная часть ресурса или веб-страница размещается в отдельном файле. Это также значительно снижает общий вес всего программного кода. Не совсем понятно? Тогда давайте разберемся на практическом примере. Повторяйте за мной:
Создайте 3 файла с расширениями .php. Назовите их header, footer, content и разместите в одной папке на серверном пространстве.
Создайте еще один файл PHP и назовите его index.
Курс «PHP-разработчик с нуля»
— Научитесь создавать сайты и веб-приложения на языке PHP.
— Изучите актуальные фреймворки Laravel, Simfony и Yii2.
— 78 часов теории и 361 час практики.
— Вы создадите 5 масштабных проектов для портфолио.
— Помощь с поиском работы или стажировки.
Курс «SQL и получение данных»
— Освоите один из основных инструментов работы с данными.
— 20 часов теории, 32 часа практики.
— Видеолекции, вебинары, практические задания и тренажёр.
— Выполните 6 домашних работ и итоговый проект.
— Помощь с поиском работы или стажировки.
Курс «веб-разработчик с нуля»
— Научитесь программировать на JavaScript и PHP.
— Сможете создавать сайты и веб-приложения.
— Сможете уверенно работать и с фронтендом, и с бэкендом веб-сервисов.
— Выполните 9 масштабных проектов для портфолио
— Помощь с поиском работы или стажировки.
В каждый из первых трех файлов вставьте соответствующие (их названию) строки кода:
На данном этапе у вас должно быть 4 файла:
В index.php поместите следующий код:
Откройте index.php в браузере. Вот что вы должны увидеть:
Вот так с помощью include «собираются» настоящие сайты. Такие ресурсы в отличие от обычных (на HTML) генерируются «налету» и называются динамическими. Функция include обеспечивает взаимосвязь всех частей дизайна и функционала в динамических сайтах.
Каждый из файлов нашего демонстрационного проекта можно легко заменить на другой или подключить его на любой веб-странице ресурса с помощью данной функции.
В PHP существует еще одна конструкция для подключения файлов – require. Но зачем такому глубокоуважаемому языка, как PHP две одинаковых функции с разными названиями и одинаковым результатом выполнения? Вот несколько отличий между include и require:
Код файлов, подключенных с помощью require, обрабатывается интерпретатором еще на этапе запуска. А код, связываемый через include, обрабатывается после того, как внутренний указатель интерпретатора доходит до строки с этой функцией.
Из-за выше описанной особенности require больше подходит для связывания файлов динамически создаваемых ресурсов, а include – для подключения сторонних библиотек.
Include позволяет подключать не только локальные, но и удаленные файлы проекта. Благодаря чему эта функция чаще всего используется в облачных технологиях.
При возникновении сбоя в коде require полностью остановит выполнение программы и выдаст сообщение об ошибке. При использовании функции include программный код продолжает выполняться, а PHP выведет только предупреждение.
Последний «постулат» я поясню на примере использования include внутри пользовательской функции PHP. Для этого немного преобразуем код в index.php:
include
Выражение include включает и выполняет указанный файл.
Документация ниже также относится к выражению require .
Файлы включаются исходя из пути указанного файла, или, если путь не указан, используется путь, указанный в директиве include_path. Если файл не найден в include_path, include попытается проверить директорию, в которой находится текущий включающий скрипт и текущую рабочую директорию перед тем, как выдать ошибку. Конструкция include выдаст warning, если не сможет найти файл; поведение отлично от require , который выдаст фатальную ошибку.
Если путь указан — не важно, абсолютный (начинающийся с буквы диска или с \ в Windows или с / в Unix/Linux системах) или относительно текущей директории (начинающийся с . или ..) — директива include_path будет проигнорирована в любом случае. К примеру, если начинается с ../, парсер проверит родительскую директорию на наличие запрошенного файла.
Для большей информации о том, как PHP обрабатывает включаемые файлы и включаемые пути, смотрите документацию для директивы include_path.
Когда файл включается, его код наследует ту же область видимости переменных, что и строка, на которой произошло включение. Все переменные, доступные на этой строке во включающем файле будут также доступны во включаемом файле. Однако все функции и классы, объявленные во включаемом файле, будут доступны в глобальной области видимости.
Пример #1 Простой пример include
$color = ‘green’ ;
$fruit = ‘apple’ ;
echo «A $color $fruit » ; // A green apple
Если включение происходит внутри функции включающего файла, тогда весь код, содержащийся во включаемом файле, будет вести себя так, как будто он был определен внутри этой функции. То есть, он будет в той же области видимости переменных этой функции. Исключением к этому правилу являются магические константы, которые выполняются парсером перед тем, как происходит включение.
Пример #2 Включение внутри функции
function foo ()
global $color ;
/* vars.php в той же области видимости, что и foo(), *
* поэтому $fruit НЕ доступен снаружи этой области *
* $color доступен, поскольку мы переменную глобальной */
foo (); // A green apple
echo «A $color $fruit » ; // A green
Когда файл включается, парсинг в режиме PHP кода прекращается и переключается в режим HTML в начале указанного файла и продолжается снова в конце. По этой причине любой код внутри включаемого файла, который должен быть выполнен как PHP код, должен быть заключен в верные теги начала и конца PHP кода.
Если «обертки URL include» включены в PHP, вы можете также указать файл для включения через URL (с помощью HTTP или других поддерживающихся обработчиков — смотри Поддерживаемые протоколы и обработчики (wrappers) для списка протоколов) вместо локального пути. Если целевой сервер интерпретирует указанный файл как PHP код, могут быть переданы переменные во включаемый файл с помощью строки URL-запроса, как если бы использовался метод HTTP GET. Это, строго говоря, не тоже самое, что включение файла и наследование родительской области видимости; скрипт выполняется на удаленном сервере и результат выполнения включается в локальный скрипт.
Версии PHP для Windows до PHP 4.3.0 не поддерживают возможность использования удаленных файлов этой функцией даже в том случае, если включена опция allow_url_fopen.
Пример #3 Пример include через HTTP
/* В этом примере предполагается, что www.example.com настроен на обработку .php
* файлов, но не .txt. Также, ‘Works’ обозначает, что переменные
* $foo и $bar доступны внутри включаемого файла. */
// Не сработает; file.txt не обрабатывается www.example.com как PHP
include ‘http://www.example.com/file.txt?foo=1&bar=2’ ;
// Сработает.
include ‘http://www.example.com/file.php?foo=1&bar=2’ ;
$foo = 1 ;
$bar = 2 ;
include ‘file.txt’ ; // Сработает.
include ‘file.php’ ; // Сработает.
Предупреждение безопасности
Удаленные файлы могут быть обработаны на удаленной стороне (в зависимости от расширения файла и того, что удаленный сервер выполняет скрипты PHP или нет), но это все равно должно производить валидный PHP скрипт, потому что он будет затем обработан уже на локальном сервере. Если файл с удаленного сервера должен быть обработан там и выведен его результат, предпочтительнее воспользоваться функцией readfile() В противном случае, должны быть предусмотрены дополнительные меры, чтобы обезопасить удаленный скрипт от ошибок и нежелательного кода.
Смотрите также раздел Удаленные файлы, функции fopen() и file() для дополнительной информации.
Обработка возвращаемых значений: оператор include возвращает значение FALSE при ошибке и выдает предупреждение. Успешные включения, пока это не переопределено во включаемом файле, возвращают значение 1. Возможно выполнить выражение return внутри включаемого файла, чтобы завершить процесс выполнения в этом файле и вернуться к выполнению включающего файла. Также, возможно вернуть значение из включаемых файлов. Вы можете получить значение включения как если бы вы вызвали обычную функцию. Хотя это не возможно при включении удаленного файла, только если вывод удаленного файла не содержит правильные теги начала и конца PHP кода (так же, как и локальный файл). Вы можете определить необходимые переменные внутри этих тегов и они будут представлены в том месте, где файл был включен.
Так как include — это специальная языковая конструкция, круглые скобки не обязательны для заключения аргумента. Будьте осторожны при сравнении возвращаемого значения.
Пример #4 Сравнение возвращаемого значения при include
// не сработает, интерпретируется как include((‘vars.php’) == ‘OK’), т.е. include(»)
if (include( ‘vars.php’ ) == ‘OK’ ) echo ‘OK’ ;
>
// сработает
if ((include ‘vars.php’ ) == ‘OK’ ) echo ‘OK’ ;
>
?>
Пример #5 Выражения include и return
$bar имеет значение 1, т.к. включение файла произошло успешно. Заметьте разницу между примерами сверху. Первый использует return внутри включаемого файла, тогда как второй не использует. Если файл не может быть включен, возвращается FALSE и возникает E_WARNING .
Если во включаемом файле определены функции, они могут быть использованы в главном файле вне зависимости от того, были ли они объявлены до return или после. Если файл включается дважды, PHP 5 выдаст фатальную ошибку, потому что функции уже были определены, в то время как PHP 4 не обратил бы внимания на функции, определенные после return . Рекомендуется использовать include_once вместо того, чтобы проверять был ли уже файл включен ранее.
Другой путь «включить» PHP файл в переменную — это захватить вывод используя Функции контроля вывода с include. К примеру:
Пример #6 Использование буферизированного вывода для включения PHP файла в строку
$string = get_include_contents ( ‘somefile.php’ );
function get_include_contents ( $filename ) if ( is_file ( $filename )) ob_start ();
include $filename ;
return ob_get_clean ();
>
return false ;
>
Для того, чтобы включать файлы автоматически в скрипты, обратите внимание на конфигурационные директивы auto_prepend_file и auto_append_file в php.ini .
Замечание: Поскольку это языковая конструкция, а не функция, она не может вызываться при помощи переменных функций.