Report
class Report (View source)
Properties
| protected | $session | ||
| protected ReportDownloader | $reportDownloader | ||
| protected | $format | ||
| protected | $data | Report Data | |
| protected | $query | ||
| protected string | $fields | ||
| protected string | $during | During clause | |
| protected string | $where | Where Condition | |
| protected string | $type | ||
| protected bool | $magicSelect |
Methods
Reports constructor.
Set the format for the report.
Set the fields to retrieve
Set the report type
Set the starting and ending dates for the report.
Set where condition
Mark magicSelect as true.
Get the report as a SimpleXMLObj
Get report as string
Get report as stream
Save the report in a file.
Pull fields out of fields list.
No description
No description
Get a list of the report formats.
No description
Details
at line 74
__construct(null $session = null)
Reports constructor.
at line 89
$this
format($format)
Set the format for the report.
at line 105
$this
select($fields)
Set the fields to retrieve
at line 118
$this
from($reportType)
Set the report type
at line 138
$this
during($starting, $ending)
Set the starting and ending dates for the report.
dates format 'Ymd' => e.g. 20170112,20171020
at line 154
$this
where($condition)
Set where condition
at line 166
$this
magicSelect()
Mark magicSelect as true.
at line 178
SimpleXMLElement
getAsSimpleXMLObj()
Get the report as a SimpleXMLObj
at line 205
string
getAsString()
Get report as string
at line 216
Stream
getStream()
Get report as stream
at line 229
bool
saveToFile($filePath, string $format = 'csvforexcel')
Save the report in a file.
at line 299
$this
except($excepts)
Pull fields out of fields list.
at line 347
array
getTypes()
at line 355
array
getFields()
at line 365
array
getFormats()
Get a list of the report formats.