Merge pull request #133 from fgibaux/add-missing-types-phpdoc

Add missing types phpdoc
IsraelOrtuno · Jul 31, 2023 · 173a7a7 · 173a7a7
2 parents 669ed53 + d1bc799
commit 173a7a7
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 32 deletions.
diff --git a/src/Resources/Basics/Entity.php b/src/Resources/Basics/Entity.php
@@ -22,7 +22,7 @@ abstract class Entity extends Resource
     /**
      * List the resource associated emails.
      *
-     * @param       $id
+     * @param  int  $id
      * @param array $options
      * @return Response
      */
@@ -36,8 +36,8 @@ public function emails($id, $options = [])
     /**
      * Add a follower to a resource.
      *
-     * @param $id
-     * @param $user_id
+     * @param int $id
+     * @param int $user_id
      * @return Response
      */
     public function addFollower($id, $user_id)
@@ -48,8 +48,8 @@ public function addFollower($id, $user_id)
     /**
      * Delete a follower from a resource.
      *
-     * @param $id
-     * @param $follower_id
+     * @param int $id
+     * @param int $follower_id
      * @return Response
      */
     public function deleteFollower($id, $follower_id)
@@ -60,8 +60,8 @@ public function deleteFollower($id, $follower_id)
     /**
      * Merge a resource with another.
      *
-     * @param $id
-     * @param $merge_with_id
+     * @param int $id
+     * @param int $merge_with_id
      * @return Response
      */
     public function merge($id, $merge_with_id)

diff --git a/src/Resources/Basics/Resource.php b/src/Resources/Basics/Resource.php
@@ -89,7 +89,7 @@ public function add(array $values)
     /**
      * Update an entity by ID.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $values
 	 * @return Response
      */
@@ -103,7 +103,7 @@ public function update($id, array $values)
     /**
      * Delete an entity by ID.
      *
-     * @param $id
+     * @param int $id
 	 * @return Response
      */
     public function delete($id)
@@ -137,7 +137,7 @@ public function getName()
     /**
      * Check if the method is enabled for use.
      *
-     * @param $method
+     * @param string $method
      * @return bool
      */
     public function isEnabled($method)
@@ -146,8 +146,8 @@ public function isEnabled($method)
             return false;
         }
 
-        // First we will make sure the method only belongs to this abtract class
-        // as this does not have to interfiere with methods described in child
+        // First we will make sure the method only belongs to this abstract class
+        // as this does not have to interfere with methods described in child
         // classes. We can now check if it is found in the enabled property.
         if (! in_array($method, get_class_methods(get_class()))) {
             return true;
@@ -159,7 +159,7 @@ public function isEnabled($method)
     /**
      * Check if the method is disabled for use.
      *
-     * @param $method
+     * @param string $method
      * @return bool
      */
     public function isDisabled($method)
@@ -208,8 +208,8 @@ public function setDisabled($disabled)
     /**
      * Magic method call.
      *
-     * @param       $method
-     * @param array $args
+     * @param string $method
+     * @param array  $args
      * @return void
      * @throws PipedriveException
      */

diff --git a/src/Resources/Traits/FindsByName.php b/src/Resources/Traits/FindsByName.php
@@ -9,9 +9,9 @@ trait FindsByName
     /**
      * Find an element by name.
      *
-     * @param       $term
-     * @param array $options
-     * @deprecated  Use search method instead
+     * @param string $term
+     * @param array  $options
+     * @deprecated   Use search method instead
 	 * @return Response
      */
     public function findByName($term, $options = [])

diff --git a/src/Resources/Traits/HandlesAssignments.php b/src/Resources/Traits/HandlesAssignments.php
@@ -9,7 +9,7 @@ trait HandlesAssignments
     /**
      * Get the resource assignments.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $options
      * @return Response
      */
@@ -23,8 +23,8 @@ public function assignments($id, $options = [])
     /**
      * Add a new assignment to the resource.
      *
-     * @param $id
-     * @param $user_id
+     * @param int $id
+     * @param int $user_id
      * @return Response
      */
     public function addAssignment($id, $user_id)
@@ -35,8 +35,8 @@ public function addAssignment($id, $user_id)
     /**
      * Delete an assignemt from the resource.
      *
-     * @param $id
-     * @param $user_id
+     * @param int $id
+     * @param int $user_id
      * @return Response
      */
     public function deleteAssignment($id, $user_id)

diff --git a/src/Resources/Traits/ListsActivities.php b/src/Resources/Traits/ListsActivities.php
@@ -9,7 +9,7 @@ trait ListsActivities
     /**
      * List the resource activities.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $options
      * @return Response
      */

diff --git a/src/Resources/Traits/ListsAttachedFiles.php b/src/Resources/Traits/ListsAttachedFiles.php
@@ -9,7 +9,7 @@ trait ListsAttachedFiles
     /**
      * Get the resource attached files.
      *
-     * @param       $id      The resource id
+     * @param int   $id      The resource id
      * @param array $options Extra parameters
      * @return Response
      */

diff --git a/src/Resources/Traits/ListsDeals.php b/src/Resources/Traits/ListsDeals.php
@@ -9,7 +9,7 @@ trait ListsDeals
     /**
      * Get the resource deals.
      *
-     * @param       $id      The resource id
+     * @param int   $id      The resource id
      * @param array $options Extra parameters
      * @return Response
      */

diff --git a/src/Resources/Traits/ListsFollowers.php b/src/Resources/Traits/ListsFollowers.php
@@ -9,7 +9,7 @@ trait ListsFollowers
     /**
      * List the followers of a resource.
      *
-     * @param $id
+     * @param int $id
      * @return Response
      */
     public function followers($id)

diff --git a/src/Resources/Traits/ListsPermittedUsers.php b/src/Resources/Traits/ListsPermittedUsers.php
@@ -9,7 +9,7 @@ trait ListsPermittedUsers
     /**
      * Get the resource permitted users.
      *
-     * @param      $id           The resource id
+     * @param int  $id           The resource id
      * @param null $access_level Access level value
      * @return Response
      */

diff --git a/src/Resources/Traits/ListsProducts.php b/src/Resources/Traits/ListsProducts.php
@@ -9,7 +9,7 @@ trait ListsProducts
     /**
      * Get the products attached to a resource.
      *
-     * @param       $id      The resource id
+     * @param int   $id      The resource id
      * @param array $options Extra parameters
      * @return Response
      */

diff --git a/src/Resources/Traits/ListsUpdates.php b/src/Resources/Traits/ListsUpdates.php
@@ -9,7 +9,7 @@ trait ListsUpdates
     /**
      * Get the resource updates.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $options
      * @return Response
      */

diff --git a/src/Resources/Traits/Searches.php b/src/Resources/Traits/Searches.php
@@ -7,8 +7,8 @@
 trait Searches
 {
     /**
-     * @param       $term
-     * @param array $fields
+     * @param string $term
+     * @param array  $fields
      *
      * @return Response
      */