From 6a4b853b274cc843f28d1d2f7f2a564fcd3b7f7d Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Sat, 8 Oct 2011 18:26:01 +0200 Subject: [PATCH] removed the UPDATE files --- UPDATE.ja.md | 780 ---------------------------------------------- UPDATE.md | 863 --------------------------------------------------- 2 files changed, 1643 deletions(-) delete mode 100644 UPDATE.ja.md delete mode 100644 UPDATE.md diff --git a/UPDATE.ja.md b/UPDATE.ja.md deleted file mode 100644 index e94969e694..0000000000 --- a/UPDATE.ja.md +++ /dev/null @@ -1,780 +0,0 @@ -プロジェクトをアップデートする方法 -================================== - -このドキュメントでは、Symfony2 の特定のバージョンから1つ次のバージョンへアップデートする方法を説明します。 -このドキュメントでは、フレームワークの "パブリックな" APIを使っている場合に必要な変更点についてのみ説明しています。 -フレームワークのコアコードを "ハック" している場合は、変更履歴を注意深く追跡する必要があるでしょう。 - -RC4 から RC5 ------------- - -* `MapFileClassLoader` は削除され `MapClassLoader` が採用されました。 - -* `exception_controller` の設定は、 `framework` セクションの `twig` へ移動しました。 - -* カスタムエラーページは、現在 `TwigBundle` の代わりに `FrameworkBundle` を参照する必要があります。(参照 http://symfony.com/doc/2.0/cookbook/controller/error_pages.html) - -* `EntityUserProvider` クラスは Bridge へ移動されました。 - FQCN は `Symfony\Component\Security\Core\User\EntityUserProvider` から - `Symfony\Bridge\Doctrine\Security\User\EntityUserProvider` に変更になります。 - -* `HeaderBag` からの Cookie アクセスが削除されました。 - リクエスト Cookie へのアクセスには、`Request::$cookies` を使ってください。 - -* `ResponseHeaderBag::getCookie()` メソッドと `ResponseHeaderBag::hasCookie()` メソッドは削除されました。 - -* `ResponseHeaderBag::getCookies()` メソッドの引数で、戻り値のフォーマットを指定できるようになりました。指定できる値は `ResponseHeaderBag::COOKIES_FLAT` (デフォルト値) または `ResponseHeaderBag::COOKIES_ARRAY` です。 - - * `ResponseHeaderBag::COOKIES_FLAT` を指定すると、戻り値は単純な配列になります（配列のキーは、Cookie の名前ではなくなります）: - - * array(0 => `Cookie インスタンス`, 1 => `別の Cookie インスタンス`) - - * `ResponseHeaderBag::COOKIES_ARRAY` を指定すると、戻り値は多次元配列になります: - - * array(`ドメイン` => array(`パス` => array(`Cookie 名` => `Cookie インスタンス`))) - -* 制約は有効となったキーのみを保持し、その値は保持していないため、Choice 制約の推測クラス（Guesser）は削除されました。 - -* MonologBundle の設定のリファクタリングが行われました。 - - * プロセッサでサポートされるのは、サービスのみです。このサービスは `monolog.processor` タグを使って登録します。次の 3 つの属性を指定できます: - - * `handler`: 特定のハンドラーのみに対して登録する場合、そのハンドラーの名前 - * `channel`: 特定のロギングチャンネルのみに対して登録する場合のチャンネル (`handler` とどちらか一方のみを指定) - * `method`: レコードの処理に使用するメソッド (指定しない場合は `__invoke` が使われます) - - * `SwiftMailerHandler` の email_prototype 設定に指定できるのは、サービスのみです。 - - * 変更前: - - email_prototype: @acme_demo.monolog.email_prototype - - * 変更後: - - email_prototype: acme_demo.monolog.email_prototype - - もしくは、次のようにしてプロトタイプ用のファクトリを使うこともできます: - - email_prototype: - id: acme_demo.monolog.email_prototype - method: getPrototype - -* セキュリティを考慮し、プロキシ由来の HTTP ヘッダー (`HTTP_X_FORWARDED_FOR`、`X_FORWARDED_PROTO`、`X_FORWARDED_HOST` 等) は、デフォルトでは信頼されなくなりました。リバースプロキシ経由でアプリケーションを利用する構成の場合は、次のように設定してください: - - framework: - trust_proxy_headers: true - -* 意図しない名前の衝突を避けるため、AbstractType によるフォームタイプ名の自動定義は行われなくなりました。カスタムタイプを作成する場合は、明示的に `getName()` メソッドを実装する必要があります。 - -RC3 から RC4 ------------- - -* Annotation クラスには、@Annotation を付加してください。 - (例については Validator コンポーネントの制約クラスを参照してください) - -* アノテーションのオートロードには、PHP の機構ではなく独自の機構が使われるように変更されました。 - これにより、失敗の状態についてより制御できるようになりました。 - コードを動作させるようにするには、`autoload.php` ファイルの末尾に次のコードを追加してください: - - use Doctrine\Common\Annotations\AnnotationRegistry; - - AnnotationRegistry::registerLoader(function($class) use ($loader) { - $loader->loadClass($class); - return class_exists($class, false); - }); - - AnnotationRegistry::registerFile( - __DIR__.'/../vendor/doctrine/lib/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php' - ); - - `$loader` 変数は `UniversalClassLoader` のインスタンスです。 - また、ORM のパスを `DoctrineAnnotations.php` に変更しなければいけない場合もあります。 - `UniversalClassLoader` を使っていない場合、アノテーションの登録の詳細については、[Doctrine アノテーションドキュメント](http://www.doctrine-project.org/docs/common/2.1/en/reference/annotations.html) を参照してください。 - -beta5 から RC1 --------------- - -* `Symfony\Bundle\FrameworkBundle\Command\Command` クラスの名前が - `Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand` に変更されました。 - -* ルーティングの `AnnotGlobLoader` クラスが削除されました。 - -* Twig フォームテンプレートのいくつかのブロックの名前は、衝突を避けるために変更されました。 - - * `container_attributes` から `widget_container_attributes` - * `attributes` から `widget_attributes` - * `options` から `widget_choice_options` - -* イベントの変更: - - * すべてのリスナーには、`kernel.listener` タグではなく `kernel.event_listener` タグを設定する必要があります。 - * カーネルイベントのプレフィックスが `core` から `kernel` に変更されました: - - * 変更前: - - - - * 変更後: - - - - Note: メソッド名 method 属性で独立して指定できるので、`onCoreRequest` のままでも動作しますが、将来的な一貫性のためにイベント名に合わせたメソッド名に変更しておく方がよいでしょう。 - - * `Symfony\Component\HttpKernel\CoreEvents` クラスの名前が - `Symfony\Component\HttpKernel\KernelEvents` に変更されました。 - -* `TrueValidator` と `FalseValidator` の受け付ける値をより限定しました。 - -beta4 から beta5 ----------------- - -* `UserProviderInterface::loadUser()` メソッドの名前は、メソッドの目的がより明確になるよう、`UserProviderInterface::refreshUser()` に変更されました。 - -* `WebTestCase` クラスの `$kernel` プロパティは static に変更されました。 - ファンクショナルテスト内で `$this->kernel` を使っている箇所は、`self::$kernel` に変更してください。 - -* AsseticBundle は独立したリポジトリで管理されるようになりました（Symfony2 Standard Edition にはバンドルされています）。 - -* Yaml コンポーネントの変更: - - * Exception クラスは独自の名前空間へ移動されました。 - * `Yaml::load()` メソッドの名前は `Yaml::parse()` に変更されました。 - -* `HttpFoundation` コンポーネントの `File` クラスのリファクタリング: - - * `Symfony\Component\HttpFoundation\File\File` の API が新しくなりました。 - - * `\SplFileInfo` を継承するようになりました - - * `getName()` は `getBasename()` に変更 - * `getDirectory()` は `getPath()` に変更 - * `getPath()` は `getRealPath()` に変更 - - * `move()` メソッドを呼び出した時に、対象ディレクトリがまだ存在していない場合は作成されるようになりました。 - - * `getExtension()` と `guessExtension()` の戻り値の拡張子から、先頭の `.` が除去されるように変更されました。 - - * `Symfony\Component\HttpFoundation\File\UploadedFile` の API が新しくなりました。 - - * コンストラクタに真偽値の引数が追加されました。 - この引数に true を指定すると、ファイルを移動できるようになりますが、テストモード以外では true に設定しないでください。 - コアファイル以外の外部から true に設定することは想定していません。 - - * `getMimeType()` は、対象ファイルの MIME タイプを必ず返すように変更されました。 - リクエストから MIME タイプを取得する場合は、`getClientMimeType()` メソッドを使ってください。 - - * `getSize()` は、対象ファイルのサイズを必ず返すように変更されました。 - リクエストからファイルサイズを取得する場合は、`getClientSize()` メソッドを使ってください。 - - * リクエストからオリジナルのファイル名を取得する場合は、`getClientOriginalName()` メソッドを使ってください。 - -* Twig の `extensions` 設定は削除されました。 - Twig エクステンションを登録する場合は、`twig.extension` タグを使ってください。 - -* Monolog ハンドラのスタックで、デフォルトで記録が伝播されるようになりました。 - 伝播されないようにするには、bubble を明示的に false に設定してください。 - -* `SerializerInterface` が拡張されました。 - Serializer クラスのパブリックメソッドの数は減りましたが、後方互換性が損なわれ、コンポーネント独自の Exception クラスが追加されました。 - -* `FileType` フォームクラスが大きく変更されました。 - - * テンポラリストレージが削除されました。 - - * FileType の `type` オプションが削除されました。 - 新しい動作は、以前の `type` に `file` を設定した場合の動作と同じです。 - - * ファイルウィジェットは、他の INPUT フィールドと同じようにレンダリングされるように変更されました。 - -* Doctrine の `EntityType` クラスコンストラクタの `em` 引数には、EntityManager インスタンスの代わりにエンティティマネージャー名を指定するよう変更されました。 - このオプションをを渡さない場合、以前と同じようにデフォルトのエンティティマネージャーが使われます。 - -* Console コンポーネントの中の `Command::getFullname()` メソッドと `Command::getNamespace()` メソッドは削除されました - (`Command::getName()` メソッドの振る舞いは以前の `Command::getFullname()` メソッドと同じになりました)。 - -* デフォルトの Twig フォームテンプレートは Twig bridge に移動されました。以下のようにすればテンプレートや - コンフィギュレーション設定中で現在Twig フォームテンプレートを参照できます: - - 変更前: - - TwigBundle:Form:div_layout.html.twig - - 変更後: - - form_div_layout.html.twig - -* キャッシュウォーマーに関連する設定は、すべて削除されました。 - -* `Response::isRedirected()` メソッドは `Response::isRedirect()` メソッドに統合されました。 - -beta3 から beta4 ----------------- - -* `Profile` のインスタンスを返す `Client::getProfile()` メソッドへの変更に従い、`Client::getProfiler()` メソッドは削除されました。 - -* いくつかの `UniversalClassLoader` のメソッド名は変更されました: - - * `registerPrefixFallback` から `registerPrefixFallbacks` - * `registerNamespaceFallback` から `registerNamespaceFallbacks` - -* イベントシステムはさらに柔軟になりました。リスナーは任意の有効でコール可能な PHP 関数であれば可能になりました。 - - * `EventDispatcher::addListener($eventName, $listener, $priority = 0)`: - * `$eventName` がイベント名で (もう配列ではいけません)、 - * `$listener` が コール可能な PHP 関数です。 - - * イベントクラス名と定数が変更されました: - - * 以前の `Symfony\Component\Form\Events` のクラス名と定数: - - Events::preBind = 'preBind' - Events::postBind = 'postBind' - Events::preSetData = 'preSetData' - Events::postSetData = 'postSetData' - Events::onBindClientData = 'onBindClientData' - Events::onBindNormData = 'onBindNormData' - Events::onSetData = 'onSetData' - - * 新しい `Symfony\Component\Form\FormEvents` クラス名と定数: - - FormEvents::PRE_BIND = 'form.pre_bind' - FormEvents::POST_BIND = 'form.post_bind' - FormEvents::PRE_SET_DATA = 'form.pre_set_data' - FormEvents::POST_SET_DATA = 'form.post_set_data' - FormEvents::BIND_CLIENT_DATA = 'form.bind_client_data' - FormEvents::BIND_NORM_DATA = 'form.bind_norm_data' - FormEvents::SET_DATA = 'form.set_data' - - * 以前の `Symfony\Component\HttpKernel\Events` のクラス名と定数: - - Events::onCoreRequest = 'onCoreRequest' - Events::onCoreException = 'onCoreException' - Events::onCoreView = 'onCoreView' - Events::onCoreController = 'onCoreController' - Events::onCoreResponse = 'onCoreResponse' - - * 新しい `Symfony\Component\HttpKernel\CoreEvents` のクラス名と定数: - - CoreEvents::REQUEST = 'core.request' - CoreEvents::EXCEPTION = 'core.exception' - CoreEvents::VIEW = 'core.view' - CoreEvents::CONTROLLER = 'core.controller' - CoreEvents::RESPONSE = 'core.response' - - * 以前の `Symfony\Component\Security\Http\Events` のクラス名と定数: - - Events::onSecurityInteractiveLogin = 'onSecurityInteractiveLogin' - Events::onSecuritySwitchUser = 'onSecuritySwitchUser' - - * 新しい `Symfony\Component\Security\Http\SecurityEvents` のクラス名と定数: - - SecurityEvents::INTERACTIVE_LOGIN = 'security.interactive_login' - SecurityEvents::SWITCH_USER = 'security.switch_user' - - * `addListenerService` は第 1 引数として単一のイベント名だけを取るようになりました。 - - * コンフィギュレーションのタグでは、呼び出すメソッドを指定する必要があります。 - - * 変更前: - - - - * 変更後: - - - - * Subscriber は常に連想配列を返すようになりました: - - * 変更前: - - public static function getSubscribedEvents() - { - return Events::onBindNormData; - } - - * 変更後: - - public static function getSubscribedEvents() - { - return array(FormEvents::BIND_NORM_DATA => 'onBindNormData'); - } - -* フォーム `DateType` パラメーターの `single-text` は `single_text` へ変更されました -* フォームフィールドラベルヘルパーは属性の設定も受け入れるようになりました。例 : - -```html+jinja -{{ form_label(form.name, 'Custom label', { 'attr': {'class': 'name_field'} }) }} -``` - -* Swiftmailer を使うためには、autoloader ("app/autoloader.php") を通して "init.php" を登録し、 - `Swift_` prefix の登録を autoloader から削除しなければなりません。これをどのように行うべきかの例は、 - Standard Distribution をご覧ください。 - [autoload.php](https://github.com/symfony/symfony-standard/blob/v2.0.0BETA4/app/autoload.php#L29). - -beta2 から beta3 ----------------- - -* `framework.annotations` に属する設定が少し変更されました。 - - 変更前: - - framework: - annotations: - cache: file - file_cache: - debug: true - dir: /foo - - 変更後: - - framework: - annotations: - cache: file - debug: true - file_cache_dir: /foo - -beta1 から beta2 ----------------- - -* アノテーションのパース処理が変更され、Doctrine Common 3.0 を利用するようになりました。 - クラス内で使うアノテーションは、インポートする必要があります（`use` で PHP の名前空間をインポートするのと同様です）。 - - 変更前: - -``` php -getParameter('doctrine.orm.entity_managers') - $container->getParameter('doctrine.orm.default_entity_manager') - $container->getParameter('doctrine.orm.default_connection') - - 変更後: - - $container->get('doctrine')->getEntityManagerNames() - $container->get('doctrine')->getDefaultEntityManagerName() - $container->get('doctrine')->getDefaultConnectionName() - - ただし、これらのメソッドを使わなくても、次のようにして Registry オブジェクトから直接 EntityManager オブジェクトを取得できます。 - - 変更前: - - $em = $this->get('doctrine.orm.entity_manager'); - $em = $this->get('doctrine.orm.foobar_entity_manager'); - - 変更後: - - $em = $this->get('doctrine')->getEntityManager(); - $em = $this->get('doctrine')->getEntityManager('foobar'); - -* `doctrine:generate:entities` コマンドの引数とオプションが変更されました。 - 新しい引数とオプションの詳細は、`./app/console doctrine:generate:entities --help` コマンドを実行して確認してください。 - -* `doctrine:generate:repositories` コマンドは削除されました。 - このコマンドに相当する機能は、`doctrine:generate:entities` コマンドに統合されました。 - -* Doctrine イベントサブスクライバーは、ユニークな `doctrine.event_subscriber` タグを使うように変更されました。 - また、Doctrine イベントリスナーは、ユニークな `doctrine.event_listener` タグを使うように変更されました。 - コネクションを指定するには、オプションの `connection` 属性を使ってください。 - - 変更前: - - listener: - class: MyEventListener - tags: - - { name: doctrine.common.event_listener, event: name } - - { name: doctrine.dbal.default_event_listener, event: name } - subscriber: - class: MyEventSubscriber - tags: - - { name: doctrine.common.event_subscriber } - - { name: doctrine.dbal.default_event_subscriber } - - 変更後: - - listener: - class: MyEventListener - tags: - - { name: doctrine.event_listener, event: name } # すべてのコネクションに対して登録 - - { name: doctrine.event_listener, event: name, connection: default } # デフォルトコネクションにのみ登録 - subscriber: - class: MyEventSubscriber - tags: - - { name: doctrine.event_subscriber } # すべてのコネクションに対して登録 - - { name: doctrine.event_subscriber, connection: default } # デフォルトコネクションにのみ登録 - -* アプリケーションの翻訳ファイルは、`Resources` ディレクトリに保存されるように変更されました。 - - 変更前: - - app/translations/catalogue.fr.xml - - 変更後: - - app/Resources/translations/catalogue.fr.xml - -* `collection` フォームタイプの `modifiable` オプションは、2 つのオプション "allow_add" と "allow_delete" に分割されました。 - - 変更前: - - $builder->add('tags', 'collection', array( - 'type' => 'text', - 'modifiable' => true, - )); - - 変更後: - - $builder->add('tags', 'collection', array( - 'type' => 'text', - 'allow_add' => true, - 'allow_delete' => true, - )); - -* `Request::hasSession()` メソッドの名前は `Request::hasPreviousSession()` に変更されました。`hasSession()` メソッドはまだ存在しますが、 - セッションが以前のリクエストから開始されたかどうかではなく、リクエストがセッションオブジェクトを含んでいるかチェックするのみです。 - -* Serializer: NormalizerInterface の `supports()` メソッドは `supportsNormalization()` と `supportsDenormalization()` の 2 つのメソッドに分割されました。 - -* `ParameterBag::getDeep()` メソッドは削除され、`ParameterBag::get()` メソッドの真偽値の引数に置き換えられました。 - -* Serializer: `AbstractEncoder` と `AbstractNormalizer` はそれぞれ `SerializerAwareEncoder` と `SerializerAwareNormalizer` に名前が変更されました。 - -* Serializer: すべてのインターフェイスから `$properties` という引数が除かれました。 - -* Form: オプションの値である "date" タイプの "widget" の "text" は "single-text" に名前が変更されました。 - "text" は現在は個々のテキストボックスを示します ("time" タイプのように) 。 - -* Form: ビュー変数 `name` が `full_name` に変更されました。`name` 変数には `$form->getName()` と同じ値である、ローカルの短い名前が格納されるようになりました。 - -PR12 から beta1 ---------------- - -* CSRF シークレットの設定は、`secret` という必須のグローバル設定に変更されました（また、このシークレット値は CSRF 以外でも利用されます） - - 変更前: - - framework: - csrf_protection: - secret: S3cr3t - - 変更後: - - framework: - secret: S3cr3t - -* `File::getWebPath()` メソッドと `File::rename()` メソッドは削除されました。同様に `framework.document_root` コンフィギュレーションも削除されました。 - -* `File::getDefaultExtension()` メソッドの名前は `File::guessExtension()` に変更されました。 - また、拡張子を推測できなかった場合は null を返すように変更されました。 - -* `session` のコンフィギュレーションがリファクタリングされました - - * `class` オプションが削除されました（代わりに `session.class` パラメータを使ってください） - - * PDO セッションストレージのコンフィギュレーションが削除されました（クックブックのレシピは修正中です） - - * `storage_id` オプションには、サービスIDの一部ではなく、サービスIDそのものを指定するように変更されました。 - -* `DoctrineMigrationsBundle` と `DoctrineFixturesBundle` の 2 つのバンドルは、Symfony コアから独立し、個別のリポジトリで管理されるようになりました。 - -* フォームフレームワークの大きなリファクタリングが行われました（詳細はドキュメントを参照してください） - -* `trans` タグで、翻訳するメッセージを引数として受け取る形式が廃止されました: - - {% trans "foo" %} - {% trans foo %} - - 次のような長い形式か、フィルタ形式を使ってください: - - {% trans %}foo{% endtrans %} - {{ foo|trans }} - - こうすることで、タグとフィルタの使用方法が明確になり、自動出力エスケープのルールが適用された場合により分かりやすくなります（詳細はドキュメントを参照してください）。 - -* DependencyInjection コンポーネントの `ContainerBuilder` クラスと `Definition` クラスのいくつかのメソッドの名前が、より分かりやすく一貫性のある名前に変更されました: - - 変更前: - - $container->remove('my_definition'); - $definition->setArgument(0, 'foo'); - - 変更後: - - $container->removeDefinition('my_definition'); - $definition->replaceArgument(0, 'foo'); - -* rememberme のコンフィギュレーションで、`token_provider key` サービスIDのサフィックスを指定するのではなく、サービスIDそのものを指定するように変更されました。 - -PR11 から PR12 --------------- - -* HttpFoundation\Cookie::getExpire() は getExpiresTime() に名前が変更されました。 - -* XMLのコンフィギュレーションの記述方法が変更されました。属性が1つしかないタグは、すべてタグのコンテンツとして記述するように変更されました。 - - 変更前: - - - - - - 変更後: - - MyBundle - twig - twig.extension.debug - -* SwitchUserListenerが有効な場合に、すべてのユーザーが任意のアカウントになりすませる致命的な脆弱性を修正しました。SwitchUserListenerを利用しない設定にしている場合は影響はありません。 - -* DIコンテナのコンパイルプロセスの最後に、すべてのサービスに対する参照のバリデーションがより厳密に行われるようになりました。これにより、無効なサービス参照が見つかった場合は、コンパイル時の例外が発生します（以前の動作は、実行時例外でした）。 - -PR10 から PR11 --------------- - -* エクステンションのコンフィギュレーションクラスには、`Symfony\Component\Config\Definition\ConfigurationInterface` インターフェイスを実装する必要があります。この部分の後方互換性は維持されていますが、今後の開発のために、エクステンションにこのインターフェイスを実装しておいてください。 - -* Monologのオプション `fingerscrossed` は `fingers_crossed` に名前が変更されました。 - -PR9 から PR10 -------------- - -* バンドルの論理名には、再び `Bundle` サフィックスを付けるように修正されました: - - *コントローラ*: `Blog:Post:show` -> `BlogBundle:Post:show` - - *テンプレート*: `Blog:Post:show.html.twig` -> `BlogBundle:Post:show.html.twig` - - *リソース*: `@Blog/Resources/config/blog.xml` -> `@BlogBundle/Resources/config/blog.xml` - - *Doctrine*: `$em->find('Blog:Post', $id)` -> `$em->find('BlogBundle:Post', $id)` - -* `ZendBundle` は `MonologBundle` に置き換えられました。 - これに関するプロジェクトのアップデート方法は、Symfony Standard Edition の変更点を参考にしてください: - https://github.com/symfony/symfony-standard/pull/30/files - -* コアバンドルのパラメータは、ほぼすべて削除されました。 - 代わりにバンドルのエクステンションの設定で公開されている設定を使うようにしてください。 - -* 一貫性のために、いくつかのコアバンドルのサービス名が変更されました。 - -* バリデータの名前空間が `validation` から `assert` へ変更されました（PR9向けにアナウンスされていましたが、PR10での変更となりました）: - - 変更前: - - @validation:NotNull - - 変更後: - - @assert:NotNull - - さらに、いくつかの制約で使われていた `Assert` プレフィックスは削除されました(`AssertTrue` から `True` へ変更) - -* `ApplicationTester::getDisplay()` と `CommandTester::getDisplay()` メソッドは、コマンドの終了コードを返すようになりました - - -PR8 から PR9 ------------- - -* `Symfony\Bundle\FrameworkBundle\Util\Filesystem` は、`Symfony\Component\HttpKernel\Util\Filesystem` へ移動されました - -* `Execute` 制約は、`Callback` 制約に名前が変更されました - -* HTTPの例外クラスのシグニチャが変更されました: - - 変更前: - - throw new NotFoundHttpException('Not Found', $message, 0, $e); - - 変更後: - - throw new NotFoundHttpException($message, $e); - -* RequestMatcher クラスでは、正規表現に `^` と `$` が自動的には追加されなくなりました - - この変更によって、セキュリティの設定をたとえば次のように変更する必要があります: - - 変更前: - - pattern: /_profiler.* - pattern: /login - - 変更後: - - pattern: ^/_profiler - pattern: ^/login$ - -* `app/` ディレクトリ以下のグローバルテンプレートの位置が変更されました(古いディレクトリでは動作しなくなります): - - 変更前: - - app/views/base.html.twig - app/views/AcmeDemoBundle/base.html.twig - - 変更後: - - app/Resources/views/base.html.twig - app/Resources/AcmeDemo/views/base.html.twig - -* バンドルの論理名に、`Bundle` サフィックスをつける必要がなくなりました: - - *コントローラ*: `BlogBundle:Post:show` -> `Blog:Post:show` - - *テンプレート*: `BlogBundle:Post:show.html.twig` -> `Blog:Post:show.html.twig` - - *リソース*: `@BlogBundle/Resources/config/blog.xml` -> `@Blog/Resources/config/blog.xml` - - *Doctrine*: `$em->find('BlogBundle:Post', $id)` -> `$em->find('Blog:Post', $id)` - -* Asseticのフィルターは明示的にロードする必要があります: - - assetic: - filters: - cssrewrite: ~ - yui_css: - jar: "/path/to/yuicompressor.jar" - my_filter: - resource: "%kernel.root_dir%/config/my_filter.xml" - foo: bar diff --git a/UPDATE.md b/UPDATE.md deleted file mode 100644 index c61249ae71..0000000000 --- a/UPDATE.md +++ /dev/null @@ -1,863 +0,0 @@ -How to update your project? -=========================== - -This document explains how to upgrade from one Symfony2 version to the next -one. It only discusses changes that need to be done when using the "public" -API of the framework. If you "hack" the core, you should probably follow the -timeline closely anyway. - -RC4 to RC5 ----------- - -* The `MapFileClassLoader` has been removed in favor of a new - `MapClassLoader`. - -* The `exception_controller` setting has been moved from the `framework` - section to the `twig` one. - -* The custom error pages must now reference `TwigBundle` instead of - `FrameworkBundle` (see - http://symfony.com/doc/2.0/cookbook/controller/error_pages.html) - -* `EntityUserProvider` class has been moved and FQCN changed from - `Symfony\Component\Security\Core\User\EntityUserProvider` to - `Symfony\Bridge\Doctrine\Security\User\EntityUserProvider`. - -* Cookies access from `HeaderBag` has been removed. Accessing Request cookies - must be done via `Request::$cookies``. - -* `ResponseHeaderBag::getCookie()` and `ResponseHeaderBag::hasCookie()` - methods were removed. - -* The method `ResponseHeaderBag::getCookies()` now supports an argument for the - returned format (possible values are `ResponseHeaderBag::COOKIES_FLAT` - (default value) or `ResponseHeaderBag::COOKIES_ARRAY`). - - * `ResponseHeaderBag::COOKIES_FLAT` returns a simple array (the array keys - are not cookie names anymore): - - * array(0 => `a Cookie instance`, 1 => `another Cookie instance`) - - * `ResponseHeaderBag::COOKIES_ARRAY` returns a multi-dimensional array: - - * array(`the domain` => array(`the path` => array(`the cookie name` => `a Cookie instance`))) - -* Removed the guesser for the Choice constraint as the constraint only knows - about the valid keys, and not their values. - -* The configuration of MonologBundle has been refactored. - - * Only services are supported for the processors. They are now registered - using the `monolog.processor` tag which accept three optionnal attributes: - - * `handler`: the name of an handler to register it only for a specific handler - * `channel`: to register it only for one logging channel (exclusive with `handler`) - * `method`: The method used to process the record (`__invoke` is used if not set) - - * The email_prototype for the `SwiftMailerHandler` only accept a service id now. - - * Before: - - email_prototype: @acme_demo.monolog.email_prototype - - * After: - - email_prototype: acme_demo.monolog.email_prototype - - or if you want to use a factory for the prototype: - - email_prototype: - id: acme_demo.monolog.email_prototype - method: getPrototype - -* To avoid security issues, HTTP headers coming from proxies are not trusted - anymore by default (like `HTTP_X_FORWARDED_FOR`, `X_FORWARDED_PROTO`, and - `X_FORWARDED_HOST`). If your application is behind a reverse proxy, add the - following configuration: - - framework: - trust_proxy_headers: true - -* To avoid hidden naming collisions, the AbstractType does not try to define - the name of form types magically. You now need to implement the `getName()` - method explicitly when creating a custom type. - -* Renamed some methods to follow the naming conventions: - - Session::getAttributes() -> Session::all() - Session::setAttributes() -> Session::replace() - -* {_locale} is not supported in paths in the access_control section anymore. You can - rewrite the paths using a regular expression such as "(?:[a-z]{2})". - -RC3 to RC4 ----------- - -* Annotation classes must be annotated with @Annotation - (see the validator constraints for examples) - -* Annotations are not using the PHP autoloading but their own mechanism. This - allows much more control about possible failure states. To make your code - work, add the following lines at the end of your `autoload.php` file: - - use Doctrine\Common\Annotations\AnnotationRegistry; - - AnnotationRegistry::registerLoader(function($class) use ($loader) { - $loader->loadClass($class); - return class_exists($class, false); - }); - - AnnotationRegistry::registerFile( - __DIR__.'/../vendor/doctrine/lib/Doctrine/ORM/Mapping/Driver/DoctrineAnnotations.php' - ); - - The `$loader` variable is an instance of `UniversalClassLoader`. - Additionally you might have to adjust the ORM path to the - `DoctrineAnnotations.php`. If you are not using the `UniversalClassLoader` - see the [Doctrine Annotations - documentation](http://www.doctrine-project.org/docs/common/2.1/en/reference/annotations.html) - for more details on how to register annotations. - -beta5 to RC1 ------------- - -* Renamed `Symfony\Bundle\FrameworkBundle\Command\Command` to - `Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand` - -* Removed the routing `AnnotGlobLoader` class - -* Some blocks in the Twig Form templates have been renamed to avoid - collisions: - - * `container_attributes` to `widget_container_attributes` - * `attributes` to `widget_attributes` - * `options` to `widget_choice_options` - -* Event changes: - - * All listeners must now be tagged with `kernel.event_listener` instead of - `kernel.listener`. - * Kernel events are now properly prefixed with `kernel` instead of `core`: - - * Before: - - - - * After: - - - - Note: the method can of course remain as `onCoreRequest`, but renaming it - as well for consistency with future projects makes sense. - - * The `Symfony\Component\HttpKernel\CoreEvents` class has been renamed to - `Symfony\Component\HttpKernel\KernelEvents` - -* `TrueValidator` and `FalseValidator` constraints validators no longer accepts any value as valid data. - -beta4 to beta5 --------------- - -* `UserProviderInterface::loadUser()` has been renamed to - `UserProviderInterface::refreshUser()` to make the goal of the method - clearer. - -* The `$kernel` property on `WebTestCase` is now static. Change any instances - of `$this->kernel` in your functional tests to `self::$kernel`. - -* The AsseticBundle has been moved to its own repository (it still bundled - with Symfony SE). - -* Yaml Component: - - * Exception classes have been moved to their own namespace - * `Yaml::load()` has been renamed to `Yaml::parse()` - -* The File classes from `HttpFoundation` have been refactored: - - * `Symfony\Component\HttpFoundation\File\File` has a new API: - - * It now extends `\SplFileInfo`: - - * former `getName()` equivalent is `getBasename()`, - * former `getDirectory()` equivalent is `getPath()`, - * former `getPath()` equivalent is `getRealPath()`. - - * the `move()` method now creates the target directory when it does not exist, - - * `getExtension()` and `guessExtension()` do not return the extension - with a leading `.` anymore - - * `Symfony\Component\HttpFoundation\File\UploadedFile` has a new API: - - * The constructor has a new Boolean parameter that must be set to true - in test mode only in order to be able to move the file. This parameter - is not intended to be set to true from outside of the core files. - - * `getMimeType()` now always returns the mime type of the underlying file. - Use `getClientMimeType()` to get the mime type from the request. - - * `getSize()` now always returns the size of the underlying file. - Use `getClientSize()` to get the file size from the request. - - * Use `getClientOriginalName()` to retrieve the original name from the - request. - -* The `extensions` setting for Twig has been removed. There is now only one - way to register Twig extensions, via the `twig.extension` tag. - -* The stack of Monolog handlers now bubbles the records by default. To stop - the propagation you need to configure the bubbling explicitly. - -* Expanded the `SerializerInterface`, while reducing the number of public - methods in the Serializer class itself breaking BC and adding component - specific Exception classes. - -* The `FileType` Form class has been heavily changed: - - * The temporary storage has been removed. - - * The file type `type` option has also been removed (the new behavior is - the same as when the `type` was set to `file` before). - - * The file input is now rendered as any other input field. - -* The `em` option of the Doctrine `EntityType` class now takes the entity - manager name instead of the EntityManager instance. If you don't pass this - option, the default Entity Manager will be used as before. - -* In the Console component: `Command::getFullname()` and - `Command::getNamespace()` have been removed (`Command::getName()` behavior - is now the same as the old `Command::getFullname()`). - -* Default Twig form templates have been moved to the Twig bridge. Here is how - you can reference them now from a template or in a configuration setting: - - Before: - - TwigBundle:Form:div_layout.html.twig - - After: - - form_div_layout.html.twig - -* All settings regarding the cache warmers have been removed. - -* `Response::isRedirected()` has been merged with `Response::isRedirect()` - -beta3 to beta4 --------------- - -* `Client::getProfiler` has been removed in favor of `Client::getProfile`, - which returns an instance of `Profile`. - -* Some `UniversalClassLoader` methods have been renamed: - - * `registerPrefixFallback` to `registerPrefixFallbacks` - * `registerNamespaceFallback` to `registerNamespaceFallbacks` - -* The event system has been made more flexible. A listener can now be any - valid PHP callable. - - * `EventDispatcher::addListener($eventName, $listener, $priority = 0)`: - * `$eventName` is the event name (cannot be an array anymore), - * `$listener` is a PHP callable. - - * The events classes and constants have been renamed: - - * Old class name `Symfony\Component\Form\Events` and constants: - - Events::preBind = 'preBind' - Events::postBind = 'postBind' - Events::preSetData = 'preSetData' - Events::postSetData = 'postSetData' - Events::onBindClientData = 'onBindClientData' - Events::onBindNormData = 'onBindNormData' - Events::onSetData = 'onSetData' - - * New class name `Symfony\Component\Form\FormEvents` and constants: - - FormEvents::PRE_BIND = 'form.pre_bind' - FormEvents::POST_BIND = 'form.post_bind' - FormEvents::PRE_SET_DATA = 'form.pre_set_data' - FormEvents::POST_SET_DATA = 'form.post_set_data' - FormEvents::BIND_CLIENT_DATA = 'form.bind_client_data' - FormEvents::BIND_NORM_DATA = 'form.bind_norm_data' - FormEvents::SET_DATA = 'form.set_data' - - * Old class name `Symfony\Component\HttpKernel\Events` and constants: - - Events::onCoreRequest = 'onCoreRequest' - Events::onCoreException = 'onCoreException' - Events::onCoreView = 'onCoreView' - Events::onCoreController = 'onCoreController' - Events::onCoreResponse = 'onCoreResponse' - - * New class name `Symfony\Component\HttpKernel\CoreEvents` and constants: - - CoreEvents::REQUEST = 'core.request' - CoreEvents::EXCEPTION = 'core.exception' - CoreEvents::VIEW = 'core.view' - CoreEvents::CONTROLLER = 'core.controller' - CoreEvents::RESPONSE = 'core.response' - - * Old class name `Symfony\Component\Security\Http\Events` and constants: - - Events::onSecurityInteractiveLogin = 'onSecurityInteractiveLogin' - Events::onSecuritySwitchUser = 'onSecuritySwitchUser' - - * New class name `Symfony\Component\Security\Http\SecurityEvents` and constants: - - SecurityEvents::INTERACTIVE_LOGIN = 'security.interactive_login' - SecurityEvents::SWITCH_USER = 'security.switch_user' - - * `addListenerService` now only takes a single event name as its first - argument, - - * Tags in configuration must now set the method to call: - - * Before: - - - - * After: - - - - * Subscribers must now always return a hash: - - * Before: - - public static function getSubscribedEvents() - { - return Events::onBindNormData; - } - - * After: - - public static function getSubscribedEvents() - { - return array(FormEvents::BIND_NORM_DATA => 'onBindNormData'); - } - -* Form `DateType` parameter `single-text` changed to `single_text` -* Form field label helpers now accepts setting attributes, i.e.: - -```html+jinja -{{ form_label(form.name, 'Custom label', { 'attr': {'class': 'name_field'} }) }} -``` - -* In order to use Swiftmailer, you should now register its "init.php" file via - the autoloader ("app/autoloader.php") and remove the `Swift_` prefix from - the autoloader. For an example on how this should be done, see the Standard - Distribution - [autoload.php](https://github.com/symfony/symfony-standard/blob/v2.0.0BETA4/app/autoload.php#L29). - -beta2 to beta3 --------------- - -* The settings under `framework.annotations` have changed slightly: - - Before: - - framework: - annotations: - cache: file - file_cache: - debug: true - dir: /foo - - After: - - framework: - annotations: - cache: file - debug: true - file_cache_dir: /foo - -beta1 to beta2 --------------- - -* The annotation parsing process has been changed (it now uses Doctrine Common - 3.0). All annotations which are used in a class must now be imported (just - like you import PHP namespaces with the "use" statement): - - Before: - -``` php -getParameter('doctrine.orm.entity_managers') - $container->getParameter('doctrine.orm.default_entity_manager') - $container->getParameter('doctrine.orm.default_connection') - - After: - - $container->get('doctrine')->getEntityManagerNames() - $container->get('doctrine')->getDefaultEntityManagerName() - $container->get('doctrine')->getDefaultConnectionName() - - But you don't really need to use these methods anymore, as to get an entity - manager, you can now use the registry directly: - - Before: - - $em = $this->get('doctrine.orm.entity_manager'); - $em = $this->get('doctrine.orm.foobar_entity_manager'); - - After: - - $em = $this->get('doctrine')->getEntityManager(); - $em = $this->get('doctrine')->getEntityManager('foobar'); - -* The `doctrine:generate:entities` arguments and options changed. Run - `./app/console doctrine:generate:entities --help` for more information about - the new syntax. - -* The `doctrine:generate:repositories` command has been removed. The - functionality has been moved to the `doctrine:generate:entities`. - -* Doctrine event subscribers now use a unique "doctrine.event_subscriber" tag. - Doctrine event listeners also use a unique "doctrine.event_listener" tag. To - specify a connection, use the optional "connection" attribute. - - Before: - - listener: - class: MyEventListener - tags: - - { name: doctrine.common.event_listener, event: name } - - { name: doctrine.dbal.default_event_listener, event: name } - subscriber: - class: MyEventSubscriber - tags: - - { name: doctrine.common.event_subscriber } - - { name: doctrine.dbal.default_event_subscriber } - - After: - - listener: - class: MyEventListener - tags: - - { name: doctrine.event_listener, event: name } # register for all connections - - { name: doctrine.event_listener, event: name, connection: default } # only for the default connection - subscriber: - class: MyEventSubscriber - tags: - - { name: doctrine.event_subscriber } # register for all connections - - { name: doctrine.event_subscriber, connection: default } # only for the default connection - -* Application translations are now stored in the `Resources` directory: - - Before: - - app/translations/catalogue.fr.xml - - After: - - app/Resources/translations/catalogue.fr.xml - -* The option `modifiable` of the `collection` form type was split into two - options `allow_add` and `allow_delete`. - - Before: - - $builder->add('tags', 'collection', array( - 'type' => 'text', - 'modifiable' => true, - )); - - After: - - $builder->add('tags', 'collection', array( - 'type' => 'text', - 'allow_add' => true, - 'allow_delete' => true, - )); - -* `Request::hasSession()` has been renamed to `Request::hasPreviousSession()`. The - method `hasSession()` still exists, but only checks if the request contains a - session object, not if the session was started in a previous request. - -* Serializer: The NormalizerInterface's `supports()` method has been split in - two methods: `supportsNormalization()` and `supportsDenormalization()`. - -* `ParameterBag::getDeep()` has been removed, and is replaced with a boolean flag - on the `ParameterBag::get()` method. - -* Serializer: `AbstractEncoder` & `AbstractNormalizer` were renamed to - `SerializerAwareEncoder` & `SerializerAwareNormalizer`. - -* Serializer: The `$properties` argument has been dropped from all interfaces. - -* Form: Renamed option value `text` of `widget` option of the `date` type was - renamed to `single-text`. `text` indicates to use separate text boxes now - (like for the `time` type). - -* Form: Renamed view variable `name` to `full_name`. The variable `name` now - contains the local, short name (equivalent to `$form->getName()`). - -PR12 to beta1 -------------- - -* The CSRF secret configuration has been moved to a mandatory global `secret` - setting (as the secret is now used for everything and not just CSRF): - - Before: - - framework: - csrf_protection: - secret: S3cr3t - - After: - - framework: - secret: S3cr3t - -* The `File::getWebPath()` and `File::rename()` methods have been removed, as - well as the `framework.document_root` configuration setting. - -* The `File::getDefaultExtension()` method has been renamed to `File::guessExtension()`. - The renamed method now returns null if it cannot guess the extension. - -* The `session` configuration has been refactored: - - * The `class` option has been removed (use the `session.class` parameter - instead); - - * The PDO session storage configuration has been removed (a cookbook recipe - is in the work); - - * The `storage_id` option now takes a service id instead of just part of it. - -* The `DoctrineMigrationsBundle` and `DoctrineFixturesBundle` bundles have - been moved to their own repositories. - -* The form framework has been refactored extensively (more information in the - documentation). - -* The `trans` tag does not accept a message as an argument anymore: - - {% trans "foo" %} - {% trans foo %} - - Use the long version the tags or the filter instead: - - {% trans %}foo{% endtrans %} - {{ foo|trans }} - - This has been done to clarify the usage of the tag and filter and also to - make it clearer when the automatic output escaping rules are applied (see - the doc for more information). - -* Some methods in the DependencyInjection component's `ContainerBuilder` and - `Definition` classes have been renamed to be more specific and consistent: - - Before: - - $container->remove('my_definition'); - $definition->setArgument(0, 'foo'); - - After: - - $container->removeDefinition('my_definition'); - $definition->replaceArgument(0, 'foo'); - -* In the rememberme configuration, the `token_provider key` now expects a real - service id instead of only a suffix. - -PR11 to PR12 ------------- - -* `HttpFoundation\Cookie::getExpire()` was renamed to `getExpiresTime()` - -* XML configurations have been normalized. All tags with only one attribute - have been converted to tag content: - - Before: - - - - - - After: - - MyBundle - twig - twig.extension.debug - -* Fixes a critical security issue which allowed all users to switch to - arbitrary accounts when the SwitchUserListener was activated. Configurations - which do not use the SwitchUserListener are not affected. - -* The Dependency Injection Container now strongly validates the references of - all your services at the end of its compilation process. If you have invalid - references this will result in a compile-time exception instead of a run-time - exception (the previous behavior). - -PR10 to PR11 ------------- - -* Extension configuration classes should now implement the - `Symfony\Component\Config\Definition\ConfigurationInterface` interface. Note - that the BC is kept but implementing this interface in your extensions will - allow for further developments. - -* The `fingerscrossed` Monolog option has been renamed to `fingers_crossed`. - -PR9 to PR10 ------------ - -* Bundle logical names earned back their `Bundle` suffix: - - *Controllers*: `Blog:Post:show` -> `BlogBundle:Post:show` - - *Templates*: `Blog:Post:show.html.twig` -> `BlogBundle:Post:show.html.twig` - - *Resources*: `@Blog/Resources/config/blog.xml` -> `@BlogBundle/Resources/config/blog.xml` - - *Doctrine*: `$em->find('Blog:Post', $id)` -> `$em->find('BlogBundle:Post', $id)` - -* `ZendBundle` has been replaced by `MonologBundle`. Have a look at the - changes made to Symfony SE to see how to upgrade your projects: - https://github.com/symfony/symfony-standard/pull/30/files - -* Almost all core bundles parameters have been removed. You should use the - settings exposed by the bundle extension configuration instead. - -* Some core bundles service names changed for better consistency. - -* Namespace for validators has changed from `validation` to `assert` (it was - announced for PR9 but it was not the case then): - - Before: - - @validation:NotNull - - After: - - @assert:NotNull - - Moreover, the `Assert` prefix used for some constraints has been removed - (`AssertTrue` to `True`). - -* `ApplicationTester::getDisplay()` and `CommandTester::getDisplay()` method - now return the command exit code - -PR8 to PR9 ----------- - -* `Symfony\Bundle\FrameworkBundle\Util\Filesystem` has been moved to - `Symfony\Component\HttpKernel\Util\Filesystem` - -* The `Execute` constraint has been renamed to `Callback` - -* The HTTP exceptions classes signatures have changed: - - Before: - - throw new NotFoundHttpException('Not Found', $message, 0, $e); - - After: - - throw new NotFoundHttpException($message, $e); - -* The RequestMatcher class does not add `^` and `$` anymore to regexp. - - You need to update your security configuration accordingly for instance: - - Before: - - pattern: /_profiler.* - pattern: /login - - After: - - pattern: ^/_profiler - pattern: ^/login$ - -* Global templates under `app/` moved to a new location (old directory did not - work anyway): - - Before: - - app/views/base.html.twig - app/views/AcmeDemoBundle/base.html.twig - - After: - - app/Resources/views/base.html.twig - app/Resources/AcmeDemo/views/base.html.twig - -* Bundle logical names lose their `Bundle` suffix: - - *Controllers*: `BlogBundle:Post:show` -> `Blog:Post:show` - - *Templates*: `BlogBundle:Post:show.html.twig` -> `Blog:Post:show.html.twig` - - *Resources*: `@BlogBundle/Resources/config/blog.xml` -> `@Blog/Resources/config/blog.xml` - - *Doctrine*: `$em->find('BlogBundle:Post', $id)` -> `$em->find('Blog:Post', $id)` - -* Assetic filters must be now explicitly loaded: - - assetic: - filters: - cssrewrite: ~ - yui_css: - jar: "/path/to/yuicompressor.jar" - my_filter: - resource: "%kernel.root_dir%/config/my_filter.xml" - foo: bar