次のようなディレクトリ構造とクラスファイル群の構成を考えてみましょう。 トップディレクトリと library ディレクトリは include_path に含まれているものとします。

application/
    modules/
        foo/
            views/
                helpers/
                    FormLabel.php
                    FormSubmit.php
        bar/
            views/
                helpers/
                    FormSubmit.php
library/
    Zend/
        View/
            Helper/
                FormLabel.php
                FormSubmit.php
                FormText.php

では、プラグインローダーを作成してビューヘルパー群の場所を指定しましょう。

<?php
$loader = new Zend_Loader_PluginLoader();
$loader->addPrefixPath('Zend_View_Helper', 'Zend/View/Helper/')
       ->addPrefixPath('Foo_View_Helper', 'application/modules/foo/views/helpers')
       ->addPrefixPath('Bar_View_Helper', 'application/modules/bar/views/helpers');
?>

こうしておけば、クラス名のプレフィックスを除いた部分を指定するだけで ビューヘルパーをロードできるようになります。

<?php
// 'FormText' ヘルパーをロードします
$formTextClass = $loader->load('FormText'); // 'Zend_View_Helper_FormText';

// 'FormLabel' ヘルパーをロードします
$formLabelClass = $loader->load('FormLabel'); // 'Foo_View_Helper_FormLabel' 

// 'FormSubmit' ヘルパーをロードします
$formSubmitClass = $loader->load('FormSubmit'); // 'Bar_View_Helper_FormSubmit' 
?>

クラスを読み込めたら、次はそのインスタンスを作成します。

注意: 同じプレフィックスでの複数のパスの登録
時には、同じプレフィックスを複数のパスで使用することもあるかもしれません。 Zend_Loader_PluginLoader は、実際には各プレフィックスに対応するパスを配列で管理しています。 そして、最後に登録されたパスから順に検索を行います。 これは、incubator のコンポーネントを使用する場合などに便利です。

注意: インスタンス作成時のパスの定義
プレフィックスとパス (あるいはプレフィックスと複数のパス) のペアの配列を、 オプションのパラメータとしてコンストラクタに渡すことができます。

<?php
$loader = new Zend_Loader_PluginLoader(array(
    'Zend_View_Helper' => 'Zend/View/Helper/',
    'Foo_View_Helper'  => 'application/modules/foo/views/helpers',
    'Bar_View_Helper'  => 'application/modules/bar/views/helpers'
));
?>

Zend_Loader_PluginLoader には、 複数のプラグインの間でオブジェクトを共有する機能もあります。 その際にシングルトンインスタンスを作成する必要はありません。 この機能は、静的レジストリを用いて実現しています。 インスタンスを作成する際に、 コンストラクタの 2 番目のパラメータでレジストリを指定します。

<?php
// プラグインを静的レジストリ 'foobar' に保存します
$loader = new Zend_Loader_PluginLoader(array(), 'foobar');
?>

PluginLoader がインスタンス化したその他のコンポーネントで このレジストリ名を使用すると、すでに読み込まれているパスやプラグインを使用できます。

先ほどのセクションの例では、プラグインローダーでパスを追加する方法を示しました。 では、すでに読み込まれているパスを調べたりそれを削除したりしたい場合は、 いったいどうすればいいのでしょうか?

• getPaths($prefix = null) は、 $prefix を省略した場合は すべてのパスをプレフィックス / パスのペアで返します。 $prefix を指定した場合は、 そのプレフィックスに対応するパスのみを返します。

• clearPaths($prefix = null) は、 デフォルトですべての登録済みパスをクリアします。 $prefix を指定した場合は、 そのプレフィックスに関連づけられたパスが登録されている場合にそれだけをクリアします。

• removePrefixPath($prefix, $path = null) は、 指定したプレフィックスに関連づけられた特定のパスを削除します。 $path を省略した場合は、 そのプレフィックスのすべてのパスを削除します。 $path を指定した場合は、 そのパスが存在すればそのパスだけを削除します。

時には、プラグインクラスがロードされているかどうかを調べてから何かを行いたいこともあるでしょう。 isLoaded() は、プラグイン名を受け取ってその状態を返します。

PluginLoader の使用法としてもうひとつよくあるのが、 読み込まれているクラスの完全なクラス名を調べることです。 getClassName() がこの機能を実現しています。 一般に、これは isLoaded() と組み合わせて使用します。

<?php
if ($loader->isLoaded('Adapter')) {
    $class   = $loader->getClassName('Adapter');
    $adapter = call_user_func(array($class, 'getInstance'));
}
?>