validationCore Class Reference

validationCore class contains the Common methods and attributes of all types of validation related classes such as form validation upload validation etc. More...

Inheritance diagram for validationCore:

[legend]

Collaboration diagram for validationCore:

[legend]

Public Member Functions
	addCriteria ($field_name, $rules=null, $msg=null)
	Sets the Rules for form validation.
	removeCriteria ($field_name, $criteria=null)
	if a Criteria is specified Removes that specific Criteria else Removes all criterias for that Field Name Supplied
	parseCriteria ($map_file)
	Parses the validation map from an existing config file.
	validationStatus ()
	gets a (optional) form field name and returns true if its valid else returns either (if mode is Z_VLD_NUMERICAL) the index of the unmatched rule, or (Z_VLD_TEXTUAL) textuale name e.g.
	overrideErrorMsg ($field_name, $err, $err_txt)
	This method lets you overrite teh error message set for a certain form field for a certain error.
	isValid ($key=null)
	If no arguments given Returns true if all form fields in the form is valid else returns flase If a form field name is given as an arguments returns true if that form field is valid else returns false.
	errtext ($field_name)
	Returns teh error text set for a crtain field for the unmatched criteria.
	revalidate ()
	Revalidate everything.
Data Fields
	$rules = array()
	$res = array()
	$err
	$validated = false

---

Detailed Description

validationCore class contains the Common methods and attributes of all types of validation related classes such as form validation upload validation etc.

Definition at line 30 of file abstract/validation/core.php.

---

Member Function Documentation

validationCore::addCriteria( string $field_name, mixed $rules = null, mixed $msg = null )

Sets the Rules for form validation.

Must have $this->method already set before using it provide the form field name as the forst argument and an array of rules as the second argument.

if $rules is given as string $msg must be a string if a third argument $msg is given as an array it would be assumed that the 2nd argument $rules is an array of rules. If a third argument $msg is given as an String or Intger It would be assumed that 2nd argument is also a string and it would fire Error if its not string if the third argument $msg is not given it would be assumed that $rules array contains the CRITERIA(s) as the key elements and teh error message(s) as the value(s) and if the criteria is not valid it would Fire Error if the $rules array is NUMARICALLY INDEXED It would Fire Error

Parameters:

	$field_name
	$rules
	$msg	optional

{$msg is given

Definition at line 51 of file abstract/validation/core.php.

References $rules, and perror().

Referenced by parseCriteria().

Show Source

                                                           {
    if(is_null($msg)){//Check wheaher the $msg is given or not
      //{$msg is not given
        foreach($rules as $rule => $err_msg){
          if(!isset($this->rules[$field_name])){$this->rules[$field_name] = array();}
          if(!is_array($this->rules[$field_name])){$this->rules[$field_name] = array();}
          array_push($this->rules[$field_name], $rule);
          $this->err[$field_name][$rule] = $err_msg;
          $this->err[$field_name][] = $err_msg;
        }
      //}
    }else{
        if(is_string($msg)){//$msg is string
          if(!is_string($rules)){
            perror('<code>zigmoyd.validation.core.addCriteria()</code><br />expects $rule to be a string as $msg is given as a string');
          }else{
            if(!isset($this->rules[$field_name])){$this->rules[$field_name] = array();}
            if(!is_array($this->rules[$field_name])){$this->rules[$field_name] = array();}
            array_push($this->rules[$field_name], $rules);
            $this->err[$field_name][$rules] = $msg;
            $this->err[$field_name][] = $msg;
          }
        }else{
          if(is_array($msg)){//$msg is an Array
            foreach($rules as $i => $rule){
              if(!isset($this->rules[$field_name])){$this->rules[$field_name] = array();}
              if(!is_array($this->rules[$field_name])){$this->rules[$field_name] = array();}
              array_push($this->rules[$field_name], $rule);
              $this->err[$field_name][$rule] = $msg[$i];
              $this->err[$field_name][$i] = $msg[$i];
            }
          }else{
            perror('<code>zigmoyd.validation.core.addCriteria()</code><br />Invalid Datatype of $msg');
          }
        }
      //}
    }
  }

Here is the call graph for this function:

Top 

validationCore::removeCriteria( string $field_name, string $criteria = null )

if a Criteria is specified Removes that specific Criteria else Removes all criterias for that Field Name Supplied

Parameters:

	$field_name
	$criteria	optional

Definition at line 96 of file abstract/validation/core.php.

References perror().

Show Source

                                                        {//If $criteria is null Remove all criteria for the Field
    if(!is_null($criteria)){//$criteria is not Null So remove teh Specific Criteria Specified
      foreach($this->rules[$field_name] as $i => $rule){
        //{ Remove the Crite from rules Array
        if(!is_numeric($criteria)){
          if($rule == $criteria){
            unset($this->rules[$field_name][$i]);
            $this->rules[$field_name] = array_values($this->rules[$field_name]);
            break;
          }
        }else{
          if($i == $criteria){
            unset($this->rules[$field_name][$i]);
            $this->rules[$field_name] = array_values($this->rules[$field_name]);
            break;
          }
        }
        //}
      }
      //{ Remove the Criteria from Error Message's Array
      //{ Grab the alternative index that assciates with it
      //{{ Grab the current Index
      $err_keys = array_keys($this->err[$field_name]);
      foreach($err_keys as $current_indx => $current_criteria){
        if(strcmp($current_criteria, $criteria) == 0){
          break;//$current_indx holds the current index
        }
      }
      //}}
      if(is_numeric($current_criteria)){//The Error Code that user has supplied is Numarical
        //{{ Grab the Previous Index
        $indx = $err_keys[$current_indx-1];
        //}}
      }else{//The error Code that the User has supplied is Textual
        //{{ Grab the Numarical Next Index
        $indx = $err_keys[$current_indx+1];
        //}}
      }
      //}
      if(!isset($this->err[$field_name][$indx])){
        perror('<code>zigmoyd.validation.core.removeCriteria()</code><br />Zigmoyd Internal debug level Error Plese Inform this to Zigmoyd Developers<br />Alternative Index not found<br />on File '.__FILE__.' Class validation near Line '.__LINE__);
      }
      unset($this->err[$field_name][$current_criteria]);
      unset($this->err[$field_name][$indx]);
      //}
    }else{//No Criteria is Specified So all Criterias are going to be removed
      foreach($this->rules[$field_name] as $i => $rule){
        unset($this->rules[$field_name][$i]);
      }
    }
  }

Here is the call graph for this function:

Top 

validationCore::parseCriteria( string $map_file ) 

Parses the validation map from an existing config file.

Parameters:

$map_file

Definition at line 152 of file abstract/validation/core.php.

References addCriteria(), and vldMapParser::tokenize().

Referenced by zRom_upload::initValidator(), and zRom_form::initValidator().

Show Source

                                   {
    foreach($this->tokenize($map_file) as $field_name => $criteria){
      $this->addCriteria($field_name, $criteria);
    }
  }

Here is the call graph for this function:

Top 

validationCore::validationStatus( ) 

gets a (optional) form field name and returns true if its valid else returns either (if mode is Z_VLD_NUMERICAL) the index of the unmatched rule, or (Z_VLD_TEXTUAL) textuale name e.g.

required of the unmatched rule. if No form field is specified it walks through all the form fields and returns the Index or textual name of the first Unmatched form field depending upon the mode By default mode is set to Z_VLD_NUMERICA and form field name is specified to null.

Parameters:

	$form_field_name	string optional
	$validation_mode	boolean optional

Returns:

mixed

Definition at line 169 of file abstract/validation/core.php.

References $val, and perror().

Referenced by zRom_upload::initValidator(), zRom_form::initValidator(), isValid(), and revalidate().

Show Source

                             {
    //{ Handle the arguments given
    if(func_num_args() > 0){
      if(func_num_args() > 2){
        perror('<code>zigmoyd.validation.core.validationStatus()</code><br /> doesn\'t accepts more than 2 arguments');
      }elseif(func_num_args() == 2){
        //Exact 2 arguments are given
        $key = func_get_arg(0);
        $mode = func_get_arg(1);
      }else{
        //1 arguments given
        if(is_string(func_get_arg(0))){
          $key = func_get_arg(0);
          $mode = Z_VLD_NUMERICAL;
        }elseif(is_bool(func_get_arg(0))){
          $key = null;
          $mode = func_get_arg(0);
        }else{
          perror('<code>zigmoyd.validation.core.validationStatus()</code><br />Failed understand the arguments given plsese see the manual first');
        }
      }
    }else{
      $key = null;
      $mode = Z_VLD_NUMERICAL;
    }
    //}
    if($this->validated != $mode){
      $this->validate($mode);
    }
    if(!is_null($key)){
      if(!isset($this->res[$key])){
        perror('Either No rules Applied on the field `'.$key.'` or '.__CLASS__.'::validationStatus() is being called without calling '.__CLASS__.'::add_criterias() before');
      }else{
        return $this->res[$key];
      }
    }else{
      foreach($this->res as $key => $val){
        if(!is_bool($val)){return $key;}
      }
      return true;
    }
  }

Here is the call graph for this function:

Top 

validationCore::overrideErrorMsg( string $field_name, mixed $err, string $err_txt )

This method lets you overrite teh error message set for a certain form field for a certain error.

Parameters:

	$field_name
	$err
	$err_txt

Definition at line 218 of file abstract/validation/core.php.

References $err, and perror().

Show Source

                                                        {
    if(!isset($this->rules[$field_name])){
      perror("<code>zigmoyd.validation.core.overrideErrorMsg()</code><br />no rule hs been set for The field name $field_name but being used in ");
    }else{
      $this->err[$field_name][$err] = $err_txt;
      //{ Grab the alternative that assciates with it
      //{{ Grab the current Index
      $err_keys = array_keys($this->err[$field_name]);
      foreach($err_keys as $current_indx => $current_criteria){
        if($current_criteria == $err){
          break;//$current_indx holds the current index
        }
      }
      //}}
      if(is_numeric($err)){//The Error Code that user has supplied is Numarical
        //{{ Grab the Previous Index
        $indx = $err_keys[$current_indx];
        //}}
      }else{//The error Code that the User has supplied is Textual
        //{{ Grab the Numarical Next Index
        $indx = $err_keys[$current_indx+1];
        //}}
      }
      //}
      if(!isset($this->err[$field_name][$indx])){
        perror('<code>zigmoyd.validation.core.overrideErrorMsg()</code><br />Zigmoyd Internal debug level Error Plese Inform this to Zigmoyd Developers<br />Alternative Index not found<br />on /usr/lib/module/ums/validation.php Class validation near Line '.__LINE__);
      }
      $this->err[$field_name][$indx] = $err_txt;
    }
  }

Here is the call graph for this function:

Top 

validationCore::isValid( string $key = null ) 

If no arguments given Returns true if all form fields in the form is valid else returns flase If a form field name is given as an arguments returns true if that form field is valid else returns false.

Parameters:

$key

Returns:

bool

Definition at line 257 of file abstract/validation/core.php.

References validationStatus().

Referenced by zRom_upload::initValidator(), zRom_form::initValidator(), and revalidate().

Show Source

                               {
    if($this->validated != Z_VLD_NUMERICAL)$this->validate();
    if($key == null){
      //Test wheather the form is totally valid or not
      $ret = true;
      foreach($this->res as $v){
        if(!is_bool($v)){$ret = false;break;}
      }
      return $ret;
    }else{
      //Check the given form field
      if(is_bool($this->validationStatus($key))){return true;}else{return false;}
    }
  }

Here is the call graph for this function:

Top 

validationCore::errtext( string $field_name ) 

Returns teh error text set for a crtain field for the unmatched criteria.

Parameters:

$field_name

Returns:

string

Definition at line 277 of file abstract/validation/core.php.

References perror().

Referenced by zRom_upload::initValidator(), zRom_form::initValidator(), and revalidate().

Show Source

                               {
    /*{{ If the form is already not validated first validate it
    if($this->validated != $mode){
      $this->validate($mode);
    }
    }}*/
    if(!isset($this->err[$field_name])){
      perror('<code>zigmoyd.validation.core.errtext()</code><br />No error message is set for Field '.$field_name);
    }else{
      if(!isset($this->rules[$field_name])){
        perror('<code>zigmoyd.validation.core.errtext()</code><br />No rule is set for Field '.$field_name.' but being used in ');
      }else{
        if(is_bool($this->res[$field_name]) && $this->res[$field_name]){
          return true;//Field is valid
        }else{
          if(!isset($this->err[$field_name][$this->res[$field_name]])){
            perror("<code>zigmoyd.validation.core.errtext()</code><br /> No Error Message has been set for Error Index ".$this->res[$field_name]." Error Name ".$this->rules[$this->res[$field_name]]);
          }
          return $this->err[$field_name][$this->res[$field_name]];//Return the Error Text
        }
      }
    }
  }

Here is the call graph for this function:

Top 

validationCore::revalidate( ) 

Revalidate everything.

Definition at line 304 of file abstract/validation/core.php.

References $rules, errtext(), isValid(), and validationStatus().

Show Source

                       {
    $this->validate();
    $this->isValid = $this->isValid();
    foreach($this->rules as $field_name => $rules){
      //{ Make the $this->${field_names} = OBJECTS
      $this->{$field_name} = new zRom_fields($this->items[$field_name], $this->errtext($field_name), $this->isValid($field_name), $this->validationStatus($field_name));
      //}
    }
  }

Here is the call graph for this function:

Top 

---

Field Documentation

validationCore::$rules = array()

Definition at line 31 of file abstract/validation/core.php.

Referenced by addCriteria(), zRom_upload::initValidator(), zRom_form::initValidator(), and revalidate().

Top 

validationCore::$res = array()

Definition at line 32 of file abstract/validation/core.php.

Top 

validationCore::$err

Definition at line 33 of file abstract/validation/core.php.

Referenced by overrideErrorMsg().

Top 

validationCore::$validated = false

Definition at line 34 of file abstract/validation/core.php.

Top 

---

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

• abstract/validation/core.php