Inheritance diagram for Search_Page:

Public Member Functions
	__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
	$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 37 of file search_page.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 95 of file search_page.inc.

Member Function Documentation

_addDateRangeRestriction	(	&	$fields,
		&	$queries
	)

Add date range restriction to search results by adding a date range search field with special name 'matrix_search_page_date_range'

Parameters

array	$fields	Details fields from fields attr
array	$queries	Details of search queries

Returns: void private

Definition at line 2262 of file search_page.inc.

_createAdditional ( Array & $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

Array (
  'asset'          => [ref major asset to create link under],
  'link_type'    => SQ_LINK_?,
  'value'          => [link value],
  'sort_order'   => [link sort order],
  'is_dependant' => [0|1],
  'is_exclusive' => [0|1],
)

Returns: boolean private

Definition at line 123 of file search_page.inc.

_createBodycopies ( )

Creates bodycopies for this asset

Override if different bodycopies are needed (eg. in search page).

Returns: boolean protected

Definition at line 153 of file search_page.inc.

_getAdditionalSingleAssetFormatKeywords ( )

Get additional keywords to be used in the single-asset format

Provides keywords to be used alongside those provided by assets themselves. These keywords are understood only by this asset

Returns: array protected

Definition at line 3159 of file search_page.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 263 of file search_page.inc.

_getCustomisedFormKeywords ( )

Get the keyword for Customised Form

Returns: array protected

Definition at line 3177 of file search_page.inc.

& _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 665 of file search_page.inc.

_getDefaultBodycopyContent ( $bodycopy_code )

Get the default content for a bodycopy

Parameters

string $bodycopy_code The code name for the bodycopy

Returns: string private

Definition at line 185 of file search_page.inc.

_getSearchedQueries ( )

Get an array of all search terms that have been submitted

Also adjusts fields if we are performing a search within search by concating them with the terms used for the last search

Returns: array private

Definition at line 2651 of file search_page.inc.

_getSearchInSearchKeywords ( )

Get the keyword for Search In Search

Returns: array protected

Definition at line 3194 of file search_page.inc.

_hasMixedFieldTypes ( $field )

Returns true if the datasources for the supplied field imply more than one input style

Different input styles are implied if there are datasources of more than one type, or if the attributes for several asset-attribute datasources are of different types. They are also implied if a selection attribute or selection metadata field is found, since the input style for these is specific to the particular attribute or field.

Parameters

array $field Details of a field from the fields attr

Returns: boolean public

Definition at line 602 of file search_page.inc.

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

Prints the individual asset in the asset list

This is being overridden to cache the results of each asset, and add the score and result number keyword replacements

Parameters

string	$assetid	The assetid of the asset we are printing
int	$list_position	Asset's position in the list
int	$num_items	the number of items in the current list (required by Listing Engine)

Returns: void protected

Definition at line 2976 of file search_page.inc.

_printDateRange	(	$field_name,
		$current_value = `Array()`,
		$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	$read_only	should we print read only if we have a value

Returns: void private

Definition at line 743 of file search_page.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 696 of file search_page.inc.

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

Print a numeric range selection

Note: this brings in a "sub-field" specification - we need this to be able to print the upper and lower values of a 'range' search separately.

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
array	$params	the data source's params list, needed so we know what we're allowed to print
array	$sub_field	if empty, we are printing field_name% if not empty, we are printing field_name_subfield%
boolean	$read_only	should we print read only if we have a value

Returns: void private

Definition at line 942 of file search_page.inc.

_printNumericRangeDescription	(	$current_value,
		$sub_field,
		$params
	)

Print a description for a given numeric range

Parameters

array	$current_value	the values that should be printed
array	$sub_field	if empty, we are printing field_name% if not empty, we are printing field_name_subfield%
array	$params	the data source's params list, needed so we know what we're allowed to print

Returns: void private

Definition at line 871 of file search_page.inc.

_processDateRange ( $field_name )

Print a date range selection

Parameters

string $field_name the name of the field we are processing

Returns: array private

Definition at line 841 of file search_page.inc.

describeLink ( $linkid )

Return a human readable description of the passed link

Parameters

int $linkid the link ID of the link to describe

Returns: string public

Definition at line 283 of file search_page.inc.

filterAssetStatuses ( & $todo )

Remove assets with a status that we do not want to show

Search page doesnt need to filter anything because Search Manager does everything for it, including checking read access.

Parameters

array &$todo an array of assets to list in the same format as the return value of getAssetList()

Returns: void protected

See Also: getAssetList()

Definition at line 486 of file search_page.inc.

filterAssetTypes ( & $todo )

Remove and/or update the todo list based on the types of the assets in it

If an entry in the list is a child of a wanted asset type, its type code is changed to the wanted parent type. If an entry is not a wanted type or a child thereof, it is removed. Otherwise it's left alone.

Parameters

array &$todo an array of assets to list in the same format as the return value of getAssetList()

Returns: void protected

See Also: getAssetList()

Definition at line 1697 of file search_page.inc.

& getBodycopy ( $name )

Retrieves a bodycopy by name

Returns the bodycopy, or NULL if the name does not match any bodycopies

Parameters

string $name the name of the bodycopy to retrieve

Returns: mixed object|NULL private

See Also: Search_Page::bodycopies

Definition at line 546 of file search_page.inc.

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

Retrieves a bodycopy's contents by name

Parameters

string	$name	the name of the bodycopy to retrieve
array	$replacements	replacements

Returns: mixed string|NULL private

See Also: Search_Page::bodycopies; Search_Page::getBodycopy

Definition at line 572 of file search_page.inc.

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

Get Category Chooser Replacement

Parameters

string	$cat_set_name	Category Name
array	$cat_set_details	Category details
string	$default	Default value of the category
boolean	$show_empty	Whether to show the 'unselected text'

Returns: void public

Definition at line 1001 of file search_page.inc.

getExtendedAssetKeywordReplacements ( )

Returns a list of extra keywords that should be replaced for a particular listing asset

This allows search page, for instance, to define its result number and score fields so they don't blank out when keywords are replaced in listing engine.

Returns: array public

Definition at line 2239 of file search_page.inc.

getFieldReplacement	(	$field_name,
		$sub_field = `''`
	)

Returns the replacement for the specified field

Parameters

string	$field_name	the name of the field to get the replacement for
string	$sub_field	sub field

Returns: string public

Definition at line 1032 of file search_page.inc.

& getFormatBodycopy ( $link_value )

Returns the format bodycopy with the specifed link value

If the bodycopy does not exist, or it have a link type 3, NULL is returned as either no format has been customised, or the format feature has been disbled

Parameters

string $link_value the link value of the wanted bodycopy

Returns: object public

Definition at line 2949 of file search_page.inc.

getFormatBodycopyLink ( $link_value )

Returns the link for a bodycopy with the specified link value

Parameters

string $link_value the link value of the link of the wanted bodycopy

Returns: array public

Definition at line 2927 of file search_page.inc.

& getFormatFolder ( )

Returns the format folder where the format bodycopies live

Returns: object public

Definition at line 2905 of file search_page.inc.

getFormatFolderLink ( )

Returns the link for the format folder

Returns: array public

Definition at line 2891 of file search_page.inc.

getFormFormatContents	(	$form_name,
		$replacements
	)

Returns the contents of the specified bodycopy with its keywords replaced with the specified replacements

Parameters

string	$form_name	the name of the format to get the contents for
array	$replacements	the array of replacements to replace in the content

Returns: string public

Definition at line 1666 of file search_page.inc.

getFormFormatReplacements ( $form_name )

Returns the keyword replacements for the specified format bodycopy

Parameters

string $form_name the name of the form to get the replacements for

Returns: array public

Definition at line 1616 of file search_page.inc.

getGeneralReplacement ( $keyword )

Returns replacements that that are common to the bodycopies

Parameters

string $keyword the keyword of the wanted replacement

Returns: string public

Definition at line 1481 of file search_page.inc.

getInitialBodyReplacements ( )

Prints the initial bodycopy

Returns: void private

Definition at line 1570 of file search_page.inc.

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

Return search results based on supplied terms after expanding the specified field into synonyms

Parameters

array	$original_search_results	Results as returned from the original unmodified search query
array	$original_search_info	The original search query "info" structure
string	$auto_ss_field	The name of the field assigned for "Auto Synonym Search" search. Only terms corresponding to this field will be looked up for synonym matches and modified accordingly
Thesaurus	$field_name	The Thesaurus asset with which to perform synonym lookups

Returns: array public

Definition at line 3219 of file search_page.inc.

getQueryFieldValue ( $field_name = '' )

Get the value of a query field

Looks at both the query vars and session data

Parameters

string $field_name field name

Returns: string public

Definition at line 3025 of file search_page.inc.

getResultElementBodyReplacements ( $assetid )

Keyword-replaces for the result element

Parameters

int $assetid the asset ID of the result element

Returns: array public

Definition at line 2138 of file search_page.inc.

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

Keyword-replaces for the results mode

Parameters

array	&$results	the results returned
string	$bc_name	the name of the bodycopy to be printed (results \| no_results)

Returns: void private

Definition at line 1716 of file search_page.inc.

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

Returns the current search terms for the passed field

Parameters

string	$field_name	the name of the field to get the replacement for
string	$sub_field	sub field
boolean	$escape	if true, then escape the value to return using htmlspecialchars()

Returns: string public

Definition at line 1368 of file search_page.inc.

getSisFieldReplacement ( $field_name )

Returns the replacement for the specified field in a search in search form

Parameters

string $field_name the name of the field to get the replacement for

Returns: string public

Definition at line 1186 of file search_page.inc.

isDeletableLink ( $linkid )

Returns TRUE if we can delete the passed link, or a string with the error msg

Parameters

int $linkid the link id of the link to remove

Returns: mixed string|boolean public

Definition at line 241 of file search_page.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 3060 of file search_page.inc.

populateBaseSearchInfo ( )

Get the basic search settings based on the current category

Returns: boolean private

Definition at line 2820 of file search_page.inc.

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

Prepares for linking by checking that the link values are valid for this link

This function will be called if this asset is the major or minor party in the link, so the side_of_link flag should be checked to work out what side of the link this asset is on. The return value should indicate if any of the link fields were changed.

Parameters

object	&$asset	the major or minor asset that we are linking to
string	$side_of_link	the side of the link we are on (major or minor)
string	&$link_type	the type of link we are creating
string	&$value	the value that is to be associated with the link
string	&$sort_order	the position in the links list that this link should take,
string	&$dependant	'0' / '1' on whether the this asset is dependant on the asset that will be linked by the new link
string	&$exclusive	'0' / '1' on whether the this asset is linked exclusivly to the asset that will be linked by the new link

Returns: boolean public

Definition at line 220 of file search_page.inc.

printContents ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 304 of file search_page.inc.

printResultsBody ( $search = Array() )

Prints the results bodycopy

Parameters

array $search The passed search variable used for stored searches

Returns: void private

Definition at line 429 of file search_page.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 2343 of file search_page.inc.

processSearchVars ( )

This function will generate an array of the search var to process depending on the GET/POST variable defined and the search terms passed

Returns: array public

Definition at line 3442 of file search_page.inc.

sortAssetList	(	$asset_list,
		$sort_info
	)

Sort the list of assets

Parameters

array	$asset_list	an array of assets to be sorted
array	$sort_info	sorting information as provided by getSortInfo()

Returns: array public

See Also: Listing_Engine::sortAssetList(); Listing_Engine::getSortInfo()

Definition at line 504 of file search_page.inc.

Field Documentation

$bodycopies

Initial value:

= Array(
                        'initial'       => 'Initial Search Page Layout',
                        'results'       => 'Results Page Layout',
                        'no_results'    => 'No Results Page Layout',
                      )

Definition at line 44 of file search_page.inc.

$keywords

Initial value:

= Array(
                        'initial'       => Array(
                                            'submit_button',
                                            'results_per_page',
                                            'structured_root_node',
                                           ),
                        'results'       => Array(
                                            'result_list',
                                            'result_count',
                                            'current_result_page',
                                            'total_result_pages',
                                            'result_page_index',
                                            'previous_result_page_link',
                                            'next_result_page_link',
                                            'previous_result_page_href',
                                            'next_result_page_href',
                                            'initial_layout',
                                            'category_list_linked',
                                            'structured_root_node',
                                            'initial_result_count',
                                           ),
                        'no_results'    => Array(
                                            'initial_layout',
                                           ),
                    )

Definition at line 62 of file search_page.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/search/search_page/search_page.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation