MarketData SDK

ResponseBase
in package

Base class for API responses.

This class provides common functionality for handling different response formats (CSV, HTML, JSON).

Table of Contents

Properties

$_saved_filename  : string|null
$csv  : string
$html  : string

Methods

__construct()  : mixed
ResponseBase constructor.
getCsv()  : string
Get the CSV content of the response.
getHtml()  : string
Get the HTML content of the response.
isCsv()  : bool
Check if the response is in CSV format.
isHtml()  : bool
Check if the response is in HTML format.
isJson()  : bool
Check if the response is in JSON format.
saveToFile()  : string
Save CSV/HTML content to a file.

Properties

$_saved_filename

public string|null $_saved_filename = null

The filename where the response was saved (if filename parameter was used).

$csv

protected string $csv

The CSV content of the response.

$html

protected string $html

The HTML content of the response.

Methods

__construct()

ResponseBase constructor.

public __construct(object $response) : mixed
Parameters
$response : object

The raw response object from the API.

getCsv()

Get the CSV content of the response.

public getCsv() : string
Tags
throws
InvalidArgumentException

If the response is not in CSV format.

Return values
string —

The CSV content.

getHtml()

Get the HTML content of the response.

public getHtml() : string
Tags
throws
InvalidArgumentException

If the response is not in HTML format.

Return values
string —

The HTML content.

isCsv()

Check if the response is in CSV format.

public isCsv() : bool
Return values
bool —

True if the response is in CSV format, false otherwise.

isHtml()

Check if the response is in HTML format.

public isHtml() : bool
Return values
bool —

True if the response is in HTML format, false otherwise.

isJson()

Check if the response is in JSON format.

public isJson() : bool
Return values
bool —

True if the response is in JSON format, false otherwise.

saveToFile()

Save CSV/HTML content to a file.

public saveToFile(string $filename) : string
Parameters
$filename : string

The file path to save to.

Tags
throws
InvalidArgumentException

If filename is invalid (wrong extension, etc.).

RuntimeException

If file writing fails.

Return values
string —

The absolute path of the saved file.

On this page

Search results