PHP include ve require: Başka PHP Dosyalarını Yükleme

include 'header.php'; başka bir PHP dosyasının kodunu betiğin o noktasında, sanki oraya yapıştırılmış gibi çalıştırır. require 'header.php'; aynısını yapar, ama dosya yüklenemezse require betiği ölümcül bir hatayla durdurur, include ise yalnızca bir uyarı yazdırır ve devam eder. Olağan ilk kullanım her sayfanın paylaştığı bir üst ve alt bilgidir (header ve footer).

Blok önce header.php ve footer.php dosyalarını yazar, böylece dahil edilecek dosyalar olur. Çalıştırın ve Page sekmesine bakın:

<?php
file_put_contents('header.php', <<<'PHP'
<!doctype html>
<html>
<head><title><?= $title ?></title></head>
<body style="font-family: sans-serif">
<nav><a href="?">Home</a> | <a href="?">Shop</a> | <a href="?">Contact</a></nav>
<hr>
PHP);

file_put_contents('footer.php', <<<'PHP'
<hr>
<footer>&copy; <?= date('Y') ?> My Shop</footer>
</body>
</html>
PHP);

$title = 'Welcome';
require 'header.php';
?>
<h1><?= $title ?></h1>
<p>This page is made of three files: header.php, this script, and footer.php.</p>
<?php
require 'footer.php';

Dahil edilen dosyalar sıradan PHP dosyalarıdır: <?= ?> etiketleriyle HTML içerebilirler ve require öncesinde ayarlanan $title değişkenini görürler. Başlığı değiştirin ve tekrar çalıştırın; üst bilgiyi require eden her sayfa o tek dosyadaki bir değişikliği alırdı.

include ile require

Tek fark dosya eksik veya okunamaz olduğunda ne olduğudur. include iki uyarı yazdırır, false değerini verir ve betik devam eder:

Warning: include(sidebar.php): Failed to open stream: No such file or directory in /home/index.php on line 2

Warning: include(): Failed opening 'sidebar.php' for inclusion (include_path='.:/usr/share/php83') in /home/index.php on line 2

require aynı uyarıyı yazdırır ve ardından bir şey onu yakalamadıkça betiği bitiren bir Error fırlatır:

PHP Warning:  require(config.php): Failed to open stream: No such file or directory in /home/index.php on line 2
PHP Fatal error:  Uncaught Error: Failed opening required 'config.php' (include_path='.:/usr/share/php83') in /home/index.php:2

Bu yüzden sayfanın onsuz çalışamayacağı her şey (yapılandırma, fonksiyon kütüphaneleri, sınıf dosyaları) için require, isteğe bağlı parçalar için include kullanın. Meşru olarak bulunmayabilecek bir parça için uyarıya güvenmek yerine önce onu kontrol edin:

<?php
file_put_contents('banner.php', '<?php echo "Spring sale: 20% off\n";');

foreach (['banner.php', 'sidebar.php'] as $part) {
    if (is_file($part)) {
        $result = include $part;
        echo "$part included, include returned ";
        var_dump($result);
    } else {
        echo "$part not found, skipped\n";
    }
}

Çıktı:

Spring sale: 20% off
banner.php included, include returned int(1)
sidebar.php not found, skipped

include_once ve require_once

Bir fonksiyon veya sınıf tanımlayan bir dosya yalnızca bir kez yüklenebilir: ikinci kez yüklemek ölümcül bir hatadır, çünkü fonksiyon zaten vardır.

Fatal error: Cannot redeclare greet() (previously declared in /home/helpers.php:2) in /home/helpers.php on line 2

Bu, iki dosyanın her biri require 'helpers.php' yaptığı anda olur. require_once ve include_once hangi dosyaların zaten yüklendiğini hatırlar ve ikinci seferde true döndürerek onları atlar:

<?php
file_put_contents('helpers.php', <<<'PHP'
<?php
function greet(string $name): string
{
    return "Hello, $name";
}
PHP);

var_dump(require_once 'helpers.php');   // loaded: 1
var_dump(require_once 'helpers.php');   // already loaded: true, skipped
var_dump(include_once 'helpers.php');   // the same list for both

echo greet('Ada'), "\n";

Çıktı:

int(1)
bool(true)
bool(true)
Hello, Ada

Bir şeyler tanımlayan dosyalar için _once biçimlerini, birden fazla kez çıktı vermek istediğiniz şablonlar için düz include kullanın. Composer kullanan projelerde otomatik yükleyici sınıf dosyalarını sizin için yükler, bu yüzden sınıflar için require_once çağrıları büyük ölçüde ortadan kalkar; bkz. Composer.

Dahil edilen bir dosyadan değer döndürme

Dahil edilen bir dosyanın en üst seviyesindeki bir return o dosyayı durdurur ve include veya require ifadesine bir değer geri verir. Bu temiz bir yapılandırma dosyası sağlar: global değişken yok, yalnızca istediğiniz ada atadığınız bir değer.

<?php
file_put_contents('config.php', <<<'PHP'
<?php
return [
    'site'     => 'My Shop',
    'currency' => 'EUR',
    'debug'    => false,
    'db'       => ['host' => 'localhost', 'name' => 'shop'],
];
PHP);

$config = require 'config.php';

echo $config['site'], "\n";
echo $config['db']['name'], "\n";
var_dump($config['debug']);

Çıktı:

My Shop
shop
bool(false)

Laravel'in yapılandırma dosyaları (config/app.php, config/database.php ve diğerleri) bu şekilde çalışır.

Dahil edilen dosyalarda değişkenler ve kapsam

Dahil edilen kod onu dahil eden satırın kapsamında çalışır. Bir betiğin en üstünde her global değişkeni görür; bir fonksiyonun içinde yalnızca o fonksiyonun yerel değişkenlerini görür. İkinci kural küçük bir şablon işleyicinin çalışma şeklidir: yerel değişkenleri tam olarak şablonun görmesi gereken değişkenler olan bir fonksiyon.

<?php
file_put_contents('product-list.php', <<<'PHP'
<h2><?= htmlspecialchars($heading) ?></h2>
<ul>
<?php foreach ($products as $name => $price): ?>
    <li><?= htmlspecialchars($name) ?>: <?= number_format($price, 2) ?> EUR</li>
<?php endforeach; ?>
</ul>
<p><?= count($products) ?> products</p>
PHP);

function render(string $template, array $vars): string
{
    extract($vars);       // $vars['heading'] becomes $heading
    ob_start();           // capture the output instead of printing it
    include $template;
    return ob_get_clean();
}

$secret = 'not visible inside the template';

echo render('product-list.php', [
    'heading'  => 'Fruit',
    'products' => ['Apple' => 0.5, 'Mango' => 1.75, 'Cherries' => 4.2],
]);
echo render('product-list.php', [
    'heading'  => 'Tea',
    'products' => ['Sencha' => 6, 'Earl Grey' => 4.5],
]);

Page sekmesi tek bir şablon dosyasından oluşturulan iki listeyi de gösterir. include render() içinde çalıştığı için şablon $heading ve $products değişkenlerini görür ama $secret değişkenini görmez. Şablonda kullanılan foreach ... endforeach biçimi PHP'nin HTML şablonları için sunduğu alternatif söz dizimidir.

Dahil etme yolları ve DIR

'helper.php' gibi bir yol include içeren dosyaya göre çözümlenmez. PHP include_path ayarında arar (normalde geçerli çalışma dizini olan . ile başlar) ve ancak sonra dahil eden dosyanın kendi klasörüne bakar. Yani partials/nav.php içinde include 'helper.php' proje kökünden tamamen farklı bir helper.php dosyasını yükleyebilir. Geçerli dosyanın dizini olan __DIR__ tahmini ortadan kaldırır:

<?php
mkdir('partials');
file_put_contents('helper.php', '<?php echo "loaded the root helper.php\n";');
file_put_contents('partials/helper.php', '<?php echo "loaded partials/helper.php\n";');

file_put_contents('partials/nav.php', <<<'PHP'
<?php
include 'helper.php';                 // searched from the working directory
include __DIR__ . '/helper.php';      // always the file next to nav.php
echo "__DIR__ in nav.php is ", basename(__DIR__), "\n";
PHP);

include 'partials/nav.php';

Çıktı:

loaded the root helper.php
loaded partials/helper.php
__DIR__ in nav.php is partials

Her dahil etmeyi __DIR__ . '/relative/path.php' olarak yazın. Çalışma dizini betiğin nasıl başlatıldığına (web sunucusu, bir cron işi, başka bir klasörden komut satırı) bağlıdır, ama __DIR__ asla değişmez.

Kullanıcının adını verdiği bir dosyayı asla dahil etmeyin

Yaygın bir ilk yönlendirici sayfa adını URL'den okur: include $_GET['page'] . '.php';. Bu bir ziyaretçinin sunucudaki hangi dosyanın çalışacağını seçmesine izin verir, örneğin ?page=../../config (yerel dosya dahil etme) ve eski ayarlarla başka bir sunucudan bir dosyayı bile. Bunun yerine izin verilen adları dosyalara eşleyin. Bloğu çalıştırın ve bağlantılara tıklayın: her tıklama betiği farklı bir $_GET['page'] ile yeniden çalıştırır.

<?php
file_put_contents('home.php', '<h2>Home</h2><p>Welcome to the shop.</p>');
file_put_contents('about.php', '<h2>About</h2><p>We sell fruit since 1999.</p>');
file_put_contents('contact.php', '<h2>Contact</h2><p>hello@example.com</p>');

$pages = [
    'home'    => 'home.php',
    'about'   => 'about.php',
    'contact' => 'contact.php',
];

$page = $_GET['page'] ?? 'home';
$file = $pages[$page] ?? null;
if ($file === null) {
    http_response_code(404);   // before any output, or the header cannot be sent
}
?>
<nav>
    <a href="?page=home">Home</a> |
    <a href="?page=about">About</a> |
    <a href="?page=contact">Contact</a> |
    <a href="?page=../secret">../secret</a>
</nav>
<?php
if ($file === null) {
    echo '<h2>Not found</h2><p>No page called ', htmlspecialchars($page), '.</p>';
} else {
    require __DIR__ . '/' . $file;
}

require ifadesine yalnızca $pages içindeki üç ad ulaşabilir; ../secret bağlantısı "Not found" sayfasını alır. İstek değerlerini güvenle okumak $_GET ve$_POST sayfasında anlatılıyor.