azure-storage-common\src\Common\Middlewares\HistoryMiddleware.php
You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
PHP version 5
- Author
- Azure Storage PHP SDK
- Category
- Microsoft
- Copyright
- 2017 Microsoft Corporation
- License
- https://github.com/azure/azure-storage-php/LICENSE
- Link
- https://github.com/azure/azure-storage-php
- Package
- MicrosoftAzure\Storage\Common\Middlewares
\MicrosoftAzure\Storage\Common\Middlewares\HistoryMiddleware
Logging large number of entries without providing a file path may exhaust the memory.
The middleware should be pushed into client options if the logging is intended to persist between different API calls.
- Parent(s)
- \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareBase
- Author
- Azure Storage PHP SDK
- Category
- Microsoft
- Copyright
- 2017 Microsoft Corporation
- Inherited_from
- \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareBase
- License
- https://github.com/azure/azure-storage-php/LICENSE
- Link
- https://github.com/azure/azure-storage-php
Constants
Methods
__construct(string $path = '') : void
Constructor
Name | Type | Description |
---|---|---|
$path | string | the path to save the history. If path is provided, no data is going to be saved to memory and the entries are going to be serialized and saved to given path. |
__invoke(callable $handler) : callable
Middleware augments the functionality of handlers by invoking them in the process of generating responses. And it returns a function that accepts the next handler to invoke. Refer to http://docs.guzzlephp.org/en/latest/handlers-and-middleware.html#middleware for more detailed information.
Inherited from: \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware::__invoke()return function (
RequestInterface $request,
array $options
) use ($handler) {
//do something prior to sending the request.
$promise = $handler($request, $options);
return $promise->then(
function (ResponseInterface $response) use ($request, $options) {
//do something
return $response;
},
function ($reason) use ($request, $options) {
//do something
return new GuzzleHttp\Promise\RejectedPromise($reason);
}
);
};
Name | Type | Description |
---|---|---|
$handler | callable | The handler function. |
Type | Description |
---|---|
callable | The function that accepts the next handler to invoke. |
addHistory(array $entry) : void
Add an entry to history
Name | Type | Description |
---|---|---|
$entry | array | the entry to be added. |
onFulfilled(\Psr\Http\Message\RequestInterface $request, array $options) : callable
This function will be invoked after the request is sent, if the promise is fulfilled.
Name | Type | Description |
---|---|---|
$request | \Psr\Http\Message\RequestInterface | the request sent. |
$options | array | the options that the request sent with. |
Type | Description |
---|---|
callable |
onFulfilled(\Psr\Http\Message\RequestInterface $request, array $options) : callable
This function will be invoked after the request is sent, if the promise is fulfilled.
Inherited from:Name | Type | Description |
---|---|---|
$request | \Psr\Http\Message\RequestInterface | the request sent. |
$options | array | the options that the request sent with. |
Type | Description |
---|---|
callable |
onRejected(\Psr\Http\Message\RequestInterface $request, array $options) : callable
This function will be executed after the request is sent, if the promise is rejected.
Name | Type | Description |
---|---|---|
$request | \Psr\Http\Message\RequestInterface | the request sent. |
$options | array | the options that the request sent with. |
Type | Description |
---|---|
callable |
onRejected(\Psr\Http\Message\RequestInterface $request, array $options) : callable
This function will be executed after the request is sent, if the promise is rejected.
Inherited from:Name | Type | Description |
---|---|---|
$request | \Psr\Http\Message\RequestInterface | the request sent. |
$options | array | the options that the request sent with. |
Type | Description |
---|---|
callable |
onRequest(\Psr\Http\Message\RequestInterface $request) : \Psr\Http\Message\RequestInterface
This function will be executed before the request is sent.
Inherited from:Name | Type | Description |
---|---|---|
$request | \Psr\Http\Message\RequestInterface | the request before altered. |
Type | Description |
---|---|
\Psr\Http\Message\RequestInterface | the request after altered. |