ConventionSettings Class Reference
! Handler for the Convention module's settings More...
Public Member Functions | |
| ConventionSettings () | |
| load () | |
| save () | |
| nextConventionID () | |
Public Attributes | |
| $page_id = 12 | |
| The page ID of the convention page. | |
| $menu_id = 100 | |
| The ID of the menu to show on the convention page. | |
| $title | |
| The title of the convention page. | |
| $defaultDuration = 4 | |
| How many days does a convention normally span? | |
| $currentConvention = null | |
| The convention currently running. | |
| $currency | |
| What currency are we working with? Just makes showing stuff to the user prettier. | |
| $availableConventions | |
| The IDs and names of the available conventions - $id => $title. | |
| $nextConventionID = -1 | |
| The next available conventionID - NOT TO BE READ DIRECTLY! USE nextConventionID(). | |
| $conventionDir | |
| The directory in which the convention data is kept. | |
| $settingsFile | |
| Where are the settings saved to? | |
Detailed Description
! Handler for the Convention module's settingsSettings handler for the Convention module
Definition at line 7 of file ConventionSettings.php.
Member Function Documentation
| ConventionSettings::ConventionSettings | ( | ) |
Constructor for the ConventionSettings settings handler
Definition at line 25 of file ConventionSettings.php.
References $module_folder, i18n(), load(), and title.
| ConventionSettings::load | ( | ) |
Performs the actual loading of options
Definition at line 38 of file ConventionSettings.php.
References $settings.
Referenced by ConventionSettings().
| ConventionSettings::save | ( | ) |
Save the settings to file
Definition at line 69 of file ConventionSettings.php.
References $settings, array_export(), currentConvention, nextConventionID(), and title.
Referenced by nextConventionID().
| ConventionSettings::nextConventionID | ( | ) |
Definition at line 88 of file ConventionSettings.php.
References save().
Referenced by save().
Member Data Documentation
| ConventionSettings::$page_id = 12 |
| ConventionSettings::$menu_id = 100 |
The ID of the menu to show on the convention page.
Definition at line 10 of file ConventionSettings.php.
| ConventionSettings::$title |
| ConventionSettings::$defaultDuration = 4 |
How many days does a convention normally span?
Definition at line 12 of file ConventionSettings.php.
| ConventionSettings::$currentConvention = null |
| ConventionSettings::$currency |
What currency are we working with? Just makes showing stuff to the user prettier.
Definition at line 14 of file ConventionSettings.php.
| ConventionSettings::$availableConventions |
The IDs and names of the available conventions - $id => $title.
Definition at line 16 of file ConventionSettings.php.
| ConventionSettings::$nextConventionID = -1 |
The next available conventionID - NOT TO BE READ DIRECTLY! USE nextConventionID().
Definition at line 17 of file ConventionSettings.php.
| ConventionSettings::$conventionDir |
The directory in which the convention data is kept.
Definition at line 19 of file ConventionSettings.php.
| ConventionSettings::$settingsFile |
The documentation for this class was generated from the following file:
- setup/modules/convention/code/ConventionSettings.php
