【PHP8.x】gc_enable関数の使い方

<?php

/**
 * PHPのガーベージコレクション(GC)の有効化/無効化をデモンストレーションします。
 *
 * gc_enable() 関数は、gc_disable() で一時的に無効にされたガーベージコレクションを
 * 再び有効にするために使用されます。
 * PHPはデフォルトでガーベージコレクションが有効になっています。
 */
function demonstrateGarbageCollectionEnable(): void
{
    echo "--- ガーベージコレクション制御のデモンストレーション ---\n\n";

    // 1. 現在のガーベージコレクションの状態を表示
    // gc_enabled() はGCが有効なら true、無効なら false を返します。
    echo "初期状態: ガーベージコレクションは " . (gc_enabled() ? "有効" : "無効") . " です。\n";

    // 2. ガーベージコレクションを一時的に無効にする
    // gc_disable() は、GCによるオーバーヘッドを一時的に避けたい場合などに使われます。
    echo "gc_disable() を呼び出し中...\n";
    gc_disable();
    echo "現在の状態: ガーベージコレクションは " . (gc_enabled() ? "有効" : "無効") . " です。\n\n";

    // ここで、GCを無効にした状態で何らかの処理を行うことができます。
    // 例: 大量のオブジェクトを生成するが、GCサイクルを発生させたくない場合など。
    echo "GCが無効な状態で、システムは処理を続けています...\n\n";

    // 3. ガーベージコレクションを再び有効にする
    // gc_enable() は、gc_disable() で無効にしたGCを元の有効な状態に戻します。
    // 引数はなく、戻り値もありません (void)。
    echo "gc_enable() を呼び出し中...\n";
    gc_enable();
    echo "最終状態: ガーベージコレクションは " . (gc_enabled() ? "有効" : "無効") . " です。\n\n";

    echo "--- デモンストレーション終了 ---\n";
}

// 関数を実行してデモンストレーションを開始します。
demonstrateGarbageCollectionEnable();

?>

このPHPのサンプルコードは、ガーベージコレクション（GC）の有効化と無効化を制御する方法を具体的に示しています。ガーベージコレクションとは、プログラムが不要になったメモリ領域を自動的に特定し、解放する仕組みのことで、PHPでは通常、常に有効な状態で動作しています。

まず、コードはgc_enabled()関数を使って、現在のGCの状態を確認します。初期状態では「有効」であることが表示されます。次に、gc_disable()関数を呼び出し、一時的にGCを無効にしています。これは、特定の処理中にメモリ解放による性能の低下を避けたい場合などに利用されます。GCが無効な間も、システムは処理を継続します。

そして、gc_enable()関数が登場します。この関数は、gc_disable()によって停止されていたガーベージコレクションを再び有効な状態に戻す役割を持っています。gc_enable()関数は引数を一切必要とせず、特別な戻り値もありません（void）。この関数を呼び出した後、再びgc_enabled()で状態を確認すると、GCが「有効」に戻っていることがわかります。このように、gc_enable()は、必要に応じてGCの動作を再開させるために使用される、簡潔で重要な関数です。

<?php

/**
 * ガベージコレクタ(GC)の有効化・無効化を実演する関数です。
 *
 * PHPのガベージコレクタは、不要になったメモリを自動的に解放する仕組みです。
 * php.ini の 'zend.enable_gc' 設定でデフォルトの動作が決まりますが、
 * スクリプト実行中に gc_disable() と gc_enable() を使って
 * 一時的に制御することができます。
 */
function demonstrateGarbageCollectorControl(): void
{
    // 1. 現在のガベージコレクタの状態を確認します。
    // 通常は有効 (true) になっています。
    echo 'Initial GC status: ';
    var_dump(gc_enabled());
    echo PHP_EOL;

    // 2. ガベージコレクタを意図的に無効にします。
    // 特定の処理中、GCの動作を止めたい場合などに使用します。
    echo 'Disabling Garbage Collector...' . PHP_EOL;
    gc_disable();

    // 3. 無効になったことを確認します。
    echo 'GC status after disabling: ';
    var_dump(gc_enabled());
    echo PHP_EOL;

    // 4. gc_enable() を呼び出して、ガベージコレクタを再度有効にします。
    echo 'Enabling Garbage Collector...' . PHP_EOL;
    gc_enable();

    // 5. 再び有効になったことを確認します。
    echo 'GC status after enabling: ';
    var_dump(gc_enabled());
    echo PHP_EOL;
}

// 上記の関数を実行します。
demonstrateGarbageCollectorControl();

?>

gc_enable()は、PHPのガベージコレクタ（GC）を有効にするための関数です。ガベージコレクタとは、プログラムが使用しなくなったメモリ領域を自動的に検出し、解放してくれる機能です。

通常、PHPのガベージコレクタはphp.iniの設定項目であるzend.enable_gcによって、デフォルトで有効になっています。しかし、パフォーマンス上の理由などから、gc_disable()関数を使ってスクリプト実行中に一時的に無効化することが可能です。gc_enable()は、このようにして無効化されたガベージコレクタを、再び有効な状態に戻す際に使用します。

この関数は引数を取りません。また、特定の値を返すこともなく（戻り値は void）、単にガベージコレクタを有効にするという操作を実行します。

サンプルコードでは、まずgc_disable()を呼び出して意図的にガベージコレクタを無効にしています。その後にgc_enable()を呼び出すことで、ガベージコレクタが再び有効な状態に戻ることを示しています。現在の状態はgc_enabled()関数で確認できます。このように、gc_enable()はgc_disable()と対で使われるのが一般的です。