Skip to content

Commit 74a38bf

Browse files
committed
fixed documented return type
1 parent 01f64df commit 74a38bf

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

lib/Redmine/Api/Project.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function listing($forceUpdate = false, $reverse = true)
4949
/**
5050
* Get a project id given its name
5151
* @param string $name
52-
* @return int
52+
* @return integer|boolean
5353
*/
5454
public function getIdByName($name)
5555
{

lib/Redmine/Api/User.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function getCurrentUser()
6060
/**
6161
* Get a user id given its username
6262
* @param string $username
63-
* @return int
63+
* @return integer|boolean
6464
*/
6565
public function getIdByUsername($username)
6666
{

lib/Redmine/Client.php

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,13 @@ public function get($path)
159159
}
160160

161161
/**
162-
* Decodes json response
162+
* Decodes json response.
163+
*
164+
* Returns $json if no error occured during decoding but decoded value is
165+
* null.
166+
*
163167
* @param string $json
164-
* @return array
168+
* @return array|string
165169
*/
166170
public function decode($json)
167171
{
@@ -312,11 +316,13 @@ public function getImpersonateUser()
312316
}
313317

314318
/**
315-
* @param string $path
316-
* @param string $method
317-
* @param string $data
318-
* @return false|SimpleXMLElement|string
319-
* @throws \Exception If anything goes wrong on curl request
319+
* @param string $path
320+
* @param string $method
321+
* @param string $data
322+
*
323+
* @return boolean|SimpleXMLElement|string
324+
*
325+
* @throws \Exception If anything goes wrong on curl request
320326
*/
321327
protected function runRequest($path, $method = 'GET', $data = '')
322328
{

0 commit comments

Comments
 (0)