Overview

Namespaces

  • Davek1312
    • ApiIntegrator
      • Models

Classes

  • ApiIntegrator
  • Overview
  • Namespace
  • Class

Class ApiIntegrator

Retrieve's data from a third party API and deserialises the response into a model object

Abstract
Namespace: Davek1312\ApiIntegrator
Author: David Kelly davek1312@gmail.com
Located at ApiIntegrator.php
Methods summary
public
# __construct( $requestModel, $responseModelClass )

ApiIntegrator constructor. Sets $httpResponse from $requestModel.

ApiIntegrator constructor. Sets $httpResponse from $requestModel.

Parameters

$requestModel
$responseModelClass
public
# getResponseModel( )
public Davek1312\ApiIntegrator\Models\ApiIntegratorRequestModel
# getRequestModel( )

Returns

Davek1312\ApiIntegrator\Models\ApiIntegratorRequestModel
public
# setRequestModel( Davek1312\ApiIntegrator\Models\ApiIntegratorRequestModel $requestModel )

Parameters

$requestModel
public string
# getResponseModelClass( )

Returns

string
public
# setResponseModelClass( string $responseModelClass )

Parameters

$responseModelClass
public GuzzleHttp\Psr7\Response
# getHttpResponse( )

Returns

GuzzleHttp\Psr7\Response
public
# setHttpResponse( GuzzleHttp\Psr7\Response $httpResponse )

Parameters

$httpResponse
public string
# getResponseBody( )

Returns

string
public
# setResponseBody( string $responseBody )

Parameters

$responseBody
Properties summary
protected Davek1312\ApiIntegrator\Models\ApiIntegratorRequestModel $requestModel
#
protected string $responseModelClass
#
protected GuzzleHttp\Psr7\Response $httpResponse
#
protected string $responseBody
#
API documentation generated by ApiGen