guillermoandrae/php-highrise-api

A PHP client for the Highrise API.

dev-master 2019-08-07 17:47 UTC

Requires

• php: ^7.1
• guillermoandrae/php-collection: ^0.1.0
• guillermoandrae/php-debug: ^0.1.0
• guillermoandrae/php-repository: ^1.0
• guzzlehttp/guzzle: ^6.3
• icanboogie/inflector: ^1.4

Requires (Dev)

• phpunit/phpunit: ^7.1
• squizlabs/php_codesniffer: ^3.2

MIT

README

See the Highrise API documentation for information about specific resources.

Installation

Do this, then relax:

composer require guillermoandrae/php-highrise-api

Getting Started

To use the client, instantiate it and use either the resource() method or one of the many aliases available through the __call() method. For example, to get a list of all of the users associated with your account, you can do the following:

use Guillermoandrae\Highrise\Client\Client;

$subdomain = 'xxxxxx'; // add your subdomain here
$token = '1234567890'; // add your token

$client = new Client($subdomain, $token);
$users = $client->users()->findAll();
var_dump($users);

To see which aliases are available, check the docblock of the Client class.

Testing

Run the following command to make sure you don't ruin the code coverage percentage:

composer check-coverage

Run the following command to make sure your code is appropriately styled:

composer check-style

Run the following command to invoke both of the above commands easily:

composer test