Open Journal Systems  3.3.0
MetadataRecord Class Reference

Public Member Functions

 addDescription ($metadataDescription, $replace=true)
 
getDescription ($applicationEntityId)
 
getDescriptions ()
 
 removeDescription ($applicationEntityId)
 
 setDescriptions (&$descriptions)
 

Data Fields

 $_descriptions = array()
 

Detailed Description

Class modeling a meta-data record (DCMI abstract model: an instance of a description set, RDF: a graph of several subject nodes with associated object nodes).

See also
MetadataProperty
MetadataDescription

Definition at line 21 of file MetadataRecord.inc.php.

Member Function Documentation

◆ addDescription()

MetadataRecord::addDescription (   $metadataDescription,
  $replace = true 
)

Add a meta-data description.

Parameters
$metadataDescriptionMetadataDescription
$replacewhether to replace a description if a description for the same application entity instance already exists.
Returns
boolean true if a valid description was added, otherwise false

Definition at line 38 of file MetadataRecord.inc.php.

Referenced by setDescriptions().

◆ getDescription()

& MetadataRecord::getDescription (   $applicationEntityId)

Get a specific description

Parameters
$applicationEntityIdstring consisting of 'assocType:assocId'
Returns
boolean true if the description was found and removed, otherwise false
See also
MetadataRecord::getApplicationEntityIdFromMetadataDescription()

Definition at line 85 of file MetadataRecord.inc.php.

◆ getDescriptions()

& MetadataRecord::getDescriptions ( )

Get all descriptions

Returns
array statements

Definition at line 75 of file MetadataRecord.inc.php.

References $_descriptions.

◆ removeDescription()

MetadataRecord::removeDescription (   $applicationEntityId)

Remove description.

Parameters
$applicationEntityIdstring consisting of 'assocType:assocId'
Returns
boolean true if the description was found and removed, otherwise false
See also
MetadataRecord::getApplicationEntityIdFromMetadataDescription()

Definition at line 61 of file MetadataRecord.inc.php.

◆ setDescriptions()

MetadataRecord::setDescriptions ( $descriptions)

Replace all descriptions at once. If one of the descriptions is invalid then the meta-data record will be empty after this operation.

Parameters
$descriptionsarray descriptions
Returns
boolean true if all descriptions could be added, false otherwise

Definition at line 104 of file MetadataRecord.inc.php.

References addDescription().

Field Documentation

◆ $_descriptions

array MetadataRecord::$_descriptions = array()

the MetadataDescriptions in this record

Definition at line 26 of file MetadataRecord.inc.php.

Referenced by getDescriptions().


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