Listing_Engine_Edit_Fns Class Reference

Inheritance diagram for Listing_Engine_Edit_Fns:

Public Member Functions
	__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 42 of file listing_engine_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Definition at line 49 of file listing_engine_edit_fns.inc.

Member Function Documentation

_addNewSortOption	(	&	$options,
			$new_option
	)

Add an option to the sort-by array

The new option is added in such a way as to preserve the positioning of 'no sorting' and 'random' at the end of the list, if that's their current position

Parameters

array	&$options	The current list of options
array	$new_option	Option to add

Returns

void public

Definition at line 1832 of file listing_engine_edit_fns.inc.

_getAvailableTypes

(

&

$asset

)

Gets a list of the available asset types that can be use for type formats.

Parameters

object

&$asset

the asset whose interface we are painting

Returns

boolean public

Definition at line 676 of file listing_engine_edit_fns.inc.

_getStandardSortByOptions

(

&

$asset

)

Get the possible 'sort by' options

Parameters

object

&$asset

asset being painted

Returns

array protected

Definition at line 2231 of file listing_engine_edit_fns.inc.

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

Paint the inteface for configuring asset-attribute sort-by options

Parameters

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

Returns

boolean private

Definition at line 1238 of file listing_engine_edit_fns.inc.

_paintDefaultFormatLink	(		$root_assetid,
			$bodycopy_name,
			$bodycopy_description,
			$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
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 603 of file listing_engine_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 1719 of file listing_engine_edit_fns.inc.

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

Paint the inteface for configuring keyword sort fields

Parameters

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

Returns

boolean private

Definition at line 1572 of file listing_engine_edit_fns.inc.

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

Paint the inteface for configuring metadata-field-value sort-by options

Parameters

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

Returns

boolean private

Definition at line 1426 of file listing_engine_edit_fns.inc.

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

Paint the inteface for configuring standard asset field sort-by options

Parameters

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

Returns

boolean private

Definition at line 1095 of file listing_engine_edit_fns.inc.

_paintStructuredTypes	(	&	$asset,
		&	$o,
			$prefix,
		&	$options
	)

Paint the interface for changing the dropdown lists options

Parameters

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

Returns

boolean public

Definition at line 3671 of file listing_engine_edit_fns.inc.

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

Process the inteface for configuring asset-attribute sort-by options

Parameters

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

Returns

boolean private

Definition at line 1364 of file listing_engine_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 1772 of file listing_engine_edit_fns.inc.

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

Process the inteface for configuring keyword sort fields

Parameters

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

Returns

boolean private

Definition at line 1670 of file listing_engine_edit_fns.inc.

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

Process the inteface for configuring metadata-field-value sort-by options

Parameters

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

Returns

boolean private

Definition at line 1524 of file listing_engine_edit_fns.inc.

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

Process the inteface for configuring standard asset field sort-by options

Parameters

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

Returns

boolean private

Definition at line 1197 of file listing_engine_edit_fns.inc.

_processStructuredTypes	(	&	$asset,
		&	$o,
			$prefix,
		&	$options
	)

Process the interface for editing the dropdown lists options

Parameters

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

Returns

boolean public

Definition at line 3731 of file listing_engine_edit_fns.inc.

isAZListing	(	&	$asset,
			$prefix
	)

Returns TRUE if this is A-Z listing format

Even though it looks trivial, this is required to perfom some show_if checks on the backend edit interface

Parameters

object	&$asset	The asset that we are using for this interface
string	$prefix	the prefix for this asset

Returns

boolean public

Definition at line 3967 of file listing_engine_edit_fns.inc.

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

Paint the interface for selecting assets to be excluded

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 4204 of file listing_engine_edit_fns.inc.

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

Paint the interface for editing custom asset positions

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 201 of file listing_engine_edit_fns.inc.

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

Paint the interface for choosing which asset types to list

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 68 of file listing_engine_edit_fns.inc.

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

Paints the interface for previewing the column layout

Parameters

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

Returns

boolean public

Definition at line 491 of file listing_engine_edit_fns.inc.

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

Paints the interface for setting the number of columns to display per row

Parameters

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

Returns

boolean public

Definition at line 342 of file listing_engine_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 568 of file listing_engine_edit_fns.inc.

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

Paints the inteface for choosing a default sort by field

Parameters

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

Returns

boolean public

Definition at line 1908 of file listing_engine_edit_fns.inc.

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

Paints the inteface for changing the default sort direction text

Parameters

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

Returns

boolean public

Definition at line 2177 of file listing_engine_edit_fns.inc.

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

Paint the Group By field

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 2356 of file listing_engine_edit_fns.inc.

paintGroupByKeyword	(	&	$asset,
		&	$o,
			$prefix,
			$group_by_option
	)

Paint 'Group By Standard Asset Field' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
array	$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2891 of file listing_engine_edit_fns.inc.

paintGroupByMetadata	(	&	$asset,
		&	$o,
			$prefix,
			$group_by_option
	)

Paint 'Group By Metadata' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
array	$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2557 of file listing_engine_edit_fns.inc.

paintGroupByParentAsset	(	&	$asset,
		&	$o,
			$prefix,
			$group_by_option
	)

Paint 'Group By Parent Asset' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
array	$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2726 of file listing_engine_edit_fns.inc.

paintGroupByStandardAssetField	(	&	$asset,
		&	$o,
			$prefix,
			$group_by_option
	)

Paint 'Group By Standard Asset Field' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
array	$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2645 of file listing_engine_edit_fns.inc.

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

Paint the interface for Group 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 634 of file listing_engine_edit_fns.inc.

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

Paints the inteface for choosing a sort by raw or presentation value

Parameters

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

Returns

boolean public

Definition at line 1856 of file listing_engine_edit_fns.inc.

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

Paint a place to add a new 'Group By' field

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 2956 of file listing_engine_edit_fns.inc.

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

Paint the interface for selecting searched permissions

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 3592 of file listing_engine_edit_fns.inc.

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

Paint the interface for editing custom position 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 864 of file listing_engine_edit_fns.inc.

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

Paints the list of current proxy asset types (when one of these asset returns a list of result, the children are listed rather than the proxy itself)

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 4058 of file listing_engine_edit_fns.inc.

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

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

Returns

boolean public

Definition at line 2255 of file listing_engine_edit_fns.inc.

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

Paint the interface for selecting root nodes to exclude. All children of root nodes will be excluded

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 4270 of file listing_engine_edit_fns.inc.

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

Paint the current Asset Selections

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 3089 of file listing_engine_edit_fns.inc.

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

Paints the interface for re ordering the sort options

Parameters

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

Returns

boolean public

Definition at line 1991 of file listing_engine_edit_fns.inc.

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

Paints the interface for managing sort-by options

Parameters

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

Returns

boolean public

Definition at line 1007 of file listing_engine_edit_fns.inc.

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

Paint the interface for selecting searched statuses

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 3512 of file listing_engine_edit_fns.inc.

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

Paint the interface for a single set of selectable create locations

Parameters

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

Returns

void public

Definition at line 3764 of file listing_engine_edit_fns.inc.

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

Paint the current Asset Targets

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 3335 of file listing_engine_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 702 of file listing_engine_edit_fns.inc.

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

Process use format bodycopy dropdown

This function returns boolean FALSE if write access to links cannot be gained on the listing engine asset, TRUE otherwise.

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 3987 of file listing_engine_edit_fns.inc.

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

Processes the interface for selecting assets to be excluded

Parameters

object	&$asset	the asset to which we belong
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns

boolean public

Definition at line 4239 of file listing_engine_edit_fns.inc.

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

Process the interface for editing custom asset positions

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 291 of file listing_engine_edit_fns.inc.

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

Process the asset types to list

When a type is removed from the listing, the type format bodycopy is removed. We need to be able to have type formats for the children of all our proxy asset types.

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 131 of file listing_engine_edit_fns.inc.

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

Processes the interface for previewing the column layout

Parameters

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

Returns

void public

Definition at line 551 of file listing_engine_edit_fns.inc.

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

Processes the interface for setting the number of columns to display per row

Parameters

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

Returns

void public

Definition at line 436 of file listing_engine_edit_fns.inc.

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

Processes the default sort by option

Parameters

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

Returns

boolean public

Definition at line 1948 of file listing_engine_edit_fns.inc.

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

Processes the inteface for changing the default sort direction text

Parameters

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

Returns

boolean public

Definition at line 2210 of file listing_engine_edit_fns.inc.

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

Process the Group By field

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 2483 of file listing_engine_edit_fns.inc.

processGroupByKeyword	(	&	$asset,
		&	$o,
			$prefix,
			$key,
		&	$group_by_option
	)

Process 'Group By Standard Asset Field' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
int	$key	key
array	&$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2925 of file listing_engine_edit_fns.inc.

processGroupByMetadata	(	&	$asset,
		&	$o,
			$prefix,
			$key,
		&	$group_by_option
	)

Paint 'Group By Metadata' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
int	$key	key
array	&$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2609 of file listing_engine_edit_fns.inc.

processGroupByParentAsset	(	&	$asset,
		&	$o,
			$prefix,
			$key,
		&	$group_by_option
	)

Process 'Group By Parent Asset' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
int	$key	key
array	&$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2839 of file listing_engine_edit_fns.inc.

processGroupByStandardAssetField	(	&	$asset,
		&	$o,
			$prefix,
			$key,
		&	$group_by_option
	)

Process 'Group By Standard Asset Field' Option

Parameters

object	&$asset	asset being painted
object	&$o	backend outputter
string	$prefix	prefix for the html doc element name
int	$key	key
array	&$group_by_option	the 'group by' array element

Returns

boolean public

Definition at line 2694 of file listing_engine_edit_fns.inc.

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

Processes the sort by raw/presentation value option

Parameters

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

Returns

boolean public

Definition at line 1887 of file listing_engine_edit_fns.inc.

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

Process the 'new Group By field' field

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 2997 of file listing_engine_edit_fns.inc.

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

Processes the interface for selecting searched permissions

Parameters

object	&$asset	the asset to which we belong
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns

boolean public

Definition at line 3641 of file listing_engine_edit_fns.inc.

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

Process the interface for editing custom position 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 940 of file listing_engine_edit_fns.inc.

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

Processes the list of current proxy asset types

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 4159 of file listing_engine_edit_fns.inc.

processRootNode	(	&	$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 2289 of file listing_engine_edit_fns.inc.

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

Processes the interface for selecting root nodes to exclude. All children of root nodes will be excluded

Parameters

object	&$asset	the asset to which we belong
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns

boolean public

Definition at line 4303 of file listing_engine_edit_fns.inc.

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

Process Asset Selection modifications and deletions

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 3238 of file listing_engine_edit_fns.inc.

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

Processes the interface for re ordering the sort options

Parameters

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

Returns

boolean public

Definition at line 2143 of file listing_engine_edit_fns.inc.

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

Process the inteface for managing sort-by options

Parameters

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

Returns

boolean private

Definition at line 1065 of file listing_engine_edit_fns.inc.

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

Processes the interface for selecting searched statuses

Parameters

object	&$asset	the asset to which we belong
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns

boolean public

Definition at line 3558 of file listing_engine_edit_fns.inc.

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

Paint the interface for a single set of selectable create locations

Parameters

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

Returns

void public

Definition at line 3915 of file listing_engine_edit_fns.inc.

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

Process Asset Target modifications and deletions

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 3453 of file listing_engine_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 790 of file listing_engine_edit_fns.inc.

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

Process use format bodycopy

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 4024 of file listing_engine_edit_fns.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/listing_engine/listing_engine_edit_fns.inc