AvaTax SDK PHP

The AvaTax PHP SDK is available as a Composer package. To use the AvaTax PHP SDK from Composer:

• Add a composer.json file to your project and link to AvaTax:

{
    "require": {
        "avalara/avataxclient": "*"
    }
}

• Run composer install to download the latest version.

The PHP SDK uses a fluent interface to define a connection to AvaTax and to make API calls to calculate tax on transactions. Here's an example of connecting to the API:

• SDK uses PSR-3, a common interface used for logging capabilities in PHP.
• The client would implement the binding on their end like Monolog, Analog, and so on to enable logging.
• By default, there is no logging enabled.
• All the attributes which are part of a log message are in LogObject.php
• To enable or disable logging of request and response objects, there is a boolean variable logRequestAndResponseBody passed as a constructor argument. The default is set to false.
• The output of logging is in JSON format.

Logging could be enabled on the client side by adding a logging library like Monolog. This could be done by adding the dependency and version in composer.json:

"require": { 
	 ....
	 "monolog/monolog": "^3.2" 
}, 

By adding the above configuration, the logging framework will recognise the binding. Now, we will have to provide logging object as contructor parameter to AvaTaxClient. This could be done as below:

// Include the packages/classes we would need to create the logger object 

use Monolog\Logger;
use Monolog\Handler\StreamHandler; 
use Monolog\Formatter\JsonFormatter; 
use Monolog\Processor\PsrLogMessageProcessor; 

The following example shows how we can add a configuration to display logs at console (stdout):

$stream_handler = new StreamHandler("php://stdout"); 

$stream_handler->setFormatter(new JsonFormatter()); 

// Follow PSR-3 specification. 
$psrProcessor = new PsrLogMessageProcessor();

$logger = new Logger('appLogger', [$stream_handler], [$psrProcessor]); 

// Create a new client 
$client = new Avalara\AvaTaxClient('phpTestApp', '1.0', 'localhost', 'sandbox',[], $logger, true); 

This should add logging to the SDK, and the logs would be displayed on console. If we want to use other configurations where we want logs to be stored in files, then the handler(StreamHandler in the above case) would require changes accordingly.