NextPDF CodeIgniter インテグレーション

概要

パッケージをインストールすると、CodeIgniter 4 に自動的に組み込まれます。このページは、その組み込みに関するリファレンスです。検出、バインディングモデル、構成の公開、そして統合が動作することを確認する単一メソッドのスモークテストについて説明します。

インストール

composer require nextpdf/codeigniter

サービスプロバイダーを編集したり、ブートストラップファイルを変更したりする必要はありません。検証済みのバージョン制約については、/integrations/codeigniter/install/ を参照してください。

ブート/自動検出

CodeIgniter 4 は、Composer のパッケージ検出を通じてパッケージを見つけます。これは、フレームワークのデフォルトである Config\Modules::$discoverInComposer が true の場合に行われます。PSR-4 プレフィックス NextPDF\CodeIgniter\ は src/CodeIgniter/ にマッピングされます。このマッピングにより、フレームワークは NextPDF\CodeIgniter\Config\Services を該当ファイルに resolve（解決）します（PSR-4 §x1.x3）。/integrations/codeigniter/boot-and-discovery/ では、完全なシーケンスと、それを制御する Config\Modules のプロパティについて説明しています。

コンテナーバインディング

CodeIgniter 4 は PSR-11 コンテナーを同梱していません。PSR-11 §1.3 では、サービスロケーターパターンを推奨していません（SHOULD NOT の助動詞）。このパッケージはフレームワークのロケーター規約に従いながら、その使用を最小限に抑えています。各バインディングは、bool $getShared パラメーターを持つ名前付きの静的ファクトリー 1 つです。

サービス名	戻り値	デフォルトの有効期間
`fontRegistry`	`FontRegistryInterface`	共有
`imageRegistry`	`ImageRegistry`	共有
`documentFactory`	`DocumentFactoryInterface`	共有
`pdfDocument`	`Document`	新規
`pdf`	`Pdf`	新規
`tsaClient`	`?TsaClient`	共有
`pdfSigner`	`?SignerInterface`	新規

どちらのエントリーポイントから解決しても同じです。

<?php

declare(strict_types=1);

use NextPDF\CodeIgniter\Config\Services;

$a = Services::pdf(false);   // direct
$b = \service('pdf');        // helper → Services::pdf()

グローバルヘルパー pdf() および pdf_document() は、Services::pdf(false) と Services::pdfDocument(false) をラップする薄いラッパーにすぎません。

構成の公開

パッケージの構成は NextPDF\CodeIgniter\Config\NextPdf に定義されています。これは non-final な BaseConfig です。これをオーバーライドする方法は、サポートされているものが 2 つあります。

1. クラスを拡張する（型付きで、バージョン管理対象です）。app/Config/NextPdf.php を作成します。

<?php

declare(strict_types=1);

namespace Config;

use NextPDF\CodeIgniter\Config\NextPdf as BaseNextPdf;

final class NextPdf extends BaseNextPdf
{
    public int $imageCacheMb = 100;
}

CodeIgniter は、パッケージのデフォルトの代わりにアプリケーションのクラスを読み込みます。

2. .env でオーバーライドする（環境ごとに設定できます）。プレフィックスは、小文字の短いクラス名である nextpdf です。

nextpdf.imageCacheMb = 100
nextpdf.signature.enabled = true
nextpdf.signature.certificate = /etc/nextpdf/cert.pem

/integrations/codeigniter/configuration/ では、すべてのキーと配列のオーバーライドルールを説明しています。

サービスプロバイダー/バンドルのスモークテスト

CodeIgniter には、テスト対象となるサービスプロバイダーやバンドルクラスはありません。代わりに、同等のスモークテストでは、検出によりサービスが解決されること、および有効期間が指定どおりに動作することの 2 点を確認します。以下のテストは、パッケージ自身の機能テストのアサーションを反映した、実行可能なコントローラーアクションです。

<?php

declare(strict_types=1);

namespace App\Controllers;

use CodeIgniter\HTTP\ResponseInterface;
use NextPDF\CodeIgniter\Config\Services;
use NextPDF\CodeIgniter\Libraries\Pdf;
use NextPDF\Core\Document;

final class NextPdfSmokeController extends BaseController
{
    public function check(): ResponseInterface
    {
        // Discovery resolved the services.
        $document = Services::pdfDocument(false);
        $library = Services::pdf(false);

        // Documents are fresh per call (no cross-request leakage).
        $freshIsolated = Services::pdfDocument(false) !== $document;

        // Registries are shared singletons.
        $registrySingleton = Services::fontRegistry() === Services::fontRegistry();

        // Optional services degrade to null without Premium / TSA config.
        $signerOptional = Services::pdfSigner(false) === null;

        $ok = $document instanceof Document
            && $library instanceof Pdf
            && $freshIsolated
            && $registrySingleton
            && $signerOptional;

        return $this->response
            ->setStatusCode($ok ? 200 : 500)
            ->setJSON([
                'discovery' => $document instanceof Document,
                'document_fresh_per_call' => $freshIsolated,
                'registry_shared' => $registrySingleton,
                'signer_optional_null' => $signerOptional,
            ]);
    }
}

このアクションにルートをマッピングしてリクエストします。ステータスコード 200 のレスポンスで、すべてのフラグが true に設定されていれば、統合が正しく機能していることを確認できます。ここでの各アサーションは、パッケージの機能テストスイートで検証済みの動作に対応しています。

エッジケースと注意点

ホストアプリケーションが Composer の検出を無効にしている場合は、nextpdf/codeigniter を Config\Modules::$composerPackages['only'] に追加してください。
Services::pdfDocument(true) は、共有のドキュメントを返します。これはテスト時のリセット専用です。リクエストコードやジョブコードでは、共有のドキュメントを決してリクエストしないでください。
Services::pdfSigner() と Services::tsaClient() は、署名または TSA URL が構成されるまでは null を返します。これは意図された正常な機能低下であり、障害ではありません。

準拠

モジュール検出のためのクラスパスのマッピング（PSR-4 Autoloader §x1.x3）。
バインディングモデルに関するサービスロケーターのガイダンス（PSR-11 Container §1.3）。

商用コンテキスト

NextPDF のコアは Apache-2.0 です。Pro および Enterprise のサービスは、インストールされると同じ Services インターフェイス上で利用できます。CodeIgniter パッケージは、対応するサービスメソッドを公開します。それぞれのメソッドは、対応する Premium パッケージがインストールされるまで null を返します。</get-license/?intent=codeigniter> を参照してください。