Zend Framework 1.7

Wenn man von einem älteren Release auf Zend Framework 1.7 oder höher hochrüstet sollte man die folgenden Migrations Hinweise beachten.

Zend_Controller

Änderungen im Dispatcher Interface

Benutzer haben uns darauf aufmerksam gemacht das Zend_Controller_Action_Helper_ViewRenderer Methoden auf der abstrakten Dispatcher Klasse verwendet hat die nicht im Dispatcher Interface waren. Die folgenden Methoden wurden hinzugefügt um sicherzustellen das eigene Dispatcher weiterhin mit den ausgelieferten Implementierungen funktionieren:

  • formatModuleName(): sollte verwendet werden um einen rohen Controllernamen zu nehmen, wie den einen der in einem Anfrageobjekt gepackt ist, und Ihn in einen richtigen Klassennamen zu reformatieren den eine Klasse, die Zend_Controller_Action erweitert, verwenden würde

Zend_File_Transfer

Änderungen bei der Verwendung von Filtern und Prüfungen

Wie von Benutzern erwähnt, arbeiteten die Prüfungen von Zend_File_Transfer nicht in Verbindung mit Zend_Config zusammen, durch den Fakt das Sie keine benannten Arrays verwendet haben.

Deswegen wurden alle Filter und Prüfungen für Zend_File_Transfer überarbeitet. Wärend die alten Signaturen weiterhin funktionieren, wurden sie als veraltet markiert, und werfen eine PHP Notiz mit der Aufforderung das zu beheben.

Die folgende Liste zeigt die Änderungen und was für die richtige Verwendung der Parameter getan werden muß.

Filter: Rename
  • Alte API der Methode: Zend_Filter_File_Rename($oldfile, $newfile, $overwrite)

  • Neue API der Methode: Zend_Filter_File_Rename($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: source identisch mit $oldfile, target identisch mit $newfile, overwrite identisch mit $overwrite

Beispiel 1013. Änderungen für den Rename Filter von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addFilter('Rename',
                   array('/path/to/oldfile', '/path/to/newfile', true));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addFilter('Rename',
                   array('source' => '/path/to/oldfile',
                         'target' => '/path/to/newfile',
                         'overwrite' => true));

Prüfung: Count
  • Alte API der Methode: Zend_Validate_File_Count($min, $max)

  • Neue API der Methode: Zend_Validate_File_Count($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: min identisch mit $min, max identisch mit $max

Beispiel 1014. Änderungen für die Count Prüfung von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Count',
                      array(2, 3));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Count',
                      false,
                      array('min' => 2,
                            'max' => 3));

Prüfung: Extension
  • Alte API der Methode: Zend_Validate_File_Extension($extension, $case)

  • Neue API der Methode: Zend_Validate_File_Extension($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: * identisch mit $extension und kann jeden anderen Schlüssel haben case identisch mit $case

Beispiel 1015. Änderungen für die Extension Prüfung von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Extension',
                      array('jpg,gif,bmp', true));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Extension',
                      false,
                      array('extension1' => 'jpg,gif,bmp',
                            'case' => true));

Prüfung: FilesSize
  • Alte API der Methode: Zend_Validate_File_FilesSize($min, $max, $bytestring)

  • Neue API der Methode: Zend_Validate_File_FilesSize($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: min identisch mit $min, max identisch mit $max, bytestring identisch mit $bytestring

Zustätzlich wurde die Signatur der useByteString() Methode geändert. Sie kann nur verwendet werden um zu testen ob die Prüfung ByteStrings in den erzeugten Meldungen verwendet oder ncht. Um den Wert dieses Flags zu setzen muß die setUseByteString() Methode verwendet werden.

Beispiel 1016. Änderungen für die FilesSize Prüfung von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('FilesSize',
                      array(100, 10000, true));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('FilesSize',
                      false,
                      array('min' => 100,
                            'max' => 10000,
                            'bytestring' => true));

// Beispiel für 1.6
$upload->useByteString(true); // Flag setzen

// Gleiches Beispiel für 1.7
$upload->setUseByteSting(true); // Flag setzen

Prüfung: Hash
  • Alte API der Methode: Zend_Validate_File_Hash($hash, $algorithm)

  • Neue API der Methode: Zend_Validate_File_Hash($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: * identisch mit $hash und kann jeden anderen Schlüssel haben algorithm identisch mit $algorithm

Beispiel 1017. Änderungen für die Hash Prüfung von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Hash',
                      array('12345', 'md5'));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Hash',
                      false,
                      array('hash1' => '12345',
                            'algorithm' => 'md5'));

Prüfung: ImageSize
  • Alte API der Methode: Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth, $maxheight)

  • Neue API der Methode: Zend_Validate_File_FilesSize($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: minwidth identisch mit $minwidth, maxwidth identisch mit $maxwidth, minheight identisch mit $minheight, maxheight identisch mit $maxheight

Beispiel 1018. Änderungen für die ImageSize Prüfung von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('ImageSize',
                      array(10, 10, 100, 100));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('ImageSize',
                      false,
                      array('minwidth' => 10,
                            'minheight' => 10,
                            'maxwidth' => 100,
                            'maxheight' => 100));

Prüfung: Size
  • Alte API der Methode: Zend_Validate_File_Size($min, $max, $bytestring)

  • Neue API der Methode: Zend_Validate_File_Size($options) wobei $options die folgenden Schlüssel für das Array akzeptiert: min identisch mit $min, max identisch mit $max, bytestring identisch mit $bytestring

Beispiel 1019. Änderungen für die Size Prüfung von 1.6 zu 1.7

// Beispiel für 1.6
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Size',
                      array(100, 10000, true));

// Gleiches Beispiel für 1.7
$upload = new Zend_File_Transfer_Adapter_Http();
$upload->addValidator('Size',
                      false,
                      array('min' => 100,
                            'max' => 10000,
                            'bytestring' => true));

Zend_Locale

Änderungen bei der Verwendung von isLocale()

Bezugnehmend auf den Codingstandard mußte isLocale() so geändert werden das es ein Boolean zurückgibt. In vorhergehenden Releases wurde im Erfolgsfall ein String zurückgegeben. Für das Release 1.7 wurde ein Kompatibilitätsmodus hinzugefügt der es erlaubt das alte Verhalten, das ein String zurückgegeben wird, zu verwenden, aber das triggert auch eine User Warning die darauf hinweist das man auf das neue Verhalten wechseln sollte. Das Rerouting welches das alte Verhalten von isLocale() durchgeführt hätte ist nicht länger notwendig, da alle I18n Komponenten jetzt das Rerouting selbst durchführen.

Um die Skripte auf die neue API zu migrieren muß die Methode einfach wie anbei gezeigt verwendet werden.

Beispiel 1020. Wie man isLocale() von 1.6 nach 1.7 ändern muß

// Beispiel für 1.6
if ($locale = Zend_Locale::isLocale($locale)) {
    // mach was
}

// Selbes Beispiel für 1.7

// Man sollte den Kompatibilitätsmodus ändern um User Warnings zu verhindern
// Aber man kann das in der Bootstrap tun
Zend_Locale::$compatibilityMode = false;

if (Zend_Locale::isLocale($locale)) {
}

Es ist zu beachten das man den zweiten Parameter verwendet kann um zu sehen ob das Gebietsschema richtig ist ohne das ein Rerouting durchgeführt wird.

// Beispiel für 1.6
if ($locale = Zend_Locale::isLocale($locale, false)) {
    // mach was
}

// Selbes Beispiel für 1.7

// Man sollte den Kompatibilitätsmodus ändern um User Warnings zu verhindern
// Aber man kann das in der Bootstrap tun
Zend_Locale::$compatibilityMode = false;

if (Zend_Locale::isLocale($locale, false)) {
    if (Zend_Locale::isLocale($locale, true)) {
        // gar kein Gebietsschema
    }

    // Original String ist kein Gebietsschema, kann aber Reroutet werden
}

Änderungen bei der Verwendung von getDefault()

Die Bedeutung der getDefault() Methode wurde verändert durch den Fakt das Framework-weite Gebietsschemata integriert wurden welche mit setDefault() gesetzt werden können. Deswegen gibe es nicht mehr die Kette der Gebietsschemata zurück sondern nur die gesetzten Framework-weiten Gebietsschemata.

Um die eigenen Skripte auf die neue API zu migrieren, muß einfach die Methode wie unten gezeigt verwendet werden.

Beispiel 1021. Wie man getDefault() von 1.6 auf 1.7 ändert

// Beispiel für 1.6
$locales = $locale->getDefault(Zend_Locale::BROWSER);

// Selbes Beispiel für 1.7

// Man sollte den Compatibility Mode setzen um User Notices zu verhindern
// Das kann in der Bootstrap Datei getan werden
Zend_Locale::$compatibilityMode = false;

$locale = Zend_Locale::getOrder(Zend_Locale::BROWSER);

Es ist zu beachten das der zweite Parameter der alten getDefault() Implementation nicht mehr vorhanden ist, aber die zurückgegebenen Werte die gleichen sind.


Anmerkung

Standardmäßig ist das alte Verhalten noch immer aktiv, wirft aber eine User Notice. Wenn man den eigenen Code zum neuen Verhalten geändert hat sollte man auch den Compatibility Mode auf FALSE setzen damit keine Notices mehr geworfen werden.

Zend_Translate

Setzen von Sprachen

Wenn man die automatische Erkennung von Sprachen verwendet, oder Sprachen manuell auf Zend_Translate setzt kann es sein das man von Zeit zu Zeit eine Notiz geworfen bekommen die über nicht hinzugefügte oder leere Übersetzungen schreibt. In einigen vorhergehenden Releases wurde in einigen Fällen auch eine Exception geworfen.

Der Grund ist, das wenn ein Benutzer eine nicht existierende Sprache anfragt, man einfach keinen Weg hat um festzustellen was falsch ist. Deswegen haben wir diese Notizen hinzugefügt die einem in den eigenen Logs zeigen das der Benutzer eine Sprache angefragt hat die man nicht unterstützt. Es ist zu beachten das der Code, selbst wenn eine Notiz getriggert wird, weiterhin ohne Probleme arbeitet.

Aber wenn man einen eigenen Fehler oder Exception Handler, wie XDebug, verwendet wird man alle Notizen zurückerhalten, selbst wenn man das nicht gewollt hat. Das ist der Fall, weil diese Handler alle Einstellungen von PHP selbst überschreiben.

Um diese Notizen wegzubekommen kann man einfach die neue Option 'disableNotices' auf TRUE setzen. Der Standardwert ist FALSE.

Beispiel 1022. Setzen von Sprachen ohne das man Notizen erhält

Nehmen wir an das wir 'en' vorhanden haben und unser Benutzer 'fr' anfragt was nicht in unserem Portfolio der übersetzten Sprachen ist.

$language = new Zend_Translate('gettext',
                               '/path/to/translations',
                               'auto');

In diesem Fall werden wir eine Notiz darüber erhalten das die Sprache 'fr' nicht vorhanden ist. Durch das einfache Hinzufügen der Option wird die Notiz abgeschaltet.

$language = new Zend_Translate('gettext',
                               '/path/to/translations',
                               'auto',
                               array('disableNotices' => true));

Zend_View

Anmerkung

Die Änderung der API in Zend_View sind nur dann zu beachten wenn man zum Release 1.7.5 oder höher hochrüstet.

Vor dem 1.7.5 Release wurde das Zend Framework Team darauf aufmerksam gemacht das eine potentielle Local File Inclusion (LFI) Schwäche in der Zend_View::render() Methode existiert. Vor 1.7.5, erlaubte die Methode standardmäßig, die Fähigkeit View Skripte zu spezifizieren die Schreibweisen für Eltern-Verzeichnisse enthalten (z.B. "../" oder "..\"). Das öffnet die Möglichkeit für eine LFI Attacke wenn ungefilterte Benutzereingaben an die render() Methode übergeben werden:

// Wobei $_GET['foobar'] = '../../../../etc/passwd'
echo $view->render($_GET['foobar']); // LFI Einbruch

Zend_View wirft jetzt standardmäßig eine Ausnahme wenn so ein View Skript angefragt wird.

Ausschalten des LFI Schutzes für die render() Methode

Da viele Entwickler gemeldet haben das Sie so eine Schreibweise in Ihren Anwendungen verwenden die nicht das Ergebnis einer Benutzereingabe sind, wurde ein spezielles Flag erstellt um das Deaktivieren des standardmäßigen Schutzes zu erlauben. Es gibt 2 Methoden um das Durchzuführen: Indem der 'lfiProtectionOn' Schlüssel in den Konstruktor-Optionen übergeben wird, oder durch den expliziten Aufruf der setLfiProtection() Methode.

// Ausschalten über den Konstruktor
$view = new Zend_View(array('lfiProtectionOn' => false));

// Ausschalten über expliziten Aufruf der Methode:
$view = new Zend_View();
$view->setLfiProtection(false);