Object model

From ReservesDirect: Open Source EReserves System

Developer's Guide edit developer toc (http://www.reservesdirect.org/wiki/index.php?title=Template:Dev_toc&action=edit) Contributing Definitions Object model Course Instances, Course Aliases and Courses Database structure and data dictionary Code structure and contents Planned features Development partners Support Data Feeds Use cases

Table of contents

1 course 1.1 Attributes 1.2 Methods 2 user 2.1 Attributes 2.2 Methods 2.3 Child Classes

course

Attributes

• courseAliasID (int)
• courseID (int)
• courseNo (int)
• department (string)
• departID (int)
• name (string)
• notes (array)
• section (int)

Methods

• Insert Methods Here

user

Attributes

• dfltRole (int)
• email (string)
• firstName (string)
• lastLogin (date)
• lastName (string)
• notes (array)
• userID (int)
• userName (string)

Methods

• createUser($userName, $firstName="", $lastName="", $email="", $dfltRole=0) void
  • Inserts a new user record into the users table of the database
  • Returns an error code if user already exists in the database
• destroy() void
• getDefaultRole() int
• getEmail()
• getFirstName()
• getLastLogin()
• getLastName()
• getLibraries()
• getName()
• getNotes() void
• getUserByID(int $userID) void
• getUserByUserName(string $userName)
• getUserClass()
• getUserID()
• getUsername()
• isSpecialUser()
• setDefaultRole(int $dfltRole) void
• setEmail(string $email)
• setFirstName(string $firstName) void
• setLastLogin() void
• setLastName(string $lastName) void
• setNote($noteID=NULL, string $type, string $noteText) void
• setUserName(string $userName) void
• user($userID = NULL) void

Child Classes

• student
  • custodian
  • proxy
    • instructor
      • staff
        • admin