shared-setup.php File Reference

Go to the source code of this file.

Classes
class	setupPage
	The setupPage class, used to make sure all the setup pages are rendered in a consistent manner. More...
class	optionsPanel
	Settings editor class. More...
Functions
	spotModuleCommand ($page_data, $moduleCommandName, $loopcontrol, $loopcontrollimit=1000)
	drawCommand ($title, $description="", $url, $extraClass="", $target="")
	renderOptionsRow ($theOption, $mainVarName="", $alternateTipPosition=false)
	globalID_setup ($splitID)
Variables
	$modules_globalID [] = "globalID_setup"

---

Function Documentation

drawCommand	(	$	title,
		$	description = "",
		$	url,
		$	extraClass = "",
		$	target = ""
	)

Draws a command link

Parameters:

	title	The command link title
	description	Optional. The description of the command link
	url	The URL the command link should call
	extraClass	Optional. Extra class information (Will be added after the command class)

Returns:

string A string containing the rendered command link

Definition at line 75 of file shared-setup.php.

References i18n().

Referenced by dox_renderListOptions(), drawProfileHint(), modulesetup_discuss(), modulesetup_documents(), parse_userlist_control(), SimpleListEditor::render(), setupPage::render(), discuss_importer_phpbb2::render(), discussThread::render(), Hotel::render(), Event::render(), Convention::render(), Member::renderBlock(), blogger_entry::renderControls(), renderEditor(), Member::renderEditor(), Hotel::renderEditor(), Convention::renderEditor(), blogger_user::renderEditor(), Event::renderLink(), gallery2_viewType_oldstyle::renderSingleImage(), gallery2_viewType_table::renderSingleImage(), and subscriptionsManager::renderSubscribeControl().

Here is the call graph for this function:

globalID_setup

(

$

splitID

)

Returns the pageID that corresponds to the globalID for the setup page

Parameters:

splitID

The global ID to check

Returns:

string A string containing the URL corresponding to the globalID, if existing

TODO: Make use of the following!!! - search/replace $_REQUEST["module_section"], $_REQUEST["module_subsection"], $_REQUEST["module_action"] Done, but needs implementing into blogger, events and gallery...

Definition at line 656 of file shared-setup.php.

renderOptionsRow	(	$	theOption,
		$	mainVarName = "",
		$	alternateTipPosition = false
	)

Renders an options row, from an array as defined by the following:

array( "title" => The i18nified human name of the option, shown as the title, "tip" => A longer i18nified tip, which is shown as a comment below the name, "name" => The actual name of the option, the name of the $_POST variable, "current" => The current value of the option, "type" => Which type of option it is. Possible values are: header (special), label, text, password, textbox, pagedata, checkbox, datetime, time, date, radio, select "options" => For select you must additionally define an array element called "options" containing an array, with key/value sets with the options and descriptions of each element in the select, where current is the key of the currently chosen option For radio you must additionally define an array element called "options" containing an array, with key/value sets with the options and title ? descriptions of each element in the radio group, where current is the key of the currently chosen option. Format as such: key => array(title,description) For date and datetime, optionally choose a start year and end year as elements in an array of the format 0 => startyear, 1 => endyear )

Parameters:

	theOption	Option data, as defined in the function description
	mainVarName	Optional. If this is set, an extra array layer will be added to the $_POST data

Returns:

string The rendered options row (table row with two cells, or spanning two cells)

Definition at line 201 of file shared-setup.php.

References $formatting_toolbar, $i, i18n(), and parse_page_data().

Referenced by optionsPanel::render().

Here is the call graph for this function:

spotModuleCommand	(	$	page_data,
		$	moduleCommandName,
		$	loopcontrol,
		$	loopcontrollimit = 1000
	)

Will spot the first module command name of $moduleCommandName in $page_data, and return the parameters

$loopcontrol = 0;
$moduleCommandName = "profilegallerylist";
while( $parameters = spotModuleCommand( $page_data, $moduleCommandName, &$loopcontrol ) )
{
        if( $parameters == " " )
                $parameters = "";
        
        $page_data = str_replace( "\\$moduleCommandName($parameters)", $replaceData, $page_data );
}

Parameters:

	page_data	The page data to look through
	moduleCommandName	The name of the command to look for
	loopcontrol	A variable used for loop control. Pass ByRef!
	loopcontrollimit	How many loops do we accept before bailing - defaults to 1000

Returns:

mixed The command parameters, or false if the module command was not found

Definition at line 38 of file shared-setup.php.

Referenced by parse_blogger(), parse_convention(), parse_discussforum(), parse_discusssection(), parse_discussthread(), and parse_gallery2().

---

Variable Documentation

$modules_globalID[] = "globalID_setup"

Definition at line 801 of file shared-setup.php.