IP.Board  3.3.0
adminOutput Class Reference
Inheritance diagram for adminOutput:
output

Public Member Functions

 __construct (ipsRegistry $registry)
 fetchFakeApps ()
 formCheckbox ($name, $checked=false, $val=1, $id='', $js="", $css='')
 formDropdown ($name, $list=array(), $default_val="", $id="", $js="", $css="", $optgroups=array())
 formInput ($name, $value="", $id="", $size="30", $type='text', $js="", $css="", $maxLength='')
 formMultiDropdown ($name, $list=array(), $default=array(), $size=5, $id="", $js="", $css='')
 formSimpleInput ($name, $value="", $size='5')
 formTextarea ($name, $value="", $cols='40', $rows='5', $id="", $js="", $css="", $wrap='soft')
 formUpload ($name="FILE_UPLOAD", $id='', $js="", $css="")
 formYesNo ($name, $default_val="", $id='', $js=array(), $css='')
 generateGroupDropdown ($formFieldName, $selected, $multiselect=FALSE, $formFieldID='')
 generatePagination ($data)
 generateSkinDropdown ($skin_array=array(), $parent=0, $iteration=0)
 loadRootTemplate ($template)
 loadTemplate ($template, $app='')
 multipleRedirectFinish ($text='Completed!')
 multipleRedirectHit ($url, $text='', $time=1)
 multipleRedirectInit ($url)
 printPopupWindow ()
 redirect ($url, $text, $time=2, $allowErrorToHalt=FALSE, $forcePage=FALSE)
 sendOutput ($return=false)
 setMessage ($message, $persistent=0)
 showDownload ($data, $name, $type="unknown/unknown", $compress=true)
 showError ($message, $code=0, $logError=FALSE, $logExtra='', $header=500)
 showInsideIframe ($url="", $html="")
 silentRedirectWithMessage ($url, $allowErrorToHalt=false)

Data Fields

 $body_extra = ''
 $cm_output = ''
 $core_nav = array()
 $extra_nav = array()
 $extra_title = array()
 $global_error
 $global_message
 $global_template = ''
 $html = ''
 $html_main = ''
 $ignoreCoreNav = false
 $nav = array()
 $persistent_message = 0
 $sidebar_extra = ''

Protected Member Functions

 _buildGlobalSubMenu ()
 _buildMenu ()
 _buildSubMenu ()
 _sendOutputSetUp ($type)

Protected Attributes

 $_IS_PRINTED
 $tabKeys = array( 'core', 'forums', 'members', 'lookfeel', 'support', 'reports', 'other' )

Constructor & Destructor Documentation

__construct ( ipsRegistry registry)

Constructor

Parameters:
objectipsRegistry reference
Returns:
void

Member Function Documentation

_buildGlobalSubMenu ( ) [protected]

Build the secondary menu globally

Returns:
string Menu HTML
_buildMenu ( ) [protected]

Build the primary menu

Returns:
string Menu HTML
_buildSubMenu ( ) [protected]

Build the secondary menu

Returns:
string Menu HTML
_sendOutputSetUp ( type) [protected]

Global set up stuff Sorts the JS module array, calls initiate on the output engine, etc

Parameters:
stringType of output (normal/popup/redirect/error)
Returns:
void

Reimplemented from output.

Retrieve list of "fake apps" to generate tabs for them in ACP

Returns:
array
Since:
3.0
formCheckbox ( name,
checked = false,
val = 1,
id = '',
js = "",
css = '' 
)

Create a checkbox form field

Parameters:
stringField name
booleanField checked or not
stringField value
stringHTML id attribute [defaults to $name]
stringJavascript to add to the checkbox
stringCSS class(es) to add to field
Returns:
string Form checkbox field
formDropdown ( name,
list = array(),
default_val = "",
id = "",
js = "",
css = "",
optgroups = array() 
)

Create a form dropdown/select list

Parameters:
stringField name
arrayOptions. Multidimensional array in format of array( array( 'value', 'display' ), array( 'value', 'display', 'optgroup_key' ) )
stringDefault value
stringHTML id attribute [defaults to $name]
stringJavascript to add to list
stringCSS class(es) to add to field
arrayOptgroups
Returns:
string Form dropdown list
formInput ( name,
value = "",
id = "",
size = "30",
type = 'text',
js = "",
css = "",
maxLength = '' 
)

Create a form text input field

Parameters:
stringField name
stringField current value
stringField ID [defaults to value for $name]
integerField size [defaults to 30]
stringField type [defaults to 'text']
stringJavascript code to add to field
stringCSS class(es) to add to field
Returns:
string Form input field
formMultiDropdown ( name,
list = array(),
default = array(),
size = 5,
id = "",
js = "",
css = '' 
)

Create a multiselect form field

Parameters:
stringField name
arrayOptions. Multidimensional array in format of array( array( 'value', 'display' ), array( 'value', 'display' ) )
arrayDefault values
integerNumber of items to show [defaults to 5]
stringHTML id attribute [defaults to $name]
stringJavascript to apply to field
stringCSS class(es) to add to field
Returns:
string Form multiselect field
formSimpleInput ( name,
value = "",
size = '5' 
)

Create a simpl(er) form text input field

Parameters:
stringField name
stringField current value
integerField size [defaults to 5]
Returns:
string Form input field
See also:
formInput()
formTextarea ( name,
value = "",
cols = '40',
rows = '5',
id = "",
js = "",
css = "",
wrap = 'soft' 
)

Create a form textarea field

Parameters:
stringField name
stringField current value
integerNumber of columns [defaults to 40]
integerNumber of rows [defaults to 5]
stringHTML id to assign to field [defaults to $name]
stringJavascript code to add to field
stringCSS class(es) to add to field
stringWrap type [defaults to soft]
Returns:
string Form textarea field
formUpload ( name = "FILE_UPLOAD",
id = '',
js = "",
css = "" 
)

Create a form text input field

Parameters:
stringField name
stringField ID
stringJavascript code to add to field
stringCSS class(es) to add to field
Returns:
string HTML
formYesNo ( name,
default_val = "",
id = '',
js = array(),
css = '' 
)

Create yes/no radio buttons

Parameters:
stringField name
stringDefault values
stringHTML id attribute (appended with "_yes" and "_no" on the respective fields) [defaults to $name]
arrayJavascript to add to the fields. Array keys should be 'yes' and 'no', values being the javascript to add.
stringCSS class(es) to add to field
Returns:
string Form yes/no radio buttons
generateGroupDropdown ( formFieldName,
selected,
multiselect = FALSE,
formFieldID = '' 
)

Generate a drop down list of groups

Parameters:
stringForm field name
mixedSelected ID(s)
booleanMultiselect (TRUE is yes)
stringHTML id attribute value
Returns:
string HTML dropdown menu
generatePagination ( data)

Build up page span links

Parameters:
arrayPage data
Returns:
string Parsed page links HTML
Since:
2.0

Reimplemented from output.

generateSkinDropdown ( skin_array = array(),
parent = 0,
iteration = 0 
)

Generate a drop down list of skins

Parameters:
arraySkin array
intParent id
intIteration
Returns:
array Array of skins to add to dropdown
loadRootTemplate ( template)

Load a root (non-application) template

Parameters:
stringTemplate name
Returns:
object
loadTemplate ( template,
app = '' 
)

Load a template file

Parameters:
stringTemplate name
stringApplication [defaults to current application]
Returns:
object

Reimplemented from output.

multipleRedirectFinish ( text = 'Completed!')

Finish a multi-redirect session

Parameters:
stringText to display
Returns:
void
multipleRedirectHit ( url,
text = '',
time = 1 
)

Hit a multi-redirect. Uses AJAX or redirect page appropriately

Parameters:
stringUrl to initialize
stringText to initialize with
booleanAdd to the text
Returns:
void

Initialize a multi-redirect. Creates an iframe that continuously adds the last status to the content of the iframe.

Parameters:
stringUrl to initialize
stringText to initialize with
booleanAdd to the text
Returns:
void

Print a popup window - wraps HTML page in minimalized output

Returns:
void
redirect ( url,
text,
time = 2,
allowErrorToHalt = FALSE,
forcePage = FALSE 
)

Redirect user to another page

Parameters:
stringPage to redirect to
stringText to show during redirect
integerNumber of seconds between page loads
booleanAllow a populated $this->registry to stop the redirect with the option to continue
booleanForce full redirect
Returns:
void
sendOutput ( return = false)

Output the HTML to the browser

Parameters:
boolReturn finished output instead of printing
Returns:
void

Reimplemented from output.

setMessage ( message,
persistent = 0 
)

Set a global message to be used

Parameters:
string$messageMessage to show
int$persistentWhether to show message inline (1) or not (0)
Returns:
void
showDownload ( data,
name,
type = "unknown/unknown",
compress = true 
)

Show a download dialog box

Parameters:
stringData for the download
stringFilename
stringMime-type to send to browser
booleanCompress the download
Returns:
void
showError ( message,
code = 0,
logError = FALSE,
logExtra = '',
header = 500 
)

Display an error page

Parameters:
stringText to display
integerError code
booleanLog error message
stringExtra log data
integerHeader code to send (ignored for ACP)
Returns:
void

Reimplemented from output.

showInsideIframe ( url = "",
html = "" 
)

Show a page inside an iframe

Parameters:
stringURL
stringOptional HTML to show inside the iframe
Returns:
void
silentRedirectWithMessage ( url,
allowErrorToHalt = false 
)

Redirect user to another page with no intermediary screen

Parameters:
stringUrl to send the user to
booleanAllow a populated $this->registry to stop the redirect with the option to continue
Returns:
void

The documentation for this class was generated from the following file:
 All Data Structures Functions Variables