The AT&T PHP Codekit allows you to interact with AT&T's APIs.

• PHP 5.4 or higher
• PHP CURL extension

Clone the latest version of the Codekit to a folder.

From the Codekit folder, copy the 'lib' folder to the DocumentRoot folder; for example, this folder might be: /var/www/

Include or require the relevant parts of the Codekit. For example, if the Codekit is installed in the /var/www/lib/ directory and there is a file called app.php in the /var/www/app/ folder, you can require the OAuth library by adding the following line of code to the app.php file:

require_once __DIR__ . '../lib/OAuth/OAuthTokenService.php';

Both the example code and the PHP sample applications can be used as references to see usage.

Examples can be found in the 'examples' folder. Each example must be modified before it can be executed, and each example file contains comments detailing the changes needed.

To run the test code, PHPUnit is required. For directions on installing PHPUnit, refer to PHPUnit github page.

Test code can be found in the 'tests' folder for unit tests and 'integration_tests' for integration tests. The phpunit command can be used to run these tests. For example, to run unit tests:

phpunit tests

To run integration tests, the configuration values in 'integration_tests/cfgs/' must be configured.

The Codekit contains inline documentation, which can be generated using phpDocumentor via the phpdoc command. For directions on installing phpDocumentor, refer to its website. For example, to generate the documentation to the 'output' folder, the following command can be used:

phpdoc run -d lib -t output

The Codekit follows the PEAR coding standards.