azure-storage-common\src\Common\Middlewares\HistoryMiddleware.php

Show: PublicProtectedPrivateinherited
Table of Contents
LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

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

Package: MicrosoftAzure\Storage\Common\Middlewares
This class provides the functionality to log the requests/options/responses.

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

>VConstant  TITLE_LENGTH = 120

Methods

methodpublic__construct(string $path = '') : void

Constructor

Parameters
NameTypeDescription
$pathstring

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.

methodpublic__invoke(callable $handler) : callable
inherited

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);
       }
   );
};
Parameters
NameTypeDescription
$handlercallable

The handler function.

Returns
TypeDescription
callableThe function that accepts the next handler to invoke.
methodpublicaddHistory(array $entry) : void

Add an entry to history

Parameters
NameTypeDescription
$entryarray

the entry to be added.

methodpublicclearHistory() : void

Clear the history

methodpublicgetHistory() : array

Gets the saved paried history.

Returns
TypeDescription
array
methodprotectedonFulfilled(\Psr\Http\Message\RequestInterface $request, array $options) : callable

This function will be invoked after the request is sent, if the promise is fulfilled.

Parameters
NameTypeDescription
$request\Psr\Http\Message\RequestInterface

the request sent.

$optionsarray

the options that the request sent with.

Returns
TypeDescription
callable
methodprotectedonFulfilled(\Psr\Http\Message\RequestInterface $request, array $options) : callable
inherited

This function will be invoked after the request is sent, if the promise is fulfilled.

Inherited from:
Parameters
NameTypeDescription
$request\Psr\Http\Message\RequestInterface

the request sent.

$optionsarray

the options that the request sent with.

Returns
TypeDescription
callable
methodprotectedonRejected(\Psr\Http\Message\RequestInterface $request, array $options) : callable

This function will be executed after the request is sent, if the promise is rejected.

Parameters
NameTypeDescription
$request\Psr\Http\Message\RequestInterface

the request sent.

$optionsarray

the options that the request sent with.

Returns
TypeDescription
callable
methodprotectedonRejected(\Psr\Http\Message\RequestInterface $request, array $options) : callable
inherited

This function will be executed after the request is sent, if the promise is rejected.

Inherited from:
Parameters
NameTypeDescription
$request\Psr\Http\Message\RequestInterface

the request sent.

$optionsarray

the options that the request sent with.

Returns
TypeDescription
callable
methodprotectedonRequest(\Psr\Http\Message\RequestInterface $request) : \Psr\Http\Message\RequestInterface
inherited

This function will be executed before the request is sent.

Inherited from:
Parameters
NameTypeDescription
$request\Psr\Http\Message\RequestInterface

the request before altered.

Returns
TypeDescription
\Psr\Http\Message\RequestInterfacethe request after altered.
Documentation was generated by phpDocumentor 2.9.1.