Formagic
Back to top  

Email rule checks if a valid email address is entered.

The following arguments are supported:

  • (boolean)'checkDns': Performs DNS lookup
package Formagic\Rule
author Marc Schrader
author Florian Sonnenburg
since 0.2.0 First time introduced
inherited_from \Formagic_Rule_Abstract

 Methods

Constructor

__construct(array $arguments = array()) 
Inherited

The default error message that is displayed if the rule is violated can be overwritten by $errorMessage.

see

Parameters

$arguments

array

The rule options.

Returns translated error message of rule

getMessage() : string
Inherited

Returns

stringMessage string

Returns rule type identification string.

getName() : string
Inherited

Returns

stringThe rule name

Sets the error message property.

setMessage(mixed $message) : \Formagic_Rule_Abstract
Inherited

Usually a rule will have one error message string that is used if the validation fails. If neccessary, Formagic_Rule_Abstract::_errorMessage can hold other variables, eg. an array of error messages for different outcomes of the validation process.

Implements a fluent interface pattern.

see

Parameters

$message

mixed

The error message value.

Returns

\Formagic_Rule_Abstract$this object.

Performs rule check

validate(string $value) : boolean

Subclasses have to implement their behavior here.

inherited_from \Formagic_Rule_Abstract::validate()

Parameters

$value

string

Item value object to be validated

Returns

booleanTrue if the item value is email formatted

Abstract of main validate method. Returns boolean value of check success.

validate(string $value) : boolean
Inherited

Subclasses have to implement their behavior here.

Parameters

$value

string

The value to be validated.

Returns

booleanThe rule check result

Initializes email rule.

_init(array $arguments) 

Supported keys:

checkDns:
Boolean flag to decide if a DNS lookup for the given mail domain is performed with the validation
validationStrategy:
Implementation of [Formagic_Rule_EmailValidation_Interface](/classes/Formagic_Rule_EmailValidation_Interface.html) that decides if a mail address is valid.
inherited_from \Formagic_Rule_Abstract::_init()

Parameters

$arguments

array

Array of arguments

Exceptions

\Formagic_Exception If given validationStrategy is not valid

Allows subclass initialization.

_init(array $arguments) : void
Inherited

Parameters

$arguments

array

Array of arguments passed to __construct()

Checks if value is not entered by a user or if the field has not been assigned to the form.

_isNoUserValue($value) : boolean
Inherited

The value 0 (zero) for example could be something the user entered willingly and would be skipped from rule checks when using empty().

Parameters

$value

mixed Value to be checked

Returns

boolean

Returns validation provider for the item.

_getValidationStrategy() : \Formagic_Rule_EmailValidation_Interface

Defaults to Formagic_Rule_EmailValidation_PhpFilter if PHP version suffices, or to more expensive Formagic_Rule_EmailValidation_Regex if not.

Returns

\Formagic_Rule_EmailValidation_Interface

 Properties

 

Default error message

$_message : string

Default

'Please enter a valid mail address'
inherited_from \Formagic_Rule_Abstract::_message
 

Message string

$_message : string

Default

'Please enter a valid value'
 

Defines if reverse lookup of mail domain DNS is executed

$_checkDns : boolean

Default

false
 

Rule type identifier.

$_name : string

Default

 

Validation strategy

$_validationStrategy : \Formagic_Rule_EmailValidation_Interface

Default