ZEROSPAM\Framework\SDK\Response\Api\BaseResponse

Class BaseResponse

Reponse given by the client when processing a request.
Take care of providing generator for bindings

Synopsis

class BaseResponse implements IRateLimitedResponse {

• // members
• private array $objReplacementCache = ;
• protected  $data;
• protected  $rawData;
• protected array $dates = ;
• // methods
• public void __construct()
• public void setRawData()
• public array getRawData()
• public array data()
• public mixed getRawValue()
• public mixed|null get()
• public void __isset()
• public void __get()
• public void populateDataObject()
• // Inherited methods from RateLimitedTrait
• public RateLimitData getRateLimit()
• public $this setRateLimit()
}


Hierarchy

Uses

• ZEROSPAM\Framework\SDK\Response\Api\Helper\RateLimitedTrait

Implements

• ZEROSPAM\Framework\SDK\Response\Api\IRateLimitedResponse

Members

private

• $objReplacementCache — array

protected

• $data — array
• $dates — array
  Dates to be transTyped from string to Carbon.
• $rateLimit — ZEROSPAM\Framework\SDK\Response\RateLimit\RateLimitData
• $rawData — array
  Data unprocessed

Methods

public

• __construct() — UserCreationResponse constructor.
• __get()
• __isset()
• data() — Data contained in the response.
• get() — Get a specific field.
• getRawData() — Used internally
• getRawValue() — Return value in response array of the response.
• populateDataObject() — Populate the data object with the data present in the response
• setRawData() — Used internally

Inherited from ZEROSPAM\Framework\SDK\Response\Api\Helper\RateLimitedTrait

public

• getRateLimit()
• setRateLimit()

History

• 2018-12-05T15:02:50+00:00 (commit #b8fa2d7)

  Author: Antoine Aflalo (antoine.aflalo@zerospam.ca) / Commiter: Antoine Aflalo (antoine.aflalo@zerospam.ca)

  feat(Response): Save raw data in response

• 2018-09-26T17:56:12+00:00 (commit #bf95012)

  Author: Antoine Aflalo (antoine.aflalo@zerospam.ca) / Commiter: Antoine Aflalo (antoine.aflalo@zerospam.ca)

  fix(Response): Populate data object

• 2018-09-26T17:18:36+00:00 (commit #6fb8758)

  Author: Antoine Aflalo (antoine.aflalo@zerospam.ca) / Commiter: Antoine Aflalo (antoine.aflalo@zerospam.ca)

  feat(DataObject): Adds dataObject
  
  Specific object that contains data needed to be nested in the request.

• 2018-09-26T15:05:51+00:00 (commit #c4198b5)

  Author: Antoine Aflalo (antoine.aflalo@zerospam.ca) / Commiter: Antoine Aflalo (antoine.aflalo@zerospam.ca)

  perf(Response): Makes response arrayable

• 2018-07-16T14:26:38+00:00 (commit #290a97d)

  Author: Antoine Aflalo (antoine.aflalo@zerospam.ca) / Commiter: Antoine Aflalo (antoine.aflalo@zerospam.ca)

  feat(Response): Split Ratelimited from BaseResponse
  
  New type of response can now be easily build.