Page_Upcoming_Events_List_Edit_Fns Class Reference

Inheritance diagram for Page_Upcoming_Events_List_Edit_Fns:

Public Member Functions
	__construct ()
	paintEventSources (&$asset, &$o, $prefix)
	processEventSources (&$asset, &$o, $prefix)
	paintDefaultFormatLinks (&$asset, &$o, $prefix)
	_paintDefaultFormatLink ($root_assetid, $bodycopy_name, $bodycopy_description, $type_code='bodycopy', $screen='contents')
	paintTypeFormats (&$asset, &$o, $prefix)
	processTypeFormats (&$asset, &$o, $prefix)
	_getAvailableTypes (&$asset)
Public Member Functions inherited from Page_Edit_Fns
	__construct ()
Public Member Functions inherited from Asset_Edit_Fns
	Asset_Edit_Fns ()
	paintPaths (&$asset, &$o, $prefix)
	paintEditRemapURLs (&$asset, &$o, $prefix)
	processPaths (&$asset, &$o, $prefix)
	processEditRemapURLs (&$asset, &$o, $prefix)
	paintURLs (&$asset, &$o, $prefix)
	paintAddRemapURLs (&$asset, &$o, $prefix)
	processAddRemapURLs (&$asset, &$o, $prefix)
	isWorkflowComplete (&$asset)
	paintNoticeLinkedAsset (&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)
	processNoticeLinkedAsset (&$asset, $link_value, $field_name='', $multiple=FALSE)
	isSearchInstalled (&$asset, $prefix)
	isBeingCreated (&$asset)
	isNotBeingCreated (&$asset)
	paintAutomaticRemapSetting (&$asset, &$o, $prefix)
	paintCreateLink (&$asset, &$o, $prefix)
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Additional Inherited Members
Data Fields inherited from Asset_Edit_Fns
	$static_screens

Detailed Description

Definition at line 32 of file page_upcoming_events_list_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Definition at line 40 of file page_upcoming_events_list_edit_fns.inc.

Member Function Documentation

_getAvailableTypes

(

&

$asset

)

Gets a list of the available asset types that can be use for type formats. The reason it's used is so that assets (such as Search_Page) don't need to override the whole paint/process functions if they've got special asset type logic (Eg. proxy asset types)

Parameters

object

&$asset

the asset whose interface we are painting

Returns

boolean public

Definition at line 334 of file page_upcoming_events_list_edit_fns.inc.

_paintDefaultFormatLink	(		$root_assetid,
			$bodycopy_name,
			$bodycopy_description,
			$type_code = 'bodycopy',
			$screen = 'contents'
	)

Prints the table containing the links to the bodycopies (and default type format)

Parameters

string	$root_assetid	the id of the asset to look under for bodycopies; NULL indicates the listing_engine asset itself
string	$bodycopy_name	the name of the bodycopy to print, eg. 'no_results'
string	$bodycopy_description	the description to label the bodycopy with
string	$type_code	the type_code of the format to the print (by default, 'bodycopy')
string	$screen	the edit screen to link to

Returns

void private

Definition at line 140 of file page_upcoming_events_list_edit_fns.inc.

paintDefaultFormatLinks	(	&	$asset,
		&	$o,
			$prefix
	)

Paint links to the default formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 109 of file page_upcoming_events_list_edit_fns.inc.

paintEventSources	(	&	$asset,
		&	$o,
			$prefix
	)

Paint the interface for setting the root nodes from which this calendar page draws events

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 55 of file page_upcoming_events_list_edit_fns.inc.

paintTypeFormats	(	&	$asset,
		&	$o,
			$prefix
	)

Paint the interface for editing custom type formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 171 of file page_upcoming_events_list_edit_fns.inc.

processEventSources	(	&	$asset,
		&	$o,
			$prefix
	)

Process the interface for setting the root nodes from which this calendar page draws events

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 83 of file page_upcoming_events_list_edit_fns.inc.

processTypeFormats	(	&	$asset,
		&	$o,
			$prefix
	)

Process the custom type formats interface

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 259 of file page_upcoming_events_list_edit_fns.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/calendar/page_templates/page_upcoming_events_list/page_upcoming_events_list_edit_fns.inc