Download the PHP package serato/sqs-invoice-queue without Composer
On this page you can find all versions of the php package serato/sqs-invoice-queue. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download serato/sqs-invoice-queue
More information about serato/sqs-invoice-queue
Files in serato/sqs-invoice-queue
Package sqs-invoice-queue
Short Description A library for interacting with an SQS message queue that holds invoice data.
License
Homepage https://github.com/serato/invoice-queue-php
Informations about the package sqs-invoice-queue
Invoice Queue PHP SDK
A PHP library for interacting with an SQS message queue that holds invoice data.
Adding to a project via composer.json
To include this library in a PHP project add the following line to the project's
composer.json
file in the require
section:
See Packagist for a list of all available versions.
Requirements
This library requires PHP 7.1 or greater.
Style guide
Please ensure code adheres to the PHP-FIG PSR-2 Coding Style Guide
Use PHP_CodeSniffer to validate your code against coding standards:
PHPStan
Use PHPStan for static code analysis:
Unit tests
Configuration for PHPUnit is defined within phpunit.xml.
To run tests:
Usage
Invoice Validator
The Serato\InvoiceQueue\InvoiceValidator
class can validate a string or array against a
JSON schema representing valid invoice data.
The InvoiceValidator::validateJsonString
and InvoiceValidator::validateArray
methods return a boolean value
indicating the success or otherwise of the validation. Use the The InvoiceValidator::getErrors
method to
iterate over an array of validation errors.
The InvoiceValidator::validateJsonString
and InvoiceValidator::validateArray
methods can optionally take a
$defintion
parameter which will validate the input against an named definition with the JSON schema document.
If not provided, the input is validated against the root element of the JSON schema.
Invoice model
The Serato\InvoiceQueue\Invoice
class is a model for working with invoice data.
It provides getter and setter methods for individual invoice properties, a method for adding line items, a means of populating the entire model from an array, and a means of extracting a data array from the model that conforms to the invoice JSON schema.
Sqs Client
The Serato\InvoiceQueue\SqsQueue
provides functionality for interacting with AWS SQS message queues that
contain invoice data.
SqsQueue
can return a queue URL, send Serato\InvoiceQueue\Invoice
instances to a queue either individually
or in batches, and create queues if they don't currently exist.
All versions of sqs-invoice-queue with dependencies
aws/aws-sdk-php Version ^3.0.0
justinrainbow/json-schema Version ^5.0.0
psr/log Version ^1.0.0
monolog/monolog Version ^1.0.0