Skip to content

Commit cd3c3ed

Browse files
vimishorvimishor
committed
docblock & cs fix in Users/*
1 parent c23fd8e commit cd3c3ed

File tree

6 files changed

+132
-124
lines changed

6 files changed

+132
-124
lines changed

‎lib/Bitbucket/API/Users/Account.php‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Bitbucket\API\Users;
1313

1414
use Bitbucket\API\Api;
15+
use Buzz\Message\MessageInterface;
1516

1617
/**
1718
* This resource returns a user structure and the repositories array associated
@@ -25,8 +26,8 @@ class Account extends Api
2526
* Get the account profile
2627
*
2728
* @access public
28-
* @param string $account The name of an individual or team account, or validated email address.
29-
* @return mixed
29+
* @param string $account The name of an individual or team account, or validated email address.
30+
* @return MessageInterface
3031
*/
3132
public function profile($account)
3233
{
@@ -41,8 +42,8 @@ public function profile($account)
4142
* Gets the number of users counted against an account's plan.
4243
*
4344
* @access public
44-
* @param string $account The name of an individual or team account, or validated email address.
45-
* @return mixed
45+
* @param string $account The name of an individual or team account, or validated email address.
46+
* @return MessageInterface
4647
*/
4748
public function plan($account)
4849
{
@@ -57,8 +58,8 @@ public function plan($account)
5758
* Gets a count and the list of accounts following an account.
5859
*
5960
* @access public
60-
* @param string $account The name of an individual or team account, or validated email address.
61-
* @return mixed
61+
* @param string $account The name of an individual or team account, or validated email address.
62+
* @return MessageInterface
6263
*/
6364
public function followers($account)
6465
{
@@ -73,8 +74,8 @@ public function followers($account)
7374
* Gets a count and the list of events associated with an account.
7475
*
7576
* @access public
76-
* @param string $account The name of an individual or team account, or validated email address.
77-
* @return mixed
77+
* @param string $account The name of an individual or team account, or validated email address.
78+
* @return MessageInterface
7879
*/
7980
public function events($account)
8081
{

‎lib/Bitbucket/API/Users/Emails.php‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Bitbucket\API\Users;
1313

1414
use Bitbucket\API\Api;
15+
use Buzz\Message\MessageInterface;
1516

1617
/**
1718
* List, change, or create an email address.
@@ -24,8 +25,8 @@ class Emails extends Api
2425
* Get a list of user's email addresses
2526
*
2627
* @access public
27-
* @param string $account The name of an individual or team account.
28-
* @return mixed
28+
* @param string $account The name of an individual or team account.
29+
* @return MessageInterface
2930
*/
3031
public function all($account)
3132
{
@@ -41,9 +42,9 @@ public function all($account)
4142
* or if is active.
4243
*
4344
* @access public
44-
* @param string $account The name of an individual or team account.
45-
* @param string $email The email address to get.
46-
* @return mixed
45+
* @param string $account The name of an individual or team account.
46+
* @param string $email The email address to get.
47+
* @return MessageInterface
4748
*/
4849
public function get($account, $email)
4950
{
@@ -56,9 +57,9 @@ public function get($account, $email)
5657
* Add a new email address to an account
5758
*
5859
* @access public
59-
* @param string $account The name of an individual or team account.
60-
* @param string $email The email address to get.
61-
* @return mixed
60+
* @param string $account The name of an individual or team account.
61+
* @param string $email The email address to get.
62+
* @return MessageInterface
6263
*/
6364
public function create($account, $email)
6465
{
@@ -73,10 +74,10 @@ public function create($account, $email)
7374
* Sets an individual email address associated with an account to primary.
7475
*
7576
* @access public
76-
* @param string $account The name of an individual or team account.
77-
* @param string $email The email address to get.
78-
* @param bool $primary Set this address as primary for this account ?
79-
* @return mixed
77+
* @param string $account The name of an individual or team account.
78+
* @param string $email The email address to get.
79+
* @param bool $primary Set this address as primary for this account ?
80+
* @return MessageInterface
8081
*/
8182
public function update($account, $email, $primary = false)
8283
{
@@ -90,9 +91,9 @@ public function update($account, $email, $primary = false)
9091
* Delete an email address
9192
*
9293
* @access public
93-
* @param string $account The name of an individual or team account.
94-
* @param string $email The email address to get.
95-
* @return mixed
94+
* @param string $account The name of an individual or team account.
95+
* @param string $email The email address to get.
96+
* @return MessageInterface
9697
*/
9798
public function delete($account, $email)
9899
{

‎lib/Bitbucket/API/Users/Invitations.php‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Bitbucket\API\Users;
1313

1414
use Bitbucket\API\Api;
15+
use Buzz\Message\MessageInterface;
1516

1617
/**
1718
* An invitation is a request sent to an external email address to participate
@@ -25,8 +26,8 @@ class Invitations extends Api
2526
* Get a list of pending invitations
2627
*
2728
* @access public
28-
* @param string $account The name of an individual or team account.
29-
* @return mixed
29+
* @param string $account The name of an individual or team account.
30+
* @return MessageInterface
3031
*/
3132
public function all($account)
3233
{
@@ -41,9 +42,9 @@ public function all($account)
4142
* Gets any pending invitations on a team or individual account for a particular email address.
4243
*
4344
* @access public
44-
* @param string $account The name of an individual or team account.
45-
* @param string $email The email address to get.
46-
* @return mixed
45+
* @param string $account The name of an individual or team account.
46+
* @param string $email The email address to get.
47+
* @return MessageInterface
4748
*/
4849
public function email($account, $email)
4950
{
@@ -56,16 +57,16 @@ public function email($account, $email)
5657
* Get a pending invitation for group membership
5758
*
5859
* @access public
59-
* @param string $account The name of an individual or team account.
60-
* @param string $group_owner The name of an individual or team account that owns the group.
61-
* @param string $group_slug An identifier for the group.
62-
* @param string $email Name of the email address
63-
* @return mixed
60+
* @param string $account The name of an individual or team account.
61+
* @param string $groupOwner The name of an individual or team account that owns the group.
62+
* @param string $groupSlug An identifier for the group.
63+
* @param string $email Name of the email address
64+
* @return MessageInterface
6465
*/
65-
public function group($account, $group_owner, $group_slug, $email)
66+
public function group($account, $groupOwner, $groupSlug, $email)
6667
{
6768
return $this->requestGet(
68-
sprintf('users/%s/invitations/%s/%s/%s', $account, $email, $group_owner, $group_slug)
69+
sprintf('users/%s/invitations/%s/%s/%s', $account, $email, $groupOwner, $groupSlug)
6970
);
7071
}
7172

@@ -75,16 +76,16 @@ public function group($account, $group_owner, $group_slug, $email)
7576
* An invitation is a request sent to an external email address to participate one or more of an account's groups.
7677
*
7778
* @access public
78-
* @param string $account The name of an individual or team account.
79-
* @param string $group_owner The name of an individual or team account that owns the group.
80-
* @param string $group_slug An identifier for the group.
81-
* @param string $email Name of the email address
82-
* @return mixed
79+
* @param string $account The name of an individual or team account.
80+
* @param string $groupOwner The name of an individual or team account that owns the group.
81+
* @param string $groupSlug An identifier for the group.
82+
* @param string $email Name of the email address
83+
* @return MessageInterface
8384
*/
84-
public function create($account, $group_owner, $group_slug, $email)
85+
public function create($account, $groupOwner, $groupSlug, $email)
8586
{
8687
return $this->requestPut(
87-
sprintf('users/%s/invitations/%s/%s/%s', $account, $email, $group_owner, $group_slug)
88+
sprintf('users/%s/invitations/%s/%s/%s', $account, $email, $groupOwner, $groupSlug)
8889
);
8990
}
9091

@@ -94,9 +95,9 @@ public function create($account, $group_owner, $group_slug, $email)
9495
* Deletes any pending invitations on a team or individual account for a particular email address.
9596
*
9697
* @access public
97-
* @param string $account The name of an individual or team account.
98-
* @param string $email Name of the email address to delete.
99-
* @return mixed
98+
* @param string $account The name of an individual or team account.
99+
* @param string $email Name of the email address to delete.
100+
* @return MessageInterface
100101
*/
101102
public function deleteByEmail($account, $email)
102103
{
@@ -111,16 +112,16 @@ public function deleteByEmail($account, $email)
111112
* Deletes a pending invitation for a particular email on account's group.
112113
*
113114
* @access public
114-
* @param string $account The name of an individual or team account.
115-
* @param string $group_owner The name of an individual or team account that owns the group.
116-
* @param string $group_slug An identifier for the group.
117-
* @param string $email Name of the email address to delete.
118-
* @return mixed
115+
* @param string $account The name of an individual or team account.
116+
* @param string $groupOwner The name of an individual or team account that owns the group.
117+
* @param string $groupSlug An identifier for the group.
118+
* @param string $email Name of the email address to delete.
119+
* @return MessageInterface
119120
*/
120-
public function deleteByGroup($account, $group_owner, $group_slug, $email)
121+
public function deleteByGroup($account, $groupOwner, $groupSlug, $email)
121122
{
122123
return $this->requestDelete(
123-
sprintf('users/%s/invitations/%s/%s/%s', $account, $email, $group_owner, $group_slug)
124+
sprintf('users/%s/invitations/%s/%s/%s', $account, $email, $groupOwner, $groupSlug)
124125
);
125126
}
126127
}

‎lib/Bitbucket/API/Users/OAuth.php‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Bitbucket\API\Users;
1313

1414
use Bitbucket\API\Api;
15+
use Buzz\Message\MessageInterface;
1516

1617
/**
1718
* Allows you to maintain OAuth consumers.
@@ -24,8 +25,8 @@ class OAuth extends Api
2425
* Get all OAuth consumers
2526
*
2627
* @access public
27-
* @param string $account The name of an individual or team account.
28-
* @return mixed
28+
* @param string $account The name of an individual or team account.
29+
* @return MessageInterface
2930
*/
3031
public function all($account)
3132
{
@@ -38,11 +39,11 @@ public function all($account)
3839
* Create new OAuth consumer
3940
*
4041
* @access public
41-
* @param string $account The name of an individual or team account.
42-
* @param string $name A display name for the key.
43-
* @param string $description A description of the key. (optional)
44-
* @param string $url The location of the service that will use the key. (optional)
45-
* @return mixed
42+
* @param string $account The name of an individual or team account.
43+
* @param string $name A display name for the key.
44+
* @param string $description A description of the key. (optional)
45+
* @param string $url The location of the service that will use the key. (optional)
46+
* @return MessageInterface
4647
*/
4748
public function create($account, $name, $description = null, $url = null)
4849
{
@@ -66,14 +67,14 @@ public function create($account, $name, $description = null, $url = null)
6667
* Update an OAuth consumer
6768
*
6869
* @access public
69-
* @param string $account The name of an individual or team account.
70-
* @param string $name A display name for the key.
71-
* @param int $key_id The id of the key to update.
72-
* @param string $description A description of the key. (optional)
73-
* @param string $url The location of the service that will use the key. (optional)
74-
* @return mixed
70+
* @param string $account The name of an individual or team account.
71+
* @param string $name A display name for the key.
72+
* @param int $keyId The id of the key to update.
73+
* @param string $description A description of the key. (optional)
74+
* @param string $url The location of the service that will use the key. (optional)
75+
* @return MessageInterface
7576
*/
76-
public function update($account, $name, $key_id, $description = null, $url = null)
77+
public function update($account, $name, $keyId, $description = null, $url = null)
7778
{
7879
$params = array('name' => $name);
7980

@@ -86,7 +87,7 @@ public function update($account, $name, $key_id, $description = null, $url = nul
8687
}
8788

8889
return $this->requestPut(
89-
sprintf('users/%s/consumers/%d', $account, $key_id),
90+
sprintf('users/%s/consumers/%d', $account, $keyId),
9091
$params
9192
);
9293
}
@@ -95,14 +96,14 @@ public function update($account, $name, $key_id, $description = null, $url = nul
9596
* Delete OAuth consumer
9697
*
9798
* @access public
98-
* @param string $account The name of an individual or team account.
99-
* @param int $key_id The id of the key to delete.
100-
* @return mixed
99+
* @param string $account The name of an individual or team account.
100+
* @param int $keyId The id of the key to delete.
101+
* @return MessageInterface
101102
*/
102-
public function delete($account, $key_id)
103+
public function delete($account, $keyId)
103104
{
104105
return $this->requestDelete(
105-
sprintf('users/%s/consumers/%d', $account, $key_id)
106+
sprintf('users/%s/consumers/%d', $account, $keyId)
106107
);
107108
}
108109
}

0 commit comments

Comments
 (0)