6by6/float-api

PHP API for the Float Resourcing App

dev-master 2017-07-29 23:17 UTC

Requires

• athari/yalinqo: ^2.4
• guzzlehttp/guzzle: ~6.0
• jms/serializer: ^1.1

Requires (Dev)

• phpunit/phpunit: ^5.5

MIT

• Daniel Ness

README

Float API for PHP (https://www.float.com/)

Installation

You can install this library via Composer:

composer require 6by6/float-api

Get Started

Step 1

We're using the jms/serializer annotations for this project which need to be registered before they can be used. Depending on your platform there may be an existing solution (for example, Symfony has JMSSerializerBundle). There is further information regarding configuration here.

If you want to get setup quickly though, we've included the following shortcut.

\SixBySix\Float\Package::registerAnnotations();

Step 2

You'll need to grab your API key from Float (find out how here).

use SixBySix\Float;

Float\FloatClient::setApiKey("INSERT_YOUR_API_KEY");

Step 3

You're ready to go.

use SixBySix\Float\Entity\Person;
use SixBySix\Float\Entity\Project;
use SixBySix\Float\Entity\Task;

$people = Person::getAll();

$projects = Project::getAllActive();

$task = Task::getById(123);

Entities

We have covered the following entities:

Changelist

v0.0.1

• First commit
• Added read-only access to the following entities
  • Account
  • Client
  • Department
  • Holiday
  • Milestone
  • Person (People)
  • Project
  • Task