Candles
extends ResponseBase
in package
Represents a collection of financial candles for mutual funds.
Table of Contents
Properties
- $_saved_filename : string|null
- $candles : array<string|int, Candle>
- Array of Candle objects representing financial data for mutual funds.
- $next_time : int|null
- Unix time of the next quote if there is no data in the requested period, but there is data in a subsequent period.
- $status : string
- Status of the candles request. Will always be ok when there is data for the candles requested.
- $csv : string
- $html : string
Methods
- __construct() : mixed
- Constructs a new Candles instance from the given response object.
- __toString() : string
- Returns a string representation of the mutual funds candles collection.
- 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).
$candles
Array of Candle objects representing financial data for mutual funds.
public
array<string|int, Candle>
$candles
= []
$next_time
Unix time of the next quote if there is no data in the requested period, but there is data in a subsequent period.
public
int|null
$next_time
= null
$status
Status of the candles request. Will always be ok when there is data for the candles requested.
public
string
$status
= 'no_data'
$csv
protected
string
$csv
The CSV content of the response.
$html
protected
string
$html
The HTML content of the response.
Methods
__construct()
Constructs a new Candles instance from the given response object.
public
__construct(object $response) : mixed
Parameters
- $response : object
-
The response object containing candle data.
__toString()
Returns a string representation of the mutual funds candles collection.
public
__toString() : string
Return values
string —Human-readable candles summary.
getCsv()
Get the CSV content of the response.
public
getCsv() : string
Tags
Return values
string —The CSV content.
getHtml()
Get the HTML content of the response.
public
getHtml() : string
Tags
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
Return values
string —The absolute path of the saved file.