All notable changes to this project will be documented in this file, in reverse chronological order by release.
Versions 0.3.0 and prior were released as "weierophinney/problem-details".
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #51 adds a new
problem-details.default_types_mapconfig option, which can be used to define customtypevalues based on status codes.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #46 adds code to ensure newlines are stripped when creating key names for XML payloads.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
-
#39 adds the
publicvisibility modifier to all constants. -
#41 prevents crashes when the
ProblemDetailsResponseFactoryattempts to encode malformed UTF-8 sequences to JSON by ensuring theJSON_PARTIAL_OUTPUT_ON_ERRORflag is enabled.
- #30 adds PSR-15 support.
-
#24 updates all classes to use scalar and return type hints, including nullable and void types. If you were extending classes within an earlier release, you may need to update signatures of any methods you override.
-
#35 modifies the constructor of
Zend\ProblemDetails\ProblemDetailsResponseFactorysuch that it now has the following signature:public function __construct( callable $responseFactory, bool $isDebug = self::EXCLUDE_THROWABLE_DETAILS, int $jsonFlags = null, bool $exceptionDetailsInResponse = false, string $defaultDetailMessage = self::DEFAULT_DETAIL_MESSAGE )
Note that the first argument is now a
$responseFactory, is required, and must becallable. The previous$responsePrototypeand$streamFactoryarguments are now removed.The
$responseFactorywill be invoked with no arguments, and MUST return a PSR-7 ResponseInterface instance. -
#35 modifies internals of
Zend\ProblemDetails\ProblemDetailsResponseFactoryFactoryas follows:- It no longer looks for a
Zend\ProblemDetails\StreamFactoryservice. - It now requires the
Psr\Http\Message\ResponseInterfaceservice, and expects it to resolve to a PHP callable capable of producing such an instance (instead of a response instance directly).
- It no longer looks for a
-
#35 modifies the constructor of
Zend\ProblemDetails\ProblemDetailsMiddleware; the$responseFactoryargument is now required. -
#35 modifies the constructor of
Zend\ProblemDetails\ProblemDetailsNotFoundHandler; the$responseFactoryargument is now required. -
#34 updates the behavior when passing null as the
$jsonFlagparameter to theZend\ProblemDetails\ProblemDetailsResponseFactoryconstructor; in such situations, the defaultjson_encode()flags will includeJSON_PRETTY_PRINTonly when the$isDebugargument is booleantrue.
- Nothing.
-
#22 and #30 remove support for both
http-interop/http-middlewareandhttp-interop/http-server-middleware. -
#22 removes
MissingResponseExceptionas it cannot be thrown anymore, because interfaces have PHP7 return type andTypeErrorwill be thrown.
- Nothing.
- Nothing.
- #32 updates
the
ProblemDetailsResponseFactoryFactoryto allow theResponseInterfaceservice to either return an instance, or a factory capable of generating an instance.
- Nothing.
- Nothing.
- Nothing.
-
#29 adds the ability for the
ProblemDetailsMiddlewareto trigger listeners when it catches aThrowableto produce a response. Listeners are PHP callables and receive the following arguments, in the following order:Throwable $error: the throwable/exception caught by theProblemDetailsMiddleware.ServerRequestInterface $request: the request handled by theProblemDetailsMiddleware.ResponseInterface $response: the response generated by theProblemDetailsMiddleware.
Attach listeners using the
ProblemDetailsMiddleware::attachListeners()instance method.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
-
#20 fixes an issue with serialization when PHP resources are within the
$additionalaspect of the payload. When these values are encountered, the response factory now will instead returnResource of type {resource type}. -
#21 provides a defence for
$additionaldata keys that would otherwise create malformed XML tag names.
-
In #1,
Zend\ProblemDetails\ProblemDetailsResponseFactorywas updated to attempt to generate a secure-by-default and secure-in-production Problem Details response when the response is generated from an exception; essentially, it now defaults to NOT exposing this information, in order to prevent exposing internals of the application in production.To provide this, it adds two new, optional, constructor arguments:
bool $exceptionDetailsInResponseis a flag detailing whether or not details from an exception (exceptProblemDetailsExceptioncustom data) should be used in the Problem Details response; by default this isfalsestring $defaultDetailMessageis a default message to use for thedetailkey of the response in such situations; the default value isAn unknown error occurred..
Additionally,
ProblemDetailsResponseFactoryFactorywas updated to re-use the configurationdebugsetting for the$exceptionDetailsInResponseflag. -
#7 adds a
ProblemDetailsNotFoundHandlerclass and associated factory. This can be used in place of the default applicationNotFoundHandler, in addition to it, or within specific routed pipelines in order to provide Problem Details 404 responses. -
#8 adds
Zend\Expressive\ProblemDetails\Exception\ExceptionInterface, a marker interface for exceptions provided by the package. -
#12 adds support for http-interop/http-middleware 0.5.0 via a polyfill provided by the package webimpress/http-middleware-compatibility. Essentially, this means you can drop this package into an application targeting either the 0.4.1 or 0.5.0 versions of http-middleware, and it will "just work".
-
#8 renames the interface
ProblemDetailsExceptiontoProblemDetailsExceptionInterface. This was done to make the naming consistent with other ZF packages. -
#8 renames the trait
CommonProblemDetailsExceptiontoCommonProblemDetailsExceptionTrait. This was done to make the naming consistent with other ZF packages. -
#8 updates the shipped
InvalidResponseBodyExceptionandMissingResponseExceptionto extend the newExceptionInterface.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- The package is now named "zendframework/zend-problem-details".
- The top-level namespace is now named
Zend\ProblemDetails.
- Nothing.
- Nothing.
- Nothing.
- #7 adds an explicit dependency on ext/json.
- #7 updates each
of the following to place them under the new
ProblemDetails\Exceptionnamespace:CommonProblemDetailsExceptionInvalidResponseBodyExceptionMissingResponseExceptionProblemDetailsException
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #5 updates the
response factory and middleware to treat lack of/empty
Acceptheader values as*/*, per RFC-7231 section 5.3.2.
- #4 adds
ProblemDetailsReponseFactoryFactoryfor generating aProblemDetailsResponseFactoryinstance.
-
#4 changes the
ProblemDetailsResponseFactoryin several ways:- It is now instantiable. The constructor accepts a boolean indicating debug
status (
falseby default), an integer bitmask of JSON encoding flags, a PSR-7ResponseInterfaceinstance, and a callable factory for generating a writable PSR-7StreamInterfacefor the final problem details response content. createResponse()is now an instance method, and its first argument is no longer anAcceptheader, but a PSR-7ServerRequestInterfaceinstance.createResponseFromThrowable()is now an instance method, and its first argument is no longer anAcceptheader, but a PSR-7ServerRequestInterfaceinstance.
- It is now instantiable. The constructor accepts a boolean indicating debug
status (
-
#4 changes the
ProblemDetailsMiddleware; it now composes aProblemDetailsResponseFactoryinsteead of anisDebugflag. Additionally, it no longer wraps processing of the delegate in a try/catch block if the request cannot accept JSON or XML. -
#4 changes the
ProblemDetailsMiddlewareFactoryto inject theProblemDetailsMiddlewarewith aProblemDetailsResponseFactoryinstead of anisDebugflag.
- Nothing.
-
#4 removes the
ProblemDetailsJsonResponse; use theProblemDetailsResponseFactoryinstead. -
#4 removes the
ProblemDetailsXmlResponse; use theProblemDetailsResponseFactoryinstead. -
#4 removes the
CommonProblemDetailstrait; the logic is now incorporated in theProblemDetailsResponseFactory. -
#4 removes the
ProblemDetailsResponseinterface; PSR-7 response prototypes are now used instead.
- #4 updates JSON response generation to allow specifying your own JSON encoding flags. By default, it now does pretty JSON, with unescaped slashes and unicode.
Initial Release.
- Nothing.
- Nothing.
- Nothing.
- Nothing.