- Removed PHP 7.4 support.
- Minor refactoring for PHP 8.1 compatibility.
For a full description of changes, see release-3.0.0.md.
- Added support for PHP 8.0.
- Upgraded minimum PHP requirement to 7.4.
- Added typed properties.
- Removed nullable type from public method parameters.
- Updated to Guzzle 7.0.
- Updated to PHPUnit 9.5.
- Removed class
StatusCode
. - Added ctw/ctw-http as a replacement for
StatusCode
. - Switched to PHPStan for static analysis, with strict rules.
- Deprecated username and password authentication, in favor of API key authentication.
- Improved Composer 2.0 compatibility.
- Fixed PSR-4 autoloading issue in tests.
- Improved documentation for Laminas migration.
- Added support for PHP 7.4.
- Improved code quality, using static analysis.
- Updated to PHPUnit 8.
- Added support for Tracked Changes.
- Added ability to set base URI of ReportingCloud service via environment variable or PHP constant.
- Added
TxTextControl\ReportingCloud\Assert\Assert::assertBaseUri
to validate base URI. - Removed deprecated demos is
/demo/instantiation.php
.
- Removed
Webmozart\Assert
dependency.
- Implemented end-point
/v1/document/thumbnails
- Added
/demo/get-document-thumbnails.php
to exemplifygetDocumentThumbnails(string $documentFilename, int $zoomFactor, int $fromPage, int $toPage,string $imageFormat)
. - Abstracted file utilities to
TxTextControl\ReportingCloud\Stdlib\FileUtils
.
- Added support for TXT return file format.
- Added class constants for file formats to
TxTextControl\ReportingCloud\ReportingCloud
. - Added return types to all unit tests.
- Added
bin/build-gh-pages.sh
to build GitHub Pages site (API documentation and unit test coverage). - Re-organized bootstrapping of console scripts.
- Improved code quality with static analysis (phpstan, psalm and phan).
- Fixed return value of
downloadTemplate($templateName)
to binary data - it was base64 encoded data; it should have been binary data. - Added generator parameter to
Stdlib\ArrayUtils::varExportToFile
. - Split up
/resources
and/data
contents. - Split up unit tests into similarly named Traits as
TxTextControl\ReportingCloud\ReportingCloud
. - Added strict typing to all unit tests.
- Removed deprecated function calls in unit tests.
- Minor refactoring and code formatting.
For a full description of changes, see release-2.0.0.md.
- Removed all Zend Framework 3 dependencies.
- Set the minimum PHP version to 7.1.
- Added strict typing to all files.
- Upgraded to PHPUnit 7.5.
- Abstracted (magic number) HTTP codes to
TxTextControl\ReportingCloud\StatusCode\StatusCode
. - Abstracted string utilities to
TxTextControl\ReportingCloud\Stdlib\StringUtils
. - Abstracted array utilities to
TxTextControl\ReportingCloud\Stdlib\ArrayUtils
. - Abstracted console utilities to
TxTextControl\ReportingCloud\Stdlib\ConsoleUtils
. - Tested in PHP 7.1, PHP 7.2 and PHP 7.3.
- Updated documentation.
- Implemented end-point:
/v1/document/append
- Added
/demo/append-document-basic.php
and/demo/append-document-advanced.php
to exemplifyappendDocument($documentsData, $returnFormat, $documentSettings)
. - Switched from username and password authentication to API key authentication in all demos and tests. The former authentication is deprecated and will be removed in a future version.
- Updated
/bin/build-cultures.php
following change to backend.
- Added
user_document_properties
key (containing an array) to the return value ofgetTemplateInfo($templateName)
, following the addition of an extension on the backend. - Updated
/demo/get-template-info.php
to exemplifyuser_document_properties
key and array.
- Added method
uploadTemplateFromBase64($data, $templateName)
to upload templates stored in a string, in addition to on the filesystem. - Added
Base64Data
validator to validate$data
passed touploadTemplateFromBase64($data, $templateName)
. - Refactored
uploadTemplate($templateFilename)
to useuploadTemplateFromBase64($data, $templateName)
.
- Updated phpunit configuration.
- Added PDF/A return format
PDFA
toTxTextControl\ReportingCloud\Validator\ReturnFormat
.
- Split
TxTextControl\ReportingCloud\ReportingCloud
into multiple Traits. - Added
PHP_CodeSniffer
to ensure consistency in code formatting. - Added Composer script
composer test
to run unit tests. - Added Composer script
composer phpcs
to runPHP_CodeSniffer
. - Merged
media
directory todata
directory. - Implemented end-points:
/v1/account/apikeys
/v1/account/apikey
- Implemented authorization header
ReportingCloud-APIKey
. - Updated Scrutinizer configuration to run tests in multiple PHP versions.
- Updated copyright year to 2018.
- Refactored
Culture
andLanguage
validators, abstracting common logic. - Refactored
/bin/buid-culture.php
and/bin/buid-dictionaries.php
, abstracting common logic.
- Deployed
Culture
validator.
- Implemented the key culture in
mergeSettings
. - Restructured the
resources
directory.
- Implemented end-points:
/v1/proofing/check
/v1/proofing/availabledictionaries
/v1/proofing/suggestions
- Updated
AccountSettings
property map with keys:proofing_transactions
max_proofing_transactions
- Refactored
Validator
unit tests. - Added script to download and build available dictionaries resource file.
- Implemented the
mergeSettings
optionmerge_html
. - Minor updates to DocBlock documentation.
- Improved code formatting quality.
- Simplification of auto-loading for files in
/bin
,/demo
and/test
.
- Unified auto-loading for files in
/bin
,/demo
and/test
. - Updated and added documentation.
- Updated and added documentation.
- Removed Travis Building. See
/doc/travis.md
.
- Implemented end-point
/v1/fonts/list
.
- Updated
zendframework/zend-servicemanager
to^3.2
. - Added an image merging
mergeDocument()
demo. - Added script to
/bin
directory that reports on the environment in which it is running. - Added a basic
mergeDocument()
demo. - Renamed the advanced
mergeDocument()
demo. - Added documentation.
- Added new tests to check properties returned by
getTemplateInfo()
andgetAccountSettings()
. - Minor refactoring of
StaticFilter
andStaticValidator
components. - Minor refactoring, mainly of array iterations.
- Added filter to convert boolean true and false to string 'true' and 'false' (required for compatibilty with backend).
- Implemented 'test' parameter with property
/test
and related setter and getter. - Added unit tests for
findAndReplaceDocument()
method. - Refactored
mergeDocument()
andfindAndReplaceDocument()
methods. - Implemented end-point
/v1/document/findandreplace
. - Set default
Content-Type
HTTP header.
- Implemented end-point
/v1/templates/info
.
- Removed non-essential development dependencies from
composer.json
. - Set scrutinizer-ci to run tests and report on code coverage.
- Moved orphaned helper functions (
reporting_cloud_*
) to helper classTxTextControl\ReportingCloud\Stdlib\ConsoleUtils
.
- Various minor code fixes following Scrutinizer and Coveralls integration.
- Added unit tests to test all return formats in
mergeDocument()
andconvertDocument()
methods. - In unit tests migrated from
assertEquals()
toassertSame()
.
- Switched protocol from HTTP to HTTPS for all communication with the backend, now the backend supports it.
- Abstracted all parameter validation to
TxTextControl\ReportingCloud\Validator\StaticValidator
- Made
TxTextControl\ReportingCloud\Validator
properties consistent.
- Made
TxTextControl\ReportingCloud\Validator
properties consistent with those inZend\Validator
. - Updated
composer.json
to be installable on PHP 7.0.7. - Improved date/time conversion
Filter
components. - Added empty
CONTRIBUTING.md
file. - Documentation update.
- Switched from
dump()
tovar_dump()
in/demo
directory, assymfony/var-dumper
is a development dependency only. - Abstracted all date/time conversion to their own Filter components.
- Documentation fixes.
- Added validation of file extension to all occurrences of
$templateFilename
and$documentFilename
.
- Documentation fixes.
- First public release.
- Implemented end-point
/v1/templates/pagecount
. - Implemented end-point
/v1/templates/exists
.
- Added
size
key to templateList.
- Private testing only.
- Private testing only.