Previous Next

Zend_Filter_Inflector

Zend_Filter_Inflector ist ein generell verwendbares Tool für regel-basierende Beugung von Strings zu einem gegebenen Ziel.

Als Beispiel, kann es gewünscht sein MixedCase oder camelCaseWörter in einen Pfad zu transformieren; für die Lesbarkeit, OS Policies, oder andere Gründe, sollen diese auch kleingeschrieben werden, und die Wörter sollen mit einem Bindestrich ('-') getrennt werden. Eine Beugung (Inflector) kann das erledigen.

Zend_Filter_Inflector implementiert Zend_Filter_Interface; eine Beugung kann durch den Aufruf von filter() auf der Objekt Instanz durchgeführt werden.

Example #1 MixedCase und camelCaseText in ein anderes Format transformieren

$inflector = new Zend_Filter_Inflector('pages/:page.:suffix');
$inflector->setRules(array(
    ':page'  => array('Word_CamelCaseToDash', 'StringToLower'),
    'suffix' => 'html'
));

$string   = 'camelCasedWords';
$filtered = $inflector->filter(array('page' => $string));
// pages/camel-cased-words.html

$string   = 'this_is_not_camel_cased';
$filtered = $inflector->filter(array('page' => $string));
// pages/this_is_not_camel_cased.html

Funktion

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/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.

Pfade zu alternativen Filtern setzen

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 setzen

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 das 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;
    }
}

Beugungsregeln

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

Note:

Es ist wichtig festzustellen das unabhängig von der Methode in welche Regeln dem Inflector hinzugefügt werden, entweder eine nach der anderen, oder alle auf einmal; die Reihenfolge sehr wichtig ist. Speziellere Namen, oder Namen die andere Regelnamen enthalten können, müssen vor nicht speziellen Namen hinzugefügt werden. Wenn zum Beispiel zwei Regelnamen 'moduleDir' und 'module' angenommen werden, sollte die 'moduleDir' Regel vor 'module' auftreten, da 'module' in 'moduleDir' enthalten ist. Wenn 'module' vor 'moduleDir' hinzugefügt wurde, wird 'module' als Teil von 'moduleDir' erkannt und und ausgeführt wobei 'Dir' im Ziel nicht ersetzt wird.

Statische Regeln

Statische Regeln führen einfach eine Ersetzung von Strings aus; sie sollten verwendet werden wenn ein Segment in einem Ziel existiert das typischerweise statisch ist, aber welches der Entwickler ändern darf. Die setStaticRule() Methode kann verwendet werden um die Regel zu ändern:

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

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

So wie das Ziel selbst kann auch eine statische Regel an eine Referenz gebunden werden, was die Aktualisierung einer einzelnen Variablen erlaubt statt das ein Methodenaufruf benötigt wird; das ist oft nützlich wenn die Klasse intern eine Beugung verwendet, und die User den Beugungsmechanismus nicht holen sollen damit dieser aktualisiert werden kann. Die setStaticRuleReference() kann verwendet werden um das durchzuführen:

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;
    }
}

Beugungsregeln filtern

Die Filter von Zend_Filter können auch als Beugungsregeln verwendet werden. Genauso wie bei statische Regeln werden Sie an eine Zielvariable gebunden; anders als statische Regeln können mehrfache Filter definiert werden die zur Beugung verwendet werden. Diese Filter werden in der Reihenfolge ausgeführt, weswegen man vorsichtig sein sollte und Sie in der Reihenfolge registriert die für die Daten die empfangen werden sollen Sinn machen.

Regeln können durch Verwendung von setFilterRule() hinzugefügt werden (was alle vorhergehenden Regeln für diese Variable überschreibt) oder addFilterRule() (was die neue Regel zu jeder existierenden Regel für diese Variable hinzufügt). Filter werden in einem der folgenden Wege spezifiziert:

  • String. Der String kann ein Klassenname eines Filters, oder ein Segment des Klassennamens ohne jeglichem Präfix sein der im Beugungs Plugin Lader gesetzt ist (standardmäßig, ohne den 'Zend_Filter' Präfix).

  • Filter Objekt. Jede Objekt Instanz die Zend_Filter_Interface implementiert kann als ein Filter übergeben werden.

  • Array. Ein Array von einem oder mehreren Strings oder Filterobjekten wie vorher definiert.

$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()
));

Viele Regeln auf einmal setzen

Typischerweise ist es einfacher viele Regeln auf einmal zu setzen als eine einzelne Variable und die Beugungsregeln auf einmal zu konfigurieren. Zend_Filter_Inflector's addRules() und setRules() Methode erlaubt dies.

Jede Methode nimmt ein Array von Variable/Regel Paaren, wobei die Regel alles sein kann was der Typ der Regel akzeptiert (String, Filterobjekt, oder Array). Variablennamen akzeptieren eine spezielle Schreibweise um das Setzen von statischen Regeln und Filterregeln zu erlauben, entsprechend der folgenden Schreibweise:

  • ':' prefix: Filterregeln.

  • kein Präfix: statische Regel.

Example #2 Mehrere Regeln auf einmal setzen

// 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'
));

Hilfsmethoden

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.

  • setPluginLoader() kann verwendet werden wenn ein eigener Plugin Loader konfiguriert werden soll der mit Zend_Filter_Inflector verwendet werden soll; getPluginLoader() empfängt den aktuell gesetzten.

  • setThrowTargetExceptionsOn() kann verwendet werden um zu kontrollieren ob filter() eine Ausnahme wirft, oder nicht, wenn ein übergegebener Identifizierer der ersetzt werden soll nicht im Ziel gefunden wird. Standardmäßig wird keine Ausnahme geworfen. isThrowTargetExceptionsOn() zeigt wie der aktuelle Wert ist.

  • getRules($spec = null) kann verwendet werden um alle registrierten Regeln für alle Variablen zu empfangen, oder nur die Regeln für eine einzelne Variable.

  • getRule($spec, $index) holt eine einzelne Regel für eine gegebene Variable; das kann nützlich sein für das Holen einer spezifischen Filterregel für eine Variable die eine Filterkette hat. $index muß übergeben werden.

  • clearRules() löscht alle aktuell registrierten Regeln.

Zend_Config mit Zend_Filter_Inflector verwenden

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 setConfig(). Die folgenden Einstellungen können spezifiziert werden:

  • target spezifiziert das Beugungsziel.

  • filterPrefixPath spezifiziert ein oder mehrere Filter Präfix/Pfad Paare für die Verwendung mit dem Beugungsmechanismus.

  • throwTargetExceptionsOn sollte ein Boolscher Wert sein der anzeigt ob eine Ausnahme geworfen wird, oder nicht geworfen wird, wenn ein Idenzifizierer der ersetzt werden soll nach der Beugung noch immer vorhanden ist.

  • targetReplacementIdentifier spezifiziert das Zeichen das verwendet wird wenn Ersetzungsvariablen im Zielstring identifiziert werden.

  • rules spezifiziert ein Array von Beugungsregeln; es sollte aus Schlüsseln bestehen die entweder Werte oder Arrays von Werten spezifizieren, die mit addRules() übereinstimmen.

Example #3 Zend_Config mit Zend_Filter_Inflector verwenden

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

// Oder mit setConfig():
$inflector = new Zend_Filter_Inflector();
$inflector->setConfig($config);
Previous Next
Introduction to Zend Framework
Übersicht
Installation
Zend_Acl
Einführung
Verfeinern der Zugriffskontrolle
Fortgeschrittene Verwendung
Zend_Amf
Einführung
Zend_Amf_Server
Zend_Application
Einführung
Zend_Application Quick Start
Theorie der Funktionsweise
Beispiele
Kern Funktionalität
Vorhandene Ressource Plugins
Zend_Auth
Einführung
Datenbanktabellen Authentifizierung
Digest Authentication
HTTP Authentication Adapter
LDAP Authentifizierung
Open ID Authentifikation
Zend_Cache
Einführung
Die Theorie des Cachens
Zend_Cache Frontends
Zend_Cache Backends
Zend_Captcha
Einführung
Captcha Anwendung
CAPTCHA Adapter
Zend_CodeGenerator
Einführung
Zend_CodeGenerator Beispiele
Zend_CodeGenerator Referenz
Zend_Config
Einleitung
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Einführung
Definieren von Getopt Regeln
Holen von Optionen und Argumenten
Konfigurieren von Zend_Console_Getopt
Zend_Controller
Zend_Controller Schnellstart
Zend_Controller Grundlagen
Der Front Controller
Das Request Objekt
Der Standard Router
Der Dispatcher
Action Kontroller
Action Helfer
Das Response Objekt
Plugins
Eine konventionelle modulare Verzeichnis Struktur verwenden
MVC Ausnahmen
Migration von vorhergehenden Versionen
Zend_Currency
Einführung in Zend_Currency
Arbeiten mit Währungen
Migration von vorhergehenden Versionen
Zend_Date
Einführung
Theorie der Arbeitsweise
Basis Methoden
Zend_Date API Übersicht
Erstellen von Datumswerten
Konstanten für generelle Datums Funktionen
Funktionierende Beispiele
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Debug
Variablen ausgeben
Zend_Dojo
Einführung
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helfer
Formular Elemente und Dekoratore für Dojo
Zend_Dom
Einführung
Zend_Dom_Query
Zend_Exception
Verwenden von Ausnahmen
Zend_Feed
Einführung
Feeds importieren
Feeds von Websites abrufen
Einen RSS Feed konsumieren
Einen Atom Feed konsumieren
Einen einzelnen Atom Eintrag konsumieren
Verändern der Feed- und Eintragsstruktur
Eigene Klassen für Feeds und Einträge
Zend_File
Zend_File_Transfer
Prüfungen für Zend_File_Transfer
Filter für Zend_File_Transfer
Migration von vorhergehenden Versionen
Zend_Filter
Einführung
Standard Filter Klassen
Filter Ketten
Filter schreiben
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Schnellstart mit Zend_Form
Erstellen von Form Elementen mit Hilfe von Zend_Form_Element
Erstellen von Form durch Verwendung von Zend_Form
Erstellen von eigenem Form Markup durch Zend_Form_Decorator
Standard Form Elemente die mit dem With Zend Framework ausgeliefert werden
Standard Formular Dekoratoren die mit dem Zend Framework ausgeliefert werden
Internationalisierung von Zend_Form
Fortgeschrittene Verwendung von Zend_Form
Zend_Gdata
Einführung
Authentifizierung mit AuthSub
Die Buchsuche Daten API verwenden
Authentifizieren mit ClientLogin
Google Kalender verwenden
Verwenden der Google Dokumente Listen Daten API
Verwenden von Google Health
Google Tabellenkalkulation verwenden
Google Apps Provisionierung verwenden
Google Base verwenden
Picasa Web Alben verwenden
Verwenden der YouTube Daten API
Gdata Ausnahmen auffangen
Zend_Http
Einführung
Zend_Http_Client - Fortgeschrittende Nutzung
Zend_Http_Client - Verbindungsadapter
Zend_Http_Cookie und Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Einführung
Zend_Json
Einführung
Grundlegende Verwendung
Fortgeschrittene Verwendung von Zend_Json
XML zu JSON Konvertierung
Zend_Json_Server - JSON-RPC server
Zend_Layout
Einführung
Zend_Layout Schnellstart
Zend_Layout Konfigurations Optionen
Erweiterte Verwendung von Zend_Layout
Zend_Ldap
Einleitung
Zend_Loader
Dynamisches Laden von Dateien und Klassen
Der Autoloader
Ressource Autoloader
Plugins laden
Zend_Locale
Einführung
Zend_Locale verwenden
Normalisierung und Lokalisierung
Arbeiten mit Daten und Zeiten
Unterstützte Gebietsschemata
Migrieren von vorhergehenden Versionen
Zend_Log
Übersicht
Writer
Formatter
Filter
Zend_Mail
Einführung
Versand über SMTP
Versand von mehreren E-Mails über eine SMTP Verbindung
Verwendung von unterschiedlichen Versandwegen
HTML E-Mail
Anhänge
Empfänger hinzufügen
Die MIME Abgrenzung kontrollieren
Zusätzliche Kopfzeilen
Zeichensätze
Kodierung
SMTP Authentifizierung
SMTP Übertragungen sichern
Lesen von Mail Nachrichten
Zend_Measure
Einführung
Erstellung einer Maßeinheit
Ausgabe von Maßeinheiten
Manipulation von Maßeinheiten
Arten von Maßeinheiten
Zend_Memory
Übersicht
Memory Manager
Memory Objekte
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Einführung
Seiten
Container
Zend_OpenId
Einführung
Zend_OpenId_Consumer Grundlagen
Zend_OpenId_Provider
Zend_Paginator
Einführung
Verwendung
Konfiguration
Advanced usage
Zend_Pdf
Einführung
Erstellen und Laden von PDF Dokumenten
Änderungen an PDF Dokumenten speichern
Arbeiten mit Seiten
Zeichnen
Dokument Informationen und Metadaten
Anwendungsbeispiel für die Zend_Pdf Komponente
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
Einführung
Zend_Reflection Beispiele
Zend_Reflection Referenz
Zend_Registry
Die Registry verwenden
Zend_Rest
Einführung
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Überblick
Indexerstellung
Einen Index durchsuchen
Abfragesprache
Abfrage Erzeugungs API
Zeichensätze
Erweiterbarkeit
Zusammenarbeit Mit Java Lucene
Erweitert
Die besten Anwendungen
Zend_Server
Einführung
Zend_Server_Reflection
Zend_Service
Einführung
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instanzen
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Maschinen Images (AMI)
Zend_Service_Amazon_Ec2: Elastischer Block Speicher (EBS)
Zend_Service_Amazon_Ec2: Elastische IP Adressen
Zend_Service_Amazon_Ec2: Schlüsselpaare
Zend_Service_Amazon_Ec2: Regionen und Availability Zones
Zend_Service_Amazon_Ec2: Sicherheitsgruppen
Zend_Service_Amazon_S3
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Einführung
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Mitgelieferte Services
Zend_Service_StrikeIron: Erweiterte Verwendung
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Einführung
Grundsätzliche Verwendung
Fortgeschrittene Benutzung
Globales Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Zugriffsmethoden
AutoDiscovery
Zend_Tag
Einführung
Zend_Tag_Cloud
Zend_Test
Einführung
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Einführung
Arbeiten mit Zend_TimeSync
Zend_Tool_Framework
Einführung
Verwenden des CLI Tools
Architecture
Erstellen von Providern für die Verwendung mit Zend_Tool_Framework
Mitgelieferte System Provider
Zend_Tool_Project
Zend_Tool_Project Einführung
Ein Projekt erstellen
Project Provider für Zend Tool
Zend_Translate
Einführung
Adapter für Zend_Translate
Benutzen von Übersetzungs Adaptoren
Migration von vorhergehenden Versionen
Zend_Uri
Zend_Uri
Zend_Validate
Einführung
Standard Prüfklassen
Kettenprüfungen
Schreiben von Prüfern
Prüfungsmeldungen
Zend_Version
Die Version des Zend Frameworks erhalten
Zend_View
Einführung
Controller Skripte
View Scripte
View Helfer
Zend_View_Abstract
Migration von vorhergehenden Versionen
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Einführung
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework Voraussetzungen
Einführung
Zend Framework Coding Standard für PHP
Übersicht
PHP Dateiformatierung
Namens Konventionen
Code Stil
Zend Framework Performance Guide
Einführung
Laden von Klassen
Zend_Db Performance
Internationalisierung (I18n) und Lokalisierung (L10n)
Darstellen der View
Urheberrecht Informationen