Docs For Class CIB

CIB_Display

Description

**************************************************************

This file is part of CompInaBox * Copyright 2001-2002. Eric D. Nielsen, All rights reserverd * CompInaBox is availible for license under the GPL, see * the COPYING file in the root directory of the install for * the full terms of the GPL. * * File: CLASSES/CIB_Display.inc * Type: Class Files * Author: Eric D. Nielsen * Description: HTML formatting for CIB Core * Attributes: only inherited * Constructor: CIB_Display * Public Methods: userPage, loginForm, loginCell, helpBar, * hostedComps, compResults, cibServers, * outsideComps, compinaboxLogo * Private Methods: helper_formatLinks * Change Log: 8/11/02 -- created -- edn * *************************************************************

Located in /include/classes/html-formatting/CIB_Display.inc (line 21)

UIBase
   |
   --CIB_Display

Direct descendents

Class	Description
ResultDisplay	**************************************************************
Team_Display	**************************************************************

Method Summary

CIB_Display CIB_Display ([mixed $db = ""])

void calendarSideBar ()

void cibServers ()

void closedComps ()

void compAnnouncements ([mixed $limit = 5], mixed $offset)

void competitionMenu (mixed $comps)

void compinaboxLogo ()

void compResults ()

void directories ()

void displayKeyRequest (mixed $user)

void displayUserKeys (mixed $user)

void helpBar ()

void helper_displayKeys (mixed $keys, mixed $noLabel)

void helper_formatLinks (mixed $items, [mixed $numItems = ""], [mixed $path = ""])

void hostedComps ()

void loginCell ()

void loginForm (mixed $returnTo)

void outsideComps ()

void pendingActions (mixed $user)

void resultTracker ()

void siteAnnouncements ([mixed $limit = 2], mixed $offset)

void userPage (mixed $user)

Variables

Inherited Variables

Inherited from UIBase

UIBase::$db

Methods

Constructor CIB_Display (line 31)

***********************************************************

Function: CIB_Display * Arguments: db -- the queriable database object * Modifies: this * **********************************************************

CIB_Display CIB_Display ([mixed $db = ""])

calendarSideBar (line 58)

void calendarSideBar ()

cibServers (line 831)

***********************************************************

Function: cibServers * Returns: a tableCell, with links to other CIB servers * **********************************************************

void cibServers ()

closedComps (line 751)

***********************************************************

Function: closedComps * Returns: a tableCell, with links to the registration page * of all the competitions with closed registration. * **********************************************************

void closedComps ()

compAnnouncements (line 172)

void compAnnouncements ([mixed $limit = 5], mixed $offset)

competitionMenu (line 589)

void competitionMenu (mixed $comps)

compinaboxLogo (line 883)

***********************************************************

Function: compinaboxLogo * Returns: a tableCell, with the CompInaBox logo image * **********************************************************

void compinaboxLogo ()

compResults (line 778)

***********************************************************

Function: compResults * Returns: a tableCell, with links to the results page of * the most recent 10 competitions and a link to * full archive * **********************************************************

void compResults ()

directories (line 802)

***********************************************************

Function: directories * Returns: a list of hosted directories * **********************************************************

void directories ()

displayKeyRequest (line 267)

void displayKeyRequest (mixed $user)

displayUserKeys (line 226)

void displayUserKeys (mixed $user)

helpBar (line 700)

***********************************************************

Function: helpBar * Returns: a complete table row, with links to site defined * help documentation. * **********************************************************

void helpBar ()

helper_displayKeys (line 244)

void helper_displayKeys (mixed $keys, mixed $noLabel)

helper_formatLinks (line 901)

***********************************************************

Function: helper_formatLinks * Arguements: items -- an array of URLS and labels * numItems -- if the count has already been * calculated you may pass it in to * save this function from redoing it* Returns: a
-seperated series of links * **********************************************************

void helper_formatLinks (mixed $items, [mixed $numItems = ""], [mixed $path = ""])

hostedComps (line 726)

***********************************************************

Function: hostedComps * Returns: a tableCell, with links to the registration page * of all the competitions with open registration. * **********************************************************

void hostedComps ()

loginCell (line 685)

***********************************************************

Function: loginCell * Returns: a login form embedded in a table cell. Returns * the user to the index/home page * **********************************************************

void loginCell ()

loginForm (line 646)

***********************************************************

Function: loginForm * Arguments: returnTo -- return the user to this location * Returns: a simple form to authenticate the user that can * be embedded in other pages * **********************************************************

void loginForm (mixed $returnTo)

outsideComps (line 858)

***********************************************************

Function: outsideComps * Returns: a tableCell, with links to competitions on other * registration services, the next 10 are shown as * links, with the full listing on a breakout page * **********************************************************

void outsideComps ()

pendingActions (line 309)

***********************************************************

Function: pendingActions * Arguments: user -- who's pending action list to generate * Returns: a table of formatted links * Requires: nothing * **********************************************************

void pendingActions (mixed $user)

resultTracker (line 817)

***********************************************************

Function: resultTracker * Returns: portal cell to result tracker * **********************************************************

void resultTracker ()

siteAnnouncements (line 145)

void siteAnnouncements ([mixed $limit = 2], mixed $offset)

userPage (line 209)

***********************************************************

Function: userPage * Arguments: user -- display this users comps, teams, admin * Returns: a 2 column wide summary of this user's options * on this server, like a "my" page on portals * Requires: user is a valid, logged in user * **********************************************************

void userPage (mixed $user)

Inherited Methods

Inherited From UIBase

UIBase::UIBase()
UIBase::addAddressElement()
UIBase::addCheckBoxes()
UIBase::addDateElement()
UIBase::addDateRangeElement()
UIBase::addPasswordElement()
UIBase::addRadioButtons()
UIBase::addSelectBox()
UIBase::addSubmitButton()
UIBase::addTextAreaElement()
UIBase::addTextElement()
UIBase::arrayToSelectOptions()
UIBase::beginPage()
UIBase::compinaboxBox()
UIBase::developerContactInfo()
UIBase::documentHead()
UIBase::endPage()
UIBase::fullMasthead()
UIBase::helper_inputTemplate()
UIBase::navbar()
UIBase::registerLinks()
UIBase::resultLinks()
UIBase::sectionBreak()
UIBase::standardMasthead()
UIBase::wrapForm()

Documentation generated on Tue, 25 Apr 2006 12:59:57 -0400 by phpDocumentor 1.3.0RC3