Inheritance diagram for Calendar_Event:

Public Member Functions
	Calendar_Event ($assetid=0)

	_preCreateCheck (&$link)

	_createAdditional (&$link)

	delete ($release_lock=TRUE)

	getAvailableKeywords ()

	_getAllowedLinks ()

	_getDeleteLink ()

	saveAttributes ($dont_run_updated=FALSE)

	cloneComponents (&$clone, $components, $override=FALSE)

	getStartDate ()

	getEndDate ()

	getStartTime ()

	getEndTime ()

	getDuration ()

	getFriendlyStart ()

	getFriendlyEnd ()

	getFriendlyDatesAndTimes ()

	printBody ()

	processEventAction ($action_name)

	cacheCalendarData ($updating=TRUE)

	getKeywordReplacement ($keyword)

	getAsset ($whole_assetid)

	getAssetInfo (Array $assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')

	getAttributeValuesByName ($attr_name, $asset_type, $assetids, $contextid=NULL)

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 ()

Protected Member Functions
	_getName ($short_name=FALSE, $contextid=NULL)

Protected Member Functions inherited from Asset
	_preCreateCheck (Array &$link)

	_createAdditional (Array &$link)

	_abortCreate ($trigger_level_changed=FALSE, $linkid=0)

	_loadVars ()

	_getName ($short_name=FALSE, $contextid=NULL)

	_getKeywordReplacement ($keyword)

	_checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)

	makeAndSaveInitialWebPath ($path, $parent_link=NULL)

Additional Inherited Members
Data Fields inherited from Asset
	$id = 0

	$version = ''

	$name = ''

	$short_name = ''

	$status

	$languages = ''

	$charset = ''

	$force_secure = '0'

	$created

	$created_userid

	$updated

	$updated_userid

	$published

	$published_userid

	$status_changed

	$status_changed_userid

	$_is_cacheable = FALSE

	$vars = Array()

	$_available_keywords = Array()

	$data_path_suffix = ''

	$data_path = ''

	$data_path_public = ''

	$_ser_attrs = FALSE

Detailed Description

Definition at line 35 of file calendar_event.inc.

Member Function Documentation

_createAdditional ( & $link )

Perform any additional processing required during the creation of this asset

Folders set an initial web path when they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 87 of file calendar_event.inc.

_getAllowedLinks ( )

Returns an array of all the permitted links type, the type asset and the cardinality In the form

Returns: array private

Definition at line 232 of file calendar_event.inc.

_getDeleteLink ( )

Get the HTML link that users can click to delete this event

Returns: string private

Definition at line 260 of file calendar_event.inc.

_getName	(	$short_name = `FALSE`,
		$contextid = `NULL`
	)

protected

Returns name of the asset

Parameters

boolean	$short_name	whether or not we are after the shortname or the full name
int	$contextid	what context to return the name from

Returns: string private

See Also: Asset::_getName()

Definition at line 150 of file calendar_event.inc.

_preCreateCheck ( & $link )

Perform any pre-validation required during the creation of this asset

Calendar events ensure a name has been set before they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 62 of file calendar_event.inc.

cacheCalendarData ( $updating = TRUE )

Cache the calendar data's stuff

The return value indicates the success

Parameters

boolean $updating are we updating (TRUE) or inserting a new record (FALSE - set only in create() call)

Returns: boolean public

Definition at line 762 of file calendar_event.inc.

Calendar_Event ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 45 of file calendar_event.inc.

cloneComponents	(	&	$clone,
			$components,
			$override = `FALSE`
	)

Takes a clone shell and clones the sources required components to the clone shell

Parameters

object	&$clone	the clone shell
array	$components	the wanted components to clone eg. Array( 'attributes', 'metadata_shemas', 'metadata', 'workflow', 'permissions', 'data' ); or alternately Array('all');
boolean	$override	whether or not to override the existing permission, metadata schemas, workflow schemas with the new ones.

Returns: boolean public

Definition at line 419 of file calendar_event.inc.

delete ( $release_lock = TRUE )

Delete this asset from the trash

Note that the asset MUST be in the trash to delete it FROM the trash.

Parameters

boolean $release_lock should we release the lock after deleting

Returns: boolean public

Definition at line 112 of file calendar_event.inc.

getAsset ( $whole_assetid )

Returns a reference to the event asset instance represented by the passed assetid

Parameters

int $assetid the entire asset id of the asset to be loaded

Returns: mixed object|NULL public

See Also: Asset_Manager::getAsset()

Definition at line 1065 of file calendar_event.inc.

getAssetInfo	(	Array	$assetids,
			$type_code = `Array()`,
			$strict_type_code = `TRUE`,
			$field = `''`
	)

Returns an array of information about assets of the passed codes

If one value in $field then the return value is Array(assetid => '[field]'), otherwise Array(assetid => Array())

Parameters

array	$assetids	an array of assets to limit
mixed	$type_code	an asset type code, or array of typecodes, to limit results to
boolean	$strict_type_code	ensure returned assets are of the passed type codes
string	$field	single field from the asset table to return (along with the assetid) Default is all fields

Returns: array public

Definition at line 1113 of file calendar_event.inc.

getAttributeValuesByName	(	$attr_name,
		$asset_type,
		$assetids,
		$contextid = `NULL`
	)

Get the values of the attribute with the given name for the given assetids

If the assetid is an event instance (shadow assetid), get the attribute of the corresponding event asset instead

Parameters

string	$attr_name	The name of the attribute to get the values of
string	$asset_type	The type code of the asset type that defines the attribute
array	$assetids	IDs of the assets whose values we want
int	$contextid	The ID of the context we wish to get the value of the attr for. (If omitted, use the currently active context.)

Returns: array public

Definition at line 1183 of file calendar_event.inc.

getAvailableKeywords ( )

Return the keywords for this asset type.

This function is called in asset-listing situations like the asset listing, search page etc The return value is in the form:

Array(
  'name' => 'description' => 'the asset name',
);

Returns: array public

Definition at line 182 of file calendar_event.inc.

getDuration ( )

Returns the duration between the start and end dates, if they are set

If end date/time is NULL => return 0 (single point in time) If start date and end date only specified => return calendar days covered by two dates (ie. calendar days * 86400) If both fields specified in full => return the difference between the two times in seconds

Returns: int public

Definition at line 524 of file calendar_event.inc.

getEndDate ( )

Get the date component of the End Date attribute

It returns the date component of the end date (ISO8601 fmt, yyyy-mm-dd) or boolean FALSE if the date component is empty

Returns: mixed string|boolean public

Definition at line 471 of file calendar_event.inc.

getEndTime ( )

Get the time component of the End Date attribute

It returns the time component of the end date (hh:mm:ss) or boolean FALSE if the time component is empty (–:–:–)

Returns: mixed string|boolean public

Definition at line 505 of file calendar_event.inc.

getFriendlyDatesAndTimes ( )

Get the start and end details in friendly format

If date components of Start Date and End Date attributes are the same, the date is not repeated, and the times are shown in abbreviated format (see example returns below). Example returns (assuming date and time components specified):

if (start date != end date)     "23 Jul 2004 4:00pm - 25 Jul 2004 10:00am"
if (start date == end date)     "23 Jul 2004 4:00pm-5:00pm"
if (end date is empty)          "23 Jul 2004 4:00pm"

If only date components are specified:
if (start date != end date)     "23 Jul 2004 - 25 Jul 2004"
if (start date == end date)     "23 Jul 2004 (all day)"
if (end date is empty)          "23 Jul 2004"

Returns: string public

Definition at line 623 of file calendar_event.inc.

getFriendlyEnd ( )

Get the end date and time in friendly format

It returns the end date and time if appropriate, in friendly format

Returns: string public

Definition at line 589 of file calendar_event.inc.

getFriendlyStart ( )

Get the start date and time in friendly format

It returns the start date and time if appropriate, in friendly format

Returns: string public

Definition at line 570 of file calendar_event.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 864 of file calendar_event.inc.

getStartDate ( )

Get the date component of the Start Date attribute.

It returns the date component of the start date (ISO8601 fmt, yyyy-mm-dd) or boolean FALSE if the date component is empty

Returns: mixed string|boolean public

Definition at line 454 of file calendar_event.inc.

getStartTime ( )

Get the time component of the Start Date attribute

It returns the time component of the start date (hh:mm:ss) or boolean FALSE if the time component is empty (–:–:–)

Returns: mixed string|boolean public

Definition at line 488 of file calendar_event.inc.

printBody ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 652 of file calendar_event.inc.

processEventAction ( $action_name )

Process the specified action on this event, and return whatever html the action wants to show

This should be overridden by child classes. It returns HTML to show as the result of this action

Parameters

string $action_name The action to perform, eg 'cancel'

Returns: string public

Definition at line 698 of file calendar_event.inc.

saveAttributes ( $dont_run_updated = FALSE )

Save attributes set with setAttrValue to the database

Parameters

boolean $dont_run_updated if TRUE this->_updated() won't be run (THIS IS ONLY EVER CALLED FROM Asset::create())

Returns: boolean public

See Also: Asset::setAttrValue()

Definition at line 286 of file calendar_event.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/calendar/calendar_event/calendar_event.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation