Overview

Namespaces

  • Davek1312
    • ApiIntegrator
      • Models

Classes

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

Class ApiIntegratorResponseModel

Model for api responses

Davek1312\ApiIntegrator\Models\ApiIntegratorBaseModel uses Davek1312\Serialise\Traits\Serialise (not available) Davek1312\Serialise\Traits\Deserialise (not available)
Extended by Davek1312\ApiIntegrator\Models\ApiIntegratorResponseModel
Abstract
Namespace: Davek1312\ApiIntegrator\Models
Author: David Kelly davek1312@gmail.com
Located at Models/ApiIntegratorResponseModel.php
Methods summary
public
# __construct( string $dataType )

ApiIntegratorResponseModel constructor.

ApiIntegratorResponseModel constructor.

Parameters

$dataType
public object
# deserialiseResponse( string $data )

Deserialises $data into an object of this class

Deserialises $data into an object of this class

Parameters

$data

Returns

object
public string
# getResponseErrorMessage( )

Returns the error message returned by the API. This should be overridden to point the child method containing the API's error message

Returns the error message returned by the API. This should be overridden to point the child method containing the API's error message

Returns

string
public string
# getResponseErrorCode( )

Returns the error code returned by the API. This should be overridden to point the child method containing the API's error code

Returns the error code returned by the API. This should be overridden to point the child method containing the API's error code

Returns

string
public boolean
# hasResponseError( )

Returns true if getResponseErrorMessage() or getResponseErrorCode() is not empty

Returns true if getResponseErrorMessage() or getResponseErrorCode() is not empty

Returns

boolean
public string
# getDataType( )

Returns

string
public
# setDataType( string $dataType )

Parameters

$dataType
Properties summary
protected string $dataType

The API's response format: 'json' OR 'xml'

The API's response format: 'json' OR 'xml'

Exclude()

#
API documentation generated by ApiGen