Ellucian Ethos client library, built upon MelonSmasher/ethos-php, with enhancements for Laravel.
Pull the library into your project:
composer require melonsmasher/ethos-laravelPublish ethos.php to the config directory:
php artisan vendor:publish --tag ethosComplete API docs can be found here.
-
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
316Ethos data models, related by using the Ethos object ID. -
Trait model responses can be cached for a configurable amount of time.
# 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<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use MelonSmasher\EthosPHP\Student\CoursesClient;
class ExampleController extends Controller
{
public function index()
{
$ethos = getEthosSession();
$courses = new CoursesClient($ethos);
return $courses->read()->toJson();
}
}<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use MelonSmasher\EthosPHP\Laravel\Facade\Ethos;
use MelonSmasher\EthosPHP\Foundation\BuildingsClient;
class ExampleController extends Controller
{
public function index()
{
$ethos = Ethos::get();
$buildings = new BuildingsClient($ethos);
return $buildings->read()->data();
}
}An example of how to use the HasEthosPersonModel trait on a Laravel User model.
User migration:
<?php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
class CreateUsersTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('users', function (Blueprint $table) {
$table->increments('id');
$table->string('ethos_person_id')->unique(); // Add this to your user's model and fill it with the related Ethos Person ID.
$table->string('username');
$table->string('name');
$table->string('password');
$table->rememberToken();
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('users');
}
}User model:
<?php
namespace App;
use Illuminate\Foundation\Auth\User as Authenticatable;
use MelonSmasher\EthosPHP\Laravel\Traits\Foundation\HasEthosPersonModel;
class User extends Authenticatable
{
use HasEthosPersonModel;
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'ethos_person_id', // <--- This attribute must be present on your model.
'username',
'name'
];
}Example usage :
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
use App\Model\User;
class MyController extends Controller
{
/**
* Create a new controller instance.
*
* @return void
*/
public function __construct()
{
$this->middleware('auth');
}
/**
* Shows a user's Ethos Person Model
*/
public function showUserAccount($id)
{
$user = User::findOrFail($id);
return $user->ethosPerson(); // Returns the Ethos account
}
}Install PHIVE
Install build tools
phive installInstall composer requirements
./composer install
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent