Eine Beugung benötigt ein Ziel (target) und ein oder mehrere Regeln (rules). Ein Ziel ist grundsätzlich ein String der Platzhalter für Variablen definiert die ersetzt werden sollen. Sie werden durch das Voranstellen eines ':' spezifiziert: :script.

Wenn filter() aufgerufen wird, muß ein Array von Schlüssel und Wert Paaren übergeben werden die den Variablen im Ziel entsprechen.

Jede Variable im Ziel kann null oder mehr, mit Ihr assoziierte Regeln, besitzen. Regeln können entweder statisch (static) sein oder zu einer Zend_Filter Klasse verweisen. Statische Regeln werden den angegebenen Text ersetzen. Andernfalls wird eine Klasse verwendet die auf die Regel passt die angegeben wurde, um den Text zu beugen. Klasse werden typischerweise spezifiziert indem ein Kurzname verwendet wird, der den Filternamen indiziert, wobei jeglicher üblicher Präfix entfernt wurde.

Als Beispiel kann jede konkrete Zend_Filter Implementierung verwendet werden; trotzdem, statt auf diese als 'Zend_Filter_Alpha' oder 'Zend_Filter_StringToLower' zu verweisen kann einfach 'Alpha' oder 'StringToLower' spezifiziert werden.

Zend_Filter_Inflector verwendet Zend_Loader_PluginLoader um das Laden von Filtern zu managen die von der Beugung verwendet werden sollen. Standardmäßig, wird jeder Filter mit dem Präfix Zend_Filter vorhanden sein. Um auf Filter mit diesem Präfix zuzugreifen, die aber tiefer in der Hirarchie vorhanden sind, kann einfach der Zend_Filter Präfix entfernt werden:

// Verwendet Zend_Filter_Word_CamelCaseToDash als Regel
$inflector->addRules(array('script' => 'Word_CamelCaseToDash'));

Um einen alternativen Pfad zu setzen hat Zend_Filter_Inflector eine Utility Methode die den Plugin Lader verwendet, addFilterPrefixPath():

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

Alternativ kann der Plugin Lader von der Beugung empfangen, und direkt mit Ihm interagiert werden:

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

Für weitere Optionen über das Bearbeiten von Pfaden zu Filtern sollte in die PluginLoader Dokumentation gesehen werden.

Das Ziel der Beugung ist ein String mit einigen Platzhaltern für Variablen. Platzhalter haben die Form eines Identifizierers, standardmäßig einem Doppelpunkt (':'), gefolgt von einem Variablennamen: ':script', ':path', usw. Die filter() Methode sieht nach dem Identifizierer gefolgt von dem Variablennamen der ersetzt werden soll.

Der Identifizierer kann geändert werden in dem die setTargetReplacementIdentifier() Methode verwendet wird, oder indem er als drittes Argument dem Konstruktor übergeben wird:

// Über Konstruktor:
$inflector = new Zend_Filter_Inflector('#foo/#bar.#sfx', null, '#');

// Über Zugriffsmethode:
$inflector->setTargetReplacementIdentifier('#');

Typischerweise wird das Ziel über den Konstruktor gesetzt. Trotzdem kann es Ziel später geändert werden (zum Beispiel, um die Standardbeugung in Kernkomponenten die dem ViewRenderer oder Zend_Layout zu verändern). setTarget() kann für diese Zwecke verwendet werden:

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

Zusätzlich kann es gewünscht sein einen Klassenmember für die eigene Klasse zu haben, der es erlaubt das Beugungsziel zu aktualisieren -- ohne dass das Ziel jedesmal direkt aktualisiert werden muß (was Methodenaufrufe erspart). setTargetReference() erlaubt es das zu tun:

class Foo
{
    /**
     * @var string Beugungsziel
     */
    protected $_target = 'foo/:bar/:baz.:suffix';

    /**
     * Konstruktor
     * @return void
     */
    public function __construct()
    {
        $this->_inflector = new Zend_Filter_Inflector();
        $this->_inflector->setTargetReference($this->_target);
    }

    /**
     * Setzt das Ziel; Aktualisiert das Ziel für die Beugung
     *
     * @param  string $target
     * @return Foo
     */
    public function setTarget($target)
    {
        $this->_target = $target;
        return $this;
    }
}

Wie bereits in der Einführung erwähnt, gibt es zwei Typen von Regeln: statische und filter-basierende.

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

// Später ändern:
$inflector->setStaticRule('suffix', 'php');

class Foo
{
    /**
     * @var string Suffix
     */
    protected $_suffix = 'phtml';

    /**
     * Konstruktor
     * @return void
     */
    public function __construct()
    {
        $this->_inflector = new Zend_Filter_Inflector(':script.:suffix');
        $this->_inflector->setStaticRuleReference('suffix', $this->_suffix);
    }

    /**
     * Suffix setzen
     * aktualisiert die statische Suffix Regel im Beugungsmechanismus
     *
     * @param  string $suffix
     * @return Foo
     */
    public function setSuffix($suffix)
    {
        $this->_suffix = $suffix;
        return $this;
    }
}

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

// Setzt eine Regel um den Zend_Filter_Word_CamelCaseToDash Filter zu verwenden
$inflector->setFilterRule('script', 'Word_CamelCaseToDash');

// Eine Regel hinzufügen um Strings kleinzuschreiben
$inflector->addFilterRule('script', new Zend_Filter_StringToLower());

// Regeln en-masse setzen
$inflector->setFilterRule('script', array(
    'Word_CamelCaseToDash',
    new Zend_Filter_StringToLower()
));

// Es kann auch setRules() mit dieser Schreibweise verwendet werden:
$inflector->addRules(array(
    // Filterregeln:
    ':controller' => array('CamelCaseToUnderscore','StringToLower'),
    ':action'     => array('CamelCaseToUnderscore','StringToLower'),

    // Statische Regel:
    'suffix'      => 'phtml'
));

Zend_Filter_Inflector hat eine Anzahl von Hilfsmethoden für das Empfangen und Setzen der Plugin Laders, die Manipulation und das Empfangen von Regeln, und die Kontrolle ob und wann Ausnahmen geworfen werden.

Zend_Config kann verwendet werden um Regeln, Filter Präfix Pfade, oder andere Objektstati im Beugungsmachanismus zu setzen, entweder durch die Übergabe eines Zend_Config Objekts zum Konstruktor, oder durch setOptions(). Die folgenden Einstellungen können spezifiziert werden:

// Mit dem Konstruktor:
$config    = new Zend_Config($options);
$inflector = new Zend_Filter_Inflector($config);

// Oder mit setOptions():
$inflector = new Zend_Filter_Inflector();
$inflector->setOptions($config);