Docs For Class Nexista

Description

This class Nexista_is the base class Nexista_upon which to extend custom validators

Located in /kernel/validator.php (line 20)

Direct descendents

Class	Description
Nexista_RegexValidator	This validator is used to check data using a Regular Expression passed as a parameter
Nexista_GdValidator	This validator checks whether the format of the given image is supported by our version of GD.
Nexista_PhoneValidator	This validator is used to check whether or not data is a valid phone number
Nexista_CustomValidator	This validator calls a user defined function to validate the data.
Nexista_LengthValidator	This validator is used to check that a string is under a certain length.
Nexista_RequiredValidator	This validator is used to check whether or data is present.
Nexista_Nexista_XmlValidator	This validator is used to make sure that a string contains is xml safe (i.e all tags close and nest appropriately) It does not check for headers and root tags.
Nexista_NumericValidator	This validator is used to check whether or not data is composed of only numbers.
Nexista_MatchValidator	This validator is used to check whether or not two values are the same.
Nexista_ValueValidator	This validator checks that the data is equal to a certain value (i.e. true) using case insensitve string comparison
Nexista_AlphaValidator	This validator is used to check whether or not data is composed of only letters.
Nexista_DummyValidator	This validator is just a dummy validator. It is used when a field is required but no other validation is needed.
Nexista_EmailValidator	This validator is used to check whether or not data is a valid email address.
Nexista_AlphanumValidator	This validator is used to check whether or not data is composed of only alphanumeric characters.

Variable Summary

boolean $empty

string $message

array $params

boolean $required

boolean $result

Method Summary

boolean applyParams (array &$params)

string getMessage ()

void isEmpty (boolean 0)

void isRequired (boolean 0)

boolean isValid ()

boolean main ()

boolean process (array &$params, sring $required, boolean &$result)

void setEmpty ()

void setMessage (string $message)

void setRequired (string $required)

Variables

boolean $empty = false (line 38)

Data existence flag

access: protected

string $message = '' (line 56)

Validation info message

access: protected

Redefined in descendants as:

Nexista_RegexValidator::$message : Validator error message
Nexista_GdValidator::$message : Validator error message
Nexista_PhoneValidator::$message : Validator error message
Nexista_CustomValidator::$message : Validator error message
Nexista_LengthValidator::$message : Validator error message
Nexista_RequiredValidator::$message : Validator error message
Nexista_Nexista_XmlValidator::$message : Validator error message
Nexista_NumericValidator::$message : Validator error message
Nexista_MatchValidator::$message : Validator error message
Nexista_ValueValidator::$message : Validator error message
Nexista_AlphaValidator::$message : Validator error message
Nexista_DummyValidator::$message : Validator error message
Nexista_EmailValidator::$message : Validator error message
Nexista_AlphanumValidator::$message : Validator error message

array $params = array() (line 65)

Function parameter array

access: protected

Redefined in descendants as:

Nexista_RegexValidator::$params : Function parameter array
Nexista_GdValidator::$params : Function parameter array
Nexista_PhoneValidator::$params : Function parameter array
Nexista_CustomValidator::$params : Function parameter array
Nexista_LengthValidator::$params : Function parameter array
Nexista_RequiredValidator::$params : Function parameter array
Nexista_Nexista_XmlValidator::$params : Function parameter array
Nexista_NumericValidator::$params : Function parameter array
Nexista_MatchValidator::$params : Function parameter array
Nexista_ValueValidator::$params : Function parameter array
Nexista_AlphaValidator::$params : Function parameter array
Nexista_DummyValidator::$params : Function parameter array
Nexista_EmailValidator::$params : Function parameter array
Nexista_AlphanumValidator::$params : Function parameter array

boolean $required = true (line 29)

Data requirement flag

access: protected

boolean $result = false (line 47)

Validator result flag

access: protected

Methods

applyParams (line 267)

Load class Nexista_parameters

This function will check if the required parameters for this class Nexista_are supplied and will load them into $this->params array

return: success
access: protected

boolean applyParams (array &$params)

array &$params: class Nexista_parameters

getMessage (line 248)

Gets a message from validator

return: message
see: Nexista_Validator::setMessage()
access: public

string getMessage ()

isEmpty (line 223)

Gets data existence

access: public

void isEmpty (boolean 0)

boolean 0: true if present, false if absent

isRequired (line 235)

Gets data requirement flag

access: public

void isRequired (boolean 0)

boolean 0: true if required, false if not

isValid (line 200)

Gets validator result

return: validator result
access: public

boolean isValid ()

main (line 121)

Applies validator

This function should be extended in the custom validators. The function should return true/false for errors. If the item to validate is empty, call the method $this->isEmpty(). Set the property $this->valid to record validator result.

Sample code

//get data
$data = time();
//check if empty value
if(!isset($data))
$this->setEmpty();
//validate
if($data = 1)
$this->valid = true;
else
$this->valid = false;
//return true or false for function errors
return true;

return: success
access: protected

boolean main ()

Redefined in descendants as:

Nexista_RegexValidator::main() : Apply regexp to data
Nexista_GdValidator::main() : Applies validator
Nexista_PhoneValidator::main() : Applies validator
Nexista_CustomValidator::main() : Applies validator
Nexista_LengthValidator::main() : Applies validator
Nexista_RequiredValidator::main() : Applies validator
Nexista_Nexista_XmlValidator::main() : Applies validator
Nexista_NumericValidator::main() : Applies validator
Nexista_MatchValidator::main() : Applies validator
Nexista_ValueValidator::main() : Applies validator
Nexista_AlphaValidator::main() : Applies validator
Nexista_DummyValidator::main() : Applies validator
Nexista_EmailValidator::main() : Applies validator
Nexista_AlphanumValidator::main() : Applies validator

process (line 77)

Applies validator and checks requirements

return: function success
access: public

boolean process (array &$params, sring $required, boolean &$result)

array &$params: class Nexista_parameters
sring $required: item requirement parameters
boolean &$result: validator success

setEmpty (line 211)

Sets data existence to absent

access: public

void setEmpty ()

setMessage (line 140)

Sets a message from validator

This function allows a validator to set a text message that can be used to present to the user as error. Please note that this is not the error string itself. These error strings are language dependent and not set by the validator. This is rather some useful information that some validators may provide such as where and what kind of error caused the failure of the validation process.

access: protected

void setMessage (string $message)

string $message: message

setRequired (line 152)

Checks item requirements

access: protected

void setRequired (string $required)

string $required: item requirements

Nexista_Validator