Open Journal Systems  3.3.0
MetadataTypeDescription Class Reference
Inheritance diagram for MetadataTypeDescription:
ClassTypeDescription TypeDescription

Public Member Functions

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

Data Fields

 $_assocType
 
 $_metadataSchemaClassName
 
 $_metadataSchemaPackageName
 
- Data Fields inherited from ClassTypeDescription
 $_className
 
 $_packageName
 
- Data Fields 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)

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

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

Constructor & Destructor Documentation

◆ __construct()

MetadataTypeDescription::__construct (   $typeName)

Constructor

Parameters
$typeNamestring a fully qualified class name.

Reimplemented from ClassTypeDescription.

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

Member Function Documentation

◆ checkType()

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

Reimplemented from ClassTypeDescription.

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

◆ getAssocType()

MetadataTypeDescription::getAssocType ( )
Returns
integer

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

References $_assocType.

◆ getMetadataSchemaClass()

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

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

References $_metadataSchemaClassName.

◆ getNamespace()

MetadataTypeDescription::getNamespace ( )
See also
TypeDescription::getNamespace()

Reimplemented from ClassTypeDescription.

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

◆ parseTypeName()

MetadataTypeDescription::parseTypeName (   $typeName)

Field Documentation

◆ $_assocType

integer MetadataTypeDescription::$_assocType

the expected assoc type of the meta-data description

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

Referenced by getAssocType().

◆ $_metadataSchemaClassName

string MetadataTypeDescription::$_metadataSchemaClassName

the expected meta-data schema class

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

Referenced by getMetadataSchemaClass().

◆ $_metadataSchemaPackageName

string MetadataTypeDescription::$_metadataSchemaPackageName

the expected meta-data schema package

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


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