Moodle Mobile 2 (Ionic 1) Plugins Development

Overview

Plugins (known as Moodle Mobile 2 addons) allow developers to extend the app functionalities.

An addon is a subdirectory that implements a set of required functionalities. For those familiars with AngularJS, addones are AngularJS modules.

IMPORTANT: Read carefully this document (Moodle Mobile Customization) before you start developing!

Moodle Mobile 2 addons

Each addon can have services, controllers, templates and lang files. The addon needs to specify a main.js file to initialize the addon and to register itself into one or more delegates (this determines where will the plugin be shown).

Naming conventions for addons:

• The module name for addons needs to be mm.addons.addonname and it should be defined in the addon main.js.
• All the services names inside an addon need to start with $mma, followed by the service name in camel-case. For example, $mmaForumData.
• The controllers names need to start with mma (without dollar), followed by the controller name in camel-case. The controller name needs to contain Ctrl to easily identify it as a controller. For example, mmaForumListCtrl.

The app comes with a predefined set of addons: messages, forum, notifications, etc. All these addons are inside the www/addons folder.

An addon can be shown in several places. The app has one delegate per each place an addon can be shown, so each addon can register itself to any set of delegates.

The delegates we have are:

• $mmSideMenuDelegate: The addons registered in here will be shown in the app’s side menu.
• $mmCourseDelegate: The addons registered in here will be shown under each course in the course list.
• $mmUserDelegate: The addons registered in here will be shown in a user page.
• $mmSettingsDelegate: The addons registered in here will be shown in the preferences page.

Structure of an addon

controllers/   - Addon controlers
lang/             - Language files
services/      - Addon services
templates/    - Addon templates
main.js         - Addon main file