PHPackages                             spinen/halo-php-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. spinen/halo-php-client

ActiveLibrary[API Development](/categories/api)

spinen/halo-php-client
======================

SPINEN's PHP Client for Halo.

1.5.0(3mo ago)11602MITPHPPHP ^8.3CI passing

Since Apr 2Pushed 3mo ago3 watchersCompare

[ Source](https://github.com/spinen/halo-php-client)[ Packagist](https://packagist.org/packages/spinen/halo-php-client)[ RSS](/packages/spinen-halo-php-client/feed)WikiDiscussions develop Synced yesterday

READMEChangelogDependencies (18)Versions (30)Used By (0)

SPINEN's Halo PHP Client
========================

[](#spinens-halo-php-client)

[![Latest Stable Version](https://camo.githubusercontent.com/fe7aa5ed913a09fc8dc9e8e07b5f7da938182cb167fd1d35a8b617d221bc33f0/68747470733a2f2f706f7365722e707567782e6f72672f7370696e656e2f68616c6f2d7068702d636c69656e742f762f737461626c65)](https://packagist.org/packages/spinen/halo-php-client)[![Latest Unstable Version](https://camo.githubusercontent.com/4919c21ef336776364a51bbda139f49a869e80d7a1d560baac74a8ba5df51850/68747470733a2f2f706f7365722e707567782e6f72672f7370696e656e2f68616c6f2d7068702d636c69656e742f762f756e737461626c65)](https://packagist.org/packages/spinen/halo-php-client)[![Total Downloads](https://camo.githubusercontent.com/eb23096bb371f11ef45e0d6179f281135fce599182adee22aaa609c1f4e56a8b/68747470733a2f2f706f7365722e707567782e6f72672f7370696e656e2f68616c6f2d7068702d636c69656e742f646f776e6c6f616473)](https://packagist.org/packages/spinen/halo-php-client)[![License](https://camo.githubusercontent.com/4ed11b04b40d6fb73cb4c64a316350d01d5acdcfb91b2a4ab98c31342ef9a7ce/68747470733a2f2f706f7365722e707567782e6f72672f7370696e656e2f68616c6f2d7068702d636c69656e742f6c6963656e7365)](https://packagist.org/packages/spinen/halo-php-client)

PHP package to interface with [Halo Service Solutions](https://haloservicesolutions.com/). We strongly encourage you to review Halo's API docs to get a feel for what this package can do, as we are just wrapping their API.

We solely use [Laravel](https://www.laravel.com) for our applications, so this package is written with Laravel in mind. We have tried to make it work outside of Laravel. If there is a request from the community to split this package into 2 parts, then we will consider doing that work.

Build Status
------------

[](#build-status)

BranchStatusCoverageCode QualityDevelop[![Build Status](https://github.com/spinen/halo-php-client/workflows/CI/badge.svg?branch=develop)](https://github.com/spinen/halo-php-client/workflows/CI/badge.svg?branch=develop)[![Code Coverage](https://camo.githubusercontent.com/a9e471dfb005e4f7ed8703ab2b96f7905fd4c938477b53f046232c30772bff71/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7370696e656e2f68616c6f2d7068702d636c69656e742f6261646765732f636f7665726167652e706e673f623d646576656c6f70)](https://scrutinizer-ci.com/g/spinen/halo-php-client/?branch=develop)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/0a3c8b91681f8a02e3cf6663634db6bb6ca4dca8b2264b242c1d1d1458010f94/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7370696e656e2f68616c6f2d7068702d636c69656e742f6261646765732f7175616c6974792d73636f72652e706e673f623d646576656c6f70)](https://scrutinizer-ci.com/g/spinen/halo-php-client/?branch=develop)Master[![Build Status](https://github.com/spinen/halo-php-client/workflows/CI/badge.svg?branch=master)](https://github.com/spinen/halo-php-client/workflows/CI/badge.svg?branch=master)[![Code Coverage](https://camo.githubusercontent.com/7a55fd7587f0c0d1e0d6f26aba201f46331a11654c149869f9c9ef22f8532f8e/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7370696e656e2f68616c6f2d7068702d636c69656e742f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/spinen/halo-php-client/?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/01a98b5ec7b5b3d9fb70b7e48724629bdc798196d7dfeb45a7913b6ba02f54ec/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7370696e656e2f68616c6f2d7068702d636c69656e742f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/spinen/halo-php-client/?branch=master)Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Laravel Setup](#laravel-setup)
    - [Configuration](#configuration)
- [Generic PHP Setup](#generic-php-setup)
    - [Examples](#examples)
- [Authentication](#authentication)
    - [Authorization Code](#authorization-code)
    - [Client Credentials](#client-credentials)
- [Usage](#usage)
    - [Supported Actions](#supported-actions)
    - [Using the Client](#using-the-client)
        - [Getting the Client object](#getting-the-client-object)
        - [Models](#models)
        - [Relationships](#relationships)
        - [Collections](#collections)
        - [Filtering using "where"](#filtering-using-where)
        - [Search](#search)
        - [Limit records returned](#limit-records-returned)
        - [Order By](#order-by)
        - [Pagination](#pagination)
    - [More Examples](#more-examples)
- [Known Issues](#known-issues)

Installation
------------

[](#installation)

Install Halo PHP Package via Composer:

```
$ composer require spinen/halo-php-client
```

Laravel Setup
-------------

[](#laravel-setup)

1. You will need to make your `User` object implement includes the `Spinen\Halo\Concerns\HasHalo` trait which will allow it to access the Client as an attribute like this: `$user->halo`

    ```