Типи, include і require: код у кількох файлах
Що ви дізнаєтесь
- Як указати типи параметрів і результату:
int,string,array,?string,void - Що вмикає
declare(strict_types=1)і коли PHP зупиняється зTypeError - Чим відрізняються
require,includeіrequire_once - Як файл повертає дані через
return [...]і навіщо в шляхах__DIR__ - Чому функції, дані й шаблони шапки й підвалу лежать поза
src/public/
У лекції «Функції: параметри і return» функції приймали будь-що: ticketPrice("сорок") без жодної помилки повертає 50. І жили вони у файлі сторінки, тож друга сторінка мусила б їх копіювати. Типи відсіюють неправильні значення ще на вході у функцію, а require підключає один файл із функціями на кожній сторінці.
Типи параметрів і результату
Тип пишуть перед параметром, а тип результату — після дужок, через двокрапку. Файл types.php:
<?php
declare(strict_types=1);
function priceTag(string $name, int $price): string
{
return "$name — $price грн";
}
function findCity(array $profile): ?string
{
return $profile["city"] ?? null; // ключа немає — null
}
function printLine(string $text): void
{
echo $text, "\n"; // нічого не повертає
}
printLine(priceTag("Чай", 40)); // Чай — 40 грн
var_dump(findCity(["name" => "Олена"])); // NULL
printLine(priceTag("Чай", "40")); // TypeError: "40" — рядок
Типи ті самі, що в лекції «Типи даних, рядки і перетворення типів»: int, float, string, bool, а ще array. Знак питання, ?string, означає «рядок або null»: міста в профілі може й не бути. void — функція нічого не повертає: return; у ній можна, а return $x; — ні. Поверне функція не той тип — PHP зупиниться з повідомленням Return value must be of type int, string returned. Довідка — на php.net.
strict_types і TypeError
Рядок declare(strict_types=1); одразу після <?php вмикає строгий режим (strict mode). Без нього PHP перетворює аргумент на потрібний тип, якщо може: "40" стане числом 40. У строгому режимі тип має збігатися точно, тож останній рядок прикладу зупинить скрипт: Fatal error: Uncaught TypeError: priceTag(): Argument #2 ($price) must be of type int, string given, called in /var/www/html/public/types.php on line 21. Повідомлення називає функцію, параметр, очікуваний і отриманий тип і рядок виклику.
Режим діє на виклики з того файлу, де його оголошено, тому declare пишуть першим рядком кожного файлу. Дані з адресного рядка й форм завжди приходять рядками — перетворюйте їх явно, через (int) з модуля 5: ticketPrice((int) ($_GET['age'] ?? 0)).
include і require: код у кількох файлах
require 'шлях'; вставляє інший PHP-файл у місце виклику і виконує його. Три способи підключення відрізняються тим, що стається, коли щось не так:
require— файлу немає:Fatal error, скрипт зупиняється. Для того, без чого сторінка не працює: функцій, даних, шаблонів.include— файлу немає:Warning, скрипт іде далі. Для необов'язкових частин.require_once— якrequire, але той самий файл удруге не підключає. Для файлів із функціями: друге підключення дало бCannot redeclare function.
Шлях будують від __DIR__ — «магічної» константи з каталогом поточного файлу (а __FILE__ з лекції «Шлях запиту, шляхи до файлів і IDE» — шлях до самого файлу). Відносний шлях require '../functions.php' PHP рахує від поточного робочого каталогу, а не від файлу з require, тож у підключеному файлі він веде не туди. Довідка — на php.net.
Код поза веб-коренем
Як ви бачили в модулі 2, корінь сайту для nginx — src/public/: файл src/test.php давав 404. А PHP підключає файли звідки завгодно. Тому в src/public/ лишають тільки сторінки, а решту кладуть поза веб-коренем:
intita-php/
└── src/
├── cafe/ ← функції, дані, шаблони: браузер їх не відкриє
│ ├── functions.php
│ ├── menu.php
│ └── templates/
│ ├── header.php
│ └── footer.php
└── public/ ← корінь сайту
└── cafe/
└── index.php ← http://localhost:8080/cafe/
Так ніхто не відкриє за адресою файл із функціями чи даними, а згодом — і з паролем до бази. Гостьову книгу в практиці модуля ви розкладете так само. functions.php — це declare(strict_types=1); і функції на кшталт priceTag(), без викликів і виводу. menu.php — лише дані:
<?php
// src/cafe/menu.php — лише дані, без виводу
return [
["name" => "Капучино", "price" => 65],
["name" => "Чай", "price" => 40],
["name" => "Какао", "price" => 55],
];
return у файлі поза функцією віддає значення тому, хто підключав: $menu = require __DIR__ . '/../../cafe/menu.php'; кладе масив у змінну сторінки.
Шаблони шапки й підвалу
Однакові для всіх сторінок шапку й підвал теж виносять в окремі файли — шаблони (templates). Шапка src/cafe/templates/header.php:
<!DOCTYPE html>
<html lang="uk">
<head>
<meta charset="UTF-8">
<title><?= $title ?></title>
</head>
<body>
<h1><?= $title ?></h1>
Підвал footer.php — <footer> і закривні </body>, </html>. Сторінка src/public/cafe/index.php збирає все разом:
<?php
declare(strict_types=1);
require_once __DIR__ . '/../../cafe/functions.php';
$menu = require __DIR__ . '/../../cafe/menu.php';
$title = "Меню кав'ярні";
require __DIR__ . '/../../cafe/templates/header.php';
?>
<ul>
<?php foreach ($menu as $item): ?>
<li><?= priceTag($item["name"], $item["price"]) ?></li>
<?php endforeach; ?>
</ul>
<?php require __DIR__ . '/../../cafe/templates/footer.php'; ?>
Браузер отримає цілу сторінку: шапку з «Меню кав'ярні», три <li> на кшталт Капучино — 65 грн і підвал. Шаблон бачить $title, бо підключений файл виконується в області видимості рядка з require — на відміну від функції. Тому $title задають до підключення шапки. Друга сторінка задасть свій $title і підключить ті самі шаблони, а правка шапки з'явиться на всіх сторінках.
Підсумок
- Тип параметра пишуть перед ним (
int $age), тип результату — після дужок (): string);?string— рядок абоnull,void— нічого. declare(strict_types=1);у першому рядку вмикає строгий режим:"40"замістьintдаєTypeError.requireбез файлу —Fatal error,include—Warning, і скрипт іде далі.require_onceпідключає файл лише раз — так функції не оголошуються двічі.- Файл із
return [...]повертає дані:$menu = require …;. - Шляхи будують від
__DIR__— каталогу поточного файлу. - У
src/public/— лише сторінки; функції, дані й шаблони — поза веб-коренем, і шаблон бачить змінні сторінки.
Що далі
Практика «Гостьова книга, крок 4: функції і шаблони», а потім модуль 10 «Форми: GET і POST» — сторінки почнуть приймати дані, які надсилає користувач.