Class: EmailRule

Source Location: /framework/validation/rules/email.inc.php

http://wact.sourceforge.net/index.php/EmailRule

Class Overview

Rule
   |
   --SingleFieldRule
      |
      --DomainRule
         |
         --EmailRule

Check for a valid email address.

Methods

Child classes:

DNSEmailRule: Check for a valid email address and verify that a mail server DNS record exists for this address.

Inherited Variables

Class: SingleFieldRule

SingleFieldRule::$ErrorList
SingleFieldRule::$fieldname
SingleFieldRule::$IsValid

Class: Rule

Rule::$Group

Inherited Methods

Class: DomainRule

DomainRule::DomainRule(): Constructs a DomainRule
DomainRule::Check(): Performs validation of a single value

Class: SingleFieldRule

SingleFieldRule::SingleFieldRule(): Constructs Rule
SingleFieldRule::Check(): Check a Single Value to see if its valid
SingleFieldRule::Error(): Signal that an error has occurred.
SingleFieldRule::getField(): Returns the fieldname the rule applies to
SingleFieldRule::IsValid(): Have we already determined this error to be invalid?
SingleFieldRule::validate(): Perform validation

Class: Rule

Rule::setGroup(): Sets the error message group (related to the vars file)
Rule::validate(): Perform validation

Class Details

Check for a valid email address.

todo:	Find the RFC that describes valid email addresses and post a link to it here.
access:	public
see:	http://wact.sourceforge.net/index.php/EmailRule

Class Methods

constructor EmailRule

Constructs a EmailRule

EmailRule EmailRule(
string
$fieldname, array
1)

API Tags:

access:

public

Parameters:

array	1	of acceptable values
string	$fieldname	fieldname to validate

method Check

Performs validation of a single value

void Check(
string
$value)

API Tags:

access:

protected

Overrides DomainRule::Check() (Performs validation of a single value)

Parameters:

string

$value

value to validate

method CheckDomain

Performs validation of an email domain

void CheckDomain(
string
$value)

API Tags:

access:

protected

Overridden in child classes as:

DNSEmailRule::CheckDomain(): Performs validation of a single value

Parameters:

string

$value

value to validate

method CheckUser

Performs validation of an email user

void CheckUser(
string
$value)

API Tags:

TODO:	Verify that this is reasonable:
access:	protected

Parameters:

string

$value

value to validate

Documentation generated on Sun, 28 Nov 2004 19:46:06 -0800 by phpDocumentor 1.2.3