Class ReportingCloud
DEFAULT_DATE_FORMAT = 'Y-m-d\TH:i:sP'
Default date/time format of backend is 'ISO 8601'
Note, last letter is 'P' and not 'O':
O - Difference to Greenwich time (GMT) in hours (e.g. +0200) P - Difference to Greenwich time (GMT) with colon between hours and minutes (e.g. +02:00)
Backend uses the 'P' variant
$apiKey : string
Backend API key
$username : string
Backend username
$password : string
Backend password
$baseUri : string
Backend base URI
$debug : bool
Debug flag of REST client
$test : bool
When true, API call does not count against quota "TEST MODE" watermark is added to document
$timeout : int
Backend timeout in seconds
$version : string
Backend version string
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.
| string | $text | Corpus of text that should be spell checked |
| string | $language | Language of specified text |
getProofingSuggestions(string $word, string $language, int $max = 10) : array<int,string>
Return an array of suggestions for a misspelled word
| string | $word | Word that should be spell checked |
| string | $language | Language of specified text |
| int | $max | Maximum number of suggestions to return |
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
| string | $templateName | Template name |
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.
| string | $templateName | Template name |
| int | $zoomFactor | Zoom factor |
| int | $fromPage | From page |
| int | $toPage | To page |
| string | $imageFormat | Image format |
uploadTemplateFromBase64(string $data, string $templateName) : bool
Upload a base64 encoded template to template storage
| string | $data | Template encoded as base64 |
| string | $templateName | Template name |
convertDocument(string $documentFilename, string $returnFormat) : string
Convert a document on the local file system to a different format
| string | $documentFilename | Document filename |
| string | $returnFormat | Return format |
mergeDocument(array<int|string,array|bool|int|string> $mergeData, string $returnFormat, string $templateName = '', string $templateFilename = '', bool $append = false, array<string,bool|int|string> $mergeSettings = []) : array<int,string>
Merge data into a template and return an array of binary data.
Each record in the array is the binary data of one document
| array |
$mergeData | Array of merge data |
| string | $returnFormat | Return format |
| string | $templateName | Template name |
| string | $templateFilename | Template filename on local file system |
| bool | $append | Append flag |
| array |
$mergeSettings | Array of merge settings |
appendDocument(array<int|string,array|bool|int|string> $documentsData, string $returnFormat, array<string,bool|int|string> $documentSettings = []) : string
Combine documents by appending them, divided by a new section, paragraph or nothing
| array |
$documentsData | |
| string | $returnFormat | |
| array |
$documentSettings |
findAndReplaceDocument(array<string,string> $findAndReplaceData, string $returnFormat, string $templateName = '', string $templateFilename = '', array<string,bool|int|string> $mergeSettings = []) : string
Perform find and replace in document and return binary data.
| array |
$findAndReplaceData | Array of find and replace data |
| string | $returnFormat | Return format |
| string | $templateName | Template name |
| string | $templateFilename | Template filename on local file system |
| array |
$mergeSettings | Array of merge settings |
getDocumentThumbnails(string $documentFilename, int $zoomFactor, int $fromPage, int $toPage, string $imageFormat) : array<int,string>
Generate a thumbnail image per page of specified document filename.
Return an array of binary data with each record containing one thumbnail.
| string | $documentFilename | Document filename |
| int | $zoomFactor | Zoom factor |
| int | $fromPage | From page |
| int | $toPage | To page |
| string | $imageFormat | Image format |
removeTrackedChange(string $documentFilename, int $id, bool $accept) : array<int|string,array|bool|int|string>
Removes a specific tracked change and returns the resulting document.
| string | $documentFilename | Document filename |
| int | $id | The ID of the tracked change that needs to be removed |
| bool | $accept | Specifies whether the tracked change should be accepted or not (reject) |
buildPropertyMapArray(array $array, \TxTextControl\ReportingCloud\PropertyMap\AbstractPropertyMap $propertyMap) : array
Using the passed propertyMap, recursively build array
| array | $array | Array |
| \TxTextControl\ReportingCloud\PropertyMap\AbstractPropertyMap | $propertyMap | PropertyMap |
request(string $method, string $uri, array<string,array|bool|int|string> $options) : \Psr\Http\Message\ResponseInterface
Request the URI with options
| string | $method | HTTP method |
| string | $uri | URI |
| array |
$options | Options |