Page_Calendar_Edit_Fns Class Reference

Inheritance diagram for Page_Calendar_Edit_Fns:

Public Member Functions
	__construct ()
	paintRootNodes (&$asset, &$o, $prefix)
	processRootNodes (&$asset, &$o, $prefix)
	paintViewsChooser (&$asset, &$o, $prefix)
	processViewsChooser (&$asset, &$o, $prefix)
	paintInitialView (&$asset, &$o, $prefix)
	processInitialView (&$asset, &$o, $prefix)
	_paint5MinTimeField ($prefix, $default_hour=9, $default_min=0, $default_is_pm=FALSE)
	_process5MinTimeField ($prefix)
	paintDayStart (&$asset, &$o, $prefix)
	processDayStart (&$asset, &$o, $prefix)
	paintDayEnd (&$asset, &$o, $prefix)
	processDayEnd (&$asset, &$o, $prefix)
	paintWeekDays (&$asset, &$o, $prefix)
	processWeekDays (&$asset, &$o, $prefix)
	paintLookAndFeel (&$asset, &$o, $prefix)
	processLookAndFeel (&$asset, &$o, $prefix)
	paintDayTitleFormat (&$asset, &$o, $prefix)
	processDayTitleFormat (&$asset, &$o, $prefix)
	paintWeekTitleFormat (&$asset, &$o, $prefix)
	processWeekTitleFormat (&$asset, &$o, $prefix)
	paintMonthTitleFormat (&$asset, &$o, $prefix)
	processMonthTitleFormat (&$asset, &$o, $prefix)
	paintMonthDayHeadingFormat (&$asset, &$o, $prefix)
	processMonthDayHeadingFormat (&$asset, &$o, $prefix)
	paintWeekDayHeadingFormat (&$asset, &$o, $prefix)
	processWeekDayHeadingFormat (&$asset, &$o, $prefix)
	paintYearTitleFormat (&$asset, &$o, $prefix)
	processYearTitleFormat (&$asset, &$o, $prefix)
	_paintTitleFormat ($view, &$asset, &$o, $prefix)
	_processTitleFormat ($view, &$asset, &$o, $prefix)
	_paintHeadingFormat ($view, $time_period, &$asset, &$o, $prefix)
	_processHeadingFormat ($view, $time_period, &$asset, &$o, $prefix)
	_paintNavigationLimit ($view, &$asset, &$o, $prefix)
	_processNavigationLimit ($view, &$asset, &$o, $prefix)
	paintColumnNodes (&$asset, &$o, $prefix)
	processColumnNodes (&$asset, &$o, $prefix)
	paintYearNaviLimit (&$asset, &$o, $prefix)
	processYearNaviLimit (&$asset, &$o, $prefix)
	paintMonthNaviLimit (&$asset, &$o, $prefix)
	processMonthNaviLimit (&$asset, &$o, $prefix)
	paintWeekNaviLimit (&$asset, &$o, $prefix)
	processWeekNaviLimit (&$asset, &$o, $prefix)
	paintDayNaviLimit (&$asset, &$o, $prefix)
	processDayNaviLimit (&$asset, &$o, $prefix)
	paintUseNoResultBodycopy (&$asset, &$o, $prefix)
	processUseNoResultBodycopy (&$asset, &$o, $prefix)
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 33 of file page_calendar_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Definition at line 41 of file page_calendar_edit_fns.inc.

Member Function Documentation

_paint5MinTimeField	(		$prefix,
			$default_hour = 9,
			$default_min = 0,
			$default_is_pm = FALSE
	)

Paint an interface where you can choose a point in time with 5-minute precision

Parameters

string	$prefix	prefix for the form elements
int	$default_hour	the default value for the hour field
int	$default_min	the default value for the minutes field
boolean	$default_is_pm	whether the default time is pm

Returns

void private

Definition at line 316 of file page_calendar_edit_fns.inc.

_paintHeadingFormat	(		$view,
			$time_period,
		&	$asset,
		&	$o,
			$prefix
	)

Generic function to paint the interface for specifying a view's heading format

Parameters

string	$view	the view this is the interface for
string	$time_period	the time period used (eg; 'day' for day heading)
object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean private

Definition at line 829 of file page_calendar_edit_fns.inc.

_paintNavigationLimit	(		$view,
		&	$asset,
		&	$o,
			$prefix
	)

Generic function to paint the interface for specifying limit range

Parameters

string	$view	view of navigation limit attribute
object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean private

Definition at line 882 of file page_calendar_edit_fns.inc.

_paintTitleFormat	(		$view,
		&	$asset,
		&	$o,
			$prefix
	)

Generic function to paint the interface for specifying a view's title format

Parameters

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

Returns

boolean private

Definition at line 778 of file page_calendar_edit_fns.inc.

_process5MinTimeField

(

$prefix

)

Process a 5-minute-precision time-choosing field Returns: HH:MM value of the element, in 24 hour format

Parameters

string

$prefix

prefix for the form elements

Returns

string public

Definition at line 342 of file page_calendar_edit_fns.inc.

_processHeadingFormat	(		$view,
			$time_period,
		&	$asset,
		&	$o,
			$prefix
	)

Generic function to process the interface for specifying a view's heading format

Parameters

string	$view	the view this is the interface for
string	$time_period	the time period used (eg; 'day' for day heading)
object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean private

Definition at line 856 of file page_calendar_edit_fns.inc.

_processNavigationLimit	(		$view,
		&	$asset,
		&	$o,
			$prefix
	)

Generic function to process the interface for specifying limit range

Parameters

string	$view	view of navigation limit attribute
object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean private

Definition at line 909 of file page_calendar_edit_fns.inc.

_processTitleFormat	(		$view,
		&	$asset,
		&	$o,
			$prefix
	)

Generic function to process the interface for specifying a view's title format

Parameters

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

Returns

boolean private

Definition at line 803 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you choose which root nodes to columnise by in day view

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 938 of file page_calendar_edit_fns.inc.

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

Paint the interface for choosing the latest time to be displayed in a day

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 424 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the day limit for navigating calendar page

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 1127 of file page_calendar_edit_fns.inc.

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

Paint the interface for choosing the earliest time to be displayed in a day

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 372 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the date format for the day view's title

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 573 of file page_calendar_edit_fns.inc.

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

Paint the interface for choosing which view the frontend user sees first

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 255 of file page_calendar_edit_fns.inc.

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

Paint the explanation of the CSS implementation and link to the CSS

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 533 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the date format for the days shown in the month view

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 675 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the month limit for navigating calendar page

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 1059 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the date format for the month view's title

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 641 of file page_calendar_edit_fns.inc.

paintRootNodes	(	&	$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 59 of file page_calendar_edit_fns.inc.

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

Paint "use no result" bodycopy interface

Return boolean FALSE if write access to links is not held, TRUE otherwise

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 1163 of file page_calendar_edit_fns.inc.

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

Paint the interface for choosing which calendar views are available on the frontend

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 152 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the date format for the days shown in the week view

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 709 of file page_calendar_edit_fns.inc.

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

Paint the interface for choosing the days to include in the week view

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 476 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the week limit for navigating calendar page

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 1093 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the date format for the week view's title

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 607 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the year limit for navigating calendar page

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 1025 of file page_calendar_edit_fns.inc.

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

Paint the interface that lets you specify the date format for the year view's title

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 743 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you choose which root nodes to columnise by in day view

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 996 of file page_calendar_edit_fns.inc.

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

Process the interface for choosing the latest time to be displayed in a day

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 453 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the day limit for navigating calendar page

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 1144 of file page_calendar_edit_fns.inc.

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

Process the interface for choosing the earliest time to be displayed in a day

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 402 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the date format for the day view's title

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 590 of file page_calendar_edit_fns.inc.

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

Process the interface for choosing which view the frontend user sees first

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 289 of file page_calendar_edit_fns.inc.

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

Does nothing

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 556 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the date format for the days shown in the month view

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 692 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the month limit for navigating calendar page

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 1076 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the date format for the month view's title

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 658 of file page_calendar_edit_fns.inc.

processRootNodes	(	&	$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 125 of file page_calendar_edit_fns.inc.

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

Process "use no result" bodycopy 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 1190 of file page_calendar_edit_fns.inc.

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

Process the interface for choosing which calendar views are available on the frontend

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 216 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the date format for the days shown in the week view

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 726 of file page_calendar_edit_fns.inc.

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

Process the interface for choosing the days to include in the week view

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 506 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the week limit for navigating calendar page

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 1110 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the date format for the week view's title

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 624 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the year limit for navigating calendar page

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 1042 of file page_calendar_edit_fns.inc.

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

Process the interface that lets you specify the date format for the year view's title

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 760 of file page_calendar_edit_fns.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/calendar/page_templates/page_calendar/page_calendar_edit_fns.inc