Inheritance diagram for MetadataDataObjectAdapter:

Public Member Functions
	__construct ($filterGroup, $mode=null)

	addLocalizedStatements (&$metadataDescription, $propertyName, $localizedValues)

	extractMetadataFromDataObject (&$sourceDataObject)

	extractUnmappedDataObjectMetadataFields (&$dataObject, &$metadataDescription)

	getAssocType ()

	getDataObjectClass ()

	getDataObjectMetadataFieldNames ($translated=true)

	getDataObjectName ()

	getMetadataFieldNames ($translated=true)

	getMetadataNamespace ()

&	getMetadataSchema ()

	getMetadataSchemaName ()

	getMode ()

&	getTargetDataObject ()

&	injectMetadataIntoDataObject (&$metadataDescription, &$targetDataObject)

	injectUnmappedDataObjectMetadataFields (&$metadataDescription, &$dataObject)

&	instantiateDataObject ()

&	instantiateMetadataDescription ()

&	process (&$input)

	setTargetDataObject (&$targetDataObject)

Public Member Functions inherited from PersistableFilter
	__construct ($filterGroup)

	addSetting ($setting)

	getClassName ()

	getFilterGroup ()

	getInternalSettings ()

	getIsTemplate ()

	getLocalizedSettingNames ()

	getParentFilterId ()

	getSetting ($settingName)

	getSettingNames ()

&	getSettings ()

	hasSetting ($settingName)

	hasSettings ()

	setIsTemplate ($isTemplate)

	setParentFilterId ($parentFilterId)

Public Member Functions inherited from Filter
	addError ($message)

	clearErrors ()

&	execute (&$input, $returnErrors=false)

	getDisplayName ()

	getErrors ()

&	getInputType ()

&	getLastInput ()

&	getLastOutput ()

&	getOutputType ()

&	getRuntimeEnvironment ()

	getSequence ()

	hasErrors ()

	isCompatibleWithRuntimeEnvironment ()

	setDisplayName ($displayName)

	setRuntimeEnvironment (&$runtimeEnvironment)

	setSequence ($seq)

	setTransformationType (&$inputType, &$outputType)

	supports (&$input, &$output)

	supportsAsInput (&$input)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	getSetMetadataFieldNames ($translated=true)

	getSupportedExtractionAdapters ()

	getSupportedInjectionAdapters ()

	getSupportedMetadataSchemas ()

	hasData ($key, $locale=null)

	injectMetadata ($metadataDescription)

	removeSupportedMetadataAdapter ($metadataSchemaName)

	setAllData (&$data)

	setData ($key, $value, $locale=null)

	setHasLoadableAdapters ($hasLoadableAdapters)

	setId ($id)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Data Fields
	$_assocType

	$_dataObjectClass

	$_dataObjectName

	$_metadataFieldNames

	$_metadataSchema

	$_metadataSchemaName

	$_mode

Data Fields inherited from PersistableFilter
	$_filterGroup

	$_settings = array()

Data Fields inherited from Filter
	$_errors = array()

	$_input

	$_inputType

	$_output

	$_outputType

	$_runtimeEnvironment = false

Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Additional Inherited Members
Static Public Member Functions inherited from PersistableFilter
static	tempGroup ($inputType, $outputType)

Static Public Member Functions inherited from Filter
static	supportedRuntimeEnvironmentSettings ()

Detailed Description

Class that injects/extracts a meta-data description into/from an application entity object (DataObject).

See also: DataObject; MetadataSchema; MetadataDescription

These adapters have to be persistable as they'll be provided by plug-ins via the filter registry.

Definition at line 29 of file MetadataDataObjectAdapter.inc.php.

Constructor & Destructor Documentation

◆ __construct()

MetadataDataObjectAdapter::__construct	(	$filterGroup,
		$mode = `null`
	)

Constructor

Parameters

$filterGroup FilterGroup

Reimplemented from Filter.

Definition at line 76 of file MetadataDataObjectAdapter.inc.php.

References getDataObjectClass(), Filter\getInputType(), Filter\getOutputType(), and Filter\setDisplayName().

Member Function Documentation

◆ addLocalizedStatements()

MetadataDataObjectAdapter::addLocalizedStatements	(	&	$metadataDescription,
			$propertyName,
			$localizedValues
	)

Set several localized statements in a meta-data schema.

Parameters

$metadataDescription	MetadataDescription
$propertyName	string
$localizedValues	array (keys: locale, values: localized values)

Definition at line 368 of file MetadataDataObjectAdapter.inc.php.

Referenced by extractUnmappedDataObjectMetadataFields().

◆ extractMetadataFromDataObject()

MetadataDataObjectAdapter::extractMetadataFromDataObject ( & $sourceDataObject )

Extract a MetadataDescription from a source DataObject.

Parameters

$sourceDataObject DataObject

Returns: MetadataDescription

Reimplemented in MetadataDescriptionDummyAdapter, and Dc11SchemaArticleAdapter.

Definition at line 238 of file MetadataDataObjectAdapter.inc.php.

Referenced by process().

◆ extractUnmappedDataObjectMetadataFields()

MetadataDataObjectAdapter::extractUnmappedDataObjectMetadataFields	(	&	$dataObject,
		&	$metadataDescription
	)

Directly extract all fields that are not mapped to the data object from the data object's data array.

Parameters

$dataObject	DataObject
$metadataDescription	MetadataDescription

Definition at line 416 of file MetadataDataObjectAdapter.inc.php.

References addLocalizedStatements(), getDataObjectMetadataFieldNames(), and getMetadataSchema().

◆ getAssocType()

MetadataDataObjectAdapter::getAssocType ( )

Get the association type corresponding to the data object type.

Returns: integer

Definition at line 198 of file MetadataDataObjectAdapter.inc.php.

References $_assocType.

Referenced by instantiateMetadataDescription().

◆ getDataObjectClass()

MetadataDataObjectAdapter::getDataObjectClass ( )

Return the data object class name (without the package prefix)

Returns: string

Definition at line 183 of file MetadataDataObjectAdapter.inc.php.

References $_dataObjectClass, and getDataObjectName().

Referenced by __construct(), and instantiateDataObject().

◆ getDataObjectMetadataFieldNames()

MetadataDataObjectAdapter::getDataObjectMetadataFieldNames ( $translated = true )

Return the additional field names introduced by the meta-data schema that need to be persisted in the ..._settings table corresponding to the DataObject which is supported by this adapter. NB: The field names must be prefixed with the meta-data schema namespace identifier.

Parameters

$translated boolean if true, return localized field names, otherwise return additional field names.

Returns: array an array of field names to be persisted.

Reimplemented in Dc11SchemaArticleAdapter.

Definition at line 254 of file MetadataDataObjectAdapter.inc.php.

References getMetadataFieldNames().

Referenced by extractUnmappedDataObjectMetadataFields(), and injectUnmappedDataObjectMetadataFields().

◆ getDataObjectName()

MetadataDataObjectAdapter::getDataObjectName ( )

Get the supported application entity (class) name

Returns: string

Definition at line 173 of file MetadataDataObjectAdapter.inc.php.

References $_dataObjectName.

Referenced by getDataObjectClass(), instantiateDataObject(), and process().

◆ getMetadataFieldNames()

MetadataDataObjectAdapter::getMetadataFieldNames ( $translated = true )

Return all field names introduced by the meta-data schema that might have to be persisted.

Parameters

$translated boolean if true, return localized field names, otherwise return additional field names.

Returns: array an array of field names to be persisted.

Reimplemented from DataObject.

Reimplemented in MetadataDescriptionDummyAdapter.

Definition at line 336 of file MetadataDataObjectAdapter.inc.php.

References getMetadataSchema().

Referenced by getDataObjectMetadataFieldNames().

◆ getMetadataNamespace()

MetadataDataObjectAdapter::getMetadataNamespace ( )

Convenience method that returns the meta-data name space.

Returns: string

Definition at line 164 of file MetadataDataObjectAdapter.inc.php.

References getMetadataSchema().

◆ getMetadataSchema()

& MetadataDataObjectAdapter::getMetadataSchema ( )

Get the supported meta-data schema (lazy load)

Returns: MetadataSchema

Definition at line 147 of file MetadataDataObjectAdapter.inc.php.

References $_metadataSchema, getMetadataSchemaName(), and instantiate().

Referenced by extractUnmappedDataObjectMetadataFields(), MetadataDescriptionDummyAdapter\getMetadataFieldNames(), getMetadataFieldNames(), and getMetadataNamespace().

◆ getMetadataSchemaName()

MetadataDataObjectAdapter::getMetadataSchemaName ( )

Get the fully qualified class name of the supported meta-data schema.

Returns: string

Definition at line 139 of file MetadataDataObjectAdapter.inc.php.

References $_metadataSchemaName.

Referenced by getMetadataSchema(), and instantiateMetadataDescription().

◆ getMode()

MetadataDataObjectAdapter::getMode ( )

One of the METADATA_DOA_*_MODE constants.

Returns: integer

Definition at line 130 of file MetadataDataObjectAdapter.inc.php.

References $_mode.

Referenced by process().

◆ getTargetDataObject()

& MetadataDataObjectAdapter::getTargetDataObject ( )

Get the target data object for meta-data injection.

Parameters

$targetDataObject DataObject

Definition at line 214 of file MetadataDataObjectAdapter.inc.php.

Referenced by process().

◆ injectMetadataIntoDataObject()

& MetadataDataObjectAdapter::injectMetadataIntoDataObject	(	&	$metadataDescription,
		&	$targetDataObject
	)

Inject a MetadataDescription into the target DataObject

Parameters

$metadataDescription	MetadataDescription
$targetDataObject	DataObject

Returns: DataObject

Reimplemented in MetadataDescriptionDummyAdapter, and Dc11SchemaArticleAdapter.

Definition at line 228 of file MetadataDataObjectAdapter.inc.php.

Referenced by process().

◆ injectUnmappedDataObjectMetadataFields()

MetadataDataObjectAdapter::injectUnmappedDataObjectMetadataFields	(	&	$metadataDescription,
		&	$dataObject
	)

Directly inject all fields that are not mapped to the data object into the data object's data array for automatic persistence by the meta-data framework.

Parameters

$metadataDescription	MetadataDescription
$dataObject	DataObject

Definition at line 388 of file MetadataDataObjectAdapter.inc.php.

References getDataObjectMetadataFieldNames().

◆ instantiateDataObject()

& MetadataDataObjectAdapter::instantiateDataObject ( )

Instantiate a new data object of the correct type.

NB: This can be overridden by sub-classes for more complex data objects. The standard implementation assumes there are no constructor args to be set or configurations to be made.