\TxTextControl\ReportingCloud\FilterFilter

Class Filter

Summary

Methods

Properties

Constants

filterBooleanToString()
filterDateTimeToTimestamp()
filterTimestampToDateTime()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Filter/Filter.php
Package: TxTextControl\ReportingCloud
Class hierarchy: AbstractFilter

\TxTextControl\ReportingCloud\Filter\Filter
Uses traits: \TxTextControl\ReportingCloud\Filter\FilterBooleanToStringTrait; \TxTextControl\ReportingCloud\Filter\FilterDateTimeToTimestampTrait; \TxTextControl\ReportingCloud\Filter\FilterTimestampToDateTimeTrait

filterBooleanToString(bool  $param) : string

Convert bool true and false to string 'true' and 'false'.

This is necessary to prevent Guzzle from converting the query parameter to ?param=0 or ?param=1, which the backend does not recognize.

The backend only recognizes query parameter ?param=true and ?param=false.

bool

$param

string —

filterDateTimeToTimestamp(string  $dateTimeString) : int

Convert the date/time format used by the backend (e.g. "2016-04-15T19:05:18+00:00") to a UNIX timestamp.

string

$dateTimeString

int —

filterTimestampToDateTime(int  $timestamp) : string

Convert a UNIX timestamp to the date/time format used by the backend (e.g. "2016-04-15T19:05:18+00:00").

int

$timestamp

string —