propel-validator
[ class tree: propel-validator ] [ index: propel-validator ] [ all elements ]
Packages:
propel
propel-adapter
propel-logger
propel-map
propel-om
propel-util
propel-validator


Files:
BasicValidator.php
MatchValidator.php
MaxLengthValidator.php
MaxValueValidator.php
MinLengthValidator.php
MinValueValidator.php
NotMatchValidator.php
RequiredValidator.php
UniqueValidator.php
ValidationFailed.php
ValidValuesValidator.php

Interfaces:
BasicValidator
Classes:
MatchValidator
MaxLengthValidator
MaxValueValidator
MinLengthValidator
MinValueValidator
NotMatchValidator
RequiredValidator
UniqueValidator
ValidationFailed
ValidValuesValidator

Class: ValidationFailed

Source Location: /validator/ValidationFailed.php

Class Overview




Simple class that serves as a container for any information about a failed validation.




Author(s):






        
        

Version:


    
  
  • $Revision: 521 $
    • 



        






Methods
























Class Details



[line 37]

Simple class that serves as a container for any information about a failed validation.

Currently this class stores the qualified column name (e.g. tablename.COLUMN_NAME) and  the message that should be displayed to the user.
An array of these objects will be returned by BasePeer::doValidate() if validation  failed.





Tags:





  

    author:  Hans Lellelid <hans@xmpl.org>
  

  

    version:  $Revision: 521 $
  

  

    see:  BasePeer::doValidate()
  










[ Top ]








Class Methods




  

	
	
constructor __construct [line 54]

	

    

    

		ValidationFailed __construct(
string
$colname, string
$message, [object
$validator = null])
    

    


	
		Construct a new ValidationFailed object.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $colname  
        Column name.
      

          

        string  
        $message  
        Message to display to user.
      

          

        object  
        $validator  
        The Validator that caused this column to fail.
      

        

    


        
[ Top ]

  

  

	
	
method getColumn [line 74]

	

    

    

		string getColumn(
)
    

    


	
		Gets the column name.





Tags:





  

    return:  Qualified column name (tablename.COLUMN_NAME)
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getMessage [line 92]

	

    

    

		string getMessage(
)
    

    


	
		Gets the message for the validation failure.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getValidator [line 110]

	

    

    

		object getValidator(
)
    

    


	
		Gets the validator object that caused this to fail.





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setColumn [line 65]

	

    

    

		void setColumn(
string
$v)
    

    


	
		Set the column name.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $v  
        
      

        

    


        
[ Top ]

  

  

	
	
method setMessage [line 83]

	

    

    

		void setMessage(
string
$v)
    

    


	
		Set the message for the validation failure.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $v  
        
      

        

    


        
[ Top ]

  

  

	
	
method setValidator [line 101]

	

    

    

		void setValidator(
object
$v)
    

    


	
		Set the validator object that caused this to fail.





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        object  
        $v  
        
      

        

    


        
[ Top ]

  

  

	
	
method __toString [line 121]

	

    

    

		string __toString(
)
    

    


	
		"magic" method to get string represenation of object.

Maybe someday PHP5 will support the invoking this method automatically  on (string) cast.  Until then it's pretty useless.





Tags:





  

    access:  public
  









	
        
[ Top ]

  






        

		    

		    Documentation generated on Thu, 22 Nov 2007 03:33:56 +0000 by phpDocumentor 1.4.0