Funnelback_Search_Page_Edit_Fns Class Reference

Inheritance diagram for Funnelback_Search_Page_Edit_Fns:

Public Member Functions
	__construct ()
	integratedSearch (&$owner, $prefix)
	paintDefaultFormatLinks (&$asset, &$o, $prefix)
	paintFlusterFormatLinks (&$asset, &$o, $prefix)
	paintSpellFormatLinks (&$asset, &$o, $prefix)
	_paintDefaultFormatLink ($root_assetid, $bodycopy_name, $bodycopy_description, $delete_control=FALSE, $prefix='', $type_code='bodycopy', $screen='contents')
	paintTypeFormats (&$asset, &$o, $prefix)
	processTypeFormats (&$asset, &$o, $prefix)
	paintFunnelbackOptions (&$asset, &$o, $prefix)
	processFunnelbackOptions (&$asset, &$o, $prefix)
	paintSort (&$asset, &$o, $prefix)
	processSort (&$asset, &$o, $prefix)
	paintDefaultScope (&$asset, &$o, $prefix)
	processDefaultScope (&$asset, &$o, $prefix)
	paintScope (&$asset, &$o, $prefix)
	processScope (&$asset, &$o, $prefix)
	_paintOptionValue ($values, &$asset, &$o, $prefix)
	_printOptionField ($key, $value, $order, $prefix, $size='10')
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 30 of file funnelback_search_page_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

Definition at line 38 of file funnelback_search_page_edit_fns.inc.

Member Function Documentation

_paintDefaultFormatLink	(		$root_assetid,
			$bodycopy_name,
			$bodycopy_description,
			$delete_control = FALSE,
			$prefix = '',
			$type_code = 'bodycopy',
			$screen = 'contents'
	)

Prints the table containing the links to the bodycopies (and default type format)

Parameters

string	$root_assetid	the id of the asset to look under for bodycopies; NULL indicates the listing_engine asset itself
string	$bodycopy_name	the name of the bodycopy to print, eg. 'no_results'
string	$bodycopy_description	the description to label the bodycopy with
boolean	$bodycopy_description	print the delete control or not
string	$prefix	the prefix of the asset
string	$type_code	the type_code of the format to the print (by default, 'bodycopy')
string	$screen	the edit screen to link to

Returns

void private

Definition at line 174 of file funnelback_search_page_edit_fns.inc.

_paintOptionValue	(		$values,
		&	$asset,
		&	$o,
			$prefix
	)

Print the interface for filling in a value

Parameters

array	$values	the values we are painting
object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

void private

Definition at line 814 of file funnelback_search_page_edit_fns.inc.

_printOptionField	(		$key,
			$value,
			$order,
			$prefix,
			$size = '10'
	)

paint the option field

Parameters

string	$key	the key of the current field
string	$value	the value of the current field
string	$order	the order of the current field
string	$prefix	the prefix of the current form/field
int	$size	the size of the field

Returns

string private

Definition at line 1026 of file funnelback_search_page_edit_fns.inc.

integratedSearch	(	&	$owner,
			$prefix
	)

Returns true if integrated search is enabled

Parameters

object	&$owner	the search manager
string	$prefix	the prefix for this asset

Returns

boolean public

Definition at line 56 of file funnelback_search_page_edit_fns.inc.

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

Paint links to the default formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 73 of file funnelback_search_page_edit_fns.inc.

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

Paints the default scope options

Parameters

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

Returns

boolean public

Definition at line 696 of file funnelback_search_page_edit_fns.inc.

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

Paint links to the fluster formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 108 of file funnelback_search_page_edit_fns.inc.

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

Paints the search options for choosing the url/collections

Parameters

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

Returns

boolean public

Definition at line 331 of file funnelback_search_page_edit_fns.inc.

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

Paints the scope options

Parameters

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

Returns

boolean public

Definition at line 746 of file funnelback_search_page_edit_fns.inc.

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

Paints the sort options

Parameters

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

Returns

boolean public

Definition at line 640 of file funnelback_search_page_edit_fns.inc.

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

Paint links to the spell formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 140 of file funnelback_search_page_edit_fns.inc.

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

Paint the interface for editing custom type formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 212 of file funnelback_search_page_edit_fns.inc.

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

Processes the default scope options

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 722 of file funnelback_search_page_edit_fns.inc.

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

Processes the search options for choosing the url/collections

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 514 of file funnelback_search_page_edit_fns.inc.

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

Processes the scope options

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 767 of file funnelback_search_page_edit_fns.inc.

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

Processes the sort options

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 669 of file funnelback_search_page_edit_fns.inc.

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

Process the interface for editing custom type formats

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 267 of file funnelback_search_page_edit_fns.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/funnelback/page_templates/funnelback_search_page/funnelback_search_page_edit_fns.inc