Skip to content

Commit

Permalink
Merge pull request #133 from fgibaux/add-missing-types-phpdoc
Browse files Browse the repository at this point in the history
Add missing types phpdoc
  • Loading branch information
IsraelOrtuno authored Jul 31, 2023
2 parents 669ed53 + d1bc799 commit 173a7a7
Show file tree
Hide file tree
Showing 12 changed files with 32 additions and 32 deletions.
14 changes: 7 additions & 7 deletions src/Resources/Basics/Entity.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ abstract class Entity extends Resource
/**
* List the resource associated emails.
*
* @param $id
* @param int $id
* @param array $options
* @return Response
*/
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down
16 changes: 8 additions & 8 deletions src/Resources/Basics/Resource.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public function add(array $values)
/**
* Update an entity by ID.
*
* @param $id
* @param int $id
* @param array $values
* @return Response
*/
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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;
Expand All @@ -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)
Expand Down Expand Up @@ -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
*/
Expand Down
6 changes: 3 additions & 3 deletions src/Resources/Traits/FindsByName.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [])
Expand Down
10 changes: 5 additions & 5 deletions src/Resources/Traits/HandlesAssignments.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ trait HandlesAssignments
/**
* Get the resource assignments.
*
* @param $id
* @param int $id
* @param array $options
* @return Response
*/
Expand All @@ -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)
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsActivities.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ trait ListsActivities
/**
* List the resource activities.
*
* @param $id
* @param int $id
* @param array $options
* @return Response
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsAttachedFiles.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsDeals.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsFollowers.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ trait ListsFollowers
/**
* List the followers of a resource.
*
* @param $id
* @param int $id
* @return Response
*/
public function followers($id)
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsPermittedUsers.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsProducts.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Traits/ListsUpdates.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ trait ListsUpdates
/**
* Get the resource updates.
*
* @param $id
* @param int $id
* @param array $options
* @return Response
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Resources/Traits/Searches.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
trait Searches
{
/**
* @param $term
* @param array $fields
* @param string $term
* @param array $fields
*
* @return Response
*/
Expand Down

0 comments on commit 173a7a7

Please sign in to comment.