Doctrine

Timestamp:

06/24/08 04:15:13 (13 months ago)

Author:

jwage

Message:

Documentation.

Files:

• branches/0.11/lib/Doctrine/Validator.php (modified) (6 diffs)

branches/0.11/lib/Doctrine/Validator.php

@@ -21 +21 @@
 
 /**
- * Doctrine_Validator
- * Doctrine_Validator performs validations on record properties
+ * This class is responsible for performing all validations on record properties
  *
  * @package     Doctrine
@@ -41 +40 @@
 
     /**
-     * returns a validator object
+     * Get a validator instance for the passed $name
      *
-     * @param string $name
-     * @return Doctrine_Validator_Interface
+     * @param  string   $name  Name of the validator or the validator class name
+     * @return Doctrine_Validator_Interface $validator
      */
     public static function getValidator($name)
@@ -63 +62 @@
 
     /**
-     * validates a given record and saves possible errors
-     * in Doctrine_Validator::$stack
+     * Validates a given record and saves possible errors in Doctrine_Validator::$stack
      *
-     * @param Doctrine_Record $record
+     * @param  Doctrine_Record $record
      * @return void
      */
@@ -84 +82 @@
      * Validates the length of a field.
      *
-     * @param string $value
-     * @param string $type
-     * @param string $maximumLength
-     * @return boolean $success
+     * @param  string  $value         Value to validate
+     * @param  string  $type          Type of field being validated
+     * @param  string  $maximumLength Maximum length allowed for the column
+     * @return boolean $success       True/false for whether the value passed validation
      */
     public static function validateLength($value, $type, $maximumLength)
@@ -105 +103 @@
 
     /**
-     * whether or not this validator has errors
+     * Whether or not errors exist on this validator
      *
-     * @return boolean
+     * @return boolean True/false for whether or not this validate instance has error
      */
     public function hasErrors()
@@ -115 +113 @@
 
     /**
-     * returns whether or not the given variable is
-     * valid type
+     * Validate the type of the passed variable
      *
-     * @param mixed $var
-     * @param string $type
+     * @param  mixed  $var   Variable to validate
+     * @param  string $type  Type of the variable expected
      * @return boolean
      */