Search_Page_Edit_Fns Class Reference

Inheritance diagram for Search_Page_Edit_Fns:

Public Member Functions
	__construct ()
	paintRootAsset (&$asset, &$o, $prefix, $category='', $read_only=FALSE)
	processRootAsset (&$asset, &$o, $prefix)
	paintFields (&$asset, &$o, $prefix)
	processFields (&$asset, &$o, $prefix)
	paintExcludeFields (&$asset, &$o, $prefix)
	processExcludeFields (&$asset, &$o, $prefix)
	paintStyles (&$asset, &$o, $prefix)
	processStyles (&$asset, &$o, $prefix)
	paintCategories (&$asset, &$o, $prefix)
	_paintCategoryOptions (&$asset, $prefix, $set_name, $options, $wa)
	_paintStatusChooser ($name, $current_values, $editable=TRUE, $visible=TRUE)
	_paintAssetChooser ($name, $current_value, $editable=TRUE, $visible=TRUE)
	processCategories (&$asset, &$o, $prefix)
	_processCategoryOptions (&$asset, $prefix, $set_name, $old_options)
	paintAddCategory (&$asset, &$o, $prefix)
	processAddCategory (&$asset, &$o, $prefix)
	paintCustomiseSearchForms (&$asset, &$o, $prefix)
	processCustomiseSearchForms (&$asset, &$o, $prefix)
	paintThesaurusAsset (&$asset, &$o, $prefix)
	processThesaurusAsset (&$asset, &$o, $prefix)
	paintAutoSynonymSearch (&$asset, &$o, $prefix)
	processAutoSynonymSearch (&$asset, &$o, $prefix)
	paintEnableMultiWordSynonymLookups (&$asset, &$o, $prefix)
	processEnableMultiWordSynonymLookups (&$asset, &$o, $prefix)
	thesaurusInstalled (&$asset, $prefix)
	_paintExtraSortOptions (&$asset, &$o, $prefix)
	_processExtraSortOptions (&$asset, &$o, $prefix)
	paintSavedSearch (&$asset, &$o, $prefix)
	processSavedSearch (&$asset, &$o, $prefix)
Public Member Functions inherited from Listing_Engine_Edit_Fns
	__construct ($assetid=0)
	paintAssetTypes (&$asset, &$o, $prefix)
	processAssetTypes (&$asset, &$o, $prefix)
	paintAssetPositions (&$asset, &$o, $prefix)
	processAssetPositions (&$asset, &$o, $prefix)
	paintColumnSettings (&$asset, &$o, $prefix)
	processColumnSettings (&$asset, &$o, $prefix)
	paintColumnPreview (&$asset, &$o, $prefix)
	processColumnPreview (&$asset, &$o, $prefix)
	paintDefaultFormatLinks (&$asset, &$o, $prefix)
	_paintDefaultFormatLink ($root_assetid, $bodycopy_name, $bodycopy_description, $type_code='bodycopy', $screen='contents')
	paintGroupFormatLinks (&$asset, &$o, $prefix)
	_getAvailableTypes (&$asset)
	paintTypeFormats (&$asset, &$o, $prefix)
	processTypeFormats (&$asset, &$o, $prefix)
	paintPositionFormats (&$asset, &$o, $prefix)
	processPositionFormats (&$asset, &$o, $prefix)
	paintSortOptions (&$asset, &$o, $prefix)
	processSortOptions (&$asset, &$o, $prefix)
	_paintStandardFieldSortOptions (&$asset, &$o, $prefix)
	_processStandardFieldSortOptions (&$asset, &$o, $prefix)
	_paintAttributeSortOptions (&$asset, &$o, $prefix)
	_processAttributeSortOptions (&$asset, &$o, $prefix)
	_paintMetadataSortOptions (&$asset, &$o, $prefix)
	_processMetadataSortOptions (&$asset, &$o, $prefix)
	_paintKeywordSortOptions (&$asset, &$o, $prefix)
	_processKeywordSortOptions (&$asset, &$o, $prefix)
	_paintExtraSortOptions (&$asset, &$o, $prefix)
	_processExtraSortOptions (&$asset, &$o, $prefix)
	_addNewSortOption (&$options, $new_option)
	paintMetadataSortType (&$asset, &$o, $prefix)
	processMetadataSortType (&$asset, &$o, $prefix)
	paintDefaultSortByOption (&$asset, &$o, $prefix)
	processDefaultSortByOption (&$asset, &$o, $prefix)
	paintSortOptionOrder (&$asset, &$o, $prefix)
	processSortOptionOrder (&$asset, &$o, $prefix)
	paintDefaultSortDirection (&$asset, &$o, $prefix)
	processDefaultSortDirection (&$asset, &$o, $prefix)
	_getStandardSortByOptions (&$asset)
	paintRootNode (&$asset, &$o, $prefix)
	processRootNode (&$asset, &$o, $prefix)
	paintGroupBy (&$asset, &$o, $prefix)
	processGroupBy (&$asset, &$o, $prefix)
	paintGroupByMetadata (&$asset, &$o, $prefix, $group_by_option)
	processGroupByMetadata (&$asset, &$o, $prefix, $key, &$group_by_option)
	paintGroupByStandardAssetField (&$asset, &$o, $prefix, $group_by_option)
	processGroupByStandardAssetField (&$asset, &$o, $prefix, $key, &$group_by_option)
	paintGroupByParentAsset (&$asset, &$o, $prefix, $group_by_option)
	processGroupByParentAsset (&$asset, &$o, $prefix, $key, &$group_by_option)
	paintGroupByKeyword (&$asset, &$o, $prefix, $group_by_option)
	processGroupByKeyword (&$asset, &$o, $prefix, $key, &$group_by_option)
	paintNewGroupBy (&$asset, &$o, $prefix)
	processNewGroupBy (&$asset, &$o, $prefix)
	paintSelections (&$asset, &$o, $prefix)
	processSelections (&$asset, &$o, $prefix)
	paintTargets (&$asset, &$o, $prefix)
	processTargets (&$asset, &$o, $prefix)
	paintStatus (&$asset, &$o, $prefix)
	processStatus (&$asset, &$o, $prefix)
	paintPermissions (&$asset, &$o, $prefix)
	processPermissions (&$asset, &$o, $prefix)
	_paintStructuredTypes (&$asset, &$o, $prefix, &$options)
	_processStructuredTypes (&$asset, &$o, $prefix, &$options)
	paintStructuredDropdownOptions (&$asset, &$o, $prefix)
	processStructuredDropdownOptions (&$asset, &$o, $prefix)
	isAZListing (&$asset, $prefix)
	paintUseNoResultsBodycopy (&$asset, &$o, $prefix)
	processUseNoResultsBodycopy (&$asset, &$o, $prefix)
	paintProxyTypes (&$asset, &$o, $prefix)
	processProxyTypes (&$asset, &$o, $prefix)
	paintAssetExclusion (&$asset, &$o, $prefix)
	processAssetExclusion (&$asset, &$o, $prefix)
	paintRootNodeExclusion (&$asset, &$o, $prefix)
	processRootNodeExclusion (&$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 29 of file search_page_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Definition at line 37 of file search_page_edit_fns.inc.

Member Function Documentation

_paintAssetChooser	(		$name,
			$current_value,
			$editable = TRUE,
			$visible = TRUE
	)

Paint the interface for choosing a root asset for a category option

Parameters

string	$name	Name for the form field
int	$current_value	The current root asset id for the option
boolean	$editable	Whether the field is editable
boolean	$visible	Whether the field should be css-visible initially

Returns

void private

Definition at line 1280 of file search_page_edit_fns.inc.

_paintCategoryOptions	(	&	$asset,
			$prefix,
			$set_name,
			$options,
			$wa
	)

Paint the interface for managing a category set's category options

Parameters

object	&$asset	The asset whose categories are being managed
string	$prefix	The prefix for form fields
string	$set_name	The category set whose options are being managed
array	$options	The current category options
boolean	$wa	Whether we have write access to the field

Returns

void private

Definition at line 1114 of file search_page_edit_fns.inc.

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

Paint the inteface for configuring extra sort fields

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for form elements

Returns

boolean private

Definition at line 1971 of file search_page_edit_fns.inc.

_paintStatusChooser	(		$name,
			$current_values,
			$editable = TRUE,
			$visible = TRUE
	)

Paint the interface for choosing statuses for a category option

Parameters

string	$name	Name for the form field
array	$current_values	The current search statuses for the option
boolean	$editable	Whether the field is editable
boolean	$visible	Whether the field should be css-visible initially

Returns

void private

Definition at line 1232 of file search_page_edit_fns.inc.

_processCategoryOptions	(	&	$asset,
			$prefix,
			$set_name,
			$old_options
	)

Process the interface where category options for a category set are managed

Updates and creates notice links for category options' root nodes

Parameters

object	&$asset	The asset whose categories are being managed
string	$prefix	The prefix for form fields
string	$set_name	The name of the category set whose options are being managed
array	$old_options	The existing options for this category set

Returns

array public

Definition at line 1362 of file search_page_edit_fns.inc.

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

Process the inteface for configuring extra sort fields

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for form elements

Returns

boolean private

Definition at line 2007 of file search_page_edit_fns.inc.

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

Paints the interface for adding a category set

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1474 of file search_page_edit_fns.inc.

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

Paints the auto synonym search section

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1781 of file search_page_edit_fns.inc.

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

Paints the interface for managing the search categories

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1000 of file search_page_edit_fns.inc.

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

Paints the interface to customise the search forms

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1530 of file search_page_edit_fns.inc.

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

Paints the "Enable Multi-Word Synonym Lookups" item

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1873 of file search_page_edit_fns.inc.

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

Paints the interface for adding and configuring Exlude fields.

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

void public

Definition at line 532 of file search_page_edit_fns.inc.

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

Paints the interface for adding and configuring search fields.

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

void public

Definition at line 156 of file search_page_edit_fns.inc.

paintRootAsset	(	&	$asset,
		&	$o,
			$prefix,
			$category = '',
			$read_only = FALSE
	)

Paints the root node selection box

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
string	$category	the category we are painting for (if blank we paint for the whole search page)
boolean	$read_only	force read only view

Returns

boolean public

Definition at line 59 of file search_page_edit_fns.inc.

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

Paint the inteface for configuring saved search

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for form elements

Returns

boolean private

Definition at line 2049 of file search_page_edit_fns.inc.

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

Paints the interface for selecting search field styles

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

void public

Definition at line 900 of file search_page_edit_fns.inc.

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

Paints the thesaurus asset selection box

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1691 of file search_page_edit_fns.inc.

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

Processes the interface for adding a search category set

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1495 of file search_page_edit_fns.inc.

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

Processes the auto synonym search section

Parameters

object	&$asset	the asset being painted
object	&$o	backend outputter class
string	$prefix	prefix for the html doc element name

Returns

void public

Definition at line 1844 of file search_page_edit_fns.inc.

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

Processes the interface for managing the search categories

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1306 of file search_page_edit_fns.inc.

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

Processes the interface to customise the search forms

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 1583 of file search_page_edit_fns.inc.

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

Processes the "Enable Multi-Word Synonym Lookups" item

Parameters

object	&$asset	the asset being painted
object	&$o	backend outputter class
string	$prefix	prefix for the html doc element name

Returns

void public

Definition at line 1928 of file search_page_edit_fns.inc.

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

Processes the interface for adding and configuring Exclude fields.

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 831 of file search_page_edit_fns.inc.

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

Processes the interface for adding and configuring search fields.

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 464 of file search_page_edit_fns.inc.

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

Processes the value input from root node selection box

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name

Returns

void public

Definition at line 100 of file search_page_edit_fns.inc.

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

Process the interface for configuring saved search

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for form elements

Returns

boolean private

Definition at line 2081 of file search_page_edit_fns.inc.

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

Processes the interface for changing search page field styles

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

boolean public

Definition at line 953 of file search_page_edit_fns.inc.

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

Processes the value input from thesaurus asset selection box

Parameters

object	&$asset	the search page asset
object	&$o	the backend outputter
string	$prefix	prefix for form elements

Returns

void public

Definition at line 1724 of file search_page_edit_fns.inc.

thesaurusInstalled	(	&	$asset,
			$prefix
	)

Return TRUE if the thesaurus asset type is installed

Parameters

object	&$asset	the asset whose interface we are painting
string	$prefix	the prefix for this asset

Returns

boolean public

Definition at line 1951 of file search_page_edit_fns.inc.

---

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

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