Inheritance diagram for Page_Calendar_Rolling:

Public Member Functions
	__construct ($assetid=0)

	_createAdditional (&$link)

	_getAllowedLinks ()

	onRequestKeywords (&$broadcaster, $vars=Array())

	printBody ()

	getKeywordReplacement ($keyword)

	_getCacheKey ()

	_getPageContentsReplacements ()

	_getStartEndDates ($time_unit, $time, $modifier=0)

	_getEvents ($start_date=NULL, $end_date=NULL, $time=NULL)

	getFormats ($type='type_formats')

&	getFolder ($type='type_formats')

	createNoResultsBodycopy ($enable_on_create=TRUE)

&	getNoResultsBodycopy ($only_if_enabled=TRUE)

	isNoResultsBodycopyEnabled ()

	setUseNoResultsBodycopy ($enabled)

Public Member Functions inherited from Page
	__construct ($assetid=0)

	_getAllowedLinks ()

	printBody ()

Public Member Functions inherited from Asset
	Asset ($assetid=0)

	create (Array &$link)

	load ($assetid)

	_loadDataPaths ()

	reload ()

	canDelete ()

	delete ($release_lock=TRUE, $check_locked=TRUE)

	useSystemVersion ()

	loadSystemVersion ()

	saveSystemVersion ()

	clearSystemVersion ()

	revertToSystemVersion ()

	revertNoticeLinksToSystemVersion ()

	_updated ($update_parents=TRUE)

	type ()

	getTypeAncestors ($include_asset=TRUE)

	incrementVersion ($number='micro', $update_parents=TRUE)

	getLanguages ()

	setLanguages (Array $languages)

	setCharset ($charset)

	setForceSecure ($force_secure)

	remapAssetids (Array $map)

	morph ($new_type_code)

	_morphCleanup ($new_type_code)

	onRequestKeywords (Asset $broadcaster, Array $vars=Array())

	canClone ()

	cloneComponents (Asset $clone, Array $components, $override=FALSE)

	cloneComponentsAdditional (Asset $clone, Array $components)

	cloneLinks (Asset $clone)

	getStatus ()

	getAvailableStatii ()

	getStatusDescription ()

	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)

	setDate ($date_type, $time=NULL, $userid=NULL)

	lockTypes ()

	canForceablyAcquireLock ($lock_type)

	getEditingLocks ($keywords)

	_getAllowedLinks ()

	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)

	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)

	canCreateLink (Asset $minor, $link_type, $exclusive)

	canMoveLink (Asset $minor, Asset $old_major, $link_type)

	describeLink ($linkid)

	isDeletableLink ($linkid)

	canDeleteLink ($linkid)

	deleteLink ($linkid, $check_locked=TRUE)

	linksUpdated ()

	canCloneLink ()

	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)

	setAttrValue ($name, $value)

	attr ($name)

&	attrByRef ($name)

	getAttribute ($name, $mute_errors=FALSE)

	getAssetKeywords ($descriptions=FALSE)

	getAvailableKeywords ()

	getKeywordReplacement ($keyword)

	getAssetWebPathKeywordReplacement ()

	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)

	processCustomKeywords ($keywords=Array())

	getContent ()

	setContent ()

	getEffectiveLastUpdatedTime ($assetids)

	readAccess (Array $assetids=Array())

	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)

	adminAccess ($lock_type='', Array $assetids=Array())

	backendAccess ()

	liveEditAccess ($lock_type)

	canliveEdit ($lock_type)

	effectiveUnrestricted ()

	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)

	accessEffective ()

	permissionsUpdated ()

	printFrontend ()

	printFrontendAsset (Asset $asset, $design=NULL)

	getValidProtocols ()

	printHead ()

	printBody ()

	getCurrentPaintLayoutName ()

	getCurrentDesignName ()

	printBodyWithPaintLayout ($layout_id='')

	initLimbo ()

	printLimbo ()

	paintBackend (Backend_Outputter $o)

	getPrefix ()

	processBackend (Backend_Outputter $o, Array &$link)

	getEI ()

	getEditFns ()

	getBackendHref ($screen='', $backend_page=TRUE)

	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)

	getURLs ()

	getHref ($base_url=NULL, $ignore_rollback=FALSE)

	getWebDataPath ()

	getWebPaths ()

	saveWebPaths ($paths, $auto_add_remaps=TRUE)

	getLookups ($field='')

	getDesignLookups ()

	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)

	deleteLookupValue ($layout_name, $layout_value)

	setPaintLayouts ($layouts)

	updateLookups ($auto_add_remaps=TRUE)

	setLookupValues (Array $values)

	getAssetStatusDescriptionKeywordReplacement ()

	getAssetStatusColourKeywordReplacement ()

	replaceKeywordsInString ($string)

	fastTrack ($tasks)

	unFastTrack ($tasks)

	shouldFastTrack ($task, $assetid=NULL)

	getFaskTrackedTaskAssetids ($task)

	getDependantParentsURL ()

Public Member Functions inherited from MySource_Object
	MySource_Object ()

	__sleep ()

	__wakeup ()

Data Fields
	$bodycopies

Additional Inherited Members
Protected Member Functions inherited from Page
	_preCreateCheck (Array &$link)

	_createAdditional (Array &$link)

	_getName ($short_name=FALSE)

Detailed Description

Definition at line 34 of file page_calendar_rolling.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 64 of file page_calendar_rolling.inc.

Member Function Documentation

_createAdditional ( & $link )

Perform any additional processing required during the creation of this asset

For example, creating other child assets should be performed in this method

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 81 of file page_calendar_rolling.inc.

_getAllowedLinks ( )

Returns an array of all the permitted link type, the type asset and the cardinality

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 147 of file page_calendar_rolling.inc.

_getCacheKey ( )

Work out the unique cache key to represent the current page

Returns: string private

Definition at line 328 of file page_calendar_rolling.inc.

_getEvents	(	$start_date = `NULL`,
		$end_date = `NULL`,
		$time = `NULL`
	)

Get the events that should be displayed in this calendar page Returns: (date => array (assetid => array ( details )))

Parameters

string	$start_date	Start date
string	$end_date	End date
int	$time	The time to use as a point of reference when calculating start_date and end_date - if the latter two variables are set, $time goes unused

Returns: array protected

Definition at line 708 of file page_calendar_rolling.inc.

_getPageContentsReplacements ( )

Get the keyword replacements to use in the page contents bodycopy

Returns: array protected

Definition at line 374 of file page_calendar_rolling.inc.

_getStartEndDates	(	$time_unit,
		$time,
		$modifier = `0`
	)

Gets the start and end dates by time unit (eg. months) for a passed time

(eg. pass in 'months' and strtotime('2006-08-10'), and this function will return '2006-08-01' and '2006-08-30')

Parameters

string	$time_unit	either 'days', 'weeks', or 'months'
int	$time	the time to use as a point of reference, in unix timestamp
int	$modifier	modifies the time so that it's shifted $modifier days/weeks/months in the future/past

Returns: mixed array|FALSE private

Definition at line 653 of file page_calendar_rolling.inc.

createNoResultsBodycopy ( $enable_on_create = TRUE )

Creates the no-results bodycopy

Parameters

boolean $enable_on_create if TRUE, will set the bodycopy to be enabled (TYPE_2 link) when it is created. If FALSE, creates it disabled (TYPE_3 link).

Returns: boolean public

Definition at line 877 of file page_calendar_rolling.inc.

& getFolder ( $type = 'type_formats' )

Return a reference to a folder linked to this asset determined by the passed in value on the link

Parameters

string $type the value on the link for this folder

Returns: object public

Definition at line 850 of file page_calendar_rolling.inc.

getFormats ( $type = 'type_formats' )

Get a list of all formats of a certain type

The results of this function are cached for the length of the script execution

Parameters

string $type the value on the link for the formats folder

Returns: array public

Definition at line 824 of file page_calendar_rolling.inc.

getKeywordReplacement ( $keyword )

Get bodycopy keyword replacement

Provides a mechanism for providing keyword replacement functions by looking up the function named 'getKeywordNameKeywordReplacement' so an asset wishing to add support for 'best_ever' custom keyword should implement a function getBestEverKeywordReplacement() which returns a replacement string

Parameters

string $keyword Keyword to find a replacement for

Returns: string public

Definition at line 312 of file page_calendar_rolling.inc.

& getNoResultsBodycopy ( $only_if_enabled = TRUE )

Returns the no-results bodycopy

Parameters

boolean $only_if_enabled if TRUE, will return NULL if the bodycopy is disabled. If FALSE, will only return NULL if never created.

Returns: mixed object|NULL public

Definition at line 922 of file page_calendar_rolling.inc.

isNoResultsBodycopyEnabled ( )

Returns whether the no-results bodycopy is enabled

Returns: boolean public

Definition at line 950 of file page_calendar_rolling.inc.

onRequestKeywords	(	&	$broadcaster,
			$vars = `Array()`
	)

Add valid keywords for this asset to an array of keywords when asked

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array

Returns: boolean private

Definition at line 167 of file page_calendar_rolling.inc.

printBody ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 233 of file page_calendar_rolling.inc.

setUseNoResultsBodycopy ( $enabled )

Handles the enabling or disabling of the no-results bodycopy

Parameters

boolean $enabled set to TRUE to enable the format bodycopy, set to FALSE to disable it

Returns: boolean public

Definition at line 976 of file page_calendar_rolling.inc.

Field Documentation

$bodycopies

Initial value:

= Array(
                        ''          => Array(
                                        'name'      => 'Page Contents',
                                        'content'   => Array(
                                                        'content'   => '%event_list%',
                                                       ),
                                       ),
                        'time_unit' => Array(
                                        'name'      => 'Time Unit Format',
                                        'content'   => Array(
                                                        'content'   => "<h3>%time_unit_start_datetime_Y-m-d%</h3>\n%time_unit_event_list%",
                                                       ),
                                       ),
                      )

Definition at line 42 of file page_calendar_rolling.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/calendar/page_templates/page_calendar_rolling/page_calendar_rolling.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation