OmarElGabry / miniPHP

app/controllers/AdminController.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     /**
      * view a user
      *
-     * @param integer|string $userId
+     * @param integer $userId
      */
     public function viewUser($userId = 0){
 

app/controllers/PostsController.php

Doc Comments +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
     /**
      * view a post
      *
-     * @param integer|string $postId
+     * @param integer $postId
      */
     public function view($postId = 0){
 

app/core/Config.php

Doc Comments +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
     /**
      * Gets a configuration value
      *
-     * @param $key string
+     * @param string $key string
      * @return string|null
      * @throws Exception if configuration file doesn't exist
      */

app/core/Cookie.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
      *
      * @access public
      * @static static method
-     * @return string   User ID
+     * @return integer   User ID
      */
     public static function getUserId(){
         return (int)self::$userId;

app/models/Pagination.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
      * Get number of total pages.
      *
      * @access public
-     * @return integer
+     * @return double
      */
     public function totalPages() {
         return ceil($this->totalCount/$this->perPage);

app/models/User.php

Doc Comments +2 added lines, -2 removed lines

@@ -167,7 +167,7 @@ 
      * @access public
      * @param  integer  $userId
      * @param  string   $emailToken
-     * @return mixed
+     * @return boolean
      * @throws Exception If failed to revoke email updates.
      */
     public function revokeEmail($userId, $emailToken){
@@ -206,7 +206,7 @@ 
      * @access public
      * @param  integer  $userId
      * @param  string   $emailToken
-     * @return mixed
+     * @return boolean
      * @throws Exception If failed to update current email.
      */
     public function updateEmail($userId, $emailToken){

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 = [

app/core/Request.php

Doc Comments +3 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
       * count fields in $this->data and optionally exclude some fields
       *
       * @param  array   $exclude
-      * @return mixed
+      * @return integer
       */
      public function countData(array $exclude = []){
          $count = count($this->data);
@@ -90,7 +90,7 @@ 
       * safer and better access to $this->data
       *
       * @param  string   $key
-      * @return mixed
+      * @return string|null
       */
      public function data($key){
          return array_key_exists($key, $this->data)? $this->data[$key]: null;
@@ -100,7 +100,7 @@ 
       * safer and better access to $this->query
       *
       * @param  string   $key
-      * @return mixed
+      * @return string
       */
      public function query($key){
          return array_key_exists($key, $this->query)? $this->query[$key]: null;

app/core/Controller.php

Doc Comments +1 added lines, -1 removed lines

@@ -175,7 +175,7 @@
      * call error action method and set response status code
      * This will work as well for ajax call, see how ajax calls are handled in main.js
      *
-     * @param int|string $code
+     * @param integer $code
      *
      */
     public function error($code){