PostTrait
Trait PostTrait
Table of Contents
Methods
- appendDocument() : string
- Combine documents by appending them, divided by a new section, paragraph or nothing
- convertDocument() : string
- Convert a document on the local file system to a different format
- findAndReplaceDocument() : string
- Perform find and replace in document and return binary data.
- getDocumentThumbnails() : array<string|int, mixed>
- Generate a thumbnail image per page of specified document filename.
- getTrackedChanges() : array<string|int, mixed>
- Return the tracked changes in a document.
- mergeDocument() : array<string|int, mixed>
- Merge data into a template and return an array of binary data.
- removeTrackedChange() : array<string|int, mixed>
- Removes a specific tracked change and returns the resulting document.
- uploadTemplate() : bool
- Upload a template to template storage
- uploadTemplateFromBase64() : bool
- Upload a base64 encoded template to template storage
- buildDocumentsArray() : array<string|int, mixed>
- Using passed documentsData array, build array for backend
- buildDocumentSettingsArray() : array<string|int, mixed>
- Using passed documentsSettings array, build array for backend
- buildFindAndReplaceDataArray() : array<string|int, mixed>
- Using passed findAndReplaceData associative array (key-value), build array for backend (list of string arrays)
- buildMergeSettingsArray() : array<string|int, mixed>
- Using passed mergeSettings array, build array for backend
- buildPropertyMapArray() : array<string|int, mixed>
- Using the passed propertyMap, recursively build array
- request() : ResponseInterface
- Request the URI with options
- uri() : string
- Construct URI with version number
- post() : mixed
- Execute a POST request via REST client
Methods
appendDocument()
Combine documents by appending them, divided by a new section, paragraph or nothing
public
appendDocument(array<string|int, mixed> $documentsData, string $returnFormat[, array<string|int, mixed> $documentSettings = [] ]) : string
Parameters
- $documentsData : array<string|int, mixed>
- $returnFormat : string
- $documentSettings : array<string|int, mixed> = []
Return values
stringconvertDocument()
Convert a document on the local file system to a different format
public
convertDocument(string $documentFilename, string $returnFormat) : string
Parameters
- $documentFilename : string
-
Document filename
- $returnFormat : string
-
Return format
Return values
stringfindAndReplaceDocument()
Perform find and replace in document and return binary data.
public
findAndReplaceDocument(array<string|int, mixed> $findAndReplaceData, string $returnFormat[, string $templateName = '' ][, string $templateFilename = '' ][, array<string|int, mixed> $mergeSettings = [] ]) : string
Parameters
- $findAndReplaceData : array<string|int, mixed>
-
Array of find and replace data
- $returnFormat : string
-
Return format
- $templateName : string = ''
-
Template name
- $templateFilename : string = ''
-
Template filename on local file system
- $mergeSettings : array<string|int, mixed> = []
-
Array of merge settings
Return values
stringgetDocumentThumbnails()
Generate a thumbnail image per page of specified document filename.
public
getDocumentThumbnails(string $documentFilename, int $zoomFactor, int $fromPage, int $toPage, string $imageFormat) : array<string|int, mixed>
Return an array of binary data with each record containing one thumbnail.
Parameters
- $documentFilename : string
-
Document filename
- $zoomFactor : int
-
Zoom factor
- $fromPage : int
-
From page
- $toPage : int
-
To page
- $imageFormat : string
-
Image format
Return values
array<string|int, mixed>getTrackedChanges()
Return the tracked changes in a document.
public
getTrackedChanges(string $documentFilename) : array<string|int, mixed>
Parameters
- $documentFilename : string
-
Document filename
Return values
array<string|int, mixed>mergeDocument()
Merge data into a template and return an array of binary data.
public
mergeDocument(array<string|int, mixed> $mergeData, string $returnFormat[, string $templateName = '' ][, string $templateFilename = '' ][, bool $append = false ][, array<string|int, mixed> $mergeSettings = [] ]) : array<string|int, mixed>
Each record in the array is the binary data of one document
Parameters
- $mergeData : array<string|int, mixed>
-
Array of merge data
- $returnFormat : string
-
Return format
- $templateName : string = ''
-
Template name
- $templateFilename : string = ''
-
Template filename on local file system
- $append : bool = false
-
Append flag
- $mergeSettings : array<string|int, mixed> = []
-
Array of merge settings
Return values
array<string|int, mixed>removeTrackedChange()
Removes a specific tracked change and returns the resulting document.
public
removeTrackedChange(string $documentFilename, int $id, bool $accept) : array<string|int, mixed>
Parameters
- $documentFilename : string
-
Document filename
- $id : int
-
The ID of the tracked change that needs to be removed
- $accept : bool
-
Specifies whether the tracked change should be accepted or not (reject)
Return values
array<string|int, mixed>uploadTemplate()
Upload a template to template storage
public
uploadTemplate(string $templateFilename) : bool
Parameters
- $templateFilename : string
-
Template name
Return values
booluploadTemplateFromBase64()
Upload a base64 encoded template to template storage
public
uploadTemplateFromBase64(string $data, string $templateName) : bool
Parameters
- $data : string
-
Template encoded as base64
- $templateName : string
-
Template name
Return values
boolbuildDocumentsArray()
Using passed documentsData array, build array for backend
protected
abstract buildDocumentsArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
-
AppendDocument array
Return values
array<string|int, mixed>buildDocumentSettingsArray()
Using passed documentsSettings array, build array for backend
protected
abstract buildDocumentSettingsArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
Return values
array<string|int, mixed>buildFindAndReplaceDataArray()
Using passed findAndReplaceData associative array (key-value), build array for backend (list of string arrays)
protected
abstract buildFindAndReplaceDataArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
-
FindAndReplaceData array
Return values
array<string|int, mixed>buildMergeSettingsArray()
Using passed mergeSettings array, build array for backend
protected
abstract buildMergeSettingsArray(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
-
MergeSettings array
Return values
array<string|int, mixed>buildPropertyMapArray()
Using the passed propertyMap, recursively build array
protected
abstract buildPropertyMapArray(array<string|int, mixed> $array, AbstractPropertyMap $propertyMap) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
-
Array
- $propertyMap : AbstractPropertyMap
-
PropertyMap
Return values
array<string|int, mixed>request()
Request the URI with options
protected
abstract request(string $method, string $uri, array<string|int, mixed> $options) : ResponseInterface
Parameters
- $method : string
-
HTTP method
- $uri : string
-
URI
- $options : array<string|int, mixed>
-
Options
Return values
ResponseInterfaceuri()
Construct URI with version number
protected
abstract uri(string $uri) : string
Parameters
- $uri : string
-
URI
Return values
stringpost()
Execute a POST request via REST client
private
post(string $uri[, array<string|int, mixed> $query = [] ][, mixed $json = '' ][, int $statusCode = 0 ]) : mixed
Parameters
- $uri : string
-
URI
- $query : array<string|int, mixed> = []
-
Query
- $json : mixed = ''
-
JSON
- $statusCode : int = 0
-
Required HTTP status code for response