Caution
The documentation you are viewing is for an older version of this component.
Switch to the latest (v3) version.
Migration
Migration to Version 2
If you are only using the PSR-7 implementations (e.g., Request, Response,
ServerRequest, etc.), migrating to v2 can be done by updating your
laminas/laminas-diactoros constraint in your composer.json. You have two
options for doing so:
- Adopt the v2 release specifically:
$ composer require "laminas/laminas-diactoros:^2.0"
-
Update your constraint to allow either version:
- Edit the constraint in your
composer.jsonto read:
"laminas/laminas-diactoros": "^1.8.6 || ^2.0"- Update your dependencies:
$ composer update - Edit the constraint in your
The first approach may fail if libraries you depend on specifically require a version 1 release. The second approach may leave you on a version 1 release in situations where other libraries you depend on require version 1.
Changed
-
Laminas\Diactoros\RequestTraitnow raises anInvalidArgumentExceptioninwithMethod()for invalid HTTP method values. -
Laminas\Diactoros\Serializer\Request::toString()no longer raises anUnexpectedValueExceptiondue to an unexpected HTTP method; this is due to the fact that the HTTP method value can no longer be set to an invalid value. -
Laminas\Diactoros\marshalHeadersFromSapi()is parsing headers differently compared to the legacy implementation. As a consequence Headers with'0'as values will be part of the parsed Headers. In former versions those headers were ignored. Usages of\Laminas\Diactoros\MessageTrait::hasHeader()and\Laminas\Diactoros\MessageTrait::getHeader()might be affected if you are usingServerRequestFactory::fromGlobals()functionality.
Removed
Several features were removed for version 2. These include removal of the
Emitter functionality, the Server implementation, and a number of methods on
the ServerRequestFactory.
Emitters
Laminas\Diactoros\Response\EmitterInterface and all emitter implementations were
removed from laminas-diactoros. They are now available in the
laminas/laminas-httphandlerrunner package.
In most cases, these can be replaced by changing the namespace of imported
classes from Laminas\Diactoros\Response to Laminas\HttpHandlerRunner\Emitter.
Server
The Laminas\Diactoros\Server class has been removed. We recommend using the
RequestHandlerRunner class from laminas/laminas-httphandlerrunner
to provide these capabilities instead. Usage is similar, but the
RequestHandlerRunner provides better error handling, and integration with
emitters.
ServerRequestFactory Methods
A number of public static methods have been removed from
ServerRequestFactory. The following table details the methods removed, and
replacements you may use if you still require the functionality.
| Method Removed | Replacement functionality |
|---|---|
normalizeServer() |
Laminas\Diactoros\normalizeServer() |
marshalHeaders() |
Laminas\Diactoros\marshalHeadersFromSapi() |
marshalUriFromServer() |
Laminas\Diactoros\marshalUriFromSapi() |
marshalRequestUri() |
Uri::getPath() from the Uri instance returned by marshalUriFromSapi() |
marshalHostAndPortFromHeaders() |
Uri::getHost() and Uri::getPort() from the Uri instances returned by marshalUriFromSapi() |
stripQueryString() |
explode("?", $path, 2)[0] |
normalizeFiles() |
Laminas\Diactoros\normalizeUploadedFiles() |