Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
MetadataTypeDescription Class Reference
Inheritance diagram for MetadataTypeDescription:
ClassTypeDescription TypeDescription

Public Member Functions

 checkType (&$object)
 
 getAssocType ()
 
 getMetadataSchemaClass ()
 
 getNamespace ()
 
 MetadataTypeDescription ($typeName)
 
 parseTypeName ($typeName)
 
- Public Member Functions inherited from ClassTypeDescription
 checkType (&$object)
 
 ClassTypeDescription ($typeName)
 
 getNamespace ()
 
 parseTypeName ($typeName)
 
 splitClassName ($typeName)
 
- Public Member Functions inherited from TypeDescription
 _parseTypeNameInternally ($typeName)
 
 checkType (&$object)
 
 getNamespace ()
 
 getTypeDescription ()
 
 getTypeName ()
 
 isCompatible ($object)
 
 parseTypeName ($typeName)
 
 TypeDescription ($typeName)
 

Public Attributes

 $_assocType
 
 $_metadataSchemaClassName
 
 $_metadataSchemaPackageName
 
- Public Attributes inherited from ClassTypeDescription
 $_className
 
 $_packageName
 
- Public Attributes inherited from TypeDescription
 $_cardinality
 
 $_typeName
 

Detailed Description

Type validator for metadata input/output.

This type description accepts descriptors of the following form: metadata::fully.qualified.MetadataSchema(ASSOC)

e.g.: metadata::lib.pkp.plugins.metadata.nlm30.schema.Nlm30CitationSchema(ARTICLE)

The assoc form must be the final part of a ASSOC_TYPE_* definition. It can be '*' to designate any assoc type.

Definition at line 28 of file MetadataTypeDescription.inc.php.

Member Function Documentation

MetadataTypeDescription::checkType ( $object)
See Also
TypeDescription::checkType()

Definition at line 120 of file MetadataTypeDescription.inc.php.

References $_assocType.

MetadataTypeDescription::getAssocType ( )
Returns
integer

Definition at line 77 of file MetadataTypeDescription.inc.php.

MetadataTypeDescription::getMetadataSchemaClass ( )
Returns
string the fully qualified class name of the meta-data schema.

Definition at line 70 of file MetadataTypeDescription.inc.php.

MetadataTypeDescription::getNamespace ( )
MetadataTypeDescription::MetadataTypeDescription (   $typeName)

Constructor

Parameters
$typeNamestring a fully qualified class name.

Definition at line 53 of file MetadataTypeDescription.inc.php.

MetadataTypeDescription::parseTypeName (   $typeName)

Member Data Documentation

integer MetadataTypeDescription::$_assocType

the expected assoc type of the meta-data description

Definition at line 45 of file MetadataTypeDescription.inc.php.

Referenced by checkType().

string MetadataTypeDescription::$_metadataSchemaClassName

the expected meta-data schema class

Definition at line 39 of file MetadataTypeDescription.inc.php.

string MetadataTypeDescription::$_metadataSchemaPackageName

the expected meta-data schema package

Definition at line 33 of file MetadataTypeDescription.inc.php.


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