Documentation

Zend Framework 1.7(日本語) - Zend Framework Migration Notes

Zend Framework 1.7(日本語)

以前のバージョンから Zend Framework 1.7 またはそれ以降に更新する際は、 下記の移行上の注意点に注意すべきです。

Zend_Controller

ディスパッチャインターフェイスの変更

ユーザからの指摘により、 Zend_Controller_Action_Helper_ViewRenderer が使っているディスパッチャ抽象クラスのメソッドの中で ディスパッチャインターフェイスに存在しないものがあることに気づきました。 次のメソッドを追加し、 自作のディスパッチャが同梱の実装と共存できるようにしています。

  • formatModuleName(): リクエストオブジェクト内に格納されたりしている生のコントローラ名を受け取り、 それを再フォーマットして Zend_Controller_Action を継承した適切なクラス名にします。

Zend_File_Transfer

フィルタやバリデータを使用する際の変更点

Zend_File_Transfer のバリデータが Zend_Config と組み合わせて使えないという指摘がありました。 名前つき配列を使っていなかったからです。

そこで、Zend_File_Transfer 用のすべてのフィルタとバリデータを作り直しました。 古い構文でも動作しますがこれは非推奨となり、 設定せずに実行すると PHP の notice が発生するようになります。

次のリストは、パラメータの使用法に関する変更点をまとめたものです。

Rename フィルタ

  • 古い形式の API: Zend_Filter_File_Rename($oldfile, $newfile, $overwrite)

  • 新しい形式の API: Zend_Filter_File_Rename($options) $options には次の配列キーを使えます。 source ($oldfile と同等)、 target ($newfile と同等)、 overwrite ($overwrite と同等)

Example #1 rename フィルタの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addFilter('Rename',
  4.                    array('/path/to/oldfile', '/path/to/newfile', true));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addFilter('Rename',
  9.                    array('source' => '/path/to/oldfile',
  10.                          'target' => '/path/to/newfile',
  11.                          'overwrite' => true));

Count バリデータ

  • 古い形式の API: Zend_Validate_File_Count($min, $max)

  • 新しい形式の API: Zend_Validate_File_Count($options) $options には次の配列キーを使えます。 min ($min と同等)、 max ($max と同等)

Example #2 count バリデータの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Count',
  4.                       array(2, 3));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Count',
  9.                       false,
  10.                       array('min' => 2,
  11.                             'max' => 3));

Extension バリデータ

  • 古い形式の API: Zend_Validate_File_Extension($extension, $case)

  • 新しい形式の API: Zend_Validate_File_Extension($options) $options には次の配列キーを使えます。 * ($extension と同等、任意の他のキーを使用可能)、 case ($case と同等)

Example #3 extension バリデータの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Extension',
  4.                       array('jpg,gif,bmp', true));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Extension',
  9.                       false,
  10.                       array('extension1' => 'jpg,gif,bmp',
  11.                             'case' => true));

FilesSize バリデータ

  • 古い形式の API: Zend_Validate_File_FilesSize($min, $max, $bytestring)

  • 新しい形式の API: Zend_Validate_File_FilesSize($options) $options には次の配列キーを使えます。 min ($min と同等)、 max ($max と同等)、 bytestring ($bytestring と同等)

さらに useByteString() メソッドのシグネチャも変わりました。 このメソッドの使用法は、 そのバリデータが生成するメッセージでバイト文字列を使うことを想定しているかどうかを調べるだけになりました。 フラグの値を設定するには setUseByteString() メソッドを使用します。

Example #4 filessize バリデータの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('FilesSize',
  4.                    array(100, 10000, true));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('FilesSize',
  9.                       false,
  10.                       array('min' => 100,
  11.                             'max' => 10000,
  12.                             'bytestring' => true));
  13.  
  14. // 1.6 の例
  15. $upload->useByteString(true); // set flag
  16.  
  17. // 1.7 の例
  18. $upload->setUseByteSting(true); // set flag

Hash バリデータ

  • 古い形式の API: Zend_Validate_File_Hash($hash, $algorithm)

  • 新しい形式の API: Zend_Validate_File_Hash($options) $options には次の配列キーを使えます。 * ($hash と同等、任意の他のキーを使用可能)、 algorithm ($algorithm と同等)、

Example #5 hash バリデータの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Hash',
  4.                    array('12345', 'md5'));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Hash',
  9.                       false,
  10.                       array('hash1' => '12345',
  11.                             'algorithm' => 'md5'));

ImageSize バリデータ

  • 古い形式の API: Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth, $maxheight)

  • 新しい形式の API: Zend_Validate_File_FilesSize($options) $options には次の配列キーを使えます。 minwidth ($minwidth と同等)、 maxwidth ($maxwidth と同等)、 minheight ($minheight と同等)、 maxheight ($maxheight と同等)

Example #6 imagesize バリデータの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('ImageSize',
  4.                       array(10, 10, 100, 100));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('ImageSize',
  9.                       false,
  10.                       array('minwidth' => 10,
  11.                             'minheight' => 10,
  12.                             'maxwidth' => 100,
  13.                             'maxheight' => 100));

Size バリデータ

  • 古い形式の API: Zend_Validate_File_Size($min, $max, $bytestring)

  • 新しい形式の API: Zend_Validate_File_Size($options) $options には次の配列キーを使えます。 min ($min と同等)、 max ($max と同等)、 bytestring ($bytestring と同等)

Example #7 size バリデータの 1.6 から 1.7 での変更点

  1. // 1.6 の例
  2. $upload = new Zend_File_Transfer_Adapter_Http();
  3. $upload->addValidator('Size',
  4.                       array(100, 10000, true));
  5.  
  6. // 1.7 の例
  7. $upload = new Zend_File_Transfer_Adapter_Http();
  8. $upload->addValidator('Size',
  9.                       false,
  10.                       array('min' => 100,
  11.                             'max' => 10000,
  12.                             'bytestring' => true));

Zend_Locale

isLocale() を使う際の変更点

コーディング規約に従うと、 isLocale() は boolean 値を返さなければなりませんでした。 以前のバージョンでは、成功したばあいに文字列を返していました。 リリース 1.7 では、互換性モードが追加されて文字列を返す古い挙動も使えます。 しかし、このばあいは新しい挙動に変更するようにというユーザ警告が発生します。 古い挙動の isLocale() が行っていた再ルーティングはもはや不要で、 すべての I18n は自分自身で再ルーティングを行います。

あなたのスクリプトを新しい API 用に変更するには、次のようにメソッドを使用します。

Example #8 isLocale() を 1.6 用から 1.7 用に変更する方法

  1. // 1.6 の例
  2. if ($locale = Zend_Locale::isLocale($locale)) {
  3.     // ここで何かします
  4. }
  5.  
  6. // 1.7 の例
  7.  
  8. // 互換性モードを変更して警告の発生を防ぐ必要があります
  9. // これは起動ファイルで行うことができます
  10. Zend_Locale::$compatibilityMode = false;
  11.  
  12. if (Zend_Locale::isLocale($locale)) {
  13. }

2 番目のパラメータを使えば、 そのロケールが正しくて再ルーティングが発生しなかったかどうかがわかることに注意しましょう。

  1. // 1.6 の例
  2. if ($locale = Zend_Locale::isLocale($locale, false)) {
  3.     // ここで何かします
  4. }
  5.  
  6. // 1.7 の例
  7.  
  8. // 互換性モードを変更して警告の発生を防ぐ必要があります
  9. // これは起動ファイルで行うことができます
  10. Zend_Locale::$compatibilityMode = false;
  11.  
  12. if (Zend_Locale::isLocale($locale, false)) {
  13.     if (Zend_Locale::isLocale($locale, true)) {
  14.         // ロケールはありません
  15.     }
  16.  
  17.     // もとの文字列はロケールを持ちませんが再ルーティングできます
  18. }

getDefault() を使用する際の変更

getDefault() メソッドの意味が変わりました。 フレームワークにロケールが統合され、それを setDefault() で設定できるようになったからです。 このメソッドはもはやロケールチェインを返すことはなく、 フレームワークのロケールに設定されたものだけを返します。

あなたのスクリプトを新しい API 用に変更するには、次のようにメソッドを使用します。

Example #9 getDefault() を 1.6 用から 1.7 用に変更する方法

  1. // 1.6 の例
  2. $locales = $locale->getDefault(Zend_Locale::BROWSER);
  3.  
  4. // 1.7 の例
  5.  
  6. // 互換性モードを変更して警告の発生を防ぐ必要があります
  7. // これは起動ファイルで行うことができます
  8. Zend_Locale::$compatibilityMode = false;
  9.  
  10. $locale = Zend_Locale::getOrder(Zend_Locale::BROWSER);

古い実装における getDefault() の 2 番目のパラメータはもはや使えないことに注意しましょう。 返り値がそれと同じ値となります。

Note: デフォルトでは古い挙動も有効ですが、ユーザ警告が発生します。 新しい挙動にあわせてコードを変更し終えたら、 互換性モードを FALSE に変更して警告が発生しないようにしなければなりません。

Zend_Translate

言語の設定

言語の自動検出を使用したり Zend_Translate に手動で言語を設定したりする際に、 「追加に失敗」や「翻訳がない」などの理由で notice が発行されることがありました。 以前のリリースでは、場合によっては例外が発生することもありました。

その原因は、存在しない言語をユーザが指定した際に 何が問題なのかを知る簡単な方法がなかったことにあります。 そこで私たちは notice を発行させるようにしていたのです。 ログに記録が残るので、サポートしていない言語がリクエストされたことがわかるようになります。 そしてたとえ notice が発行されたとしても、コード自体は問題なく動作します。

しかし、xdebug のような独自のエラーハンドラ/例外ハンドラを使った場合など、 意図せぬものも含めてすべての notice を拾ってしまうこともあります。 そういった独自のハンドラは PHP の設定を上書きしてしまうことがあるからです。

これらの notice を発生させないようにするためには、新たなオプション 'disableNotices' を TRUE に設定するだけです。デフォルトは FALSE となっています。

Example #10 notice を取得せずに言語の設定を行う

ここでは、'en' に対応しているところにユーザから 'fr' がリクエストされたものと家庭します。この翻訳は登録されていません。

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

この場合、存在しない言語 'fr' が指定されたことに関する notice が発行されます。 オプションを追加すると、この notice は発生しなくなります。

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

Zend_View

Note: Zend_View 内の API 変更は、 リリース 1.7.5 またはそれ以降にアップグレードする際にだけ注意すべきです。

Zend Framework 開発陣は、1.7.5 より前のバージョンにおいて Zend_View::render() メソッドにローカルファイル読み込み (Local File Inclusion: LFI) 脆弱性の問題があることに気づきました。 1.7.5 より前のバージョンでは、このメソッドはデフォルトで 親ディレクトリを指す記法 ("../" や "..\") を含むビュースクリプトも指定できてしまいます。 フィルタリングをしていないユーザ入力が render() メソッドに渡されると、 LFI 攻撃を受ける可能性が出てきます。

  1. // $_GET['foobar'] = '../../../../etc/passwd' だったら……
  2. echo $view->render($_GET['foobar']); // LFI

Zend_View は、このようなビュースクリプトがリクエストされると デフォルトで例外を発生させるようになりました。

render() メソッドにおける LFI 保護機能の無効化

多くの開発者から「ユーザの入力ではない 場面で、意図的にこれらの記法を使っていることもある」という指摘を受けたため、 特別なフラグを用意してデフォルトの保護機能を無効化できるようにしました。 無効化する方法は二通りあります。コンストラクタのオプションで 'lfiProtectionOn' キーを指定するか、あるいは setLfiProtection() メソッドをコールします。

  1. // コンストラクタでの無効化
  2. $view = new Zend_View(array('lfiProtectionOn' => false));
  3.  
  4. // メソッドコールによる無効化
  5. $view = new Zend_View();
  6. $view->setLfiProtection(false);

Copyright

© 2006-2020 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts