Public Member Functions | |
| __construct ($typeName) | |
| checkType (&$object) | |
| getNamespace () | |
| parseTypeName ($typeName) | |
| splitClassName ($typeName) | |
 Public Member Functions inherited from TypeDescription | |
| _parseTypeNameInternally ($typeName) | |
| getTypeDescription () | |
| getTypeName () | |
| isCompatible ($object) | |
Data Fields | |
| $_className | |
| $_packageName | |
| Data Fields inherited from TypeDescription | |
| $_cardinality | |
| $_typeName | |
Detailed Description
A type description that validates objects by class type.
Example type identifier: 'class::lib.pkp.classes.submission.PKPSubmission'
Definition at line 20 of file ClassTypeDescription.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| ClassTypeDescription::__construct | ( | $typeName | ) |
Constructor
- Parameters
-
$typeName string a fully qualified class name.
Reimplemented from TypeDescription.
Reimplemented in MetadataTypeDescription.
Definition at line 38 of file ClassTypeDescription.inc.php.
Member Function Documentation
◆ checkType()
| ClassTypeDescription::checkType | ( | & | $object | ) |
- See also
- TypeDescription::checkType()
Reimplemented from TypeDescription.
Reimplemented in MetadataTypeDescription.
Definition at line 74 of file ClassTypeDescription.inc.php.
◆ getNamespace()
| ClassTypeDescription::getNamespace | ( | ) |
- See also
- TypeDescription::getNamespace()
Reimplemented from TypeDescription.
Reimplemented in MetadataTypeDescription.
Definition at line 48 of file ClassTypeDescription.inc.php.
◆ parseTypeName()
| ClassTypeDescription::parseTypeName | ( | $typeName | ) |
- See also
- TypeDescription::parseTypeName()
Reimplemented from TypeDescription.
Reimplemented in MetadataTypeDescription.
Definition at line 59 of file ClassTypeDescription.inc.php.
References splitClassName().
◆ splitClassName()
| ClassTypeDescription::splitClassName | ( | $typeName | ) |
Splits a fully qualified class name into a package and a class name string.
- Parameters
-
$typeName the type name to be split up.
- Returns
- array an array with the package name as its first entry and the class name as its second entry.
Definition at line 96 of file ClassTypeDescription.inc.php.
Referenced by parseTypeName(), and MetadataTypeDescription\parseTypeName().
Field Documentation
◆ $_className
| string ClassTypeDescription::$_className |
a valid class name
Definition at line 25 of file ClassTypeDescription.inc.php.
◆ $_packageName
| string ClassTypeDescription::$_packageName |
a valid package name
Definition at line 31 of file ClassTypeDescription.inc.php.
The documentation for this class was generated from the following file:
