PHP download

Download the PHP package melonsmasher/ethos-php without Composer

On this page you can find all versions of the php package melonsmasher/ethos-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download melonsmasher/ethos-php
More information about melonsmasher/ethos-php
Files in melonsmasher/ethos-php

Vendor melonsmasher
Package ethos-php
Short Description A PHP library to interact with the Ellucian Ethos API.
License MIT
Homepage https://github.com/MelonSmasher/ethos-php

Keywords api banner ERP college ethos ellucian colleague higher-ed

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of melonsmasher/ethos-php

Informations about the package ethos-php

ethos-php

A PHP library to interact with the Ellucian Ethos API.

GitHub top language Packagist PHP Version Support Codacy grade

Installation

API Docs

Complete API docs can be found here.

Features

As of now ethos-php has support for 316 models/routes. It supports nearly all Banner & Colleague models with the following feature set.

A fluent API allowing for methods to be chained to improve readability.
Convenience methods that return the response data as an object: data(), as an array: toArray(), and as a JSON string: toJson().
Simple control over API pagination. Max ten items returned per-page.
Automatic re-authentication when a session expires.
Support for Banner and Colleague backends.
Automatically versioned API calls.
Control over request params and headers.
Class level awareness of Ethos CRUD support.
Support for ID based routes. E.G. /api/persons/35b16136-bafd-4b5d-9dd2-995ad9f4ba00
Support for the /consume subscription message queue route.

Features To Come

Support for the /publish subscription message queue route.

Usage/Examples

The example below demonstrates the fluent API, convenience methods, and control over pagination.

The example below demonstrates the ability to provide custom request parameters.

Dev Setup

Install PHIVE

Install build tools

Install composer requirements

All versions of ethos-php with dependencies

PHP Build Version

Package Version

Version v0.1.2 Release 29. Apr 2021
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of ethos-php from vendor melonsmasher

Requires php Version >=7.2.0
ext-json Version *
guzzlehttp/guzzle Version ~7.0
myclabs/php-enum Version ^1.8

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package melonsmasher/ethos-php contains the following files

Loading the files please wait ....