3.4 Guide de Migration¶

Dépréciations sur Request & Response¶

La majorité des dépréciations de la version 3.4 se trouve sur les objets Request et Response. Les méthodes existantes qui modifient directement les objets sont maintenant dépréciées et remplacées par les méthodes qui suivent le pattern des « objets immutables » décrit dans le standard PSR-7.

Plusieurs propriétés de Cake\Network\Request ont été dépréciées :

• Request::$params est dépréciée. Utilisez Request::getAttribute('params') à la place.

• Request::$data est dépréciée. Utilisez Request::getData() à la place.

• Request::$query est dépréciée. Utilisez Request::getQueryParams() à la place.

• Request::$cookies est dépréciée. Utilisez Request::getCookie() à la place.

• Request::$base est dépréciée. Utilisez Request::getAttribute('base') à la place.

• Request::$webroot est dépréciée. Utilisez Request::getAttribute('webroot') à la place.

• Request::$here est dépréciée. Utilisez Request::getRequestTarget() à la place.

• Request::$_session a été renommée Request::$session.

Certaines méthodes de Cake\Network\Request ont été dépréciées :

• Les méthodes __get() & __isset() sont dépréciées. Utilisez getParam() à la place.

• method() est dépréciée. Utilisez plutôt getMethod().

• setInput() est dépréciée. Utilisez plutôt withBody().

• Les méthodes ArrayAccess ont toutes été dépréciées.

• Request::param() est dépréciée. Utilisez plutôt Request::getParam() .

• Request::data() est dépréciée. Utilisez plutôt Request::getData().

• Request::query() est dépréciée. Utilisez plutôt Request::getQuery().

• Request::cookie() est dépréciée. Utilisez plutôt Request::getCookie().

Plusieurs méthodes de Cake\Network\Response ont été dépréciées soit parce qu’elles faisaient doublon avec les méthodes PSR-7, soit parce qu’elles ont été rendues obsolètes du fait de l’introduction du stack PSR-7 :

• Response::header() est dépréciée. Utilisez plutôt getHeaderLine(), hasHeader() ou Response::getHeader().

• Response::body() est dépréciée. Utilisez plutôt Response::withBody().

• Response::statusCode() est dépréciée. Utilisez plutôt Response::getStatusCode().

• Response::httpCodes() Cette méthode ne devrait plus être utilisée. CakePHP supporte maintenant tous les statuts standards recommandés.

• Response::protocol() est dépréciée. Utilisez plutôt Response::getProtocolVersion().

• send(), sendHeaders(), _sendHeader(), _sendContent(), _setCookies(), _setContentType(), et stop() sont dépréciées et rendues obsolètes par le stack HTTP PSR-7.

Du fait que les responses sont maintenant des objets immutables du fait des recommandations du standard PSR-7, de nombreuses méthodes « helper » de l’objet Response ont été dépréciées. Leurs variantes immutables sont maintenant recommandées :

• Response::location() devient Response::withLocation()

• Response::disableCache() devient Response::withDisabledCache()

• Response::type() devient Response::withType()

• Response::charset() devient Response::withCharset()

• Response::cache() devient Response::withCache()

• Response::modified() devient Response::withModified()

• Response::expires() devient Response::withExpires()

• Response::sharable() devient Response::withSharable()

• Response::maxAge() devient Response::withMaxAge()

• Response::vary() devient Response::withVary()

• Response::etag() devient Response::withEtag()

• Response::compress() devient Response::withCompression()

• Response::length() devient Response::withLength()

• Response::mustRevalidate() devient Response::withMustRevalidate()

• Response::notModified() devient Response::withNotModified()

• Response::cookie() devient Response::withCookie()

• Response::file() devient Response::withFile()

• Response::download() devient Response::withDownload()

Veuillez vous référez à la section Adopter les Responses Immutable pour plus d’informations avant de mettre à jour votre code car utiliser les méthodes immutables va demander plus de changements que le simple remplacement des méthodes.

Autres dépréciations¶

• Les propriétés _public_ de Cake\Event\Event sont dépréciées, de nouvelles méthodes ont été ajoutées pour lire et écrire ces propriétés.

• Event::name() est dépréciée. Utilisez Event::getName() à la place.

• Event::subject() est dépréciée. Utilisez Event::getSubject() à la place.

• Event::result() est dépréciée. Utilisez Event::getResult() à la place.

• Event::data() est dépréciée. Utilisez Event::getData() à la place.

• La valeur de Auth.redirect stockée en session n’est plus utilisée. Un paramètre d’URL est maintenant utilisé pour stocker l’URL de redirection. Ceci retire cependant la possibilité de définir une URL de redirection en session en dehors des scénarios de login.

• AuthComponent ne stocke plus les URLs de redirection quand l’URL non autorisée n’est pas une action GET.

• L’option ajaxLogin du AuthComponent est dépréciée. Vous devez maintenant utiliser le code de statut HTTP 403 pour déclencher le bon comportement côté client.

• La méthode beforeRedirect du RequestHandlerComponent est dépréciée.

• Le code de statut HTTP 306 de Cake\Network\Response est dépréciée. Sa phrase de statut est maintenant “Unused” car ce code de statut n’est pas standard.

• Cake\Database\Schema\Table a été renommée en Cake\Database\Schema\TableSchema. Le nom précédent portait à confusion pour de nombreux utilisateurs.

• L’option fieldList pour Cake\ORM\Table::newEntity() et patchEntity() a été renommée en fields pour être plus cohérent avec les autres parties de l’ORM.

• Router::parse() est dépréciée. Router::parseRequest() est maintenant la méthode recommandée car elle accepte une request en argument et donne plus de contrôle et de flexibilité dans la manipulation des requêtes entrantes.

• Route::parse() est dépréciée. Route::parseRequest() est maintenant la méthode recommandée car elle accepte une request en argument et donne plus de contrôle et de flexibilité dans la manipulation des requêtes entrantes.

• FormHelper::input() est dépréciée. Utilisez FormHelper::control() à la place.

• FormHelper::inputs() est dépréciée. Utilisez FormHelper::controls() à la place.

• FormHelper::allInputs() est dépréciée. Utilisez FormHelper::allControls() à la place.

• Mailer::layout() est dépréciée. Utilisez Mailer::setLayout() exposée par Mailer::__call() à la place.

Dépréciation des getters / setters combinés¶

Par le passé, CakePHP a exposé des méthodes combinées qui opéraient à la fois comme getter et comme setter. Ces méthodes compliquaient l’auto-complétion de certains IDE et auraient compliqué la mise en place de typage strictes sur les retours des méthodes dans le futur. Pour ces raisons, les getters / setters combinés sont maintenant séparés dans différentes méthodes.

La liste qui suit regroupe les méthodes qui sont dépréciées et remplacées par des méthodes getX() et setX() :

Cake\Core\InstanceConfigTrait

• config()

Cake\Core\StaticConfigTrait

• config()

• dsnClassMap()

CakeConsoleConsoleOptionParse

• command()

• description()

• epliog()

CakeDatabaseConnection

• driver()

• schemaCollection()

• useSavePoints() (devenue enableSavePoints() / isSavePointsEnabled())

CakeDatabaseDriver

• autoQuoting (devenue enableAutoQuoting() / isAutoQuotingEnabled())

CakeDatabaseExpressionFunctionExpression

• name()

CakeDatabaseExpressionQueryExpression

• tieWith() (devenue setConjunction() / getConjunction())

CakeDatabaseExpressionValuesExpression

• columns()

• values()

• query()

CakeDatabaseQuery

• connection()

• selectTypeMap()

• bufferResults() (devenue enableBufferedResults() / isBufferedResultsEnabled())

CakeDatabaseSchemaCachedCollection

• cacheMetadata()

CakeDatabaseSchemaTableSchema

• options()

• temporary() (devenue setTemporary() / isTemporary())

CakeDatabaseTypeMap

• defaults()

• types()

CakeDatabaseTypeMapTrait

• 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()

CakeORMEagerLoadable

• config()

• setter part of canBeJoined() (devenue setCanBeJoined())

CakeORMEagerLoader

• matching() (getMatching() devra être appelée après setMatching() pour conserver l’ancien comportement)

• autoFields() (devenue enableAutoFields() / isAutoFieldsEnabled())

CakeORMLocatorTableLocator

• config()

CakeORMQuery

• eagerLoader()

• hydrate() (now enableHydration()/isHydrationEnabled())

• autoFields() (now enableAutoFields()/isAutoFieldsEnabled())

CakeORMTable

• table()

• alias()

• registryAlias()

• connection()

• schema()

• primaryKey()

• displayField()

• entityClass()

CakeMailerEmail

• from()

• sender()

• replyTo()

• readReceipt()

• returnPath()

• to()

• cc()

• bcc()

• charset()

• headerCharset()

• emailPattern()

• subject()

• template() (devenue setTemplate() / getTemplate() et setLayout() / getLayout())

• viewRender() (devenue setViewRenderer() / getViewRenderer())

• viewVars()

• theme()

• helpers()

• emailFormat()

• transport()

• messageId()

• domain()

• attachments()

• configTransport()

• profile()

CakeValidationValidator

• provider()

CakeViewStringTemplateTrait

• templates()

CakeViewViewBuilder

• templatePath()

• layoutPath()

• plugin()

• helpers()

• theme()

• template()

• layout()

• options()

• name()

• className()

• autoLayout() (devenue enableAutoLayout() / isAutoLayoutEnabled())

Astuces pour Migrer vos Components¶

Dans les versions précédentes de CakePHP, les Components possédaient souvent des références aux objets Request et Response pour pouvoir les modifier. Avant d’utiliser les méthodes immutable, vous devriez utiliser les Response attachées au Controller:

// Dans une méthode de Component (or callback)
$this->response->header('X-Rate-Limit', $this->remaining);

// Deviendrait
$controller = $this->getController();
$controller->response = $controller->response->withHeader('X-Rate-Limit', $this->remaining);

Dans les callbacks des Components, vous pouvez utiliser l’objet Event pour accéder à la Response / au Controller:

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