Inheritance diagram for Metadata_Field_Select:

Public Member Functions
	__construct ($assetid=0)

	setAttrValue ($name, $value)

	getSelectionAttribute ()

	getMetadataValue (Asset $asset, $value_str)

	getValueFromKey ($option_str)

	getContextedSelectOptions ()

	getKeyFromValue ($option_str)

	getAdditionalKeywordReplacement ($host_assetid, $additional_keyword, $contextid=NULL)

	importOptionsFromCSV ($filename, $header=FALSE)

Public Member Functions inherited from Metadata_Field
	__construct ($assetid=0)

	_getAllowedLinks ()

	getDefaultValue ()

	getMetadataValue (Asset $asset, $value_str)

	saveAttributes ($dont_run_updated=FALSE)

	delete ($release_lock=TRUE)

	getAdditionalKeywordReplacement ($additional_keyword)

Public Member Functions inherited from Asset
	Asset ($assetid=0)

	create (Array &$link)

	load ($assetid)

	_loadDataPaths ()

	reload ()

	canDelete ()

	delete ($release_lock=TRUE, $check_locked=TRUE)

	useSystemVersion ()

	loadSystemVersion ()

	saveSystemVersion ()

	clearSystemVersion ()

	revertToSystemVersion ()

	revertNoticeLinksToSystemVersion ()

	_updated ($update_parents=TRUE)

	type ()

	getTypeAncestors ($include_asset=TRUE)

	incrementVersion ($number='micro', $update_parents=TRUE)

	getLanguages ()

	setLanguages (Array $languages)

	setCharset ($charset)

	setForceSecure ($force_secure)

	remapAssetids (Array $map)

	morph ($new_type_code)

	_morphCleanup ($new_type_code)

	onRequestKeywords (Asset $broadcaster, Array $vars=Array())

	canClone ()

	cloneComponents (Asset $clone, Array $components, $override=FALSE)

	cloneComponentsAdditional (Asset $clone, Array $components)

	cloneLinks (Asset $clone)

	getStatus ()

	getAvailableStatii ()

	getStatusDescription ()

	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)

	setDate ($date_type, $time=NULL, $userid=NULL)

	lockTypes ()

	canForceablyAcquireLock ($lock_type)

	getEditingLocks ($keywords)

	_getAllowedLinks ()

	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)

	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)

	canCreateLink (Asset $minor, $link_type, $exclusive)

	canMoveLink (Asset $minor, Asset $old_major, $link_type)

	describeLink ($linkid)

	isDeletableLink ($linkid)

	canDeleteLink ($linkid)

	deleteLink ($linkid, $check_locked=TRUE)

	linksUpdated ()

	canCloneLink ()

	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)

	setAttrValue ($name, $value)

	attr ($name)

&	attrByRef ($name)

	getAttribute ($name, $mute_errors=FALSE)

	getAssetKeywords ($descriptions=FALSE)

	getAvailableKeywords ()

	getKeywordReplacement ($keyword)

	getAssetWebPathKeywordReplacement ()

	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)

	processCustomKeywords ($keywords=Array())

	getContent ()

	setContent ()

	getEffectiveLastUpdatedTime ($assetids)

	readAccess (Array $assetids=Array())

	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)

	adminAccess ($lock_type='', Array $assetids=Array())

	backendAccess ()

	liveEditAccess ($lock_type)

	canliveEdit ($lock_type)

	effectiveUnrestricted ()

	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)

	accessEffective ()

	permissionsUpdated ()

	printFrontend ()

	printFrontendAsset (Asset $asset, $design=NULL)

	getValidProtocols ()

	printHead ()

	printBody ()

	getCurrentPaintLayoutName ()

	getCurrentDesignName ()

	printBodyWithPaintLayout ($layout_id='')

	initLimbo ()

	printLimbo ()

	paintBackend (Backend_Outputter $o)

	getPrefix ()

	processBackend (Backend_Outputter $o, Array &$link)

	getEI ()

	getEditFns ()

	getBackendHref ($screen='', $backend_page=TRUE)

	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)

	getURLs ()

	getHref ($base_url=NULL, $ignore_rollback=FALSE)

	getWebDataPath ()

	getWebPaths ()

	saveWebPaths ($paths, $auto_add_remaps=TRUE)

	getLookups ($field='')

	getDesignLookups ()

	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)

	deleteLookupValue ($layout_name, $layout_value)

	setPaintLayouts ($layouts)

	updateLookups ($auto_add_remaps=TRUE)

	setLookupValues (Array $values)

	getAssetStatusDescriptionKeywordReplacement ()

	getAssetStatusColourKeywordReplacement ()

	replaceKeywordsInString ($string)

	fastTrack ($tasks)

	unFastTrack ($tasks)

	shouldFastTrack ($task, $assetid=NULL)

	getFaskTrackedTaskAssetids ($task)

	getDependantParentsURL ()

Public Member Functions inherited from MySource_Object
	MySource_Object ()

	__sleep ()

	__wakeup ()

Protected Member Functions
	_clearContextedSelectOptionsCache ()

Protected Member Functions inherited from Metadata_Field
	_preCreateCheck (Array &$link)

	_getName ($short_name=FALSE)

Protected Member Functions inherited from Asset
	_preCreateCheck (Array &$link)

	_createAdditional (Array &$link)

	_abortCreate ($trigger_level_changed=FALSE, $linkid=0)

	_loadVars ()

	_getName ($short_name=FALSE, $contextid=NULL)

	_getKeywordReplacement ($keyword)

	_checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)

	makeAndSaveInitialWebPath ($path, $parent_link=NULL)

Additional Inherited Members
Static Public Member Functions inherited from Metadata_Field
static	encodeValueString ($value, $components)

static	decodeValueString ($str, &$value, &$components)

Data Fields inherited from Asset
	$id = 0

	$version = ''

	$name = ''

	$short_name = ''

	$status

	$languages = ''

	$charset = ''

	$force_secure = '0'

	$created

	$created_userid

	$updated

	$updated_userid

	$published

	$published_userid

	$status_changed

	$status_changed_userid

	$_is_cacheable = FALSE

	$vars = Array()

	$_available_keywords = Array()

	$data_path_suffix = ''

	$data_path = ''

	$data_path_public = ''

	$_ser_attrs = FALSE

Detailed Description

Definition at line 32 of file metadata_field_select.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 42 of file metadata_field_select.inc.

Member Function Documentation

_clearContextedSelectOptionsCache ( )

protected

Cleans up the contexted select options cache

This resets the cache set up by the above function. When the context is the default, it resets everything (since all contexts depend on it). In an alternate context, it only resets that context's cache.

See Also: Metadata_Field_Select::getContextedSelectOptions()

Returns: void

Definition at line 243 of file metadata_field_select.inc.

getAdditionalKeywordReplacement	(	$host_assetid,
		$additional_keyword,
		$contextid = `NULL`
	)

Return any additional keyword that may be provided by the field

This is mainly used in situations such as returning the current key and value for Select fields. Where a keyword is not supported, the function should return NULL.

Note that if asset_metadata keywords conflict due to additional keywords, the one with the longest field name will prevail. For instance, a keyword 'asset_metadata_field_value' will select a field named 'field_value' over a field named 'field' with an additional keyword 'value'.

Parameters

string	$host_assetid	The ID of the asset that metadata details were requested from
string	$additional_keyword	The additional keyword requested
int	$contextid	Use the stored metadata value for this context. If omitted, use the current context.

Returns: mixed string|NULL

Definition at line 319 of file metadata_field_select.inc.

getContextedSelectOptions ( )

Get the select options that apply to this context

This method gets the current select options saved to the context, and augments them with any keys now in the default context (and its values), and removes the contexts that no longer exist. This is necessary because the default context is the ultimate authority on what kets

These are cached in a _tmp var indexed by context ID, and is cleared when the select_options attribute is saved.

Returns: array

See Also: Metadata_Field_Select::_clearContextedSelectOptionsCache()

Definition at line 185 of file metadata_field_select.inc.

getKeyFromValue ( $option_str )

Returns the option key(s) corresponding to the given option value(s) If no corresponding key is found, the option_str is returned

Parameters

string $option_str an string of one or more option keys

Returns: string public

Definition at line 270 of file metadata_field_select.inc.

getMetadataValue	(	Asset	$asset,
			$value_str
	)

Generate an array of current values for the passed metadata field names

Returns the metadata value for the passed asset

Parameters

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

Returns: string public

Definition at line 118 of file metadata_field_select.inc.

getSelectionAttribute ( )

Get a selection attribute that can be used to paint and process the values of this field

Returns: object public

Definition at line 79 of file metadata_field_select.inc.

getValueFromKey ( $option_str )

Returns the option value(s) corresponding to the given option key(s) If no corresponding value is found, the option_str is returned

Parameters

string $option_str an string of one or more option keys

Returns: string public

Definition at line 138 of file metadata_field_select.inc.

importOptionsFromCSV	(	$filename,
		$header = `FALSE`
	)

Replace options with an imported CSV file.

If 1 column: value only - key is sequentially assigned (from 0) If 2 columns: key, value If 3 columns: key, value, default [1|0]

Parameters

string	$filename	The (temp) file name to import
boolean	$header	Whether the file has a csv header or not

Returns: void

it means its a empty line, discard it !!!

Definition at line 416 of file metadata_field_select.inc.

setAttrValue	(	$name,
		$value
	)

Queue the setting of the value of an attribute

Overrides the default only to clean out the cached select options array when the select options are (re)set, so any future calls to getContextedSelectOptions() are current.

Parameters

string	$name	the name of the attribute
string	$value	the new value of the attribute

Returns: boolean public

See Also: saveAttributes()

Definition at line 63 of file metadata_field_select.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/assets/metadata/metadata_fields/metadata_field_select/metadata_field_select.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation