Developer Area/API

 

Overview

Finding your way around

Dev setup

Dev tools

Contributing

Testing

Keep in touch	API Docs	Architecture	Release Instructions	Plugins

API Documentation

Basic development documentation

These pages describe specific Mahara APIs. Note: we're in the process of reorganizing our developer documentation, so not all API documentation pages will be present in this list. Please use the wiki's search feature if you don't find what you need here. Also, not all API's are documented. :(

• Architecture Introduction
• Hello World
  • https://mahara.org/interaction/forum/topic.php?id=5515&offset=0&limit=10#post23705
  • My sample page with pieforms and dwoo: https://wiki.mahara.org/index.php/BasicPHPFileTemplates#Sample_page_using_pieforms_and_dwoo
• Database-DML
• Database-DDL
  • I wrote a forum post here that gives an outline of how the database works: https://mahara.org/interaction/forum/topic.php?id=5515&offset=0&limit=10#post23753

Changing things locally

• Language strings
• Developer_Area/Local customizations
  • aka the "/local" directory

How to set / access certain information

• Config API
• Retrieving user input
  • aka "What to use instead of $_GET and $_POST"
• Cron API
• CLI Framework for writing command-line Mahara scripts
• Events API
• File uploads API
• Login form
• Mahara global variables
  • $SESSION, $USER, $THEME, etc
• Mahara Mobile
• Notification Plugins & Activities
• Pagetop Constants
• Pieforms
• Sideblocks API
• Site menus
• Smarty&Dwoo

Making a custom theme

• Themes

Accessing webservice API

• Webservices
  • you can also go to the 'webservice/wsdoc.php' page in your local Mahara instance to see what Webservice APIs are available