Open Journal Systems  3.3.0
FormValidatorEmail Class Reference
Inheritance diagram for FormValidatorEmail:
FormValidator

Public Member Functions

 __construct (&$form, $field, $type='optional', $message='email.invalid')
 
 getMessage ()
 
- Public Member Functions inherited from FormValidator
 __construct (&$form, $field, $type, $message, $validator=null)
 
 getField ()
 
 getFieldValue ()
 
getForm ()
 
 getType ()
 
getValidator ()
 
 isEmptyAndOptional ()
 
 isValid ()
 

Additional Inherited Members

- Data Fields inherited from FormValidator
 $_field
 
 $_form
 
 $_message
 
 $_type
 
 $_validator
 

Detailed Description

Form validation check for email addresses.

See also
FormValidator

Definition at line 20 of file FormValidatorEmail.inc.php.

Constructor & Destructor Documentation

◆ __construct()

FormValidatorEmail::__construct ( $form,
  $field,
  $type = 'optional',
  $message = 'email.invalid' 
)

Constructor.

Parameters
$formForm the associated form
$fieldstring the name of the associated field
$typestring the type of check, either "required" or "optional"
$messagestring the error message for validation failures (i18n key)

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

Member Function Documentation

◆ getMessage()

FormValidatorEmail::getMessage ( )

Get the error message associated with a failed validation check.

Returns
string

Reimplemented from FormValidator.

Definition at line 34 of file FormValidatorEmail.inc.php.

References FormValidator\getFieldValue().


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