3.4 移行ガイド¶

Request と Response の非推奨¶

3.4 で非推奨になった大部分は Request と Response オブジェクトにあります。 オブジェクトをその場で更新する既存のメソッドは非推奨になり、 PSR-7 規格にある不変オブジェクトパターンに従ったメソッドに取って代わられています。

Cake\Network\Request のいくつかのプロパティーが非推奨になりました。

• Request::$params は非推奨です。代わりに Request::getAttribute('params') を使用してください。

• Request::$data は非推奨です。代わりに Request::getData() を使用してください。

• Request::$query は非推奨です。代わりに Request::getQueryParams() を使用してください。

• Request::$cookies は非推奨です。代わりに Request::getCookie() を使用してください。

• Request::$base は非推奨です。代わりに Request::getAttribute('base') を使用してください。

• Request::$webroot は非推奨です。代わりに Request::getAttribute('webroot') を使用してください。

• Request::$here は非推奨です。代わりに Request::getAttribute('here') を使用してください。

• Request::$_session が Request::$session に名前が変更されました。

Cake\Network\Request の多くのメソッドが は非推奨になりました。

• __get() と __isset() メソッドは非推奨です。代わりに getParam() を使用してください。

• method() は非推奨です。代わりに getMethod() を使用してください。

• setInput() は非推奨です。代わりに withBody() を使用してください。

• ArrayAccess のメソッドはすべて非推奨です。

• Request::param() は非推奨です。代わりに Request::getParam() を使用してください。

• Request::data() は非推奨です。代わりに Request::getData() を使用してください。

• Request::query() は非推奨です。代わりに Request::getQuery() を使用してください。

• Request::cookie() は非推奨です。代わりに Request::getCookie() を使用してください。

Cake\Network\Response のいくつかのメソッドは、 PSR-7 のメソッドと重複していたり、 PSR-7 スタックによって廃止されているため、 非推奨になりました。

• Response::header() は非推奨です。代わりに getHeaderLine(), hasHeader() や Response::getHeader() を使用してください。

• Response::body() は非推奨です。代わりに Response::withBody() を使用してください。

• Response::statusCode() は非推奨です。 代わりに Response::getStatusCode() を使用してください。

• Response::httpCodes() このメソッドは使われなくなりました。 CakePHP はすべての現在推奨されるステータスコードの規格をサポートしています。

• Response::protocol() は非推奨です。 代わりに Response::getProtocolVersion() を使用してください。

• send(), sendHeaders(), _sendHeader(), _sendContent(), _setCookies(), _setContentType(), そして stop() は非推奨になり、 PSR-7 HTTP スタックで廃止されました。

レスポンスが PSR-7 標準で推奨されているような不変オブジェクトパターンに従うことに伴い、 Response のいくつかの 'ヘルパー' メソッドは非推奨になり、不変バリアントが推奨されます。

• Response::location() は Response::withLocation() となります。

• Response::disableCache() は Response::withDisabledCache() となります。

• Response::type() は Response::withType() となります。

• Response::charset() は Response::withCharset() となります。

• Response::cache() は Response::withCache() となります。

• Response::modified() は Response::withModified() となります。

• Response::expires() は Response::withExpires() となります。

• Response::sharable() は Response::withSharable() となります。

• Response::maxAge() は Response::withMaxAge() となります。

• Response::vary() は Response::withVary() となります。

• Response::etag() は Response::withEtag() となります。

• Response::compress() は Response::withCompression() となります。

• Response::length() は Response::withLength() となります。

• Response::mustRevalidate() は Response::withMustRevalidate() となります。

• Response::notModified() は Response::withNotModified() となります。

• Response::cookie() は Response::withCookie() となります。

• Response::file() は Response::withFile() となります。

• Response::download() は Response::withDownload() となります。

追加の変更が必要な不変メソッドを介してレスポンスを使用するためにコードを更新する前に、 不変レスポンスを採用 セクションの詳細をご確認ください。

その他の非推奨¶

• Cake\Event\Event の public プロパティーは非推奨となり、 関連するプロパティーを読み取り/書き込みするために新しいメソッが追加されました。

• Event::name() は非推奨です。代わりに Event::getName() を使用してください。

• Event::subject() は非推奨です。代わりに Event::getSubject() を使用してください。

• Event::result() は非推奨です。代わりに Event::getResult() を使用してください。

• Event::data() は非推奨です。代わりに Event::getData() を使用してください。

• Auth.redirect セッション変数は使用されなくなりました。 代わりに、リダイレクト URL を格納するためにクエリー文字列パラメーターが使用されます。 これには、ログインシナリオ外のセッションにリダイレクト URL を格納する機能を削除するという 追加の効果があります。

• AuthComponent は、許可されていないURLが GET アクション以外の場合、 リダイレクト URL を保存しません。

• AuthComponent の ajaxLogin オプションは非推奨です。 クライアント側のコードで正しい動作を引き起こすには、 403 ステータスコードを使用するべきです。

• RequestHandlerComponent の beforeRedirect メソッドは非推奨です。

• Cake\Network\Response の 306 ステータスコードは非推奨になりました。 このステータスコードは非標準であるため、ステータスフレーズは "Unused" に変更されています。

• Cake\Database\Schema\Table は Cake\Database\Schema\TableSchema に名前が変更されました。 以前の名前は多くのユーザーを混乱させました。

• Cake\ORM\Table::newEntity() と patchEntity() の fieldList オプションは、 ORM の他の部分とそろえるため fields に名前が変更されました。

• Router::parse() は非推奨です。代わりに、リクエストを受け入れリクエストが届いた際の処理で より多くの制御や柔軟性を与えるために Router::parseRequest() を使用してください。

• Route::parse() は非推奨です。代わりに、リクエストを受け入れリクエストが届いた際の処理で より多くの制御や柔軟性を与えるために Route::parseRequest() を使用してください。

• FormHelper::input() は非推奨です。代わりに FormHelper::control() を使用してください。

• FormHelper::inputs() は非推奨です。代わりに FormHelper::controls() を使用してください。

• FormHelper::allInputs() は非推奨です。代わりに FormHelper::allControls() を使用してください。

• Mailer::layout() は非推奨です。 代わりに Mailer::__call() が提供する Mailer::setLayout() を使用してください。

非推奨の複合 get / set メソッド¶

過去には、CakePHP は get / set モードの両方を提供する 'モーダル' メソッドを 利用していました。これらのメソッドにより、IDE の自動補完や、将来的に厳格な戻り値の型を追加する機能が 複雑になります。これらの理由から、複合 get / set メソッドは、 個別の get および set メソッドに分割されています。

推奨されなくなり、 getX() と setX() メソッドに置き換えられたメソッドのリストを次に示します。

Cake\Core\InstanceConfigTrait

• config()

Cake\Core\StaticConfigTrait

• config()

• dsnClassMap()

Cake\Console\ConsoleOptionParser

• command()

• description()

• epilog()

Cake\Database\Connection

• driver()

• schemaCollection()

• useSavePoints() (今は enableSavePoints()/isSavePointsEnabled())

Cake\Database\Driver

• autoQuoting (今は enableAutoQuoting()/isAutoQuotingEnabled())

Cake\Database\Expression\FunctionExpression

• name()

Cake\Database\Expression\QueryExpression

• tieWith() (今は setConjunction()/getConjunction())

Cake\Database\Expression\ValuesExpression

• columns()

• values()

• query()

Cake\Database\Query

• connection()

• selectTypeMap()

• bufferResults() (今は enableBufferedResults()/isBufferedResultsEnabled())

Cake\Database\Schema\CachedCollection

• cacheMetadata()

Cake\Database\Schema\TableSchema

• options()

• temporary() (今は setTemporary()/isTemporary())

Cake\Database\TypeMap

• defaults()

• types()

Cake\Database\TypeMapTrait

• typeMap()

• defaultTypes()

Cake\ORM\Association

• name()

• cascadeCallbacks()

• source()

• target()

• conditions()

• bindingKey()

• foreignKey()

• dependent()

• joinType()

• property()

• strategy()

• finder()

Cake\ORM\Association\BelongsToMany

• targetForeignKey()

• saveStrategy()

• conditions()

Cake\ORM\Association\HasMany

• saveStrategy()

• foreignKey()

• sort()

Cake\ORM\Association\HasOne

• foreignKey()

Cake\ORM\EagerLoadable

• config()

• canBeJoined() のセッター部分 (今は setCanBeJoined())

Cake\ORM\EagerLoader

• matching() (以前の動作を維持するために getMatching() は setMatching() の後に呼び出される必要があります)

• autoFields() (今は enableAutoFields()/isAutoFieldsEnabled())

Cake\ORM\Locator\TableLocator

• config()

Cake\ORM\Query

• eagerLoader()

• hydrate() (今は enableHydration()/isHydrationEnabled())

• autoFields() (今は enableAutoFields()/isAutoFieldsEnabled())

Cake\ORM\Table

• table()

• alias()

• registryAlias()

• connection()

• schema()

• primaryKey()

• displayField()

• entityClass()

Cake\Mailer\Email

• from()

• sender()

• replyTo()

• readReceipt()

• returnPath()

• to()

• cc()

• bcc()

• charset()

• headerCharset()

• emailPattern()

• subject()

• template() (今は setTemplate()/getTemplate() そして setLayout()/getLayout())

• viewRender() (今は setViewRenderer()/getViewRenderer())

• viewVars()

• theme()

• helpers()

• emailFormat()

• transport()

• messageId()

• domain()

• attachments()

• configTransport()

• profile()

Cake\Validation\Validator

• provider()

Cake\View\StringTemplateTrait

• templates()

Cake\View\ViewBuilder

• templatePath()

• layoutPath()

• plugin()

• helpers()

• theme()

• template()

• layout()

• options()

• name()

• className()

• autoLayout() (今は enableAutoLayout()/isAutoLayoutEnabled())

コンポーネント移行のヒント¶

CakePHP の以前のバージョンでは、コンポーネントは後で変更を加えるために、 リクエストとレスポンスの両方の参照を保持することがよくありました。不変メソッドを採用する前に、 コントローラーに添付されているレスポンスを使用する必要があります。

// コンポーネントのメソッド (コールバックを除く) の中で
$this->response->header('X-Rate-Limit', $this->remaining);

// 以下のようにするべきです
$controller = $this->getController();
$controller->response = $controller->response->withHeader('X-Rate-Limit', $this->remaining);

コンポーネントのコールバックでは、イベントオブジェクトを使用して レスポンス/コントローラーにアクセスできます。

public function beforeRender($event)
{
    $controller = $event->getSubject();
    $controller->response = $controller->response->withHeader('X-Teapot', 1);
}