Inheritance diagram for Metadata_Field_Edit_Fns:

Public Member Functions
	__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_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Returns: object public

Definition at line 41 of file metadata_field_edit_fns.inc.

Member Function Documentation

canUsePlainDefault ( Metadata_Field $asset )

Show-if that returns TRUE if we can get away with the default edit interface for a field

Parameters

Metadata_Field $asset The asset being painted/processed

Returns: boolean

Definition at line 493 of file metadata_field_edit_fns.inc.

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

Output the complete metadata tag for this field

Parameters

Metadata_Field	$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 427 of file metadata_field_edit_fns.inc.

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

Paint the field with the interface for filling in metadata values

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$value_str	the current value for this field in the asset (NOT $asset) NULL means that there is no current value set
boolean	$write_access	does the current user have write access to the asset that we are setting metadata for (NOT THE SAME AS $asset)

Returns: boolean public

Definition at line 309 of file metadata_field_edit_fns.inc.

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

Paint the interface for viewing keyword instructions

Parameters

Metadata_Field	$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 59 of file metadata_field_edit_fns.inc.

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

Paint the interface for editing value components

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 100 of file metadata_field_edit_fns.inc.

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

Paint the interface for filling in metadata values

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$value_str	the current value for this field in the asset (NOT $asset) NULL means that there is no current value set
boolean	$write_access	does the current user have write access to the asset that we are setting metadata for (NOT THE SAME AS $asset)
boolean	$enable_default	Whether to show the 'use default' checkbox
string	$type_code	The type_code of the asset that the metadata is being printed

Returns: boolean public

Definition at line 351 of file metadata_field_edit_fns.inc.

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

Process the interface for filling in metadata values

Returns true if this field has been processed, false if not and it should be ignored

Parameters

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

Returns: boolean public

Definition at line 372 of file metadata_field_edit_fns.inc.

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

Processes the interface forview keyword instructions

Note that keyword instructions are not processed so this function always returns false

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 83 of file metadata_field_edit_fns.inc.

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

Processes the interface for editing value components

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 213 of file metadata_field_edit_fns.inc.

requiredFieldsComplete	(	Metadata_Field	$asset,
			$value_str
	)

Check if all required fields have been completed in the values supplied

Parameters

Metadata_Field	$asset	the asset whose metadata we are checking
string	$value_str	the current value for this field in the asset (NOT $asset) NULL means that there is no current value set

Returns: boolean public

Definition at line 389 of file metadata_field_edit_fns.inc.

requiresCustomDefault ( Metadata_Field $asset )

Show-if that returns TRUE if we may need a custom default field

We may require a custom default to replace the normal field if it is a non-contextable field, and we are not in a default context. In this case we should be redirected to a paint/process which will use the default value of the default context.

Parameters

Metadata_Field $asset The asset being painted/processed

Returns: boolean

Definition at line 512 of file metadata_field_edit_fns.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/assets/metadata/metadata_field/metadata_field_edit_fns.inc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation