Ein Zend_Auth-Adapter wird verwendet, um sich gegenüber einem speziellen Typ von Authentifizierungsdiensten zu authentifizieren, wie LDAP, RDBMS, oder dateibasierenden Speichern. Verschiedene Adapter besitzen leicht unterschiedliche Optionen und Verhaltensweisen, aber einige grundlegende Dinge haben Authentifizierungsadapter gemeinsam. Zum Beispiel dass für die Authentifizierung Anmeldedaten akzeptiert werden (enthält auch vorgegebene Identitäten), dass Abfragen am Authentifizierungsservice durchgeführt werden, und dass Ergebnisse zurückgegeben werden, sind für Zend_Auth-Adapter gebräuchlich.

Jede Zend_Auth-Adapterklasse implementiert Zend_Auth_Adapter_Interface. Dieses Interface definiert eine Methode authenticate(), die eine Adapterklasse implementieren muß, um eine Authentifizierungsanfrage auszuführen. Jede Adapterklasse muß vorher vorbereitet werden, bevor authenticate() aufgerufen wird. Diese Vorbereitung des Adapters enthält das Setzen der Anmeldedaten (z.B. Benutzername und Passwort) und die Definition von Werten für adapterspezifische Konfigurationoptionen, wie Datenbankverbindungsdaten für einen Datenbank-Tabellen-Adapter.

Das folgende ist ein Beispiel eines Authentifierungs-Adapters der einen Benutzernamen und ein Passwort für die Authentifizierung benötigt. Andere Details, wie zum Beispiel der Authentifizierungs-Service abgefragt wird, werden der Kürze halber ausgelassen:

class MyAuthAdapter implements Zend_Auth_Adapter_Interface
{
    /**
     * Setzt Benutzername und Passwort für die Authentifizierung
     *
     * @return void
     */
    public function __construct($username, $password)
    {
        // ...
    }

    /**
     * Führt einen Authentifizierungs-Versuch durch
     *
     * @throws Zend_Auth_Adapter_Exception Wenn die Authentifizierung nicht
     *                                     durchgeführt wurde
     * @return Zend_Auth_Result
     */
    public function authenticate()
    {
        // ...
    }
}

Wie im Docblock angegeben, muß authenticate() eine Instanz von Zend_Auth_Result (oder einer von Zend_Auth_Result abgeleiteten Klassen) zurückgeben. Wenn aus bestimmten Gründen eine Durchführung einer Authentifizierungsanfrage nicht möglich ist, sollte authenticate() eine Ausnahme werfen, die von Zend_Auth_Adapter_Exception abgeleitet ist.

Zend_Auth-Adapter geben eine Instanz von Zend_Auth_Result mit Hilfe von authenticate() zurück, um die Ergebnisse des Authentifizierungsversuchs darzustellen. Adapter befüllen das Objekt Zend_Auth_Result bei der Erstellung, so dass die folgenden vier Methoden ein grundsätzliches Set von benutzerbezogenen Operationen bieten, die für die Ergebnisse von Zend_Auth Adapter üblich sind:

Ein Entwickler möchte basierend auf dem Typ des Authentifizierungsergebnisses zu spezialisierteren Operationen verzweigen. Einige Operationen die für Entwickler nützlich sein können, sind zum Beispiel das Sperren von Konten nachdem zu oft ein falsches Passwort angegeben wurde, das Markieren von IP-Adressen, nachdem zuviele nicht existierende Identitäten angegeben wurden und das Anbieten von speziellen, benutzerdefinierten Nachrichten für Authentifizierungsergebnisse an den Benutzer. Die folgenden Ergebniscodes sind vorhanden:

Zend_Auth_Result::SUCCESS
Zend_Auth_Result::FAILURE
Zend_Auth_Result::FAILURE_IDENTITY_NOT_FOUND
Zend_Auth_Result::FAILURE_IDENTITY_AMBIGUOUS
Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID
Zend_Auth_Result::FAILURE_UNCATEGORIZED

Das folgende Beispiel zeigt, wie ein Entwickler anhand des Ergebniscodes verzweigen könnte:

// Innerhalb von AuthController / loginAction
$result = $this->_auth->authenticate($adapter);

switch ($result->getCode()) {

    case Zend_Auth_Result::FAILURE_IDENTITY_NOT_FOUND:
        /** Was wegen nicht existierender Identität machen **/
        break;

    case Zend_Auth_Result::FAILURE_CREDENTIAL_INVALID:
        /** Was wegen ungültigen Anmeldededaten machen **/
        break;

    case Zend_Auth_Result::SUCCESS:
        /** Was wegen erfolgreicher Authentifizierung machen **/
        break;

    default:
        /** Was wegen anderen Fehlern machen **/
        break;
}

Eine Anfrage zu authentifizieren, die Anmeldedaten enthält ist per se nützlich, aber auch wichtig, um die Authentifizierungs-Identität bearbeiten zu können, ohne dass immer die Anmeldedaten bei jeder Anfrage vorhanden sein müssen.

Trotzdem ist HTTP ein statusloses Protokoll, und Techniken wie Cookies und Sessions wurden entwickelt um Stati über mehrere Anfragen hinweg in server-seitigen Web-Anwendungen zu erhalten.

// Eine Referenz zur Singleton Instanz von Zend_Auth speichern
$auth = Zend_Auth::getInstance();

// 'someNamespace' statt 'Zend_Auth' verwenden
$auth->setStorage(new Zend_Auth_Storage_Session('someNamespace'));

/**
 * @todo Den Auth Adapter $authAdapter erstellen
 */

// Authentifizieren, das Ergebnis speichern, und die Identität bei Erfolg
// persistent machen
$result = $auth->authenticate($authAdapter);

class MyStorage implements Zend_Auth_Storage_Interface
{
    /**
     * Gibt true zurück wenn und nur wenn der Speicher leer ist
     *
     * @throws Zend_Auth_Storage_Exception Wenn es unmöglich ist festzustellen,
     *                                     ob der Speicher leer ist
     * @return boolean
     */
    public function isEmpty()
    {
        /**
         * @todo Implementierung
         */
    }

    /**
     * Gibt den Inhalt des Speichers zurück
     *
     * Das Verhalten ist undefiniert, wenn der Speicher leer ist.
     *
     * @throws Zend_Auth_Storage_Exception Wenn das Lesen vom Speicher
     *                                     unmöglich ist
     * @return mixed
     */
    public function read()
    {
        /**
         * @todo Implementierung
         */
    }

    /**
     * Schreibt $contents in den Speicher
     *
     * @param  mixed $contents
     * @throws Zend_Auth_Storage_Exception Wenn das Schreiben von $contents in
     *                                     den Speicher unmöglich ist
     * @return void
     */
    public function write($contents)
    {
        /**
         * @todo Implementierung
         */
    }

    /**
     * Löscht die Intalte vom Speicher
     *
     * @throws Zend_Auth_Storage_Exception Wenn das Löschen der Inhalte vom
     *                                     Speicher unmöglich ist
     * @return void
     */
    public function clear()
    {
        /**
         * @todo Implementierung
         */
    }

}

// Zend_Auth anweisen, dass die selbstdefinierte Speicherklasse verwendet wird
Zend_Auth::getInstance()->setStorage(new MyStorage());

/**
 * @todo Den Auth Adapter $authAdapter erstellen
 */

// Authentifizieren, das Ergebnis speichern, und die Identität bei Erfolg
$result = Zend_Auth::getInstance()->authenticate($authAdapter);

Es gibt zwei vorhandene Wege um Zend_Auth-Adapter zu verwenden:

Das folgende Beispiel zeigt, wie ein Zend_Auth-Adapter indirekt verwendet werden kann, durch die Verwendung der Klasse Zend_Auth:

// Eine Referenz zur Singleton-Instanz von Zend_Auth erhalten
$auth = Zend_Auth::getInstance();

// Authentifizierungs Adapter erstellen
$authAdapter = new MyAuthAdapter($username, $password);

// Authentifizierungsversuch, das Ergebnis abspeichern
$result = $auth->authenticate($authAdapter);

if (!$result->isValid()) {
    // Authentifizierung fehlgeschlagen; die genauen Gründe ausgeben
    foreach ($result->getMessages() as $message) {
        echo "$message\n";
    }
} else {
    // Authentifizierung erfolgreich; die Identität ($username) wird in
    // der Session gespeichert
    // $result->getIdentity() === $auth->getIdentity()
    // $result->getIdentity() === $username
}

Sobald die Authentifizierung in einer Anfrage durchgeführt wurde, so wie im obigen Beispiel, ist es sehr einfach zu prüfen, ob eine erfolgreich authentifizierte Identität existiert:

$auth = Zend_Auth::getInstance();
if ($auth->hasIdentity()) {
    // Identität existiert; auslesen
    $identity = $auth->getIdentity();
}

Um eine Identität vom persistenten Speicher zu entfernen, muß einfach die Methode clearIdentity() verwendet werden. Das würde typischerweise für die Implementierung einer "Abmelde"-Operation in einer Anwendung Verwendung finden.

Zend_Auth::getInstance()->clearIdentity();

Wenn die automatische Verwendung von persistenten Speichern für einen bestimmten Verwendungszweck unangebracht ist, kann ein Entwickler einfach die Verwendung der Klasse Zend_Auth umgehen, und eine Adapterklasse direkt verwenden. Die direkte Verwendung einer Adapterklasse enthält das Konfigurieren und Vorbereiten eines Adapter-Objekts und den Aufruf dessen Methode authenticate(). Adapter-spezifische Details werden in der Dokumentation jedes Adapters besprochen. Das folgende Beispeil verwendet MyAuthAdapter direkt:

// Den Authentifizierungsadapter erstellen
$authAdapter = new MyAuthAdapter($username, $password);

// Authentifizierungsversuch, speichere das Ergebnis
$result = $authAdapter->authenticate();

if (!$result->isValid()) {
    // Authentifizierung fehlgeschlagen; die genauen Gründe ausgeben
    foreach ($result->getMessages() as $message) {
        echo "$message\n";
    }
} else {
    // Authentifizierung erfolgreich
    // $result->getIdentity() === $username
}