Inheritance diagram for Page_Calendar_Events_Search:

Public Member Functions
	__construct ($assetid=0)

	printContents ()

	processSearch ($search=Array())

	getEventInstances ($event_assetids)

	processEventSearch ($search=Array())

	isEmptyQuery ($query)

	_getEventSearchQuery ($search=Array())

	_getEvents ()

	getGeneralReplacement ($keyword)

	_getStoredQueryValue ($filter_name, $filter_type)

	getEventFilterField ($filter_name)

	_printDateRange ($field_name, $current_value=Array(), $single_field=TRUE, $use_picker=TRUE, $read_only=FALSE)

&	_getDateField ($field_name)

	_printDateRangeDescription ($current_value)

	_processDateFilter ($field_name, $type)

	_processFuzzyDate ($type)

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

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

	_createAdditional (Array &$link)

	_createBodycopies ()

	_getDefaultBodycopyContent ($bodycopy_code)

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

	isDeletableLink ($linkid)

	_getAllowedLinks ()

	describeLink ($linkid)

	printContents ()

	printResultsBody ($search=Array())

	filterAssetStatuses (&$todo)

	sortAssetList ($asset_list, $sort_info)

&	getBodycopy ($name)

&	getBodycopyContents ($name, $replacements=Array())

	_hasMixedFieldTypes ($field)

&	_getDateField ($field_name)

	_printDateRangeDescription ($current_value)

	_printDateRange ($field_name, $current_value=Array(), $read_only=FALSE)

	_processDateRange ($field_name)

	_printNumericRangeDescription ($current_value, $sub_field, $params)

	_printNumericRange ($field_name, $current_value=NULL, $params, $sub_field='', $read_only=FALSE)

	getCategoryChooserReplacement ($cat_set_name, $cat_set_details, $default='', $show_empty=TRUE)

	getFieldReplacement ($field_name, $sub_field='')

	getSisFieldReplacement ($field_name)

	getSearchedFieldReplacement ($field_name, $sub_field='', $escape=TRUE)

	getGeneralReplacement ($keyword)

	getInitialBodyReplacements ()

	getFormFormatReplacements ($form_name)

	getFormFormatContents ($form_name, $replacements)

	filterAssetTypes (&$todo)

	getResultsBodyReplacements (&$results, $bc_name='results')

	getResultElementBodyReplacements ($assetid)

	getExtendedAssetKeywordReplacements ()

	_addDateRangeRestriction (&$fields, &$queries)

	processSearch ($search=Array())

	_getSearchedQueries ()

	populateBaseSearchInfo ()

	getFormatFolderLink ()

&	getFormatFolder ()

	getFormatBodycopyLink ($link_value)

&	getFormatBodycopy ($link_value)

	_printAsset ($assetid, $list_position, $num_items=0)

	getQueryFieldValue ($field_name='')

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

	_getAdditionalSingleAssetFormatKeywords ()

	_getCustomisedFormKeywords ()

	_getSearchInSearchKeywords ()

	getMultiWordSynonymSearchResults (Array $original_search_results, Array $original_search_info, $auto_ss_field, Thesaurus $thesaurus)

	processSearchVars ()

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

	_createAdditional (&$link)

	_createBodycopies ()

	_getDefaultBodycopyContent ($bodycopy_code)

	lockTypes ()

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

	describeLink ($linkid)

	isDeletableLink ($linkid)

	cloneComponentsAdditional (&$clone, $components)

	_getAllowedLinks ()

&	getFolder ($type='type_formats')

	getFormats ($type='type_formats')

	printBody ()

	_getFormUrlComponents ()

	printNoResultsBodycopy (&$keywords)

	printContents ()

	_getCacheKey ()

	_getNumPerPage ()

	getAssetList ()

	sortAssetList ($asset_list, $sort_info)

	filterAssetList (&$todo)

	filterAssetStatuses (&$todo)

	filterAssetTypes (&$todo)

	getAllowedAssetTypeMap ()

	adjustAssetPositions (&$todo)

&	getChunk (&$children, &$replacements, $keywords, $result_page, $num_per_page, $group_by=NULL)

	_getPageList ($total_pages, $current_page, $window_size=NULL)

	_groupChunk (&$todo, &$chunk, &$remaining_count, $num_per_page, $group_limit=NULL)

	printAssetList ($todo)

	_printGroups (&$todo, $group_info)

	_printAssetList ($todo)

	_getShadowAssetKeywordReplacements ($assetid, $bc_keywords)

	_printAsset ($assetid, $list_position, $num_items=0)

&	_getTypeFormatBodycopy ($type_code)

	_getSelectionFieldNamePrefix ($selection_name)

	getSortableAssetInfo ()

	getRootNodes ($reload=TRUE)

	getExtendedAssetKeywordReplacements ()

	isDescending ()

	registerFormField ($field_name)

	getUsedFormFields ()

	getSortInfo ()

	groupAssetsRecursively ($group_levels, $assetids, &$results)

	limitAssetsRecursively (&$results, $limit_array)

	getGroupableParentAssetids ($child_assetid, $restrict_types=Array(), $direct_parent_only=FALSE)

&	convertProxyAssetTypes (&$results)

	_getGroupableParentAssetids ($child_assetid, $restrict_types=Array(), $root_nodes=Array(), $direct_parent_only=FALSE)

	sortGroups ($group_levels, $assetids, &$results)

	reindexGroupFormats ()

	processAssetSelections ()

	getAssetSelectionValue ($selection_name, $assetid)

	getAssetSelectionDefaults ()

	getAssetTargetDefaults ()

	_arrayCountRecursive (&$array, $limit=NULL)

	_getPositionFormats ()

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

	_getGenericSingleAssetFormatKeywords ($type=NULL)

	_getAdditionalSingleAssetFormatKeywords ()

	getAvailableKeywords ()

	_getContentsKeywords ()

	_getTypeFormatsKeywords ()

	_getGroupFolderKeywords ()

	getKeywordReplacement ($original_keyword)

	getContentsKeywordReplacements ($keywords=Array())

	getSortByKeywordReplacement ()

	getSortOrderKeywordReplacement ()

	getSubmitButtonKeywordReplacement ()

	getResetButtonKeywordReplacement ()

	getRootNodesKeywordReplacement ()

	getAssetTargetKeywordReplacement ($name)

	getStructuredRootNodeKeywordReplacement ()

	getSelectAllJSCodeKeywordReplacement ()

	_recurseCheckAllRelations (&$todo, &$relations, $prefix, $limit=NULL)

	_analyseCheckAllRelations ($todo)

	_buildRelationsJS ()

	_getFormSubmitMethod ()

	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
	$fuzzy_date_types

Data Fields inherited from Search_Page
	$bodycopies

	$defaults = Array ('query_width' => 25)

	$keywords

Data Fields inherited from Listing_Engine
	$requires_form = FALSE

	$performance_log_file_name = 'performance'

	$performance_threshold = 1000

Additional Inherited Members
Protected Member Functions inherited from Listing_Engine
	_getAssetContentsBCKeywordReplacement (Asset $asset, $contextid=NULL)

	_getAssetContentsRawBCKeywordReplacement (Asset $asset, $contextid=NULL)

	_getAssetContentsPaintBCKeywordReplacement (Asset $asset, $paint_layout, $contextid=NULL)

Detailed Description

Definition at line 29 of file page_calendar_events_search.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Returns: object public

Definition at line 67 of file page_calendar_events_search.inc.

Member Function Documentation

& _getDateField ( $field_name )

Get a datetime field for painting and processing

Parameters

string $field_name the name of the field we are creating

Returns: object private

Definition at line 755 of file page_calendar_events_search.inc.

_printDateRange	(	$field_name,
		$current_value = `Array()`,
		$single_field = `TRUE`,
		$use_picker = `TRUE`,
		$read_only = `FALSE`
	)

Print a date range selection

Parameters

string	$field_name	the name of the field we are painting #
array	$current_value	the values that should be printed instead of the date selection boxes
boolean	$single_field	whether to output single field only
boolean	$user_picker	whether to include date picker
boolean	$read_only	should we print read only if we have a value

Returns: void private

Definition at line 644 of file page_calendar_events_search.inc.

_printDateRangeDescription ( $current_value )

Print a description for a given date range

Parameters

array $current_value the values that should be printed instead of the date selection boxes

Returns: void private

Definition at line 786 of file page_calendar_events_search.inc.

_processDateFilter	(	$field_name,
		$type
	)

Process the date range selection

Parameters

string	$field_name	the name of the field we are processing
string	$type

Returns: array private

Definition at line 832 of file page_calendar_events_search.inc.

_processFuzzyDate ( $type )

Returns the date range for given fuzzy date type

Parameters

string $type

Returns: array private

Definition at line 892 of file page_calendar_events_search.inc.

getEventFilterField ( $filter_name )

Get the html content for the given event filter field

Parameters

string $filter_name the event filter name

Returns: string public

Definition at line 559 of file page_calendar_events_search.inc.

getGeneralReplacement ( $keyword )

Returns replacements for keywords that are not replaced by the parent This includes event filter keywords and keywords common to the search page bodycopies

Parameters

string $keyword the keyword of the wanted replacement

Returns: string public

Definition at line 465 of file page_calendar_events_search.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 1041 of file page_calendar_events_search.inc.

printContents ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 81 of file page_calendar_events_search.inc.

processSearch ( $search = Array() )

Processes a search request

Note that all search queries are constructed and run in the Search Manager From the posted variables, it formulates search info and returns results

Parameters

array $search The search variables used for stored searches

Returns: array public

See Also: Search_Manager:processSearch()

Definition at line 129 of file page_calendar_events_search.inc.

Field Documentation

$fuzzy_date_types

Initial value:

= Array(
                                'today' => 1, 
                                'tomorrow'=> 1, 
                                'yesterday' => 1, 
                                'this_weekend' => 0, 
                                'next_weekend' => 0, 
                                'previous_weekend' => 0, 
                                'this_week' => 1, 
                                'next_week' => 1, 
                                'previous_week' => 1, 
                                'this_fortnight' => 0, 
                                'next_fortnight' => 0, 
                                'previous_fortnight' => 0, 
                                'this_month' => 1, 
                                'next_month' => 1, 
                                'previous_month' => 1, 
                                'this_year' => 0, 
                                'next_year' => 0, 
                                'previous_year' => 0, 
                                'anytime' => 0
                            )

Definition at line 36 of file page_calendar_events_search.inc.

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

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

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation