GroupList Class Reference

Class which builds HTML list of groups. More...

List of all members.

Public Member Functions

 GroupList ()
 Class constructor.
 fillWithDatabase ()
 Fill in the list using the database.
 databaseItemExists ($groupId, $groupname)
 Check if a group exists.
 databaseInsertItem ($name)
 Insert a new group.
 databaseUpdateItem ($groupId, $newName)
 Update an existing group.
 databaseDeleteItemsExcluding ($idArray)
 Delete an existing group.
 html ()
 Show the list of groups.

Public Attributes

 $emptyListMessage = "There are no groups to display."
 The empty list message.
 $alreadyExistsMessage = "Sorry, that group already exists. Please choose a different groupname."
 The already existing message.


Detailed Description

Class which builds HTML list of groups.

This class can generate a dynamic list of groups in an HTML form.

See also:
DynamicList


Member Function Documentation

GroupList::GroupList (  ) 

Class constructor.

The class constructor.

See also:
DynamicList

GroupList::fillWithDatabase (  ) 

Fill in the list using the database.

This function is responsible for filling in the list using data from the database.

Returns:
boolean indicating success or failure.
See also:
Database

GroupList::databaseItemExists ( groupId,
groupname 
)

Check if a group exists.

This function returns boolean true if a group exists.

Parameters:
groupId The group ID to search for.
groupname The groupname to search for.
Returns:
Boolean true if the group exists.

GroupList::databaseInsertItem ( name  ) 

Insert a new group.

This function will insert a new group in the database.

GroupList::databaseUpdateItem ( groupId,
newName 
)

Update an existing group.

This function will update an existing group in the database.

Parameters:
groupId The groupId of the group.
newName The new name of the group.

GroupList::databaseDeleteItemsExcluding ( idArray  ) 

Delete an existing group.

This function is responsible for removing a group from the database.

Parameters:
name The name of the group.

GroupList::html (  ) 

Show the list of groups.

This function overrides DynamicList::html(), because we also need radio buttons for the default group.

Returns:
HTML containing the list of groups.
See also:
DynamicList

Table


Member Data Documentation

GroupList::$emptyListMessage = "There are no groups to display."

The empty list message.

GroupList::$alreadyExistsMessage = "Sorry, that group already exists. Please choose a different groupname."

The already existing message.


The documentation for this class was generated from the following file:
Generated on Sun Oct 21 06:49:25 2007 for phpSystemManager by  doxygen 1.5.2