Download the PHP package ontariotechu/xmodule without Composer
On this page you can find all versions of the php package ontariotechu/xmodule. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ontariotechu/xmodule
More information about ontariotechu/xmodule
Files in ontariotechu/xmodule
Package xmodule
Short Description Utility classes for easily and consistently scaffolding API endpoints for Modo Labs XModule
License MIT
Homepage https://github.com/uoitwebteam/xmodule
Informations about the package xmodule
XModule
PHP library for easily and consistently scaffolding REST API endpoints for Modo Labs' XModule feature.
This library provides a suite of PHP classes that directly mirror Modo's collection of XModule elements. It aids in the creation of complex XModule layouts by removing the need for boilerplate JSON and ensuring all XModule pieces fit together seamlessly using object-oriented workflows and strongly-typed parameters.
After being built, scaffolded XModules can have their contents output in fully compliant JSON using only the json_encode
result of a call to $xmodule->render()
.
Requirements
- PHP >= 7.0.0
Installation
Don't forget to include Composer's autoloader once at the beginning of your application:
Usage
Import the needed components into your server application:
Use the components to build XModule structures:
Result:
Documentation
General usage how-tos can be found in the usage.md for quick access.
Full class documentation is still pending, but in the meantime there are some very basic auto-generated docs that can be found in the /docs
folder of this repository. Documentation can be regenerated or viewed using the included Composer scripts:
Credits
- Modo Labs created XModule and the mobile application software it is used in. All trademarks belong to them.