Convention Class Reference

Inheritance diagram for Convention:

Collaboration diagram for Convention:

List of all members.

Public Member Functions

Convention ($conventionID=0)

load ()

save ()

getNextID ()

getNextMemberID ()

getEmailSubject ($whatMessage, $user)

getEmailBody ($whatMessage, $user)

getMessage ($whatType, $whatMessage, $user)

calculateAverage ()

getSpareIDs ()

handleRegistration ($username=null, $admin=false, $theFinalID)

renderEvents ($thisGlobalID)

renderEditor ()

render ()

Public Attributes

$membershipTypes

A reference to each membership type available for this convention.

$optionalChoices

A reference to each optional choice available for this convention.

$hotels

$members

$events

A reference to each event at the convention.

$adminConfirmation

Wether the administrator needs to activate a user's registration (default false).

$title

$description

$requestTShirtSize

Wether or not to ask members for their T-Shirt size.

$emailFooter

$startDate

$endDate

$owner

$registrationEnabled

Wether registration is enabled for the convention.

$eventLapse

How long is the slots an event can last (10, 15, 30, 60 minutes...).

$averagePerRoom

The average number of people per room.

$emailSubjects

The subjects of certain emails used through the system (mainly registration).

$emailBodies

The bodies of certain emails used through the system (mainly registration).

$nextID = -1

The next available ID (used for both membershipTypes and optionalChoice) - DO NOT USE DIRECTLY! Use getNextID().

$nextMemberID = -1

The next available ID for members - DO NOT USE DIRECTLY! - Use getNextMemberID().

$currentAvailable

$id

$conventionBasedir

Detailed Description

class Convention

Definition at line 37 of file Convention.php.

Member Function Documentation

Convention::Convention ( $ conventionID = 0 )

Parameters:

conventionID

If zero, this will cause the creation of a new convention. If non-zero, the convention with this ID will be loaded

Returns:

Definition at line 73 of file Convention.php.

References $conventionSettings, load(), lockableClass::lock(), and lockableClass::unlock().

Here is the call graph for this function:

Convention::load ( )

Definition at line 107 of file Convention.php.

References $settings, globalIDtoURL(), and i18n().

Referenced by Convention(), handleRegistration(), and renderEditor().

Here is the call graph for this function:

Convention::save ( )

Definition at line 200 of file Convention.php.

References $settings, array_export(), description, and title.

Referenced by calculateAverage(), getNextID(), getNextMemberID(), handleRegistration(), and renderEditor().

Here is the call graph for this function:

Convention::getNextID ( )

Definition at line 252 of file Convention.php.

References save().

Referenced by renderEditor().

Here is the call graph for this function:

Convention::getNextMemberID ( )

Definition at line 259 of file Convention.php.

References save().

Here is the call graph for this function:

Convention::getEmailSubject	(	$	whatMessage,
		$	user
	)

Get the subject for a specified email message pertaining to a certain user

Parameters:

	$whatMessage	The message required (can be one of initial, initial2, confirmation and confirmation2)
	$user	The instance of a user to work on (should be passed as reference)

Definition at line 272 of file Convention.php.

References getMessage().

Here is the call graph for this function:

Convention::getEmailBody	(	$	whatMessage,
		$	user
	)

Get the body of a specified email message pertaining to a certain user

Parameters:

	$whatMessage	The message required (can be one of initial, initial2, confirmation and confirmation2)
	$user	The instance of a user to work on (should be passed as reference)

Definition at line 283 of file Convention.php.

References getMessage().

Here is the call graph for this function:

Convention::getMessage	(	$	whatType,
		$	whatMessage,
		$	user
	)

Convenience function for grabbing a certain part of a specified message for a certain user

Parameters:

	$whatType	The type of message required (one of either emailSubject and emailBody)
	$whatMessage	The message required (can be one of initial, initial2, confirmation and confirmation2)
	$user	The instance of a user to work on (should be passed as reference)

Definition at line 295 of file Convention.php.

References title.

Referenced by getEmailBody(), and getEmailSubject().

Convention::calculateAverage ( )

Definition at line 319 of file Convention.php.

References lockableClass::lock(), save(), and lockableClass::unlock().

Referenced by renderEditor().

Here is the call graph for this function:

Convention::getSpareIDs ( )

This will return an array containing the un-used IDs that are situated in the list of members. This is used in the membership editor to manually assign a user a new ID.

Returns:: array containing the available IDs

Definition at line 357 of file Convention.php.

References $i, and endKey().

Here is the call graph for this function:

Convention::handleRegistration	(	$	username = `null`,
		$	admin = `false`,
		$	theFinalID
	)

Definition at line 366 of file Convention.php.

References $conventionSettings, $membershipTypes, $panel, $usermanager, allUsersArray(), description, endKey(), extractBetweenDelimeters(), firstKey(), Member::generateUsername(), getCountryArray(), globalIDtoURL(), i18n(), load(), lockableClass::lock(), save(), title, and lockableClass::unlock().

Referenced by render(), and renderEditor().

Here is the call graph for this function:

Convention::renderEvents ( $ thisGlobalID )

Definition at line 539 of file Convention.php.

References $i.

Referenced by render(), and renderEditor().

Convention::renderEditor ( )

Definition at line 613 of file Convention.php.

References $conventionSettings, $i, $members, $message, $panel, $renderedContent, $usermanager, allUsersArray(), calculateAverage(), currentUser(), description, drawCommand(), getCountryArray(), getNextID(), globalIDtoURL(), handleRegistration(), i18n(), load(), lockableClass::lock(), name, parse_page_data(), render(), renderEvents(), renderInformationBox(), save(), sendMessage(), thisPageURL(), title, and lockableClass::unlock().

Here is the call graph for this function:

Convention::render ( )

This renderer is used to show the end users (members and potential members) what they can do

Definition at line 1547 of file Convention.php.

References $conventionSettings, $panel, $renderedContent, $usermanager, currentUser(), description, drawCommand(), globalIDtoURL(), handleRegistration(), i18n(), parse_page_data(), renderEvents(), renderInformationBox(), sendMessage(), and title.

Referenced by renderEditor().

Here is the call graph for this function:

Member Data Documentation

Convention::$membershipTypes

A reference to each membership type available for this convention.

Definition at line 39 of file Convention.php.

Referenced by handleRegistration().

Convention::$optionalChoices

A reference to each optional choice available for this convention.

Definition at line 40 of file Convention.php.

Convention::$hotels

Definition at line 41 of file Convention.php.

Convention::$members

Definition at line 42 of file Convention.php.

Referenced by renderEditor().

Convention::$events

A reference to each event at the convention.

Definition at line 43 of file Convention.php.

Convention::$adminConfirmation

Wether the administrator needs to activate a user's registration (default false).

Definition at line 44 of file Convention.php.

Convention::$title

Definition at line 46 of file Convention.php.

Convention::$description

Definition at line 47 of file Convention.php.

Convention::$requestTShirtSize

Wether or not to ask members for their T-Shirt size.

Definition at line 48 of file Convention.php.

Convention::$emailFooter

Definition at line 49 of file Convention.php.

Convention::$startDate

Definition at line 50 of file Convention.php.

Convention::$endDate

Definition at line 51 of file Convention.php.

Convention::$owner

Definition at line 52 of file Convention.php.

Convention::$registrationEnabled

Wether registration is enabled for the convention.

Definition at line 53 of file Convention.php.

Convention::$eventLapse

How long is the slots an event can last (10, 15, 30, 60 minutes...).

Definition at line 54 of file Convention.php.

Convention::$averagePerRoom

The average number of people per room.

Definition at line 55 of file Convention.php.

Convention::$emailSubjects

The subjects of certain emails used through the system (mainly registration).

Definition at line 57 of file Convention.php.

Convention::$emailBodies

The bodies of certain emails used through the system (mainly registration).

Definition at line 58 of file Convention.php.

Convention::$nextID = -1

The next available ID (used for both membershipTypes and optionalChoice) - DO NOT USE DIRECTLY! Use getNextID().

Definition at line 60 of file Convention.php.

Convention::$nextMemberID = -1

The next available ID for members - DO NOT USE DIRECTLY! - Use getNextMemberID().

Definition at line 61 of file Convention.php.

Convention::$currentAvailable

Definition at line 63 of file Convention.php.

Convention::$id

Definition at line 64 of file Convention.php.

Convention::$conventionBasedir

Definition at line 65 of file Convention.php.

The documentation for this class was generated from the following file:

setup/modules/convention/code/Convention.php


Public Member Functions
	Convention ($conventionID=0)
	load ()
	save ()
	getNextID ()
	getNextMemberID ()
	getEmailSubject ($whatMessage, $user)
	getEmailBody ($whatMessage, $user)
	getMessage ($whatType, $whatMessage, $user)
	calculateAverage ()
	getSpareIDs ()
	handleRegistration ($username=null, $admin=false, $theFinalID)
	renderEvents ($thisGlobalID)
	renderEditor ()
	render ()
Public Attributes
	$membershipTypes
	A reference to each membership type available for this convention.
	$optionalChoices
	A reference to each optional choice available for this convention.
	$hotels
	$members
	$events
	A reference to each event at the convention.
	$adminConfirmation
	Wether the administrator needs to activate a user's registration (default false).
	$title
	$description
	$requestTShirtSize
	Wether or not to ask members for their T-Shirt size.
	$emailFooter
	$startDate
	$endDate
	$owner
	$registrationEnabled
	Wether registration is enabled for the convention.
	$eventLapse
	How long is the slots an event can last (10, 15, 30, 60 minutes...).
	$averagePerRoom
	The average number of people per room.
	$emailSubjects
	The subjects of certain emails used through the system (mainly registration).
	$emailBodies
	The bodies of certain emails used through the system (mainly registration).
	$nextID = -1
	The next available ID (used for both membershipTypes and optionalChoice) - DO NOT USE DIRECTLY! Use getNextID().
	$nextMemberID = -1
	The next available ID for members - DO NOT USE DIRECTLY! - Use getNextMemberID().
	$currentAvailable
	$id
	$conventionBasedir