PHPackages                             melonsmasher/ethos-laravel - 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. melonsmasher/ethos-laravel

ActiveLibrary[API Development](/categories/api)

melonsmasher/ethos-laravel
==========================

A Laravel package that utilizes ethos-php to interact with the Ellucian Ethos API.

v0.1.7(5y ago)121[2 PRs](https://github.com/MelonSmasher/ethos-laravel/pulls)MITPHP

Since Jun 22Pushed 3y ago1 watchersCompare

[ Source](https://github.com/MelonSmasher/ethos-laravel)[ Packagist](https://packagist.org/packages/melonsmasher/ethos-laravel)[ Docs](https://github.com/MelonSmasher/ethos-laravel)[ RSS](/packages/melonsmasher-ethos-laravel/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (1)Versions (15)Used By (0)

ethos-laravel
=============

[](#ethos-laravel)

Ellucian Ethos client library, built upon [MelonSmasher/ethos-php](https://github.com/MelonSmasher/ethos-php), with enhancements for Laravel.

[![License](https://camo.githubusercontent.com/b8cadaa967891081f8f165695470689986c028821dd8a040132f6e661795dc0d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c7565)](https://raw.githubusercontent.com/MelonSmasher/ethos-laravel/master/LICENSE)[![GitHub issues](https://camo.githubusercontent.com/ce128aafb21c8cdfd2544da3c83c47b35681c0732065071206ae1a98634cf27a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f4d656c6f6e536d61736865722f6574686f732d6c61726176656c)](https://github.com/MelonSmasher/ethos-laravel/issues)[![GitHub top language](https://camo.githubusercontent.com/f1d708af05d5fbacbe23c217e55819ddc96cbd02823d1ab648e58464f4b48acd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f746f702f4d656c6f6e536d61736865722f6574686f732d6c61726176656c)](https://camo.githubusercontent.com/f1d708af05d5fbacbe23c217e55819ddc96cbd02823d1ab648e58464f4b48acd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f746f702f4d656c6f6e536d61736865722f6574686f732d6c61726176656c)[![Codacy grade](https://camo.githubusercontent.com/5013150593818820fddc7ccb5a85f234051fc953087dc2c32d04084cb6934034/68747470733a2f2f696d672e736869656c64732e696f2f636f646163792f67726164652f6266303732353233633962343437313761613737616638646562623362386364)](https://camo.githubusercontent.com/5013150593818820fddc7ccb5a85f234051fc953087dc2c32d04084cb6934034/68747470733a2f2f696d672e736869656c64732e696f2f636f646163792f67726164652f6266303732353233633962343437313761613737616638646562623362386364)

---

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

[](#installation)

Pull the library into your project:

```
composer require melonsmasher/ethos-laravel
```

Publish `ethos.php` to the config directory:

```
php artisan vendor:publish --tag ethos
```

API Docs
--------

[](#api-docs)

Complete API docs can be [found here](https://melonsmasher.github.io/ethos-laravel/docs/).

Features
--------

[](#features)

- Ethos settings are read from `.env`.
- Ethos sessions are cached.
- Efficiently handles authentication.

    - New authenticated sessions are created before the previous session expires.
- Traits for `316` Ethos data models, related by using the Ethos object ID.
- Trait model responses can be cached for a configurable amount of time.

Config Options
--------------

[](#config-options)

```
# Your Ethos API key / refresh token.
ETHOS_SECRET=YourEthosApiKey
# The base url that should be used to connect to Ethos. If omitted https://integrate.elluciancloud.com is used.
ETHOS_BASE_URL=https://integrate.elluciancloud.com
# The ERP backend that is connected to Ethos. Must be either 'banner' or 'colleague'. If nothing is supplied 'colleague' is used.
ETHOS_ERP_BACKEND=banner
# How long trait responses should remain in the cache in seconds. Set to 0 to disable. If omitted this option is disabled.
ETHOS_TRAIT_CACHE_TTL=300
```

Usage/Examples
--------------

[](#usageexamples)

### Using Helper Function

[](#using-helper-function)

```