Перейти до змісту
Intita
Лекція · 35 хв

Функції: параметри і return

Що ви дізнаєтесь

  • Навіщо писати власні функції і як їх оголошувати й викликати
  • Чим параметри відрізняються від аргументів і як задати значення за замовчуванням
  • Що робить return і що повертає функція без нього
  • Чому функція не бачить змінних ззовні і чому global — погана заміна параметрам
  • Як назвати функцію, щоб код читався без пояснень

У модулі 8 «Масиви» ви викликали вбудовані функції: count($a) рахує елементи, implode(", ", $a) склеює масив у рядок. Як вони влаштовані всередині, знати не обов'язково: досить знати, що їм передати і що вони повернуть. Так само можна загорнути у функцію (function) власний код — дати шматку коду назву і викликати його скільки завгодно разів. Знадобилося щось змінити — правите одне місце, а не кожну копію.

Оголошення і виклик

Функцію оголошують словом function: далі назва, у круглих дужках — параметри, а у фігурних — тіло.

<?php
function priceTag($name, $price, $currency = "грн")
{
    return $name . " — " . $price . " " . $currency;
}

echo priceTag("Чашка", 150), "\n";     // Чашка — 150 грн
echo priceTag("Блокнот", 90), "\n";    // Блокнот — 90 грн
echo priceTag("Кава", 4, "€"), "\n";   // Кава — 4 €

Оголошення саме нічого не виконує: тіло запускається лише під час виклику priceTag(…). Параметри — змінні в оголошенні ($name, $price, $currency), а аргументи — значення, які передають під час виклику ("Чашка", 150). Аргументи потрапляють у параметри за порядком: перший — у перший, другий — у другий. Викликати функцію можна навіть вище за її оголошення в тому самому файлі: PHP спершу читає файл цілком. Довідка — на php.net.

Значення за замовчуванням

$currency = "грн" — значення за замовчуванням (default value): якщо третього аргументу немає, параметр отримає "грн", а виклик priceTag("Кава", 4, "€") його замінює. Такі параметри пишуть останніми, після обов'язкових. Обов'язковий аргумент пропустити не можна: priceTag("Чашка") зупинить скрипт з Fatal error: Uncaught ArgumentCountError: Too few arguments to function priceTag(), 1 passed. Детальніше — у довідці про аргументи.

Що виведе код?
<?php
function greet($name = "гостю", $greeting = "Привіт")
{
    return "$greeting, $name!";
}

echo greet("Вітаю");

return: результат функції

return робить дві речі: віддає значення туди, звідки функцію викликали, і одразу завершує її — рядки після нього не виконуються. Тому виклик вживають як звичайне значення: у виразі, в echo, у присвоєнні.

<?php
/**
 * Ціна квитка за віком відвідувача, грн.
 */
function ticketPrice($age)
{
    if ($age < 7) {
        return 0;            // далі функція не виконується
    }
    if ($age >= 65) {
        return 50;
    }
    return 100;
}

function printTicket($age)
{
    echo "Квиток: ", ticketPrice($age), " грн\n";
}

$total = ticketPrice(35) + ticketPrice(5) + ticketPrice(70);
echo $total, "\n";           // 150
$result = printTicket(12);   // Квиток: 100 грн
var_dump($result);           // NULL

Ранній return заміняє ланцюжок elseif: щойно відповідь відома, функція виходить. Функція без return (або з порожнім return;) повертає null. printTicket() надрукувала рядок, але в $result потрапив NULL: вивести результат вона вміє, а віддати — ні. Тому функція зазвичай обчислює й повертає, а друкує той, хто її викликав, — сторінка чи шаблон. Таку функцію можна вжити будь-де: у сумі, в умові if, у <?= ?>.

Що виведе код?
<?php
function twice($n)
{
    $result = $n * 2;
}

var_dump(twice(5));

Область видимості

Змінні всередині функції — локальні (local scope): вони існують, лише поки функція працює, і не бачать змінних поза нею. Файл scope.php:

<?php
$currency = "грн";

function priceLabel($price)
{
    return $price . " " . $currency;   // $currency тут не існує
}

echo priceLabel(150);

Рядок 6 дасть Warning: Undefined variable $currency in /var/www/html/public/scope.php on line 6, а замість «150 грн» сторінка покаже лише 150: на місці валюти — null, тобто порожньо. $currency поза функцією і $currency всередині — дві різні змінні, хоч і з однією назвою. Виправлення — параметр: function priceLabel($price, $currency) і виклик priceLabel(150, $currency). Параметр — теж локальна змінна, копія аргументу: якщо функція змінить $price, змінна у виклику лишиться тією самою, як копія в foreach з лекції «foreach і функції масивів».

PHP має слово global: рядок global $currency; у тілі відкриває функції зовнішню змінну. Не користуйтеся ним. Така функція залежить від змінної, якої не видно в її оголошенні: перенесіть функцію в інший файл або викличте її там, де $currency немає, — і вона зламається. До того ж глобальну змінну може змінити будь-який рядок програми, і помилку доведеться шукати по всьому коду. Параметри ж показують усе, що потрібно функції, в одному рядку — її оголошенні.

Код нижче мав вивести 410, а показує Warning: Undefined variable $rate і 0. Де помилка?
<?php
$rate = 41;

function toUah($usd)
{
    return $usd * $rate;
}

echo toUah(10);

Як назвати функцію

Назва функції — дія або те, що вона повертає: priceTag(), ticketPrice(), printTicket(). Пишуть її в camelCase, як змінні в лекції «Змінні і PHP всередині HTML». Назви на кшталт f1() чи doStuff() нічого не кажуть: щоб зрозуміти, що вони роблять, доведеться читати тіло. На відміну від змінних, назви функцій не чутливі до регістру: PriceTag() — та сама функція, що й priceTag(). Тож друге оголошення з тією самою назвою зупинить скрипт з Fatal error: Cannot redeclare function PriceTag(), а вбудовану назву (count, date) взяти взагалі не можна.

Над функцією пишуть doc-коментар /** … */ з лекції «Перша програма на PHP», як над ticketPrice() вище: одне речення про те, що функція повертає. За стандартом PSR-12 фігурна дужка функції стоїть на окремому рядку, а в if і циклах — у тому самому.

Підсумок

  • Функція — названий шматок коду: її оголошують словом function і запускають викликом назва(…).
  • Параметри — змінні в оголошенні, аргументи — значення у виклику; вони зіставляються за порядком.
  • Параметри зі значенням за замовчуванням пишуть після обов'язкових; бракує обов'язкового аргументу — ArgumentCountError.
  • return віддає значення і одразу завершує функцію; без return функція повертає null.
  • Функція обчислює й повертає результат, а друкує той, хто її викликав.
  • Змінні функції локальні: зовнішні дані передають параметрами, а не через global.
  • Назва функції — дія або результат у camelCase; назви не чутливі до регістру й не повторюються.

Що далі

Лекція «Типи, include і require: код у кількох файлах» — як указати типи параметрів і результату і як винести функції, дані й шаблони сторінки в окремі файли.