Docs For Class Core_AdministrativeInterface

Class Core_AdministrativeInterface

Description

abstract:

Located in /packages/core/lib/administrativeinterface.inc.php (line 2)

Variable Summary

string[] $AccessedFields

string[] $arrExtraSearchFields

string $CarriedFieldPhraseName

string $Class

string[] $CollapsingRows

string $Delimiter

boolean $DisplayCollapsingRows

boolean $EscapeXML

string $ImagePath

unknown_type $Object

string $QueryField

integer $RowIndentLevel

unknown_type $Theme

string $ToggleBarName

string $ToggleBarPhraseName

string[][] $Widgets

Method Summary

string closeDetailsRow ([string $FieldPhraseName = NULL], [string $NextFieldDelimiter = NULL])

string closeDetailsToggleBar ()

string closeIndentedSubSection ()

string closeStandardDetails ()

string createCheckBox (string $FieldName, [string $FieldPhraseName = NULL], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string createDetailsRow ([string $RowID = NULL], [string $FieldPhraseName = NULL], [integer $Colspan = 3])

string createDetailsSeparator ([string $RowID = NULL])

string createDetailsToggleBar (string $BarName, [string $BarPhraseName = NULL], [boolean $ClosedOnLoad = true], [ $CollapsingRows = array()])

string createHelpButton (string $PhraseName, integer $PackageID, integer $ModuleID)

string createHiddenField (string $FieldName, string $FieldValue)

string createHiddenInputsForMissedFields ()

string createHierarchicalDetails ([string $FocusField = NULL], [string $OnLoadEvent = NULL])

string createHierarchicalList (string $SearchFunction, [string[] $arrSearchArguments = array('parentid')], [string[] $arrSearchDefaults = array(parentid => 0)])

string createHierarchicalMain (string $HeaderPhraseName, [string $ClassUnderPhraseName = ''], string $TraverseFunction)

string createIndentedSubSection ()

string createInformationList (mixed $Information, [string $FieldPhraseName = NULL])

string createModuleFooter ()

string createModuleHeader (string $HeaderPhraseName, [string $Colspan = 3], [integer $Width = 700])

string createPasswordField (string $FieldName, [string $FieldPhraseName = NULL], [integer $Size = 30], [integer $MaxLength = 50], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string createPermissionsEditor (string $GetArrayFromIDArrayFunction, string $GetPermissionsFunction, string $HeaderPhraseName)

string createRadioButtons (string $FieldName, [string $FieldPhraseName = NULL], [string[] $OptionPhraseNames = array(1 => 'yes', 0 => 'no')], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string createRelationsFrame (string $RelatingClass, string $PluralRelatingClass, string $dbLoadFunction, string $SearchFunction, [string[] $arrSearchArguments = array()], [string[] $arrSearchDefaults = array()], [string $LaunchModule = 0], [string $HelpBoxPhraseName = NULL], [string $AllObjectsPhraseName = NULL], [string $ObjectsForPhraseName = NULL], [string $NoPrimaryPhraseName = NULL], [ $toStringArguments = array()])

string createRelationsRow (string $Class, string $FName, [string $HelpBoxPhraseName = NULL])

string createSelect (string $FieldName, string $SearchFunction, [string $FieldPhraseName = NULL], [string $NoSelectionPhraseName = NULL], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string createStandardDetails ([string $FocusField = NULL], [string $OnLoadEvent = NULL])

string createStandardList (string $SearchFunction, [string[] $arrSearchArguments = array()], [string[] $arrSearchDefaults = array()])

string createStandardMain (string $HeaderPhraseName)

string createTextArea (string $FieldName, [string $FieldPhraseName = NULL], [string $Rows = 8], [string $Columns = 50], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string createTextField (string $FieldName, [string $FieldPhraseName = NULL], [string $Size = 50], [string $MaxLength = 100], [string $arrEvents = NULL], [string $NextFieldDelimiter = NULL], [boolean $FormatNumber = true])

string createTransfer (string $HeaderPhraseName, string $GetArrayFromIDArrayFunction, string $TraverseFunction, string $GetChildrenFunction)

string createUserStyleDetails ([string $FocusField = NULL], [string $OnLoadEvent = NULL])

string createUserStyleList (string $SearchFunction)

string createUserStyleMain (string $HeaderPhraseName)

void includeUIFunctions (string $FunctionName)

string initialize ([string $Theme = CONFIG_CORE_DEFAULT_THEME])

boolean loadAdministrativeUIFunctions ()

boolean loadAdministrativeWidgets ()

string setClass (string $ClassName)

void setSearchFields (string $QueryField, [string[] $arrExtraSearchFields = array()])

Variables

string[] $AccessedFields = array() (line 2917)

Array of fields explicitly accessed through AdministrativeInterface functions

access: public

string[] $arrExtraSearchFields = array() (line 3016)

Names of fields to be passed to list iframe for searching

access: public

string $CarriedFieldPhraseName = NULL (line 2960)

Field name established when $NextFieldDelimiter is in a function call. Allows for displaying of help box after all fields in row are shown.

access: public

string $Class = NULL (line 2924)

Name of primary class for this interface

access: public

string[] $CollapsingRows = NULL (line 2974)

Array of row ids being hidden or displayed by a toggle anchor.

access: public

string $Delimiter = ' -> ' (line 2931)

Delimiter used when displaying hierarchical information

access: public

boolean $DisplayCollapsingRows = false (line 2981)

Indicates if current rows being added to interface should be hidden on page load.

access: public

boolean $EscapeXML = true (line 2988)

Indicates if toString and getString functions should escape values before returning their string

access: public

string $ImagePath = NULL (line 2938)

Path to image directory

access: public

unknown_type $Object = NULL (line 2945)

Primary object being edited or displayed in this interface

access: public

string $QueryField = NULL (line 3009)

Name of field to be used for queries to the list iframe

access: public

integer $RowIndentLevel = 0 (line 2967)

Depth of current indentation.

access: public

unknown_type $Theme = NULL (line 2952)

Administrative Theme used for interface display

access: public

string $ToggleBarName = NULL (line 3002)

Name of toggle anchor currently being associated with rows to hide or display

access: public

string $ToggleBarPhraseName = NULL (line 2995)

Phrase name for toggle anchor currently being associated with rows to hide or display

access: public

string[][] $Widgets = array() (line 3024)

Array of functions that may be called within administrative interface to provide functionality in arbitrary locations.

access: public

Methods

closeDetailsRow (line 11)

Returns closing HTML to a standard row for a details iframe

return: HTML to echo for the row
access: public

string closeDetailsRow ([string $FieldPhraseName = NULL], [string $NextFieldDelimiter = NULL])

string $FieldPhraseName
string $NextFieldDelimiter

closeDetailsToggleBar (line 63)

Returns closing HTML for a group of rows to be hidden and shown by clicking an anchor.

return: HTML to echo for toggling section
access: public

string closeDetailsToggleBar ()

closeIndentedSubSection (line 118)

Ends an indented section in a details iframe

return: HTML to be echoed
access: public

string closeIndentedSubSection ()

closeStandardDetails (line 140)

Returns closing HTML for a standard details iframe

return: HTML to be echoed
access: public

string closeStandardDetails ()

createCheckBox (line 170)

Returns HTML for a checkbox in a standard details iframe

return: HTML to be echoed
access: public

string createCheckBox (string $FieldName, [string $FieldPhraseName = NULL], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string $FieldName
string $FieldPhraseName
string[] $arrEvents: use event name as key and javascript as value
string $NextFieldDelimiter

createDetailsRow (line 213)

Returns HTML to open a standard details row

return: HTML to be echoed
access: public

string createDetailsRow ([string $RowID = NULL], [string $FieldPhraseName = NULL], [integer $Colspan = 3])

string $RowID: DOM id of row
string $FieldPhraseName
integer $Colspan: number of columns to cover in containing table

createDetailsSeparator (line 272)

Returns HTML to add a horizontal separator into table

return: HTML to be echoed
access: public

string createDetailsSeparator ([string $RowID = NULL])

string $RowID: DOM id of row holding separator

createDetailsToggleBar (line 298)

Returns HTML to begin a section of the details iframe to be hidden and displayed by clicking an anchor string.

return: HTML to be echoed
access: public

string createDetailsToggleBar (string $BarName, [string $BarPhraseName = NULL], [boolean $ClosedOnLoad = true], [ $CollapsingRows = array()])

string $BarName
string $BarPhraseName: phrase name of the toggling anchor's string.
boolean $ClosedOnLoad: specified if the following sections are to be hidden initially
$CollapsingRows

createHelpButton (line 332)

Returns HTML for a standard help button image. When clicked, an alert box will appear showing the specified phrase.

return: HTML to be echoed
access: public

string createHelpButton (string $PhraseName, integer $PackageID, integer $ModuleID)

string $PhraseName
integer $PackageID
integer $ModuleID

createHiddenField (line 360)

Returns HTML for a hidden form field. The object will remember the creation of the field and not make it again when creatorHiddenInputsForMissedFields is called.

return: HTML to be echoed
access: public

string createHiddenField (string $FieldName, string $FieldValue)

string $FieldName
string $FieldValue

createHiddenInputsForMissedFields (line 386)

Returns HTML to create hidden fields for all instance variables of $this->Object that were not explicitly created through other AdministrativeInterface functions.

return: HTML to be echoed.
access: public

string createHiddenInputsForMissedFields ()

createHierarchicalDetails (line 427)

Returns HTML to begin a details iframe that must recognize existence of a parent object

return: HTML to be echoed
access: public

string createHierarchicalDetails ([string $FocusField = NULL], [string $OnLoadEvent = NULL])

string $FocusField: name of field to automatically receive focus on page load
string $OnLoadEvent: javascript to be run on page load

createHierarchicalList (line 541)

Returns HTML to create a list where a parent must be recognized

return: HTML to be echoed
access: public

string createHierarchicalList (string $SearchFunction, [string[] $arrSearchArguments = array('parentid')], [string[] $arrSearchDefaults = array(parentid => 0)])

string $SearchFunction
string[] $arrSearchArguments
string[] $arrSearchDefaults

createHierarchicalMain (line 688)

Returns HTML to create a standard main frame when a parent object must be recognized

return: HTML to be echoed
access: public

string createHierarchicalMain (string $HeaderPhraseName, [string $ClassUnderPhraseName = ''], string $TraverseFunction)

string $HeaderPhraseName
string $ClassUnderPhraseName
string $TraverseFunction: function used to traverse up hierarchy from current object

createIndentedSubSection (line 835)

Returns HTML to start an indented section in a details iframe

return: HTML to be echoed
access: public

string createIndentedSubSection ()

createInformationList (line 854)

Returns HTML to show supplied information within a details iframe

return: HTML to be echoed
access: public

string createInformationList (mixed $Information, [string $FieldPhraseName = NULL])

mixed $Information: if an array is supplied, echo piece of info will be displayed in a separate row
string $FieldPhraseName

createModuleFooter (line 912)

Returns HTML to close a standard box (usually holding information for one administrative module)

return: HTML to be echoed.
access: public

string createModuleFooter ()

createModuleHeader (line 937)

Returns HTML to open a standard box (usually holding information for one administrative module)

return: HTML to be echoed
access: public

string createModuleHeader (string $HeaderPhraseName, [string $Colspan = 3], [integer $Width = 700])

string $HeaderPhraseName
string $Colspan: number of columns table should hold
integer $Width: width of box in px

createPasswordField (line 979)

Returns HTML to creator a password field in a standard details iframe

return: HTML to be echoed
access: public

string createPasswordField (string $FieldName, [string $FieldPhraseName = NULL], [integer $Size = 30], [integer $MaxLength = 50], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string $FieldName
string $FieldPhraseName
integer $Size: size attribute of password field
integer $MaxLength: maxlength attribute of password field
string[] $arrEvents: keys are event names and values are javascript to executed
string $NextFieldDelimiter

createPermissionsEditor (line 1017)

Returns HTML to create an "Advanced Permissions Editor" for current object

return: HTML to be echoed
access: public

string createPermissionsEditor (string $GetArrayFromIDArrayFunction, string $GetPermissionsFunction, string $HeaderPhraseName)

string $GetArrayFromIDArrayFunction: API function for obtaining all objects from ids passed in $_REQUEST
string $GetPermissionsFunction
string $HeaderPhraseName

createRadioButtons (line 1225)

Returns HTML to create radio buttons in a standard details iframe

return: HTML to be echoed
access: public

string $FieldName
string $FieldPhraseName
string[] $OptionPhraseNames
string[] $arrEvents: keys are event names and values are javascript to executed
string $NextFieldDelimiter

createRelationsFrame (line 1299)

Returns HTML to aid in relating objects within an iframe

return: HTML to be echoed
access: public

string createRelationsFrame (string $RelatingClass, string $PluralRelatingClass, string $dbLoadFunction, string $SearchFunction, [string[] $arrSearchArguments = array()], [string[] $arrSearchDefaults = array()], string $LaunchModule, [string $HelpBoxPhraseName = NULL], [string $AllObjectsPhraseName = NULL], [string $ObjectsForPhraseName = NULL], [string $NoPrimaryPhraseName = NULL], [ $toStringArguments = array()])

string $RelatingClass
string $PluralRelatingClass
string $dbLoadFunction: function to load all data for $this->Object
string $SearchFunction
string[] $arrSearchArguments
string[] $arrSearchDefaults
string $LaunchModule: name of module to launch with anchor at bottom of iframe
string $HelpBoxPhraseName
string $AllObjectsPhraseName
string $ObjectsForPhraseName
string $NoPrimaryPhraseName
$toStringArguments

createRelationsRow (line 1519)

Returns HTML for creating a search box and enclosing row for a relating iframe within a details iframe

return: HTML to be echoed
access: public

string createRelationsRow (string $Class, string $FName, [string $HelpBoxPhraseName = NULL])

string $Class: class to be related/unrelated
string $FName: name of php function within script to create HTML within iframe
string $HelpBoxPhraseName

createSelect (line 1575)

Returns HTML to create select box within a details iframe

return: HTML to be echoed
access: public

string $FieldName
string $SearchFunction
string $FieldPhraseName
string $NoSelectionPhraseName
string[] $arrEvents: keys are event names and values are javascript to executed
string $NextFieldDelimiter

createStandardDetails (line 1649)

Returns HTML to start a standard details iframe

return: HTML to be echoed
access: public

string createStandardDetails ([string $FocusField = NULL], [string $OnLoadEvent = NULL])

string $FocusField: field to be focused upon when frame loads
string $OnLoadEvent: javascript to be executed when frame loads

createStandardList (line 1757)

Return HTML to be echoed for a standard list of objects to be edited in an administrative module

return: HTML to be echoed
access: public

string createStandardList (string $SearchFunction, [string[] $arrSearchArguments = array()], [string[] $arrSearchDefaults = array()])

string $SearchFunction
string[] $arrSearchArguments
string[] $arrSearchDefaults

createStandardMain (line 1899)

Returns HTML for enclosing a standard module interface

return: HTML to be echoed
access: public

string createStandardMain (string $HeaderPhraseName)

string $HeaderPhraseName

createTextArea (line 1994)

Returns HTML to create a textarea within a details iframe

return: HTML to be echoed
access: public

string createTextArea (string $FieldName, [string $FieldPhraseName = NULL], [string $Rows = 8], [string $Columns = 50], [string[] $arrEvents = NULL], [string $NextFieldDelimiter = NULL])

string $FieldName
string $FieldPhraseName
string $Rows: number of rows within textarea
string $Columns: number of columns within textarea
string[] $arrEvents: keys are event names and values are javascript to executed
string $NextFieldDelimiter

createTextField (line 2043)

Returns HTML to create a text field within a details iframe

return: HTML to be echoed
access: public

string $FieldName
string $FieldPhraseName
string $Size: size attribute of text field
string $MaxLength: maxlength attribute of text field
string $arrEvents: keys are event names and values are javascript to executed
string $NextFieldDelimiter
boolean $FormatNumber

createTransfer (line 2114)

Returns HTML to create a standard interface for transfering objects within a hierarchy

return: HTML to be echoed
access: public

string createTransfer (string $HeaderPhraseName, string $GetArrayFromIDArrayFunction, string $TraverseFunction, string $GetChildrenFunction)

string $HeaderPhraseName
string $GetArrayFromIDArrayFunction: $_ARCHON function for obtaining array of objects from their ids
string $TraverseFunction: $_ARCHON function for traversing up hierarchy from a child
string $GetChildrenFunction: function to get children for an object

createUserStyleDetails (line 2343)

Returns HTML for opening a User or Usergroup style details iframe

return: HTML to be echoed
access: public

string createUserStyleDetails ([string $FocusField = NULL], [string $OnLoadEvent = NULL])

string $FocusField: field to focus upon on page load
string $OnLoadEvent: javascript to execute on page load

createUserStyleList (line 2447)

Returns HTML for creating a User or Usergroup style list lacking dynamic search functionality

return: HTML to be echoed
access: public

string createUserStyleList (string $SearchFunction)

string $SearchFunction

createUserStyleMain (line 2601)

Returns HTML to enclose an entire User or Usergroup style module interface

return: HTML to be echoed.
access: public

string createUserStyleMain (string $HeaderPhraseName)

string $HeaderPhraseName

includeUIFunctions (line 2579)

Calls additional functions connected to current administrative interface function that were added by other packages

access: public

void includeUIFunctions (string $FunctionName)

string $FunctionName

initialize (line 2690)

Initializes the administrative interface.

return: HTML to be echoed
access: public

string initialize ([string $Theme = CONFIG_CORE_DEFAULT_THEME])

string $Theme

loadAdministrativeUIFunctions (line 2736)

Searches packages for additions to administrative user interface functions to extend their functionality

Note: Only administrative functions in packages which are installed and enabled will be added

access: public

boolean loadAdministrativeUIFunctions ()

loadAdministrativeWidgets (line 2781)

Returns any array of administrative widgets.

Note: Only administrative widgets in packages which are installed and enabled will be added

The first dimension is the PackageID The second dimension is the "Widget Code" defined by the administrative widget

access: public

boolean loadAdministrativeWidgets ()

setClass (line 2815)

Sets class of primary object for the current instantiation of the administrative interface.

It then loads the current object or objects in memory according to the ids set in $_REQUEST.

return: HTML to be echoed
access: public

string setClass (string $ClassName)

string $ClassName

setSearchFields (line 2902)

Sets fields to be used within a details iframe for searching the database.

These searches are used to narrow the list of objects that may be edited.

access: public

void setSearchFields (string $QueryField, [string[] $arrExtraSearchFields = array()])

string $QueryField: field to be passed in as q within the list's $_REQUEST
string[] $arrExtraSearchFields

Documentation generated on Thu, 14 Aug 2008 20:20:51 -0500 by phpDocumentor 1.3.1