PHP Fonksiyonlar: Tanımlama, return, Parametreler ve Türler

Bir PHP fonksiyonu function anahtar kelimesi, bir ad, bir parametre listesi ve bir gövdeyle tanımlanır; return çağırana bir değer gönderir. function add(int $a, int $b): int { return $a + $b; } onu tanımlar, add(2, 3) ise çağırır ve 5 döndürür.

<?php
function greet(string $name): string
{
    return "Hello, $name";
}

function add(int $a, int $b): int
{
    return $a + $b;
}

echo greet('Ada'), "\n";
echo add(2, 3), "\n";
echo add(add(1, 2), 10), "\n";

Parametrelerden önceki string ve int tür bildirimleridir, parantezlerden sonraki : string ise dönüş türüdür. İkisi de isteğe bağlıdır, ama hataları erken yakalar ve fonksiyonun ne beklediğini belgeler.

Dönüş değerleri ve birkaç değer döndürme

return fonksiyonu hemen bitirir. return içermeyen ya da çıplak bir return; içeren bir fonksiyon null döndürür; yalnızca etkisi için çağrılıyorsa : void bildirin. Bir fonksiyon tek bir değer döndürür, ama bu değer çağıran tarafta ayrıştıracağınız bir dizi olabilir:

<?php
function grade(int $score): string
{
    if ($score >= 90) {
        return 'A';
    }
    return $score >= 75 ? 'B' : 'C';   // reached only below 90
}

function stats(array $numbers): array
{
    return [
        'min' => min($numbers),
        'max' => max($numbers),
        'avg' => array_sum($numbers) / count($numbers),
    ];
}

function logLine(string $msg): void
{
    echo "[log] $msg\n";
}

echo grade(95), grade(80), grade(40), "\n";

['min' => $min, 'max' => $max, 'avg' => $avg] = stats([4, 8, 15, 16, 23, 42]);
echo "min $min, max $max, average $avg\n";

[$quotient, $remainder] = [intdiv(17, 5), 17 % 5];
echo "17 / 5 = $quotient remainder $remainder\n";

var_dump(logLine('saved'));   // a void function returns null

[...] = söz diziminin diğer biçimleri için dizi ayrıştırma sayfasına bakın.

Varsayılan parametreler ve adlandırılmış argümanlar

= value içeren bir parametre isteğe bağlıdır: çağıranlar onu yazmayabilir. İsteğe bağlı parametreler zorunlu olanlardan sonra gelir. PHP 8.0'dan beri adlandırılmış argümanlar çağıranın herhangi bir parametreyi adıyla vermesine izin verir, böylece ihtiyacınız olmayan isteğe bağlı parametreleri atlayabilirsiniz.

<?php
function makeTag(string $text, string $tag = 'p', ?string $class = null, bool $escape = true): string
{
    $body = $escape ? htmlspecialchars($text) : $text;
    $attr = $class !== null ? " class=\"$class\"" : '';
    return "<$tag$attr>$body</$tag>";
}

echo makeTag('Hello'), "\n";
echo makeTag('Title', 'h1'), "\n";

// Named arguments: skip $tag and $class, set only $escape
echo makeTag('<b>bold</b>', escape: false), "\n";
echo makeTag(class: 'note', text: 'Order does not matter'), "\n";

Adlandırılmış argümanlar yerleşik fonksiyon çağrılarını da okunur yapar: str_pad('7', 3, '0', pad_type: STR_PAD_LEFT). Parametre adı fonksiyonun genel arayüzünün bir parçası olur, bu yüzden bir parametreyi yeniden adlandırmak ad kullanan çağıranları bozabilir.

Referansla aktarma

Normalde PHP her argümanın bir kopyasını aktarır, bu yüzden fonksiyon çağıranın değişkenini değiştiremez. Bir parametrenin önündeki & değişkenin kendisini aktarır. sort() gibi yerleşik fonksiyonlar bu şekilde çalışır.

<?php
function addOne(int $n): void
{
    $n++;          // changes the copy only
}

function addOneRef(int &$n): void
{
    $n++;          // changes the caller's variable
}

$a = 5;
addOne($a);
echo $a, "\n";

addOneRef($a);
echo $a, "\n";

function addItem(array &$cart, string $item): void
{
    $cart[] = $item;
}

$cart = [];
addItem($cart, 'apple');
addItem($cart, 'pear');
print_r($cart);

Yeni bir değer döndürmek genellikle bir argümanı değiştirmekten daha açıktır. Referansları, fonksiyon gerçekten bir şeyi yerinde değiştirmek için yapıldığında kullanın.

Tür bildirimleri ve strict_types

Varsayılan olarak PHP argümanları mümkün olduğunda bildirilen türe dönüştürür: add("5", 3) "5" değerini 5 yapar. Dosyanın en üstüne declare(strict_types=1); koymak bunu o dosyada yapılan çağrılar için kapatır, böylece yanlış bir tür dönüştürülmek yerine bir TypeError fırlatır.

<?php
declare(strict_types=1);
// This throws a TypeError on purpose: "5" is a string, not an int

function add(int $a, int $b): int
{
    return $a + $b;
}

echo add(2, 3), "\n";
echo add("5", 3), "\n";

declare satırı olmadan aynı çağrı 8 yazdırır. "five" gibi sayı olmayan dizgeler her iki modda da bir TypeError fırlatır.

Parametreler ve dönüş değerleri için bildirebileceğiniz türler:

<?php
// ?string: a string or null
function findUser(int $id): ?string
{
    $users = [1 => 'Ada', 2 => 'Linus'];
    return $users[$id] ?? null;
}

// int|float: a union type (PHP 8.0)
function half(int|float $n): float
{
    return $n / 2;
}

// mixed: anything at all
function describe(mixed $value): string
{
    return get_debug_type($value);
}

var_dump(findUser(1), findUser(9));
var_dump(half(5), half(2.5));
echo describe([1, 2]), ' ', describe(null), ' ', describe(1.5), "\n";

never, her zaman hata fırlatan veya çıkış yapan fonksiyonlar için bir dönüş türüdür. Sınıf ve arayüz adları da tür olarak çalışır.

...$args ile değişken sayıda argüman

...$numbers istenen sayıda argümanı bir dizide toplar. Çağıran taraftaki aynı ... bir diziyi ayrı argümanlara açar.

<?php
function sum(int ...$numbers): int
{
    return array_sum($numbers);
}

echo sum(), "\n";
echo sum(1, 2, 3), "\n";

$values = [10, 20, 30];
echo sum(...$values), "\n";          // spread an array

function logMessage(string $level, string ...$parts): string
{
    return strtoupper($level) . ': ' . implode(' ', $parts);
}

echo logMessage('info', 'user', 'Ada', 'logged in'), "\n";

Bir fonksiyon içinde dışarıdaki bir değişkeni kullanma

Bir fonksiyonun kendi kapsamı vardır. Dışında tanımlanan bir değişken içeride görünmez; bu JavaScript'ten gelenleri şaşırtır:

<?php
$taxRate = 0.2;

function priceWithTax(float $price): float
{
    return $price * (1 + $taxRate);   // $taxRate is undefined here
}

Warning: Undefined variable $taxRate in /path/to/index.php on line 6

ve fonksiyon fiyatı vergisiz döndürür. Bunun yerine değeri bir parametre olarak içeri verin. Bu, fonksiyonun neye bağlı olduğu konusunda dürüst kalmasını ve kolay test edilmesini sağlar:

<?php
$taxRate = 0.2;

function priceWithTax(float $price, float $taxRate): float
{
    return $price * (1 + $taxRate);
}

echo priceWithTax(100, $taxRate), "\n";
echo priceWithTax(100, 0.1), "\n";

global anahtar kelimesi de çalışır ama bağımlılığı gizler; değişken kapsamı bunu anlatır. array_map() için geri çağırmalar gibi başka fonksiyonlara verilen kısa fonksiyonlar için dışarıdaki değişkenleri use ile yakalayabilen anonim fonksiyonlar sayfasına bakın.