Documentation
\
TxTextControl
ReportingCloud
Assert
Exception
Filter
PropertyMap
Stdlib

\TxTextControl\ReportingCloud\AssertAssert

Class Assert

Summary

Methods
Properties
Constants
assertApiKey()
assertBase64Data()
assertBaseUri()
assertCulture()
getCulturesFilename()
assertDateTime()
assertDocumentDivider()
assertDocumentExtension()
assertDocumentThumbnailExtension()
assertFilenameExists()
assertImageFormat()
assertLanguage()
getDictionariesFilename()
assertOneOf()
assertPage()
assertRange()
assertRemove()
assertReturnFormat()
assertTemplateExtension()
assertTemplateFormat()
assertTemplateName()
assertTimestamp()
assertZoomFactor()
No public properties found
No constants found
valueToString()
No protected properties found
N/A
getCultures()
getDateTimeLength()
getDocumentDividers()
getDictionaries()
$apiKeyMinLength
$apiKeyMaxLength
$pageMin
$pageMax
$timestampMin
$timestampMax
$zoomFactorMin
$zoomFactorMax
N/A

Properties

$apiKeyMinLength

$apiKeyMinLength : int

Minimum length of API key

Type

int —

$apiKeyMaxLength

$apiKeyMaxLength : int

Maximum length of API key

Type

int —

$pageMin

$pageMin : int

Minimum page number

Type

int —

$pageMax

$pageMax : int

Maximum page number (PHP_INT_MAX)

Type

int —

$timestampMin

$timestampMin : int

Minimum timestamp (EPOC)

Type

int —

$timestampMax

$timestampMax : int

Maximum timestamp (PHP_INT_MAX)

Type

int —

$zoomFactorMin

$zoomFactorMin : int

Minimum zoom factor

Type

int —

$zoomFactorMax

$zoomFactorMax : int

Maximum zoom factor

Type

int —

Methods

assertApiKey()

assertApiKey(string  $value, string  $message = '') : void

Check value is a syntactically valid API key

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertBase64Data()

assertBase64Data(string  $value, string  $message = '') : void

Check value is valid base64 encoded data

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertBaseUri()

assertBaseUri(mixed  $value, string  $message = '') : void

Check value is a known base URI

Parameters

mixed $value
string $message

assertCulture()

assertCulture(string  $value, string  $message = '') : void

Check value is a valid culture

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

getCulturesFilename()

getCulturesFilename() : string

Return the filename, containing cultures array

Returns

string —

assertDateTime()

assertDateTime(string  $value, string  $message = '') : void

Check value is a valid DateTime string

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertDocumentDivider()

assertDocumentDivider(int  $value, string  $message = '') : void

Check value is a valid document divider

Parameters

int $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertDocumentExtension()

assertDocumentExtension(string  $value, string  $message = '') : void

Check value is a valid document format extension

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertDocumentThumbnailExtension()

assertDocumentThumbnailExtension(string  $value, string  $message = '') : void

Check value is a valid document thumbnail format extension

This is a special case assert method that is used only by TxTextControl\ReportingCloud\ReportingCloud::getDocumentThumbnails() as this method additionally accepts files in XLSX format. No other methods do.

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertFilenameExists()

assertFilenameExists(string  $value, string  $message = '') : void

Check filename exists and is readable

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertImageFormat()

assertImageFormat(string  $value, string  $message = '') : void

Check value is valid image format extension

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertLanguage()

assertLanguage(string  $value, string  $message = '') : void

Check value is a valid language

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

getDictionariesFilename()

getDictionariesFilename() : string

Return the filename, containing languages aka dictionaries array

Returns

string —

assertOneOf()

assertOneOf(mixed  $value, array<int,int|string>  $values, string  $message = '') : void

Check value is in values

Parameters

mixed $value
array $values
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertPage()

assertPage(int  $value, string  $message = '') : void

Check value is a valid page number

Parameters

int $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertRange()

assertRange(int  $value, int  $min, int  $max, string  $message = '') : void

Check value is in range min..max

Parameters

int $value
int $min
int $max
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertRemove()

assertRemove(mixed  $value, string  $message = '') : void

Check value is a "remove_*" value

Parameters

mixed $value
string $message

assertReturnFormat()

assertReturnFormat(string  $value, string  $message = '') : void

Check value is a valid return format extension

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertTemplateExtension()

assertTemplateExtension(string  $value, string  $message = '') : void

Check value is a valid template extension

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertTemplateFormat()

assertTemplateFormat(string  $value, string  $message = '') : void

Check value is a valid template format

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertTemplateName()

assertTemplateName(string  $value, string  $message = '') : void

Check value is a valid template name

Parameters

string $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertTimestamp()

assertTimestamp(int  $value, string  $message = '') : void

Check value is a valid timestamp

Parameters

int $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

assertZoomFactor()

assertZoomFactor(int  $value, string  $message = '') : void

Check value is a valid zoom factor

Parameters

int $value
string $message

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

valueToString()

valueToString(mixed  $value) : string

Convert value to string

Parameters

mixed $value

Returns

string —

getCultures()

getCultures() : array<int,string>

Return cultures array

Returns

array —

getDateTimeLength()

getDateTimeLength() : int

Get the length of the required dateTime string

Returns

int —

getDocumentDividers()

getDocumentDividers() : array<int,int>

Return document dividers array

Returns

array —

getDictionaries()

getDictionaries() : array<int,string>

Return languages aka dictionaries array

Returns

array —