Class PS_DB

Description

PrepStep Module Database API.

This class presents a OOP interface to the common queries needed by PrepStep functionality.

Located in /include/classes/database/PS_DB.inc (line 19)

DB
   |
   --CIB_DB
      |
      --PS_DB
Method Summary
 PS_DB PS_DB (string $dbname, string $user, mixed $pass, string $password)
 array getCanLevels (array $compTypes)
 array getCanStyles (array $compTypes)
Variables

Inherited Variables

Inherited from DB

DB::$db
DB::$dbname
DB::$lastOID
DB::$password
DB::$user
Methods
Constructor PS_DB (line 32)

PrepStep DB Constructor.

Simply call the parent constructor.

  • access: public
  • todo: Add a check after connecting to make sure its a central DB and not a per-comp DB
PS_DB PS_DB (string $dbname, string $user, mixed $pass, string $password)
  • string $dbname: what database do you want to connect to
  • string $user: as what user
  • string $password: which what password
getCanLevels (line 49)

Return the list of canonical levels Returns a list of levels normally used by competitions of a given type.

  • return: structured array listing the levels in track/index order
  • access: public
  • todo: handle multi-type competitions better
array getCanLevels (array $compTypes)
  • array $compTypes: a list of selected "types" for this competition normally a only one type is selected, at present only the last item in the list is used. Sample types are "US Collegiate", "USA Dance, Inc", "NDCA", etc
getCanStyles (line 79)

Return the list of canonical styles Returns a list of levels normally used by competitions of a given type.

  • return: structured array listing the styles in order
  • access: public
  • todo: handle multi-type competitions better
array getCanStyles (array $compTypes)
  • array $compTypes: a list of selected "types" for this competition normally a only one type is selected, at present only the last item in the list is used. Sample types are "US Collegiate", "USA Dance, Inc", "NDCA", etc

Inherited Methods

Inherited From CIB_DB

 CIB_DB::CIB_DB()
 CIB_DB::addPending()
 CIB_DB::availibleUserName()
 CIB_DB::denyPermissionToUser()
 CIB_DB::expandTeamNamesFromID()
 CIB_DB::getApprovedOutsideComps()
 CIB_DB::getCaptainsEmails()
 CIB_DB::getCibServers()
 CIB_DB::getClosedComps()
 CIB_DB::getCompAnnouncements()
 CIB_DB::getCompsByDate()
 CIB_DB::getCompStatusChoices()
 CIB_DB::getCompTypes()
 CIB_DB::getCompUnixNames()
 CIB_DB::getConfigComps()
 CIB_DB::getDocumentList()
 CIB_DB::getHostedComps()
 CIB_DB::getNonApprovedOutsideComps()
 CIB_DB::getPendingKey()
 CIB_DB::getPendingKeys()
 CIB_DB::getPendingPermissions()
 CIB_DB::getSiteAnnouncements()
 CIB_DB::getSyncRequests()
 CIB_DB::getTeamAdmin()
 CIB_DB::getTeamIDs()
 CIB_DB::getTeamMemberships()
 CIB_DB::getTeamRequests()
 CIB_DB::getTeams()
 CIB_DB::getUserPasswordByName()
 CIB_DB::getUserRoles()
 CIB_DB::grantPermissionToUser()

Inherited From DB

 DB::DB()
 DB::commit()
 DB::getDBName()
 DB::getDBpass()
 DB::getDBuser()
 DB::getLastOID()
 DB::helper_limitOffset()
 DB::helper_queryToArray()
 DB::helper_queryToArrayCategories()
 DB::helper_queryToSimpleArray()
 DB::helper_singleValueQuery()
 DB::query()
 DB::rollback()
 DB::startTransaction()

Documentation generated on Tue, 25 Apr 2006 13:08:31 -0400 by phpDocumentor 1.3.0RC3