Update docblocks on Validator class

Respect · Jan 8, 2015 · 30ed453 · 30ed453
1 parent da193b7
commit 30ed453
Showing 1 changed file with 113 additions and 89 deletions.
diff --git a/library/Validator.php b/library/Validator.php
@@ -8,96 +8,102 @@
 use Respect\Validation\Rules\AllOf;
 
 /**
- * @method static \Respect\Validation\Validator allOf()
- * @method static \Respect\Validation\Validator alnum(string $additionalChars = null)
- * @method static \Respect\Validation\Validator alpha(string $additionalChars = null)
- * @method static \Respect\Validation\Validator alwaysInvalid()
- * @method static \Respect\Validation\Validator alwaysValid()
- * @method static \Respect\Validation\Validator arr()
- * @method static \Respect\Validation\Validator attribute(string $reference, Validatable $validator = null, bool $mandatory = true)
- * @method static \Respect\Validation\Validator base()
- * @method static \Respect\Validation\Validator between(int $min = null, int $max = null, bool $inclusive = false)
- * @method static \Respect\Validation\Validator bool()
- * @method static \Respect\Validation\Validator call()
- * @method static \Respect\Validation\Validator callback(mixed $callback)
- * @method static \Respect\Validation\Validator charset(array $charset)
- * @method static \Respect\Validation\Validator cnh()
- * @method static \Respect\Validation\Validator cnpj()
- * @method static \Respect\Validation\Validator consonant(string $additionalChars = null)
- * @method static \Respect\Validation\Validator contains(mixed $containsValue, bool $identical = false)
- * @method static \Respect\Validation\Validator countryCode()
- * @method static \Respect\Validation\Validator cpf()
- * @method static \Respect\Validation\Validator creditCard()
- * @method static \Respect\Validation\Validator date(string $format = null)
- * @method static \Respect\Validation\Validator digit(string $additionalChars = null)
- * @method static \Respect\Validation\Validator directory()
- * @method static \Respect\Validation\Validator domain()
- * @method static \Respect\Validation\Validator each(Validatable $itemValidator = null, Validatable $keyValidator = null)
- * @method static \Respect\Validation\Validator email()
- * @method static \Respect\Validation\Validator endsWith(mixed $endValue, bool $identical = false)
- * @method static \Respect\Validation\Validator equals(mixed $compareTo, bool $compareIdentical=false)
- * @method static \Respect\Validation\Validator even()
- * @method static \Respect\Validation\Validator executable()
- * @method static \Respect\Validation\Validator exists()
- * @method static \Respect\Validation\Validator file()
- * @method static \Respect\Validation\Validator float()
- * @method static \Respect\Validation\Validator graph(string $additionalChars = null)
- * @method static \Respect\Validation\Validator hexRgbColor()
- * @method static \Respect\Validation\Validator in(array $haystack, bool $compareIdentical = false)
- * @method static \Respect\Validation\Validator instance(string $instanceName)
- * @method static \Respect\Validation\Validator int()
- * @method static \Respect\Validation\Validator ip(array $ipOptions = null)
- * @method static \Respect\Validation\Validator json()
- * @method static \Respect\Validation\Validator key(string $reference, Validatable $referenceValidator = null, bool $mandatory = true)
- * @method static \Respect\Validation\Validator leapDate(mixed $format)
- * @method static \Respect\Validation\Validator leapYear()
- * @method static \Respect\Validation\Validator length(int $min=null, int $max=null, bool $inclusive = true)
- * @method static \Respect\Validation\Validator lowercase()
- * @method static \Respect\Validation\Validator macAddress()
- * @method static \Respect\Validation\Validator max(int $maxValue, bool $inclusive = false)
- * @method static \Respect\Validation\Validator min(int $minValue, bool $inclusive = false)
- * @method static \Respect\Validation\Validator minimumAge(int $age)
- * @method static \Respect\Validation\Validator multiple(int $multipleOf)
- * @method static \Respect\Validation\Validator negative()
- * @method static \Respect\Validation\Validator no($useLocale = false)
- * @method static \Respect\Validation\Validator noneOf()
- * @method static \Respect\Validation\Validator not(Validatable $rule)
- * @method static \Respect\Validation\Validator notEmpty()
- * @method static \Respect\Validation\Validator noWhitespace()
- * @method static \Respect\Validation\Validator nullValue()
- * @method static \Respect\Validation\Validator numeric()
- * @method static \Respect\Validation\Validator object()
- * @method static \Respect\Validation\Validator odd()
- * @method static \Respect\Validation\Validator oneOf()
- * @method static \Respect\Validation\Validator perfectSquare()
- * @method static \Respect\Validation\Validator phone()
- * @method static \Respect\Validation\Validator positive()
- * @method static \Respect\Validation\Validator postalCode($countryCode)
- * @method static \Respect\Validation\Validator primeNumber()
- * @method static \Respect\Validation\Validator prnt(string $additionalChars = null)
- * @method static \Respect\Validation\Validator punct(string $additionalChars = null)
- * @method static \Respect\Validation\Validator readable()
- * @method static \Respect\Validation\Validator regex($regex)
- * @method static \Respect\Validation\Validator roman()
- * @method static \Respect\Validation\Validator sf(string $name, array $params = null)
- * @method static \Respect\Validation\Validator slug()
- * @method static \Respect\Validation\Validator space(string $additionalChars = null)
- * @method static \Respect\Validation\Validator startsWith(mixed $startValue, bool $identical = false)
- * @method static \Respect\Validation\Validator string()
- * @method static \Respect\Validation\Validator symbolicLink()
- * @method static \Respect\Validation\Validator tld()
- * @method static \Respect\Validation\Validator uploaded()
- * @method static \Respect\Validation\Validator uppercase()
- * @method static \Respect\Validation\Validator version()
- * @method static \Respect\Validation\Validator vowel()
- * @method static \Respect\Validation\Validator when(Validatable $if, Validatable $then, Validatable $when)
- * @method static \Respect\Validation\Validator writable()
- * @method static \Respect\Validation\Validator xdigit(string $additionalChars = null)
- * @method static \Respect\Validation\Validator yes($useLocale = false)
- * @method static \Respect\Validation\Validator zend(mixed $validator, array $params = null)
+ * @method static Validator allOf()
+ * @method static Validator alnum(string $additionalChars = null)
+ * @method static Validator alpha(string $additionalChars = null)
+ * @method static Validator alwaysInvalid()
+ * @method static Validator alwaysValid()
+ * @method static Validator arr()
+ * @method static Validator attribute(string $reference, Validatable $validator = null, bool $mandatory = true)
+ * @method static Validator base()
+ * @method static Validator between(int $min = null, int $max = null, bool $inclusive = false)
+ * @method static Validator bool()
+ * @method static Validator call()
+ * @method static Validator callback(mixed $callback)
+ * @method static Validator charset(array $charset)
+ * @method static Validator cnh()
+ * @method static Validator cnpj()
+ * @method static Validator consonant(string $additionalChars = null)
+ * @method static Validator contains(mixed $containsValue, bool $identical = false)
+ * @method static Validator countryCode()
+ * @method static Validator cpf()
+ * @method static Validator creditCard()
+ * @method static Validator date(string $format = null)
+ * @method static Validator digit(string $additionalChars = null)
+ * @method static Validator directory()
+ * @method static Validator domain()
+ * @method static Validator each(Validatable $itemValidator = null, Validatable $keyValidator = null)
+ * @method static Validator email()
+ * @method static Validator endsWith(mixed $endValue, bool $identical = false)
+ * @method static Validator equals(mixed $compareTo, bool $compareIdentical=false)
+ * @method static Validator even()
+ * @method static Validator executable()
+ * @method static Validator exists()
+ * @method static Validator file()
+ * @method static Validator float()
+ * @method static Validator graph(string $additionalChars = null)
+ * @method static Validator hexRgbColor()
+ * @method static Validator in(array $haystack, bool $compareIdentical = false)
+ * @method static Validator instance(string $instanceName)
+ * @method static Validator int()
+ * @method static Validator ip(array $ipOptions = null)
+ * @method static Validator json()
+ * @method static Validator key(string $reference, Validatable $referenceValidator = null, bool $mandatory = true)
+ * @method static Validator leapDate(mixed $format)
+ * @method static Validator leapYear()
+ * @method static Validator length(int $min=null, int $max=null, bool $inclusive = true)
+ * @method static Validator lowercase()
+ * @method static Validator macAddress()
+ * @method static Validator max(int $maxValue, bool $inclusive = false)
+ * @method static Validator min(int $minValue, bool $inclusive = false)
+ * @method static Validator minimumAge(int $age)
+ * @method static Validator multiple(int $multipleOf)
+ * @method static Validator negative()
+ * @method static Validator no($useLocale = false)
+ * @method static Validator noneOf()
+ * @method static Validator not(Validatable $rule)
+ * @method static Validator notEmpty()
+ * @method static Validator noWhitespace()
+ * @method static Validator nullValue()
+ * @method static Validator numeric()
+ * @method static Validator object()
+ * @method static Validator odd()
+ * @method static Validator oneOf()
+ * @method static Validator perfectSquare()
+ * @method static Validator phone()
+ * @method static Validator positive()
+ * @method static Validator postalCode($countryCode)
+ * @method static Validator primeNumber()
+ * @method static Validator prnt(string $additionalChars = null)
+ * @method static Validator punct(string $additionalChars = null)
+ * @method static Validator readable()
+ * @method static Validator regex($regex)
+ * @method static Validator roman()
+ * @method static Validator sf(string $name, array $params = null)
+ * @method static Validator slug()
+ * @method static Validator space(string $additionalChars = null)
+ * @method static Validator startsWith(mixed $startValue, bool $identical = false)
+ * @method static Validator string()
+ * @method static Validator symbolicLink()
+ * @method static Validator tld()
+ * @method static Validator uploaded()
+ * @method static Validator uppercase()
+ * @method static Validator version()
+ * @method static Validator vowel()
+ * @method static Validator when(Validatable $if, Validatable $then, Validatable $when)
+ * @method static Validator writable()
+ * @method static Validator xdigit(string $additionalChars = null)
+ * @method static Validator yes($useLocale = false)
+ * @method static Validator zend(mixed $validator, array $params = null)
  */
 class Validator extends AllOf
 {
+    /**
+     * @param string $ruleName
+     * @param array  $arguments
+     *
+     * @return Validator
+     */
     public static function __callStatic($ruleName, $arguments)
     {
         if ('allOf' === $ruleName) {
@@ -109,6 +115,12 @@ public static function __callStatic($ruleName, $arguments)
         return $validator->__call($ruleName, $arguments);
     }
 
+    /**
+     * @param mixed $ruleSpec
+     * @param array $arguments
+     *
+     * @return Validatable
+     */
     public static function buildRule($ruleSpec, $arguments = array())
     {
         if ($ruleSpec instanceof Validatable) {
@@ -126,6 +138,12 @@ public static function buildRule($ruleSpec, $arguments = array())
         }
     }
 
+    /**
+     * @param string $method
+     * @param array  $arguments
+     *
+     * @return self
+     */
     public function __call($method, $arguments)
     {
         if ('not' === $method) {
@@ -140,6 +158,13 @@ public function __call($method, $arguments)
         return $this->addRule(static::buildRule($method, $arguments));
     }
 
+
+    /**
+     * @param mixed $input
+     * @param array $extraParams
+     *
+     * @return AllOfException
+     */
     public function reportError($input, array $extraParams = array())
     {
         $exception = new AllOfException();
@@ -161,8 +186,7 @@ public function reportError($input, array $extraParams = array())
     /**
      * Create instance validator
      *
-     * @static
-     * @return \Respect\Validation\Validator
+     * @return Validator
      */
     public static function create()
     {