Programmer's Reference Guide

Kapitel 19. Zend_File

19.1. Zend_File_Transfer

Zend_File_Transfer ermöglicht es Entwicklern die Kontrolle über Dateiuploads sowie über Dateidownloads zu erhalten. Es erlaubt die Verwendung von eingebuaten Prüfungen für Dateizwecke und gibt sogar die Möglichkeit Dateien mit Filtern zu verändern. Zend_File_Transfer arbeitet mit Adaptern welche es erlauben die selbe API für unterschiedliche Transportprotokolle wie HTTP, FTP, WEBDAV und andere zu verwenden.

[Anmerkung] Einschränkungen

Die aktuelle Implementation von Zend_File_Transfer die in 1.6.0 ausgeliefert wird, ist auf HTTP Post Uploads limitiert. Downloaden von Dateien und andere Adapter werden in einem kommenden Release hinzugefügt. Nicht implementierte Methoden werfen eine Ausnahme. Deswegen sollte aktuell eine Instanz von Zend_File_Transfer_Adapter_Http direkt verwendet werden. Das wird sich in Zukunft ändern, sobald mehrere Adapter vorhanden sind.

[Anmerkung] Formulare

Wenn man Zend_Form verwendet sollte man die Beispiele, die im Kapitel von Zend_Form zu finden sind, lesen und verwenden und Zend_File_Transfer nicht manuell verwenden. Aber die Information die man in diesem Kapitel lesen kann sind sehr nützlich, selbst wenn man Sie nicht direkt verwendet. Alle Annahmen, Beschreibungen und Lösungen sind die gleichen wenn man Zend_File_Transfer über Zend_Form verwendet.

Die Verwendung von Zend_File_Transfer ist recht einfach. Es besteht aus zwei Teilen. Dem HTTP Formular das den Upload durchführt, und der Behandlung der hochgeladenen Dateien mit Zend_File_Transfer. Siehe das folgende Beispiel:

Beispiel 19.1. Einfaches File-Upload Formular

Dieses Beispiel zeigt einen einfachen Dateiupload welcher Zend_File_Transfer verwendet. Das erste Teil ist das Dateiformular. In unserem Beispiel gibt es nur eine Datei welche wir hochladen wollen.


<form enctype="multipart/form-data" action="/file/upload" method="POST">
    <input type="hidden" name="MAX_FILE_SIZE" value="100000" />
        Choose a file to upload: <input name="uploadedfile" type="file" />
    <br />
    <input type="submit" value="Upload File" />
</form>

Es ist zu beachten das der Bequemlichkeit halber Zend_Form_Element_File verwendet werden sollte statt das HTML manuell zu erstellen.

Der nächste Schritt ist die Erstellung des Empfängers des Uploads. In unserem Beispiel ist der Empfänger /file/upload. Als nächstes erstellen wir also den Kontroller file mit der Aktion upload.


$adapter = new Zend_File_Transfer_Adapter_Http();

$adapter->setDestination('C:\temp');

if (!$adapter->receive()) {
    $messages = $adapter->getMessages();
    echo implode("\n", $messages);
}

Wie man sieht besteht die einfachte Verwendung darin ein Ziel mit der setDestination Methode zu definieren und die receive() Methode aufzurufen. Wenn irgendwelche Uploadfehler vorhanden sind werden diese als Ausnahme zurückgegeben.


[Anmerkung] Achtung

Beachten Sie das das nur die einfachste Verwendung ist. Man sollte dieses Beispiel niemals in einer lebenden Umgebung einsetzen da es massive Sicherheitslücken aufweisst. Man sollte immer Prüfungen verwenden um die Sicherheit zu erhöhen.

19.1.1. Von Zend_File_Transfer unterstützte Adapter

Zend_File_Transfer wurde erstellt um verschiedene Adapter und auch Richtungen zu unterstützen. Es wurde designt um das Hochladen, Herunterladen und sogar das Weiterleiten (Hochladen mit einem Adapter und Herunterladen mit einem anderen Adapter zur gleichen Zeit) von Dateien zu erlauben. Aber mit Zend Framework 1.6 ist aktuell nur ein Adapter vorhanden, der Http Adapter.

Weil aktuell nur ein Adapter vorhanden ist, kann die Basisklasse aktuell noch nicht verwendet werden. Deshalb muß man, wenn man Zend_File_Transfer verwenden will, den Adapter direkt verwenden.

19.1.2. Optionen für Zend_File_Transfer

Zend_File_Transfer und dessen Adapter unterstützen verschiedene Optionen. Alle Optionen können gesetzt werden indem Sie entweder dem Constructor übergeben werden, oder durch Verwendung von setOptions($options). getOptions() gibt die aktuell gesetzten Optionen zurück. Anbei ist eine Liste aller unterstützten Optionen zu finden.

  • ignoreNoFile: Wenn diese Option auf true gesetzt ist, ignorieren alle Prüfer die Datei wenn Sie nicht vom Formular hochgeladen wurde. Diese Option ist standardmäßig false, was heißt das ein Fehler geworfen wird, wenn die Datei nicht angegeben wurde.

19.1.3. Prüfen von Dateien

Zend_File_Transfer hat verschiedene Methoden die auf verschiedenste Annahmen prüfen welche nützlich sind wenn man Dateien bearbeiten will nachdem Sie empfangen wurden.

  • isValid($files = null): Diese Methode prüft ob die angegebene Datei gültig ist, basierend auf den Prüfungen welche dieser Datei angehängt sind. Wenn keine Dateien angegeben wurden, werden alle Dateien geprüft. Es ist zu beachten das diese Methode mindestens dann aufgerufen wird, wenn man die Dateien empfängt.

  • isUploaded($files = null): Diese Methode prüft ob die angegebene Datei vom Benutzer hochgeladen wurde. Das ist nützlich wenn man verschiedene Dateien definiert hat die optional hochzuladen sind. Wenn keine Dateien angegeben wurden, werden alle Dateien geprüft.

  • isReceived($files = null): Diese Methode prüft ob die angegebene Datei bereits empfangen wurde. Wenn keine Dateien angegeben wurden, werden alle Dateien geprüft.

Beispiel 19.2. Dateien prüfen


$upload = new Zend_File_Transfer();

// Gibt alle bekannten internen Dateiinformationen zurück
$files = $upload->getFileInfo();

foreach ($files as $file => $info) {
    // Datei hochgeladen ?
    if (!$upload->isUploaded($file)) {
        print "Warum hast Du die Datei nicht hochgeladen ?";
        continue;
    }

    // Prüfungen sind ok ?
    if (!$upload->isValid($file)) {
        print "Sorry, aber die Datei ist nicht das was wir wollten";
        continue;
    }
}

$upload->receive();

19.1.4. Zusätzliche Dateiinformationen

Zend_File_Transfer kann verschiedene zusätzliche Informationen über Dateien zurückgeben. Die folgenden Methoden sind vorhanden:

  • getFileName($file = null, $path = true): Diese Methode gibt den wirklichen Namen der übertragenen Datei zurück.

  • getFileInfo($file = null): Diese Methode gibt die internen Informationen für die angegebene übertragene Datei zurück.

  • getHash($hash = 'crc32', $files = null): Diese Methode gibt einen Hash des Inhalts einer angegebenen übertragenen Datei zurück.

getFileName() akzeptiert den Namen des Elements als ersten Parameter. Wenn kein Name angegeben wird, werden alle bekannten Dateinamen in einem Array zurückgegeben. Wenn die Datei eine MultiDatei ist, wird auch ein Array zurückgegeben. Wenn nur eine einzelne Datei vorhanden ist wird nur ein String zurückgegeben.

Standardmäßig werden Dateinamen mit Ihrem kompletten Pfad zurückgegeben. Wenn man nur den Dateinamen ohne Pfad benötigt, kann der zweite Parameter $path gesetzt werden, welcher den Dateinamen ausschneidet wenn er auf false gesetzt wird.

Beispiel 19.3. Den Dateinamen bekommen


$upload = new Zend_File_Transfer();
$upload->receive();

// Gibt die Dateinamen aller Dateien zurück
$names = $upload->getFileName();

// Gibt den Dateinamen des Formularelements 'foo' zurück
$names = $upload->getFileName('foo');

[Anmerkung] Anmerkung

Es ist zu beachten das sich der Dateinamen ändern kann wenn man die Datei empfängt (receive). Das kann geschehen durch den Fakt das beim Empfangen alle Filter ausgeführt werden. Deswegen sollte man getFileName() immer ausführen nachdem man die Dateien empfangen hat.

getHash() akzeptiert den Namen eines Hash Algorithmus als ersten Parameter. Für eine Liste von bekannten Algorithmen kann in PHP's hash_algos Methode gesehen werden. Wenn kein Algorithmus angegeben wird, wird crc32 als Standardalgorithmus verwendet.

Beispiel 19.4. Den Hash einer Datei erhalten


$upload = new Zend_File_Transfer();
$upload->receive();

// Gibt die Hashes von allen Dateien als Array zurück wenn mehr als eine Datei hochgeladen wurde
$hash = $upload->getHash('md5');

// Gibt den Has für das 'foo' Formularelement zurück
$names = $upload->getHash('crc32', 'foo');

[Anmerkung] Anmerkung

Es ist zu beachten das der zurückgegebene Wert ein Array ist, wenn die Datei oder der Formularname mehr als eine einzelne Datei enthält.


Search the Manual

Translation Status Reports

View the current status report of Zend Framework manual translations.