Inheritance diagram for Backend_Outputter:

Public Member Functions
	Backend_Outputter ()

	setBuffering ($buffer=TRUE)

	setRedirect ($link, $target='self')

	addOnLoad ($call)

	addFormActionGetVar ($name, $value, $persistant=FALSE)

	getCurrentLocation ()

	setFormAnchor ($anchor)

	setPageTitle ($title)

	setHeading ($heading, $icon='')

	setSubHeading ($heading, $icon='')

	addMessage ($type, $msg)

	addCssInclude ($file)

	addJsInclude ($file)

	addOnSubmit ($call)

	addHiddenField ($name, $value='')

	addScreen ($url, $name)

	addStaticScreen ($url, $name)

	addPreloadImg ($file)

	setCharset ($charset)

	openRaw ()

	closeRaw ()

	openSection ($heading='', $icon='')

	closeSection ()

	_openSection ($init_arr)

	_nbOpenSection ($init_arr)

	_closeSection ()

	_nbCloseSection ()

	openField ($name, $format='', $note='', $hidden=FALSE, $id_name='')

	_nbOpenField ($name, $format='', $note='', $hidden=FALSE)

	closeField ()

	_nbCloseField ()

	filesPath ($file='')

	paint ()

	getAsString ()

	_paintHeader ()

	_paintSection ($section, $depth=0)

	_paintFooter ()

	_paintCssInclude ($file)

	_paintJsInclude ($file)

	note ($str)

	sectionNote ($str='')

	_nbSectionNote ($str)

	commitButton ($value='', $release_lock=TRUE, $include_section=TRUE)

	printScreenMenu ()

	printContextSwitcher ()

	printSimpleContextSwitcher ()

	onBackendMessage (&$broadcaster, $event_data=Array())

	onCreateLink (&$broadcaster, $event_data=Array())

	onDeleteLink (&$broadcaster, $event_data=Array())

	onAssetUpdate (&$broadcaster, $event_data=Array())

	onAssetTypeUpdate (&$broadcaster, $event_data=Array())

	onAssetStatusUpdate (&$broadcaster, $event_data=Array())

	getCurrentSectionNumber ()

Data Fields
	$_messages = Array()

	$_redirect = ''

	$_redirect_target = ''

	$_on_load_calls = Array()

	$_refreshing_assets = Array()

	$_action = ''

	$_persistant_get_vars = Array()

	$_anchor = ''

	$_page_title = ''

	$_heading = ''

	$_heading_icon = ''

	$_sub_heading = ''

	$_css_includes = Array()

	$_js_includes = Array()

	$_on_submit_calls = Array()

	$_hidden_fields = Array()

	$_screens = Array()

	$_static_screens = Array()

	$_contents = Array()

	$_img_button_count = 0

	$_preload_imgs = Array()

	$_files_path

	$_raw_opened = FALSE

	$_section_stack = Array()

	$_current_field = NULL

	$_section_count = 0

	$_field_count = 0

	$_charset = ''

	$_buffering = TRUE

	$_is_open_section = FALSE

	$_is_open_field = FALSE

	$_current_field_type = ''

	$_current_field_note = ''

	$_nb_section_count = 0

Detailed Description

Definition at line 40 of file backend_outputter.inc.

Member Function Documentation

_closeSection ( )

Closes a section

Returns: void private

Definition at line 681 of file backend_outputter.inc.

_nbCloseField ( )

Closes a field without buffering

Returns: boolean private

Definition at line 850 of file backend_outputter.inc.

_nbCloseSection ( )

Closes a section without buffering

Returns: void private

Definition at line 698 of file backend_outputter.inc.

_nbOpenField	(	$name,
		$format = `''`,
		$note = `''`,
		$hidden = `FALSE`
	)

Print a field without buffering (nb == non-buffering)

Parameters

string	$name	label of the field
string	$format	format 'new_line' \| 'blank' \| 'commit' \| ''
string	$note	a note to place with the field
boolean	$hidden	Whether the field should be hidden

Returns: boolean private

Definition at line 773 of file backend_outputter.inc.

_nbOpenSection ( $init_arr )

Opens a section without buffering

Parameters

array $init_arr some initialising data

Returns: void private

Definition at line 629 of file backend_outputter.inc.

_nbSectionNote ( $str )

Outputs a section note in the proper css format

NOTE: a section can only have ONE note

Parameters

string $str The note contents

Returns: void public

Definition at line 1530 of file backend_outputter.inc.

_openSection ( $init_arr )

Opens a section, with the passed initialise array

Parameters

array $init_arr some initialising data

Returns: void private

Definition at line 587 of file backend_outputter.inc.

_paintCssInclude ( $file )

Outputs a stylesheet include line for the passed file

Parameters

string $file The URL of the file to include

Returns: void public

Definition at line 1455 of file backend_outputter.inc.

_paintFooter ( )

Paint the footer of the page

Returns: void private

Definition at line 1435 of file backend_outputter.inc.

_paintHeader ( )

Paint the header of the page

Returns: void private

Definition at line 950 of file backend_outputter.inc.

_paintJsInclude ( $file )

Outputs a javascript include line for the passed file

Parameters

string $file The URL to the file

Returns: void public

Definition at line 1472 of file backend_outputter.inc.

_paintSection	(	$section,
		$depth = `0`
	)

Paint the passed section onto the page

Parameters

array	$section	an array with some infor about the section
int	$depth	an indicator to the depth we are currently at used for nested sections

Returns: void private

Definition at line 1280 of file backend_outputter.inc.

addCssInclude ( $file )

Add a stylesheet file to the page

Parameters

string $file URL of the CSS file

Returns: void public

Definition at line 366 of file backend_outputter.inc.

addFormActionGetVar	(	$name,
		$value,
		$persistant = `FALSE`
	)

Allows you to add get vars to the action section of the form

Parameters

string	$name	the name of the var
string	$value	the value of the var
boolean	$persistant	try and keep this var available at all times (even on redirects)?

Returns: void public

Definition at line 247 of file backend_outputter.inc.

addHiddenField	(	$name,
		$value = `''`
	)

Add a hidden field to the output

Parameters

string	$name	the name of the field
string	$value	the value to store in the field

Returns: void public

Definition at line 414 of file backend_outputter.inc.

addJsInclude ( $file )

Add a javascript file to the page

Parameters

string $file URL of the JS file

Returns: void public

Definition at line 382 of file backend_outputter.inc.

addMessage	(	$type,
		$msg
	)

Add a message to be displayed to the user

Parameters

string	$type	Type of message
string	$msg	Message contents

Returns: void public

Definition at line 347 of file backend_outputter.inc.

addOnLoad ( $call )

Add an onLoad call, something JS that needs to be executed right after the page finishes loading

Parameters

string $call JS code to execute

Returns: void public

Definition at line 230 of file backend_outputter.inc.

addOnSubmit ( $call )

Add an onSubmit call, some JS that needs to be executed before the form submits

Parameters

string $call The JS code

Returns: void public

Definition at line 398 of file backend_outputter.inc.

addPreloadImg ( $file )

Adds a preload image

Parameters

string $file The URL of the image

Returns: void public

Definition at line 469 of file backend_outputter.inc.

addScreen	(	$url,
		$name
	)

Adds a screen options to the drop down

Parameters

string	$url	the url to go to when this screen is selected
string	$name	the name to display in the drop down

Returns: void public

Definition at line 430 of file backend_outputter.inc.

addStaticScreen	(	$url,
		$name
	)

Adds a static screen for editing

Parameters

string	$url	The URL of the static screen
string	$name	The friendly name of the static screen

Returns: void public

Definition at line 450 of file backend_outputter.inc.

Backend_Outputter ( )

Constructor

public

Definition at line 151 of file backend_outputter.inc.

closeField ( )

Closes a field

Returns: void public

Definition at line 827 of file backend_outputter.inc.

closeRaw ( )

Closes a raw output section

Returns: void public

Definition at line 519 of file backend_outputter.inc.

closeSection ( )

Closes a section

Returns: void public

Definition at line 560 of file backend_outputter.inc.

commitButton	(	$value = `''`,
		$release_lock = `TRUE`,
		$include_section = `TRUE`
	)

Creates a standardised commit button

Parameters

string	$value	The caption of the commit button, defaults to the Commit Button Text property or 'Commit' if not found
boolean	$release_lock	whether the lock should be released
boolean	$include_section	include the section

Returns: void public

Definition at line 1554 of file backend_outputter.inc.

filesPath ( $file = '' )

Returns the path to the web dir in lib

Parameters

string $file if supplied is concatenated onto the path before returning

Returns: string public

Definition at line 883 of file backend_outputter.inc.

getAsString ( )

Returns the outputters painted contents as a string

Returns: string public

Definition at line 932 of file backend_outputter.inc.

getCurrentLocation ( )

Returns the current action, which realistically is going to be the way to get to the current location

Returns: void public

Definition at line 269 of file backend_outputter.inc.

getCurrentSectionNumber ( )

Get the section number we are up to

Returns: int public

Definition at line 1806 of file backend_outputter.inc.

note ( $str )

Outputs a note in the proper css format

Parameters

string $str The note contents

Returns: void public

Definition at line 1489 of file backend_outputter.inc.

onAssetStatusUpdate	(	&	$broadcaster,
			$event_data = `Array()`
	)

Event handler to refresh the asset map if an asset's status has changed

Parameters

object	&$broadcaster	the asset that triggered the event
array	$event_data	the vars that get submitted by the broadcaster

Returns: void public

Definition at line 1787 of file backend_outputter.inc.

onAssetTypeUpdate	(	&	$broadcaster,
			$event_data = `Array()`
	)

Event handler to refresh the asset map if an asset has been morphed to a new type

Parameters

object	&$broadcaster	the asset that triggered the event
array	$event_data	the vars that get submitted by the broadcaster

Returns: void public

Definition at line 1765 of file backend_outputter.inc.

onAssetUpdate	(	&	$broadcaster,
			$event_data = `Array()`
	)

Event handler to refresh the asset map if the short name of an asset has changed

Parameters

object	&$broadcaster	the asset that triggered the event
array	$event_data	the vars that get submitted by the broadcaster

Returns: void public

Definition at line 1745 of file backend_outputter.inc.

onBackendMessage	(	&	$broadcaster,
			$event_data = `Array()`
	)

Event handler to add a message to the flash soeone broadcasts it

Parameters

object	&$broadcaster	the asset that triggered the event
array	$event_data	the vars that get submitted by the broadcaster

Returns: void public

Definition at line 1688 of file backend_outputter.inc.

onCreateLink	(	&	$broadcaster,
			$event_data = `Array()`
	)

Event handler to refresh the asset map if a new link has been created

Parameters

object	&$broadcaster	the asset that triggered the event
array	$event_data	the vars that get submitted by the broadcaster

Returns: void public

Definition at line 1704 of file backend_outputter.inc.

onDeleteLink	(	&	$broadcaster,
			$event_data = `Array()`
	)

Event handler to refresh the asset map if a link has been deleted

Parameters

object	&$broadcaster	the asset that triggered the event
array	$event_data	the vars that get submitted by the broadcaster

Returns: void public

Definition at line 1725 of file backend_outputter.inc.

openField	(	$name,
		$format = `''`,
		$note = `''`,
		$hidden = `FALSE`,
		$id_name = `''`
	)

Opens a field inside a section

Parameters

string	$name	label of the field
string	$format	format 'new_line' \| 'blank' \| 'commit' \| ''
string	$note	a note to place with the field
string	$hidden	whether to hide the field inially or not
string	$id_name	the id name to give the element that we hide (so it can be found easily)

Returns: void public

Definition at line 724 of file backend_outputter.inc.

openRaw ( )

Opens a section of the page for raw output

Returns: void public

Definition at line 497 of file backend_outputter.inc.

openSection	(	$heading = `''`,
		$icon = `''`
	)

Opens a section

Parameters

string	$heading	The heading name
string	$icon	The heading icon

Returns: void public

Definition at line 540 of file backend_outputter.inc.

paint ( )

Paint the cached backend interface

Returns: void public

Definition at line 899 of file backend_outputter.inc.

printContextSwitcher ( )

Prints the interface for switching between contexts

The context switcher will only be painted if there is at least one alternate context set up (it does not need to be valid for initial selection). If there is only one context (ie. the default), nothing will be printed.

Returns: void

Definition at line 1628 of file backend_outputter.inc.

printScreenMenu ( )

Prints the screen selection drop down list

Returns: void public

Definition at line 1594 of file backend_outputter.inc.

printSimpleContextSwitcher ( )

Print only the drop-down part of the context switcher

It is expected that the "simple" version of the context switcher will be used within Simple Edit interfaces, in a similar way to the Screen Menu.

Returns: void

Definition at line 1653 of file backend_outputter.inc.

sectionNote ( $str = '' )

Outputs a section note in the proper css format

NOTE: a section can only have ONE note

Parameters

string $str The note contents

Returns: void public

Definition at line 1506 of file backend_outputter.inc.

setBuffering ( $buffer = TRUE )

Sets whether the backend output will buffer its output

Parameters

boolean $buffer if TRUE buffering will be turned on (on by default)

Returns: boolean public

Definition at line 187 of file backend_outputter.inc.

setCharset ( $charset )

Set the character set for the page

Parameters

string $charset the character set to use

Returns: void public

Definition at line 484 of file backend_outputter.inc.

setFormAnchor ( $anchor )

Set the anchor that the page will submit to

Parameters

string $anchor Anchor name

Returns: void public

Definition at line 284 of file backend_outputter.inc.

setHeading	(	$heading,
		$icon = `''`
	)

Set the heading for page

Parameters

string	$heading	the heading to display
string	$icon	the icon img tag (if any)

Returns: void public

Definition at line 314 of file backend_outputter.inc.

setPageTitle ( $title )

Set the page title

Parameters

$title the page title

Returns: void private

Definition at line 298 of file backend_outputter.inc.

setRedirect	(	$link,
		$target = `'self'`
	)

Set the redirect for the page

Parameters

string	$link	URL to redirect to
string	$target	Frame to redirect in

Returns: void public

Definition at line 204 of file backend_outputter.inc.

setSubHeading	(	$heading,
		$icon = `''`
	)

Set the sub heading for page

Parameters

string	$heading	the heading to display
string	$icon	the icon img tag (if any)

Returns: void public

Definition at line 331 of file backend_outputter.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/include/backend_outputter.inc

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation