OmarElGabry / miniPHP

app/models/Validation.php

Doc Comments +5 added lines, -13 removed lines

@@ -251,7 +251,7 @@ 
     /**
      * clear all existing errors
      *
-     * @return bool
+     * @return boolean|null
      */
     public function clearErrors(){
         $this->errors = [];
@@ -275,7 +275,6 @@ 
      * min string length
      *
      * @param  string  $str
-     * @param  array  $args(min)
      *
      * @return bool
      */
@@ -287,7 +286,6 @@ 
      * max string length
      *
      * @param  string  $str
-     * @param  array  $args(max)
      *
      * @return bool
      */
@@ -299,7 +297,6 @@ 
      * check if number between given range of numbers
      *
      * @param  int     $num
-     * @param  array   $args(min,max)
      * @return bool
      */
     private function rangeNum($num, $args){
@@ -340,7 +337,7 @@ 
      * check if value is contains alphabetic characters and numbers
      *
      * @param  mixed   $value
-     * @return bool
+     * @return integer
      */
     private function alphaNum($value){
         return preg_match('/\A[a-z0-9]+\z/i', $value);
@@ -350,7 +347,7 @@ 
      * check if value is contains alphabetic characters, numbers and spaces
      *
      * @param  mixed   $value
-     * @return bool
+     * @return integer
      */
     private function alphaNumWithSpaces($value){
         return preg_match('/\A[a-z0-9 ]+\z/i', $value);
@@ -364,7 +361,7 @@ 
      * - one special(non-word) character
      *
      * @param  mixed   $value
-     * @return bool
+     * @return integer
      * @see http://stackoverflow.com/questions/8141125/regex-for-password-php
      * @see http://code.runnable.com/UmrnTejI6Q4_AAIM/how-to-validate-complex-passwords-using-regular-expressions-for-php-and-pcre
      */
@@ -376,7 +373,6 @@ 
      * check if value is equals to another value(strings)
      *
      * @param  string  $value
-     * @param  array   $args(value)
      * @return bool
      */
     private function equals($value, $args){
@@ -387,7 +383,6 @@ 
      * check if value is not equal to another value(strings)
      *
      * @param  string  $value
-     * @param  array   $args(value)
      * @return bool
      */
     private function notEqual($value, $args){
@@ -412,7 +407,6 @@ 
      * check if a value of a column is unique.
      *
      * @param  string  $value
-     * @param  array   $args(table, column)
      * @return bool
      */
     private function unique($value, $args){
@@ -568,7 +562,6 @@ 
      * checks from file size
      *
      * @param  array   $file
-     * @param  array   $args(min,max)
      * @return bool
      */
     private function fileSize($file, $args){
@@ -594,7 +587,6 @@ 
      * checks from image size(dimensions)
      *
      * @param  array   $file
-     * @param  array   $dimensions(width,height)
      * @return bool
      */
     private function imageSize($file, $dimensions){
@@ -671,7 +663,7 @@ 
      * you need to change it here as well.
      *
      * @param  string  $rule
-     * @return mixed
+     * @return string|null
      */
     private static function defaultMessages($rule){
         $messages = [