Common Libraries API Guide

1.7

This guide contains documentation for the core PHP libraries used at Shodor. For your convenience, the documentation has been broken up into a number of useful groupings. Each library module has its own documentation under the "Common Libraries API" folder. Additionally, classes have been grouped according to module, which can be viewed under the "Modules" folder.

To get started, take a look at the pages below. The documentation is still a work in progress, so expect omissions and classes that are completely undocumented.

Sub-projects

• Content and Presentation:
  • Content Classes - Content-related classes
  • PageRender 2 - PageRender Framework
  • Toolkit 2 - User interface toolkit
  • XForms - Shodor XForms
• Information and Content Services:
  • Snap2 CMS - Content management system
  • TSD/Relationships - Education alignment manager
  • SDR Service - Metadata service
• User and Data Management:
  • Shodor Web Application Toolkit - Manage sessions, users, and events
  • SWAT Model 2 - Database interaction layer

Additional Documentation

• Overview of Common Structure
• SWAT JavaScript Libraries