Minimizes form validation code. More...

Public Member Functions
	FormValidation ($method= 'post')

	setMethod ($method)

	field ($field)

	fieldStore ($field)

	value ($val)

	valueStore ($val)

	getValue ()

	validate ()

	getMessages ()

	required ()

	minLength ($length)

	maxLength ($length)

	rangeLength ($min, $max)

	pregMatch ($regexp)

	email ()

	multipleEmail ()

	number ()

	numeric ()

	greaterThan ($value)

	lessThan ($value)

	equals ($value)

	equalsField ($name)

	alpha ()

	trim ()

	toEntities ($constants=null)

	toXmlEntities ()

Static Public Member Functions
static	isEmail ($email)

static	isNumber ($number)

Data Fields
const	REQUIRED = 0

const	MINIMUM_LENGTH = 1

const	MAXIMUM_LENGTH = 2

const	RANGE_LENGTH = 3

const	PREG_MATCH = 4

const	EMAIL = 5

const	EMAIL_MULTIPLE = 6

const	NUMBER = 7

const	NUMERIC = 8

const	GREATER_THAN = 9

const	LESS_THAN = 10

const	EQUALS = 11

const	EQUALS_FIELD = 12

const	ALPHA = 13

const	ALL_FIELDS = 14

	$method

	$current_field = null

	$current_field_val = null

	$messages_store = false

	$messages

Protected Member Functions
	report ($message_code, $required_value= '')

Detailed Description

Minimizes form validation code.

Version: 1.2

Author: DinuSV

The FormValidation library is a quick and easy way to validate the fields of a form. The process includes selecting the field, chaining the necessary methods in a try-catch block, and displaying the exception.

A list of the validation functions supported by this library :

$fv = new FormValidation('post'); // Form submission type: post/get
$fv->field('field_name'); // field to validate
$fv->required(); // set this field as required
$fv->minLength(15); // minimum required characters
$fv->maxLength(30); // maximum allowed characters
$fv->rangeLength(15, 30); // field must have length between this interval
$fv->pregMatch('/abc/'); // match field against regular expression
$fv->email(); // check if this field is a valid email
$fv->multipleEmail(); // emails separated by comma
$fv->number(); // separators and numbers allowed
$fv->numeric(); // only numbers allowed
$fv->greaterThan(20); // field >= 20
$fv->lessThan(20);  // field =< 20
$fv->equals('abcd');  // field must have the specified value
$fv->equalsField('password_confirm'); // field must be equal to another field
$fv->alpha(); // allow only letters
$fv->trim(); // trim field value
$fv->toEntities(); // convert this fields entities
$fv->toXmlEntities(); // convert ( <, >, &, '' ) to entities

When initializing the library, the constructor takes one optional argument representing the method the form was submited by ( post / get ). The default value is post. If you're autoloading this library, and have a form submitted by get, make sure you change the value with setMethod().

$this->formvalidation->setMethod('get');

This library can validate either selected field using the field() method, or values using the value() method. All validation functions throw an InvalidFieldException if the field does not meet specified criteria. The message can be received from the exception by using the `getMessage() function, and the field name using getFieldName();

try{
   $this->formvalidation->field('name')->required();
} catch ( InvalidFieldException $e ) {
   echo '<b>' . $e->getFieldName() . ' : </b>' . $e->getMessage();
}

The exception is thrown at the first invalid field met. This makes for printing messages one by one, until all fields have been filled properly. To output all messages within one validation, when selecting the field, 'fieldStore()' can be used instead, making the messages store into an array that can be further retrieved using getMessages(). Similarly for values, the `valueStore() method does the same thing. The received messages are stored in a 2-key array, where the first key is the fields name, and the second is the message counter for the field.

try{
    $this->formvalidation->fieldStore('name')->required();
    $this->formvalidation->fieldStore('email')->required()->email();
} catch ( InvalidFieldException $e ) {
    $messages = $this->formvalidation->getMessages();
    foreach ( $messages as $field => $fieldmsgs )
        foreach( $fieldmsgs as $message )
            echo '<b>' . $e->getFieldName() . ' : </b>' . $e->getMessage();
}

Member Function Documentation

FormValidation ( $method = 'post' )

Constructor

Parameters

string $method : [optional] get/post

setMethod ( $method )

Set the method of the form get/pos

Parameters

string $method

Returns: FormValidation : current object

field ( $field )

Set the form field to be validated

Parameters

string $field : the form field name

Returns: FormValidation : current object

fieldStore ( $field )

Set the form field to be validated. All the messages will be stored and no exceptions thrown

Parameters

string $field : the form field name

Returns: FormValidation : current object

value ( $val )

Set the value to be validated.

Parameters

mixed $val

Returns: FormValidation : current object

valueStore ( $val )

Set the value to be validated. All messages will be stored and no exceptions thrown.

Parameters

mixed $val

Returns: FormValidation : current object

getValue ( )

Get the value thats being validated

Exceptions

InvalidArgumentTypeException

Returns: mixed

report	(	$message_code,
		$required_value = `''`
	)

protected

Helper method used by this class in order to either store a value or throw an exception in case a field is not valid

Parameters

string	$message_code	: the message to be stored or reported
string	$required_value	: [optional]

Exceptions

integer	$min	: the minimum length this field needs to have in order to be valid
integer	$max	: the maximum length this field needs to have in order to be valid

rangeLength	(	$min,
		$max
	)

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

Field Documentation