ilios/local_iliosapiclient

An Ilios API client for Moodle.

Ilios: Curriculum Management from UCSF

About

The Ilios Curriculum Management System addresses the needs of the Health Professions educational community by providing a user-friendly, flexible, and robust web application to collect, manage, analyze and deliver curricular information.

Ilios creates a comprehensive view of curricula by tracking events, learning content and activities over time. The system facilitates day-to-day administration and the delivery of information to learners; enhances curricular development, review and innovation; and reduces overhead for internal and accreditation reporting. The end result is a powerful tool creating complete and accurate pictures of complex, integrated, multi-year curricula.

Ilios manages learners and instructors and their relationships to curricular materials and activities, enabling the tracking of educational hours, roles and role transitions for participants both internal and external to an institution. Ilios also provides a robust, scalable delivery mechanism for user-centric calendar and scheduling information, with direct access to critical course information, materials, and other educational systems and services.

Ilios leverages the power of your existing online learning. With its comprehensive API, Ilios allows you to integrate with external data sources and systems. For schools using online learning systems such as Moodle or Canvas, Ilios provides a backbone of curricular information to make that deployment more robust and to complement the rich online tools, activities and materials already in use.

More Information and user documentation is available at iliosproject.org

Install and Update Instructions

Instructions for a new Install

Update Ilios

Upgrading From Ilios 2.x

Frontend Theming

For information about customizing the look and feel of the Ilios frontend for your respective institution, please visit docs/custom_theming.md for more information.

API Information

If you want to connect to the Ilios API a good place to start is docs/ilios_api.md.

Interacting with Ilios from the command line

Ilios provides a command line interface, see docs/custom_cli_commands.md for a list of available commands and how to use them.

Get Ilios

Download the latest distribution or clone the codebase.

Contact

For more information on Ilios please contact:

The Ilios Project * UCSF School of Medicine * 530 Parnassus Avenue * Box 0840 * San Francisco, CA 94143

Email: [email protected]

Development of Ilios

To get a development instance of Ilios up and running quickly, please review the steps in our Quick Setup Guide for Ilios for what is recommended and required.

local_iliosapiclient's Issues

test coverage

yes, we want this.

Upgrade to Moodle 4

Ensure that this plugin works with Moodle 4.

Upgrade to Moodle 4.3

configurable batch sizes

right now, the batch size ("limit") is hard-wired to 10 in getbyids().
open this up as a method argument, and default it to 1000.

while at it, change the batch size in get() from 50 to 1000 as well.

better method names

camel case all around, for consistency.

rename the following methods to comply:

ilios_client::getbyid()
ilios_client::getbyids()
ilios_client::getAccessToken()

drop self-refresh mechanism

drop the self-refresh mechanism for the token - this feature is intentionally not supported for service tokens via the Ilios API.

also, check the token's expiration date on the Moodle side of things and fail early in case the token is expired (prior to attempting to fetch data from the API).

will have ramifications for the Moodle plugins that use this local plugin - this will result in a BREAKING update.

refs ilios/ilios#5012

removes deprecated PHPCPD integration

the PHP copy/paste detector library has long been abandoned and is slated for removal from moodle_plugin_ci in its next major release. it already has been flagged as deprecated.
remove the integration.

re-run tests on a scheduled timer/add to slack notifications

I think a next step would be to put this on a schedule and add some notifications through slack because the master Moodle updates won't get re-tested if we don't push new code and I think we'd really like to see failures when new versions and new master get pushed upstream.

Originally posted by @jrjohnson in #17 (review)

use API v3.

update the client to consume v3 endpoints of the Ilios API instead of v1.

better docs.

variable batch size

currently, any read queries against the API are hard-wired to run in batches of 50 (&limit=50).

allow for variable batch sizes, with a default value set to fifty.

getbyids returns random list when ids is an empty array

https://github.com/ilios/local_iliosapiclient/blob/master/classes/ilios_client.php#L203