2017 © Pedro Peláez
 

library php-highrise-api

A PHP client for the Highrise API.

image

guillermoandrae/php-highrise-api

A PHP client for the Highrise API.

  • Sunday, July 15, 2018
  • by guillermoandrae
  • Repository
  • 0 Watchers
  • 0 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

PHP Highrise API Client

Travis Scrutinizer Scrutinizer Coverage PHP from Travis config, (*1)

See the Highrise API documentation for information about specific resources., (*2)

Installation

Do this, then relax:, (*3)

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:, (*4)

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., (*5)

Testing

Run the following command to make sure you don't ruin the code coverage percentage:, (*6)

composer check-coverage

Run the following command to make sure your code is appropriately styled:, (*7)

composer check-style

Run the following command to invoke both of the above commands easily:, (*8)

composer test

The Versions