Search_Manager_Edit_Fns Class Reference

Inheritance diagram for Search_Manager_Edit_Fns:

Public Member Functions
	__construct ()
	paintAssetWeights (&$asset, &$o, $prefix)
	processAssetWeights (&$asset, &$o, $prefix)
	paintAssetTreeWeights (&$asset, &$o, $prefix)
	processAssetTreeWeights (&$asset, &$o, $prefix)
	paintMetadataWeights (&$asset, &$o, $prefix)
	processMetadataWeights (&$asset, &$o, $prefix)
	paintGlobalWeights (&$asset, &$o, $prefix)
	processGlobalWeights (&$asset, &$o, $prefix)
	_paintTreeWeightInterface (&$asset, &$o, $prefix, $assetid, $paint_customised=TRUE)
	_paintAssetWeightInterface (&$asset, &$o, $prefix, $weights)
	_paintAttributeWeightInterface (&$asset, &$o, $prefix, $weights, $type_code)
	_paintMetadataWeightInterface (&$asset, &$o, $prefix, $weights)
	_paintAssetTypeChooser ($field_name, $selected_type_code)
	_paintWeightingSourceInterface (&$asset, &$o, $prefix, $screen, $field_suffix='')
	_paintCurrentCustomisations (&$asset, &$o, $prefix, $weights, $screen)
	_getDisplayName ($key, $screen)
	_getCurrentCustomisation ($prefix, $screen)
	_getPostField ($screen)
	_paintWeightInterface (&$asset, &$o, $prefix, $screen, $customised=Array(), $weights=NULL)
	_processWeights (&$asset, &$o, $prefix, $screen)
	_processAssetWeights ($prefix, &$weights)
	_processAttributeWeights ($prefix, &$weights)
	_processMetadataWeights ($prefix, &$weights)
	_removeUnwantedCustomisations ($prefix, $screen, &$weights)
	_customisationsRemoved ($prefix, $screen)
	paintReindexing (&$asset, &$o, $prefix)
	processReindexing (&$asset, &$o, $prefix)
	paintNoiseWords (&$asset, &$o, $prefix)
	processNoiseWords (&$asset, &$o, $prefix)
	paintWhiteWords (&$asset, &$o, $prefix)
	processWhiteWords (&$asset, &$o, $prefix)
	indexingOn (&$owner, $prefix)
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 31 of file search_manager_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

)

Constructor

See Also

Asset_Edit_Fns::Asset_Edit_Fns

Definition at line 40 of file search_manager_edit_fns.inc.

Member Function Documentation

_customisationsRemoved	(		$prefix,
			$screen
	)

Returns true if customisations were removed in the last save action

Parameters

string	$prefix	the field prefix
string	$screen	the screen being processed

Returns

boolean private

Definition at line 1150 of file search_manager_edit_fns.inc.

_getCurrentCustomisation	(		$prefix,
			$screen
	)

Returns the key of the current source being customised

Parameters

string	$prefix	the field prefix
string	$screen	the screen currently being processed

Returns

string private

Definition at line 768 of file search_manager_edit_fns.inc.

_getDisplayName	(		$key,
			$screen
	)

Returns the displayable name for the specified key and screen

Parameters

string	$key	the key - which is either an assetid or type code
string	$screen	the current screen being painted

Returns

string private

Definition at line 739 of file search_manager_edit_fns.inc.

_getPostField

(

$screen

)

Returns the field identifier for the specified screen

Parameters

string

$screen

the screen of the wanted identifier

Returns

string private

Definition at line 800 of file search_manager_edit_fns.inc.

_paintAssetTypeChooser	(		$field_name,
			$selected_type_code
	)

Paints the interface for choosing an asset type.

Only non-system assets and instantiable assets and their ancestors are printed

Parameters

string	$field_name	the name to use for the combo box
string	$selected_type_code	the type_code that should be currently selected

Returns

void private

Definition at line 565 of file search_manager_edit_fns.inc.

_paintAssetWeightInterface	(	&	$asset,
		&	$o,
			$prefix,
			$weights
	)

Prints the interface used to specify the weights for asset components

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
array	$weights	the asset weight values

Returns

boolean private

Definition at line 300 of file search_manager_edit_fns.inc.

_paintAttributeWeightInterface	(	&	$asset,
		&	$o,
			$prefix,
			$weights,
			$type_code
	)

Prints the interface used to specify the weights for attributes

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
array	$weights	the attribute weight values
string	$type_code	the type code that the attributes belong to

Returns

boolean private

Definition at line 368 of file search_manager_edit_fns.inc.

_paintCurrentCustomisations	(	&	$asset,
		&	$o,
			$prefix,
			$weights,
			$screen
	)

Paints an interface with the current cusomisations for the specified weights and screen

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
array	$weights	the weights
string	$screen	the current screen

Returns

void private

Definition at line 649 of file search_manager_edit_fns.inc.

_paintMetadataWeightInterface	(	&	$asset,
		&	$o,
			$prefix,
			$weights
	)

Prints the interface used to customise metadata weightings

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
array	$weights	the attribute weight values

Returns

boolean private

Definition at line 445 of file search_manager_edit_fns.inc.

_paintTreeWeightInterface	(	&	$asset,
		&	$o,
			$prefix,
			$assetid,
			$paint_customised = TRUE
	)

Paints the interface for customising tree weightings for the specified asset

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields
string	$assetid	the assetid of the tree root
boolean	$paint_customised	Paint customsised

Returns

boolean private

Definition at line 237 of file search_manager_edit_fns.inc.

_paintWeightingSourceInterface	(	&	$asset,
		&	$o,
			$prefix,
			$screen,
			$field_suffix = ''
	)

Paints the interface for choosing a source to customise

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
string	$screen	the screen being processed
string	$field_suffix	the suffix to append to the field name

Returns

void private

Definition at line 607 of file search_manager_edit_fns.inc.

_paintWeightInterface	(	&	$asset,
		&	$o,
			$prefix,
			$screen,
			$customised = Array(),
			$weights = NULL
	)

Paints the weighting interface for all screens

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
string	$screen	the screen that we are painting
array	$customised	Customisation
array	$weights	the weighting information to display, if null the weights will be obtained based on the screen type

Returns

boolean private

Definition at line 827 of file search_manager_edit_fns.inc.

_processAssetWeights	(		$prefix,
		&	$weights
	)

Processes the weightings for asset component weights

Parameters

string	$prefix	the prefix for fields
array	&$weights	the weights to process

Returns

void private

Definition at line 1018 of file search_manager_edit_fns.inc.

_processAttributeWeights	(		$prefix,
		&	$weights
	)

Processes the weightings for attribute weights

Parameters

string	$prefix	the prefix for fields
array	&$weights	the weights to process

Returns

void private

Definition at line 1049 of file search_manager_edit_fns.inc.

_processMetadataWeights	(		$prefix,
		&	$weights
	)

Processes the weightings for metadata weights

Parameters

string	$prefix	the prefix for fields
array	&$weights	the weights to process

Returns

void private

Definition at line 1079 of file search_manager_edit_fns.inc.

_processWeights	(	&	$asset,
		&	$o,
			$prefix,
			$screen
	)

Processes the weightings for all weightings screen

Parameters

object	&$asset	the search_manager asset
object	&$o	the backend_outputer
string	$prefix	the prefix for fields
string	$screen	the screen to process

Returns

boolean private

Definition at line 907 of file search_manager_edit_fns.inc.

_removeUnwantedCustomisations	(		$prefix,
			$screen,
		&	$weights
	)

Removes any customisations that have been flagged for removal

Parameters

string	$prefix	the field prefix
string	$screen	the screen being processed
array	&$weights	the weights being processed

Returns

void private

Definition at line 1129 of file search_manager_edit_fns.inc.

indexingOn	(	&	$owner,
			$prefix
	)

Returns true if search indexing is on.

Parameters

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

Returns

boolean public

Definition at line 1352 of file search_manager_edit_fns.inc.

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

Paints the interface for customising the asset trees to be indexed

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 104 of file search_manager_edit_fns.inc.

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

Paints the interface for customising the assets to be indexed

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 69 of file search_manager_edit_fns.inc.

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

Paints the interface for customising the global weightings

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 195 of file search_manager_edit_fns.inc.

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

Paints the interface for customising the assets to be indexed

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 156 of file search_manager_edit_fns.inc.

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

Paint the interface for Noise Words

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter object
string	$prefix	the prefix for field

Returns

boolean public

Definition at line 1236 of file search_manager_edit_fns.inc.

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

Paint the interface for queuing a HIPO to reindex the system

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter object
string	$prefix	the prefix for field

Returns

boolean public

Definition at line 1170 of file search_manager_edit_fns.inc.

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

Paint the interface for White Words

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter object
string	$prefix	the prefix for field

Returns

boolean public

Definition at line 1295 of file search_manager_edit_fns.inc.

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

Processes the interface for customising the asset trees to be indexed

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 138 of file search_manager_edit_fns.inc.

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

Processes the interface for customising the assets to be indexed

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 87 of file search_manager_edit_fns.inc.

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

Processes the interface for customising the global weightings

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 217 of file search_manager_edit_fns.inc.

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

Processes the interface for customising the assets to be indexed

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter
string	$prefix	the prefix for fields

Returns

boolean public

Definition at line 174 of file search_manager_edit_fns.inc.

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

Process the interface for adding noise words

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter object
string	$prefix	the prefix for field

Returns

boolean public

Definition at line 1263 of file search_manager_edit_fns.inc.

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

Process the interface for queuing a HIPO to reindex the system

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter object
string	$prefix	the prefix for field

Returns

boolean public

Definition at line 1196 of file search_manager_edit_fns.inc.

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

Process the interface for adding white words

Parameters

object	&$asset	the search manager asset
object	&$o	the backend outputter object
string	$prefix	the prefix for field

Returns

boolean public

Definition at line 1322 of file search_manager_edit_fns.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/search/search_manager/search_manager_edit_fns.inc