インフレクタには、ひとつの ターゲット とひとつあるいは複数の ルール が必要です。 ターゲットは基本的に文字列であり、置き換えを行うプレースホルダを定義します。 プレースホルダは、先頭に ':' をつけて :script のように定義します。

filter() をコールするときに、 ターゲット内の変数に対応するキーと値のペアを配列で渡します。

ターゲット内の個々の変数に対して、ゼロ個以上のルールを関連づけることができます。 ルールとして指定できるのは、静的な ルールか Zend_Filter クラスです。静的なルールは、 指定されたテキストで置き換えを行います。 それ以外の場合は、ルールで指定されたクラスを使用してテキストを変換します。 クラスを指定する際には、共通のプレフィックスを除いた短いクラス名を使用します。

たとえば Zend_Filter の具象実装クラスなら何でも使用可能です。 しかし、これを使用する際には 'Zend_Filter_Alpha' あるいは 'Zend_Filter_StringToLower' とするのではなく単に 'Alpha' あるいは 'StringToLower' だけで指定するということです。

Zend_Filter_Inflector は、 Zend_Loader_PluginLoader を使用してインフレクションに使用するフィルタの読み込みを行います。 デフォルトでは、 Zend_Filter で始まる任意のフィルタを使用できます。 このプレフィックスで始まるけれどももっと深い階層にあるフィルタ、たとえば Word 系のフィルタなどを使用したい場合は、プレフィックス Zend_Filter を除いた名前を指定します。

// ルールとして Zend_Filter_Word_CamelCaseToDash を使用します
$inflector->addRules(array('script' => 'Word_CamelCaseToDash'));

別のパスを使用するには、プラグインローダへのプロキシとして Zend_Filter_Inflector のユーティリティメソッド addFilterPrefixPath() を使用します。

$inflector->addFilterPrefixPath('My_Filter', 'My/Filter/');

あるいは、プラグインローダをインフレクタから取得して、 それを直接操作することもできます。

$loader = $inflector->getPluginLoader();
$loader->addPrefixPath('My_Filter', 'My/Filter/');

フィルタのパスを変更するための詳細なオプションは、PluginLoader のドキュメント を参照ください。

インフレクタのターゲットは、変数用のプレースホルダを含む文字列となります。 プレースホルダは、先頭に識別子をつけて表します。 デフォルトの識別子はコロン (':') です。 そしてその後に変数名を続け、たとえば ':script' や ':path' のようになります。 filter() メソッドは、識別子の後に続く変数を探して置換します。

識別子を変更するには setTargetReplacementIdentifier() メソッドを使用するか、 コンストラクタの 3 番目の引数で指定します。

// コンストラクタ経由
$inflector = new Zend_Filter_Inflector('#foo/#bar.#sfx', null, '#');

// アクセサ経由
$inflector->setTargetReplacementIdentifier('#');

普通はコンストラクタでターゲットを指定することになるでしょう。 しかし、あとでターゲットを設定しなおしたくなることもあるかもしれません (たとえば、 ViewRenderer や Zend_Layout といったコアコンポーネントのデフォルトのインフレクタを変更したい場合など)。 この際に使用できるのが setTarget() です。

$inflector = $layout->getInflector();
$inflector->setTarget('layouts/:script.phtml');

さらに、クラスのメンバーを用意して インフレクタのターゲットを変更できるようにしたくなるかもしれません。 毎回直接ターゲットを変更する必要がなくなる (メソッドコールを少なくできる) からです。 そのためには setTargetReference() を使用します。

class Foo
{
    /**
     * @var string インフレクタのターゲット
     */
    protected $_target = 'foo/:bar/:baz.:suffix';

    /**
     * コンストラクタ
     * @return void
     */
    public function __construct()
    {
        $this->_inflector = new Zend_Filter_Inflector();
        $this->_inflector->setTargetReference($this->_target);
    }

    /**
     * ターゲットを設定してインフレクタのターゲットを更新します
     *
     * @param  string $target
     * @return Foo
     */
    public function setTarget($target)
    {
        $this->_target = $target;
        return $this;
    }
}

先ほど説明したように、静的なルールとフィルタを使用したルールのふたつがあります。

$inflector = new Zend_Filter_Inflector(':script.:suffix');
$inflector->setStaticRule('suffix', 'phtml');

// あとで変更します
$inflector->setStaticRule('suffix', 'php');

class Foo
{
    /**
     * @var string サフィックス
     */
    protected $_suffix = 'phtml';

    /**
     * コンストラクタ
     * @return void
     */
    public function __construct()
    {
        $this->_inflector = new Zend_Filter_Inflector(':script.:suffix');
        $this->_inflector->setStaticRuleReference('suffix', $this->_suffix);
    }

    /**
     * サフィックスを設定し、インフレクタの静的ルールを更新します
     *
     * @param  string $suffix
     * @return Foo
     */
    public function setSuffix($suffix)
    {
        $this->_suffix = $suffix;
        return $this;
    }
}

$inflector = new Zend_Filter_Inflector(':script.:suffix');

// ルールとして Zend_Filter_Word_CamelCaseToDash フィルタを使用するように設定します
$inflector->setFilterRule('script', 'Word_CamelCaseToDash');

// 文字列を小文字変換するルールを追加します
$inflector->addFilterRule('script', new Zend_Filter_StringToLower());

// 複数のルールを一括して指定します
$inflector->setFilterRule('script', array(
    'Word_CamelCaseToDash',
    new Zend_Filter_StringToLower()
));

// Could also use setRules() with this notation:
$inflector->addRules(array(
    // フィルタルール
    ':controller' => array('CamelCaseToUnderscore','StringToLower'),
    ':action'     => array('CamelCaseToUnderscore','StringToLower'),

    // 静的なルール
    'suffix'      => 'phtml'
));

Zend_Filter_Inflector のユーティリティメソッド群には、 プラグインローダーの取得や設定、 ルールの操作や取得、 例外をスローするかどうかやその時期の設定といったことを行えるものがあります。

Zend_Config を使用してルールを設定したり、 フィルタのプレフィックスのパスやその他のインフレクタの状態を設定できます。 そのためには、Zend_Config オブジェクトをコンストラクタあるいは setOptions() に渡します。 設定可能な項目は以下のとおりです。

// コンストラクタで
$config    = new Zend_Config($options);
$inflector = new Zend_Filter_Inflector($config);

// あるいは setOptions() で
$inflector = new Zend_Filter_Inflector();
$inflector->setOptions($config);