Open Journal Systems  3.3.0
ValidatorTypeDescription Class Reference
Inheritance diagram for ValidatorTypeDescription:
PrimitiveTypeDescription TypeDescription

Public Member Functions

 __construct ($typeName)
 
 checkType (&$object)
 
 getNamespace ()
 
 parseTypeName ($typeName)
 
- Public Member Functions inherited from PrimitiveTypeDescription
 _getPrimitiveTypeName (&$variable)
 
- Public Member Functions inherited from TypeDescription
 _parseTypeNameInternally ($typeName)
 
 getTypeDescription ()
 
 getTypeName ()
 
 isCompatible ($object)
 

Data Fields

 $_validatorArgs
 
 $_validatorClassName
 
- Data Fields inherited from PrimitiveTypeDescription
 $_primitiveType
 
- Data Fields inherited from TypeDescription
 $_cardinality
 
 $_typeName
 

Additional Inherited Members

- Static Public Member Functions inherited from PrimitiveTypeDescription
static _supportedPrimitiveTypes ()
 

Detailed Description

Class that describes a string input/output type that passes additional validation (via standard validator classes).

Definition at line 19 of file ValidatorTypeDescription.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ValidatorTypeDescription::__construct (   $typeName)

Constructor

Parameters
$typeNamestring Allowed primitive types are 'integer', 'string', 'float' and 'boolean'.

Reimplemented from PrimitiveTypeDescription.

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

Member Function Documentation

◆ checkType()

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

Reimplemented from PrimitiveTypeDescription.

Definition at line 93 of file ValidatorTypeDescription.inc.php.

◆ getNamespace()

ValidatorTypeDescription::getNamespace ( )
See also
TypeDescription::getNamespace()

Reimplemented from PrimitiveTypeDescription.

Definition at line 49 of file ValidatorTypeDescription.inc.php.

◆ parseTypeName()

ValidatorTypeDescription::parseTypeName (   $typeName)

Field Documentation

◆ $_validatorArgs

array ValidatorTypeDescription::$_validatorArgs

arguments to be passed to the validator constructor

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

◆ $_validatorClassName

string ValidatorTypeDescription::$_validatorClassName

the validator class name

Definition at line 24 of file ValidatorTypeDescription.inc.php.


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