Overview

Namespaces

  • Davek1312
    • ApiIntegrator
      • Models

Classes

  • ApiIntegratorBaseModel
  • ApiIntegratorRequestModel
  • ApiIntegratorResponseModel
  • Overview
  • Namespace
  • Class

Class ApiIntegratorRequestModel

Model for api requests

Davek1312\ApiIntegrator\Models\ApiIntegratorBaseModel uses Davek1312\Serialise\Traits\Serialise (not available) Davek1312\Serialise\Traits\Deserialise (not available)
Extended by Davek1312\ApiIntegrator\Models\ApiIntegratorRequestModel
Abstract
Namespace: Davek1312\ApiIntegrator\Models
Author: David Kelly davek1312@gmail.com
Located at Models/ApiIntegratorRequestModel.php
Methods summary
public
# __construct( string $url, string $connectionMethod, float $connectTimeout, float $requestTimeout, array $requestOptions = [] )

ApiIntegratorRequestModel constructor.

ApiIntegratorRequestModel constructor.

Parameters

$url
$connectionMethod
$connectTimeout
$requestTimeout
$requestOptions
public GuzzleHttp\Client
# getHttpClient( )

Returns a new GuzzleHttp\Client with all the request options

Returns a new GuzzleHttp\Client with all the request options

Returns

GuzzleHttp\Client
public array
# getAllRequestOptions( )

Merges the default request options with the additional options

Merges the default request options with the additional options

Returns

array
public GuzzleHttp\Psr7\Response
# getHttpResponse( )

Makes a HTTP request to the API

Makes a HTTP request to the API

Returns

GuzzleHttp\Psr7\Response
public string
# getUrl( )

Returns

string
public
# setUrl( string $url )

Parameters

$url
public string
# getConnectionMethod( )

Returns

string
public
# setConnectionMethod( string $connectionMethod )

Parameters

$connectionMethod
public float
# getConnectTimeout( )

Returns

float
public
# setConnectTimeout( float $connectTimeout )

Parameters

$connectTimeout
public float
# getRequestTimeout( )

Returns

float
public
# setRequestTimeout( float $requestTimeout )

Parameters

$requestTimeout
public array
# getRequestOptions( )

Returns

array
public
# setRequestOptions( array $requestOptions )

Parameters

$requestOptions
public GuzzleHttp\Exception\ConnectException
# getConnectException( )

Returns

GuzzleHttp\Exception\ConnectException
public
# setConnectException( GuzzleHttp\Exception\ConnectException $connectException )

Parameters

$connectException
public float
# getRequestTimeInSeconds( )

Returns

float
public
# setRequestTimeInSeconds( float $requestTimeInSeconds )

Parameters

$requestTimeInSeconds
public integer
# getHttpStatusCode( )

Returns

integer
public
# setHttpStatusCode( integer $httpStatusCode )

Parameters

$httpStatusCode
Properties summary
protected string $url

The API's url

The API's url

Exclude()

#
protected string $connectionMethod

HTTP connection method eg. GET, POST, PUT..

HTTP connection method eg. GET, POST, PUT..

Exclude()

#
protected float $connectTimeout

Number of seconds to wait while trying to connect to a server

Number of seconds to wait while trying to connect to a server

Exclude()

#
protected float $requestTimeout

Timeout of the request in seconds

Timeout of the request in seconds

Exclude()

#
protected array $requestOptions

Build your request using this documentation: http://docs.guzzlephp.org/en/latest/request-options.html

Build your request using this documentation: http://docs.guzzlephp.org/en/latest/request-options.html

Exclude()

#
protected GuzzleHttp\Exception\ConnectException $connectException

ConnectionException thrown in getHttpResponse()

ConnectionException thrown in getHttpResponse()

Exclude()

#
protected float $requestTimeInSeconds

Exclude()

#
protected integer $httpStatusCode

Exclude()

#
API documentation generated by ApiGen