Inheritance diagram for Metadata_Field_Hierarchy_Edit_Fns:

Public Member Functions
	__construct ()

	paintValueInterface (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $value_str, $write_access, $enable_default=TRUE, $print_cascade_values_option=TRUE)

	processInlineValueInterface (Metadata_Field_Hierarchy $asset, &$new_value_str, &$field_cascade_value)

	paintHierarchy (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	paintDrillDownView ($options, $receptacle_keys, $level_titles, $is_default, $default_keys, $prefix)

	_printJSObjects ($options, $prefix)

	_getImmediateChildren ($options, $parent_string, $target_length=NULL)

	processHierarchy (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	paintEditParams (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	processEditParams (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	generateMetadata (Metadata_Field_Hierarchy $asset, $value_str, &$tag_value, Array &$keywords)

	_sortHierarchyOptions ($hierarchy, $sort_by=0, $show_parents=FALSE, $pad='-')

	getHierarchyTree ($start_value, $options, $pad='; ')

	getParentHierarchy ($value, $options=NULL)

	getChildrenHierarchy ($value, $options=NULL)

	isFlatView (&$asset)

	isDrillDownView (&$asset)

	paintLevelTitles (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	processLevelTitles (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	paintDisplayType (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

	processDisplayType (Metadata_Field_Hierarchy $asset, Backend_Outputter $o, $prefix)

Public Member Functions inherited from Metadata_Field_Edit_Fns
	__construct ()

	paintKeywordInstructions (Metadata_Field $asset, Backend_Outputter $o, $prefix)

	processKeywordInstructions (Metadata_Field $asset, Backend_Outputter $o, $prefix)

	paintValueComponents (Metadata_Field $asset, Backend_Outputter $o, $prefix)

	processValueComponents (Metadata_Field $asset, Backend_Outputter $o, $prefix)

	paintInlineValueInterface (Metadata_Field $asset, Backend_Outputter $o, $value_str, $write_access, $print_cascade_values_option=TRUE, $type_code=NULL)

	paintValueInterface (Metadata_Field $asset, Backend_Outputter $o, $value_str, $write_access, $enable_default=TRUE, $print_cascade_values_option=TRUE, $type_code=NULL)

	processInlineValueInterface (Metadata_Field $asset, &$new_value_str, &$field_cascade_value)

	requiredFieldsComplete (Metadata_Field $asset, $value_str)

	generateMetadata (Metadata_Field $asset, $value_str, &$tag_value, Array &$keywords)

	canUsePlainDefault (Metadata_Field $asset)

	requiresCustomDefault (Metadata_Field $asset)

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 metadata_field_hierarchy_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 39 of file metadata_field_hierarchy_edit_fns.inc.

Member Function Documentation

_getImmediateChildren	(	$options,
		$parent_string,
		$target_length = `NULL`
	)

Gets the immediate children of the passed parent

Parameters

array	$options	The hierarchy options
string	$parent_string	The parent string
int	$target_length	The length of the next child of the passed parent

Returns: array private

Definition at line 681 of file metadata_field_hierarchy_edit_fns.inc.

_printJSObjects	(	$options,
		$prefix
	)

Outputs JS objects needed for the drill-down view

Parameters

array	$options	The hierarchy options
string	$prefix	The prefix of the asset

Returns: void private

Definition at line 648 of file metadata_field_hierarchy_edit_fns.inc.

_sortHierarchyOptions	(	$hierarchy,
		$sort_by = `0`,
		$show_parents = `FALSE`,
		$pad = `'-'`
	)

Sort the hierarchy field

Parameters

array	$hierarchy	An array containing the values to sort
int	$sort_by	The option to sort by (0=No Sort, 1=Sort by Key, 2=Sort by Value)
boolean	$show_parents	The option to show the parents
string	$pad	The character to show the hierarchy levels

Returns: array|NULL public

Definition at line 878 of file metadata_field_hierarchy_edit_fns.inc.

generateMetadata	(	Metadata_Field_Hierarchy	$asset,
			$value_str,
		&	$tag_value,
		Array &	$keywords
	)

Output the complete metadata tag for this field

Parameters

Metadata_Field_Hierarchy	$asset	the asset whose interface we are painting
string	$value_str	the current value for this field in the asset (NOT $asset) NULL means that there is no current value set
array	&$tag_value	the metadata tag value
array	&$keywords	an array we can put keywords in that need replacing

Returns: boolean public

Definition at line 851 of file metadata_field_hierarchy_edit_fns.inc.

getChildrenHierarchy	(	$value,
		$options = `NULL`
	)

Get the children in the hierarchy tree of this value

Parameters

string	$value	A string of the start value
array	$options	The all of the hierarchy options

Returns: array|NULL public

Definition at line 1017 of file metadata_field_hierarchy_edit_fns.inc.

getHierarchyTree	(	$start_value,
		$options,
		$pad = `'; '`
	)

Get the hierarchy tree

Parameters

string	$start_value	A string of the start value
array	$options	The all of the hierarchy options
string	$pad	The character to show the hierarchy levels

Returns: array|NULL public

Definition at line 925 of file metadata_field_hierarchy_edit_fns.inc.

getParentHierarchy	(	$value,
		$options = `NULL`
	)

Get the parents in the hierarchy tree of this value

Parameters

string	$value	A string of the start value
array	$options	The all of the hierarchy options

Returns: array|NULL public

Definition at line 981 of file metadata_field_hierarchy_edit_fns.inc.

isDrillDownView ( & $asset )

Show-if conditional: display drill-down view options if selected

Parameters

object &$asset asset being painted

Returns: boolean public

Definition at line 1062 of file metadata_field_hierarchy_edit_fns.inc.

isFlatView ( & $asset )

Show-if conditional: display flat view options if selected

Parameters

object &$asset asset being painted

Returns: boolean public

Definition at line 1046 of file metadata_field_hierarchy_edit_fns.inc.

paintDisplayType	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paint the interface for setting Display Type

Parameters

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

Returns: boolean public

Definition at line 1153 of file metadata_field_hierarchy_edit_fns.inc.

paintDrillDownView	(	$options,
		$receptacle_keys,
		$level_titles,
		$is_default,
		$default_keys,
		$prefix
	)

Recursively paint the drill-down view of the hierarchy

Parameters

array	$options	The array options
array	$receptacle_keys	The keys of the receptacle box
array	$level_titles	The titles for each level
boolean	$is_default	Whether the 'use default' button is selected
array	$default_keys	The default keys
string	$prefix	Prefix of the asset

Returns: boolean public

Definition at line 418 of file metadata_field_hierarchy_edit_fns.inc.

paintEditParams	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paint the interface for setting hierarchy edit params

Parameters

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

Returns: boolean public

Definition at line 810 of file metadata_field_hierarchy_edit_fns.inc.

paintHierarchy	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paint the interface for hierarchy

Parameters

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

Returns: boolean public

Definition at line 258 of file metadata_field_hierarchy_edit_fns.inc.

paintLevelTitles	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paint the interface for setting level titles

Parameters

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

Returns: boolean public

Definition at line 1080 of file metadata_field_hierarchy_edit_fns.inc.

paintValueInterface	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$value_str,
			$write_access,
			$enable_default = `TRUE`,
			$print_cascade_values_option = `TRUE`
	)

Paint the interface for filling in metadata values

Returns true if a submitable interface has been printed

Parameters

Metadata_Field_Hierarchy	$asset	the metadata field asset whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$value_str	the current value for this field in the owning asset (NOT $asset) NULL means that there is no current value set
boolean	$write_access	whether to allow editing of this field (typically depends on write access to owner and edit of a field)
boolean	$enable_default	Whether to show the 'use default' checkbox

Returns: boolean public

Definition at line 62 of file metadata_field_hierarchy_edit_fns.inc.

processDisplayType	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the interface for setting Display Type

Parameters

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

Returns: boolean public

Definition at line 1182 of file metadata_field_hierarchy_edit_fns.inc.

processEditParams	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the interface for setting hierarchy edit params

Parameters

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

Returns: boolean public

Definition at line 828 of file metadata_field_hierarchy_edit_fns.inc.

processHierarchy	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the interface for hierarchy field

Parameters

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

Returns: boolean public

Definition at line 736 of file metadata_field_hierarchy_edit_fns.inc.

processInlineValueInterface	(	Metadata_Field_Hierarchy	$asset,
		&	$new_value_str,
		&	$field_cascade_value
	)

Process the interface for filling in metadata values

Parameters

Metadata_Field_Hierarchy	$asset	the asset whose interface we are processing
string	&$new_value_str	a string by reference that we can store the new values in
bool	&$field_cascade_value	Whether value updates to this field should cascade to children

Returns: boolean public

Definition at line 211 of file metadata_field_hierarchy_edit_fns.inc.

processLevelTitles	(	Metadata_Field_Hierarchy	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the interface for setting level titles

Parameters

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

Returns: boolean public

Definition at line 1126 of file metadata_field_hierarchy_edit_fns.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/assets/metadata/metadata_fields/metadata_field_hierarchy/metadata_field_hierarchy_edit_fns.inc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation