Inheritance diagram for Metadata_Field:

Public Member Functions
	__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 ()

Static Public Member Functions
static	encodeValueString ($value, $components)

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

Protected Member Functions
	_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
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 31 of file metadata_field.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 41 of file metadata_field.inc.

Member Function Documentation

_getAllowedLinks ( )

Returns an array of all the permitted links type, the type asset and the cardinality

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 97 of file metadata_field.inc.

_getName ( $short_name = FALSE )

protected

Returns name of the asset

Parameters

boolean $short_name whether or not we are after the shortname or the full name

Returns: string private

See Also: Asset::_getName()

Definition at line 83 of file metadata_field.inc.

_preCreateCheck ( Array & $link )

protected

Perform any pre-validation required during the creation of this asset

Folders ensure a name has been set before they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 59 of file metadata_field.inc.

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

static

Takes a full metadata string (i.e. value and value components) and returns the value and value components

example string : This is a test desc; corporateName=squiz UK; jurisdiction=uk; email=brobe.nosp@m.rtso.nosp@m.n@squ.nosp@m.iz.c.nosp@m.o.uk; address=140 Tabernacle St Old Street; // this will return VALUE : This is a test desc COMPONENTS : Array ( [corporateName] => squiz UK [jurisdiction] => uk [email] => brobe.nosp@m.rtso.nosp@m.n@squ.nosp@m.iz.c.nosp@m.o.uk [address] => 140 Tabernacle St Old Street ) Derived from perl-code example located here: From http://dublincore.org/documents/dcmi-dcsv/index.shtml

Parameters

string	$str	the string to decode
string	&$value	the variable to place the value into the value is defined as the concatentation of all strings that don't have a component name (ie a 'name=' before them)
array	&$components	the associative array to put the components into If the array is NOT empty then only components in $str that are elements in $components will be set

Returns: void public

See Also: encodeValueString()

Definition at line 231 of file metadata_field.inc.

delete ( $release_lock = TRUE )

Delete this asset from the trash

Removes any reference to this field from both the 'sq_ast_mdata_dflt_val' and 'sq_ast_mdata_val' tables to avoid phantom entries for assets

Parameters

boolean $release_lock should we realease the lock after deleting

Returns: boolean public

Definition at line 336 of file metadata_field.inc.

static encodeValueString	(	$value,
		$components
	)

static

Takes a metadata value and value-components and returns a properly escaped string

example string : VALUE : This is a test desc COMPONENTS : Array ( [corporateName] => squiz UK [jurisdiction] => uk [email] => brobe.nosp@m.rtso.nosp@m.n@squ.nosp@m.iz.c.nosp@m.o.uk [address] => 140 Tabernacle St Old Street ) // this will return This is a test desc; corporateName=squiz UK; jurisdiction=uk; email=brobe.nosp@m.rtso.nosp@m.n@squ.nosp@m.iz.c.nosp@m.o.uk; address=140 Tabernacle St Old Street; Derived from information found here: From http://dublincore.org/documents/dcmi-dcsv/index.shtml

Parameters

string	$value	the variable to place the value into
array	$components	the associative array to put the components into

Returns: string public

See Also: decodeValueString()

Definition at line 184 of file metadata_field.inc.

getAdditionalKeywordReplacement ( $additional_keyword )

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 $additional_keyword The additional keyword requested

Returns: mixed string|NULL

Definition at line 395 of file metadata_field.inc.

getDefaultValue ( )

Get the default values for this field

Returns: array public

Definition at line 115 of file metadata_field.inc.

getMetadataValue	(	Asset	$asset,
			$value_str
	)

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

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 133 of file metadata_field.inc.

saveAttributes ( $dont_run_updated = FALSE )

Save attributes set with setAttrValue to the database

Overridden in Metadata fields so that the default value can be saved

Parameters

boolean $dont_run_updated if TRUE this->_updated() won't be run (THIS IS ONLY EVER CALLED FROM Asset::create())

Returns: boolean public

See Also: setAttrValue()

Definition at line 284 of file metadata_field.inc.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation