Code structure

From ReservesDirect: Open Source EReserves System

Home :: Features :: Screenshots :: Demo (http://www.reservesdirect.org/demo/index.html) :: Documentation :: Downloads :: Support :: Blog (http://www.reservesdirect.org/blog) :: Join Us!
ReservesDirect Documentation:   Contents | Library staff handbook | System administrator handbook | Developer handbook
Developer's Guide
edit developer toc (http://www.reservesdirect.org/wiki/index.php?title=Template:Dev_toc&action=edit)


Table of contents
1 Overview
2 Directory structure
3 Classes
4 Managers
5 Displayers
6 HTML
7 Interface
8 Javascript Widgets
9 Remote System Tie-ins
10 Cron Jobs
[edit]

Overview

For the most part RD follows a simple process flow.

  1. index.php -- basically a large switch statement, determines which manager to call based on $_REQUEST['cmd'] value
  2. secure/managers/*manager.php -- includes needed classes and prepares data for display then directs to corresponding displayer
  3. secure/displayer/*displayer.php -- displays data to user
[edit]

Directory structure

  • Root -- contains application controllers 'The things that do things'
  • CSS -- css stylesheets 'skins'
  • Help -- help pages
  • images -- system images; images on reserves are not stored here
  • rss -- the rss system
  • secure, “not so secure” -the files in this directory are intended to be read only by the php interpreter
    • displayers -- php code that generates html
    • html -- pretty much straight html
    • javascript -- js files
    • classes -- base classes
    • interface -- user classes
    • jscalendar -- calendar widget
    • managers -- business logic
[edit]

Classes

[edit]

Managers

[edit]

Displayers

[edit]

HTML

[edit]

Interface

[edit]

Javascript Widgets



[edit]

Remote System Tie-ins

[edit]

Cron Jobs

requestNotifier.php: When a physical item is requested it is added to the processing queue. This script scans the processing queue and sends notifications to the contact responsible for processing the queue. The contact is specified in the libraries table. It is recommended that this script be run daily, however run it as often as you would like to send notifications.


Retrieved from "http://www.reservesdirect.org/wiki/index.php/Code_structure"