\TxTextControl\ReportingCloudGetTrait

Trait GetTrait

Summary

Methods

Properties

Constants

getApiKeys()
proofingCheck()
getAvailableDictionaries()
getProofingSuggestions()
getTemplateInfo()
getTemplateThumbnails()
getTemplateCount()
getTemplateList()
getTemplatePageCount()
templateExists()
getFontList()
getAccountSettings()
downloadTemplate()

No public properties found

No constants found

uri()
request()
buildPropertyMapArray()

No protected properties found

N/A

get()

No private properties found

N/A

File: GetTrait.php
Package: TxTextControl\ReportingCloud
Class hierarchy: \TxTextControl\ReportingCloud\GetTrait

Methods

getApiKeys()

getApiKeys() : array<int,array<int|string,array|bool|int|string>>

Return an associative array of API keys associated with the Reporting Cloud account

Returns

array> —

proofingCheck()

proofingCheck(string  $text, string  $language) : array<int|string,array|bool|int|string>

Check a corpus of text for spelling errors.

Return an array of misspelled words, if spelling errors are found in the corpus of text.

Return an empty array, if no misspelled words are found in the corpus of text.

Parameters

string	$text	Corpus of text that should be spell checked
string	$language	Language of specified text

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

array —

getAvailableDictionaries()

getAvailableDictionaries() : array<int,string>

Return an array of available dictionaries on the Reporting Cloud service

Returns

array —

getProofingSuggestions()

getProofingSuggestions(string  $word, string  $language, int  $max = 10) : array<int,string>

Return an array of suggestions for a misspelled word

Parameters

string	$word	Word that should be spell checked
string	$language	Language of specified text
int	$max	Maximum number of suggestions to return

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

array —

getTemplateInfo()

getTemplateInfo(string  $templateName) : array<int|string,array|bool|int|string>

Return an array of merge blocks and merge fields in a template file in template storage

Parameters

string

$templateName

Template name

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

array —

getTemplateThumbnails()

getTemplateThumbnails(string  $templateName, int  $zoomFactor, int  $fromPage, int  $toPage, string  $imageFormat) : array<int,string>

Generate a thumbnail image per page of specified template in template storage.

Return an array of binary data with each record containing one thumbnail.

Parameters

string	$templateName	Template name
int	$zoomFactor	Zoom factor
int	$fromPage	From page
int	$toPage	To page
string	$imageFormat	Image format

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

array —

getTemplateCount()

getTemplateCount() : int

Return the number of templates in template storage

Returns

int —

getTemplateList()

getTemplateList() : array<int|string,array|bool|int|string>

Return an array properties for the templates in template storage

Returns

array —

getTemplatePageCount()

getTemplatePageCount(string  $templateName) : int

Return the number of pages in a template in template storage

Parameters

string

$templateName

Template name

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

int —

templateExists()

templateExists(string  $templateName) : bool

Return true, if the template exists in template storage

Parameters

string

$templateName

Template name

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

bool —

getFontList()

getFontList() : array<int,string>

Return an array of available fonts on the Reporting Cloud service

Returns

array —

getAccountSettings()

getAccountSettings() : array<int|string,array|bool|int|string>

Return an array properties for the ReportingCloud account

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

array —

downloadTemplate()

downloadTemplate(string  $templateName) : string

Download the binary data of a template from template storage

Parameters

string

$templateName

Template name

Throws

\TxTextControl\ReportingCloud\Exception\InvalidArgumentException

Returns

string —

uri()

uri(string  $uri) : string

Construct URI with version number

Parameters

string

$uri

URI

Returns

string —

request()

request(string  $method, string  $uri, array  $options) : \Psr\Http\Message\ResponseInterface

Request the URI with options

Parameters

string	$method	HTTP method
string	$uri	URI
array	$options	Options

Throws

\TxTextControl\ReportingCloud\Exception\RuntimeException

Returns

\Psr\Http\Message\ResponseInterface —

buildPropertyMapArray()

buildPropertyMapArray(array  $array, \TxTextControl\ReportingCloud\PropertyMap\AbstractPropertyMap  $propertyMap) : array

Using the passed propertyMap, recursively build array

Parameters

array	$array	Array
\TxTextControl\ReportingCloud\PropertyMap\AbstractPropertyMap	$propertyMap	PropertyMap

Returns

array —

get()

get(string  $uri, array<string,int|string>  $query = [], mixed  $json = '', int  $statusCode) : mixed

Execute a GET request via REST client

Parameters

string	$uri	URI
array	$query	Query
mixed	$json	JSON
int	$statusCode	Required HTTP status code for response

Returns

mixed —