Include, Require и комментарии PHP

В этой статье мы рассмотрим:

  • Комментарии PHP;
  • Для чего использовать комментарии?;
  • PHP include и include_once;
  • Пример: include / include_once;
  • PHP require и require_once;
  • Пример: require;
  • Require по сравнению с Require_once.

Комментарии PHP

  • Комментарии помогают понять код;
  • Комментарии поясняют, что делает код;
  • Однострочный комментарий начинается с двойной косой черты // и заканчивается в конце строки:
php_single_comment
  • Комментарий из нескольких строк начинается с косой черты, за которой следует звездочка /*, и заканчиваются звездочкой и косой чертой */:
multi_line_comments

На приведенном ниже изображении показан PHP-файл с однострочным комментарием и комментарием из нескольких строк:

php_comments

PHP Include и PHP include_once

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

Синтаксис оператора include:

<?php
Include/include_once 'file_name';
?>

Где:

  • Include/include_once — это оператор, который подключает файл;
  • ‘file_name’ — имя подключаемого файла.

Пример: Include / Include_once

Предположим, что вы разрабатываете сайт, который содержит одинаковое меню навигации на всех страницах.

В этом случае можно создать общий header, а затем подключать его на каждой странице с помощью include path PHP. Давайте посмотрим, как это можно сделать.

Мы создадим для файла:

header.php
<a href="/index.php">Home</a>
<a href="/aboutus.php">About us</a>
<a href="/services.php">Services</a>
<a href="/contactus.php">Contact Us</a>
 index.php
<?php
include 'header.php';
?>

В результате использования include PHP путь к файлу будет выведен заголовок страницы.

PHP Require & PHP require_once

Оператор require имеет два варианта: require и require_once. Он также используется для подключения файлов.

Require_once игнорируется, если требуемый файл уже был добавлен любым из четырех операторов.

Он имеет следующий синтаксис:

<?php
require/require_once 'file_name';
?>

Где:

  • require/require_once — оператор подключения файла;
  • ‘file_name’ — файл, который должен быть подключен.

Разница между Include и Require

Include Require
Выдает предупреждение при возникновении ошибки. Не выдает предупреждение.
Выполнение скрипта продолжается при возникновении ошибки. Выполнение скрипта останавливается при возникновении ошибки.

Пример: Require

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

config.php
<?php
$config['host'] = 'localhost';
$config['db'] = 'my_database';
$config['uid'] = 'root';
$config['password'] = '';
?>

Рассмотрим пример подключения конфигурационного файла:

pages_model.php
<?php
require 'config.php'; //подключаем конфигурационный файл
// другой код для подключения к базе данных
?>

Require и Require_once

  • Заголовок, футер, сайдбар могут быть общими для многих страниц. Это позволяет изменять сайт, обновив один файл;
  • Параметры конфигурации базы данных, пользовательские функции могут быть общими для многих страниц, что позволяет обеспечить использование на сайте / в приложении одинаковых настроек;
  • Операторы PHP include или require используются для подключения файлов;
  • Include_once / require_once игнорируется, если запрашиваемый файл уже подключен с использованием любого из четырех операторов;
  • Оператор include выдает предупреждение и продолжает исполнение кода, если запрашиваемый файл не был найден;
  • Оператор require вызывает фатальную ошибку и останавливает выполнение скрипта;
  • В большинстве случаев должен использоваться оператор include, за исключением ситуаций, когда без запрашиваемого файла не может работать весь скрипт.

Заключение

  • Комментарии используются, чтобы помочь нам понять код;
  • Однострочные комментарии начинаются с двойной косой черты //;
  • Комментарии из нескольких строк заключены в /* */;
  • Операторы PHP include, include_once, require и require_once используются для подключения файлов;
  • Include_once / require_once игнорируются, если запрашиваемый файл уже подключен с использованием любого из четырех операторов;
  • Оператор include выдает предупреждение и продолжает исполнение кода, если запрашиваемый файл не был найден;
  • Оператор require вызывает фатальную ошибку и останавливает выполнение скрипта;
  • В большинстве случаев должен использоваться оператор include, за исключением ситуаций, когда без запрашиваемого файла не может работать весь скрипт.

Перевод статьи «PHP Include, Require & Comments» был подготовлен дружной командой проекта Сайтостроение от А до Я.