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 .
Замечание: Поскольку это языковая конструкция, а не функция, она не может вызываться при помощи переменных функций.
set_include_path
Задаёт значение настройки конфигурации include_path на время выполнения скрипта.
Список параметров
Возвращаемые значения
Возвращает старое значение include_path в случае успешного выполнения или false в случае возникновения ошибки.
Примеры
Пример #1 Пример использования set_include_path()
// Или так
ini_set ( ‘include_path’ , ‘/usr/lib/pear’ );
?>
Пример #2 Составление более длинного пути include path
Используя константу PATH_SEPARATOR , можно добавить к пути вложенные директории независимо от операционной системы.
В этом примере мы добавим /usr/lib/pear в конец существующего пути include_path .
Смотрите также
- ini_set() — Устанавливает значение настройки конфигурации
- get_include_path() — Получение текущего значения настройки конфигурации include_path
- restore_include_path() — Восстанавливает изначальное значение настройки конфигурации include_path
- include — include
User Contributed Notes 1 note
If you find that this function is failing for you, and you’re not sure why, you may have set your php include path in your sites’s conf file in Apache (this may be true of .htaccess as well)
So to get it to work, comment out any «php_value include_path» type lines in your Apache conf file, and you should be able to set it now in your php code.
- Опции PHP/информационные функции
- assert_options
- assert
- cli_get_process_title
- cli_set_process_title
- dl
- extension_loaded
- gc_collect_cycles
- gc_disable
- gc_enable
- gc_enabled
- gc_mem_caches
- gc_status
- get_cfg_var
- get_current_user
- get_defined_constants
- get_extension_funcs
- get_include_path
- get_included_files
- get_loaded_extensions
- get_required_files
- get_resources
- getenv
- getlastmod
- getmygid
- getmyinode
- getmypid
- getmyuid
- getopt
- getrusage
- ini_alter
- ini_get_all
- ini_get
- ini_parse_quantity
- ini_restore
- ini_set
- memory_get_peak_usage
- memory_get_usage
- memory_reset_peak_usage
- php_ini_loaded_file
- php_ini_scanned_files
- php_sapi_name
- php_uname
- phpcredits
- phpinfo
- phpversion
- putenv
- set_include_path
- set_time_limit
- sys_get_temp_dir
- version_compare
- zend_thread_id
- zend_version
- get_magic_quotes_gpc
- get_magic_quotes_runtime
- restore_include_path
Пути для подключаемых файлов с помощью директивы include_path.Чтобы была возможность указывать одинаковые пути к подключаемым файлам независимо от нахождения файла со скриптом, в котором этот путь нужно получить, можно указать этот путь в директиве include_path.
Например есть папка «includes», а в ней файлы для подключения. Задав необходимые параметры для include_path, из скрипта любого файла вашего сайта можно будет получить нужный файл этой папки просто прописав его имя: require_once ‘файл.расширение’.include_path определяется в главном файле конфигурации php.ini. В ней указывается список директорий, в которых функции require, include, fopen(), file(), readfile() и file_get_contents() ищут файлы. Список директорий (папок) разделяется двоеточием в Unix или точкой с запятой в Windows.
Если вы используете сервер Apache. то директиву include_раth можете указать в глобальном файле конфигурации сервера (который обычно называется httpd.conf) или в файле конфигурации для конкретного каталога (который обычно называется .htaccess) воспользовавшись следующим синтаксисом:
php_value include_path ".:/usr/local/liЬ/php-libraries"
Если у вас нет прав доступа, необходимых для редактирования файла php.ini, или не хотите менять конфигурационный файл при переносах сайта — можете задать пути включения файлов, на время выполнения скрипта, прямо из сценария с помощью функции set_include_path().
Например нам нужно подключить файлы находящиеся в папке includes, которая в корне сайта:
$path = 'includes'; $result = set_include_path(get_include_path() . PATH_SEPARATOR . $path);
где $path – путь к нужной папке относительно точки входа (файла index.php)
Можно указать абсолютный путь:$path = $_SERVER['DOCUMENT_ROOT']. '/includes';
. PATH_SEPARATOR . realpath(dirname(__FILE__) . '/../includes')
где realpath() — преобразует относительный путь в абсолютный.
Также можно указывать вложенную папку, например $path = ‘includes/folder’;После этого, для подключения файлов, можно просто указывать их названия:
Вызвав get_include_path() мы добавили в начало списка данные, которые уже были в include_path,
потом идет разделитель и нужный путь.С помощью установки пути в include_path, из какого бы файла и папки не вызывался нужный файл, путь не изменится.
Можно также использовать ini_set (одно и тоже):
// Работает с версии PHP 4.3.0 set_include_path('/usr/lib/pear'); // Работает во всех версиях PHP ini_set('include_path', '/usr/lib/pear');set_include_path( get_include_path() . PATH_SEPARATOR . 'folder1' . PATH_SEPARATOR . 'folder2' . PATH_SEPARATOR . 'folder3'); spl_autoload_register( function( $class ) < include $class . '.php'; >);
Указывать директиву include_path в файле .htaccess не рекомендуется по следующим причинам:
— вы затрете пути, которые уже были в системе (например, каталог PEAR);
— при переносе сайта к другому хостеру придется изменять .htaccess, т.к. в директиве include_path указаны абсолютные пути к каталогам;
— из-за использования разных разделителей каталогов (в Unix (:), в Windows (;)) возникают проблемы при отладке скриптов на локальной машине)
Пути для подключаемых файлов с помощью директивы include_path.