@@ -112,6 +112,7 @@ discard block |
||
| 112 | 112 | |
| 113 | 113 | /** |
| 114 | 114 | * Add a service |
| 115 | + * @param string $service |
|
| 115 | 116 | */ |
| 116 | 117 | public function addService($service, $version = false) { |
| 117 | 118 | global $apiConfig; |
@@ -320,7 +321,7 @@ discard block |
||
| 320 | 321 | * token, if a token isn't provided. |
| 321 | 322 | * @throws Google_AuthException |
| 322 | 323 | * @param string|null $token The token (access token or a refresh token) that should be revoked. |
| 323 | - * @return boolean Returns True if the revocation was successful, otherwise False. |
|
| 324 | + * @return boolean|null Returns True if the revocation was successful, otherwise False. |
|
| 324 | 325 | */ |
| 325 | 326 | public function revokeToken($token = null) { |
| 326 | 327 | self::$auth->revokeToken($token); |
@@ -182,7 +182,7 @@ |
||
| 182 | 182 | /** |
| 183 | 183 | * @visible for testing. |
| 184 | 184 | * @param Google_HttpRequest $request |
| 185 | - * @return Google_HttpRequest|bool Returns the cached object or |
|
| 185 | + * @return Google_HttpRequest Returns the cached object or |
|
| 186 | 186 | * false if the operation was unsuccessful. |
| 187 | 187 | */ |
| 188 | 188 | public function getCachedRequest(Google_HttpRequest $request) { |
@@ -44,6 +44,9 @@ discard block |
||
| 44 | 44 | |
| 45 | 45 | public $accessKey; |
| 46 | 46 | |
| 47 | + /** |
|
| 48 | + * @param string|boolean $url |
|
| 49 | + */ |
|
| 47 | 50 | public function __construct($url, $method = 'GET', $headers = array(), $postBody = null) { |
| 48 | 51 | $this->setUrl($url); |
| 49 | 52 | $this->setRequestMethod($method); |
@@ -87,7 +90,7 @@ discard block |
||
| 87 | 90 | } |
| 88 | 91 | |
| 89 | 92 | /** |
| 90 | - * @return string HTTP Response Code. |
|
| 93 | + * @return integer HTTP Response Code. |
|
| 91 | 94 | */ |
| 92 | 95 | public function getResponseHttpCode() { |
| 93 | 96 | return (int) $this->responseHttpCode; |
@@ -133,7 +133,7 @@ |
||
| 133 | 133 | |
| 134 | 134 | /** |
| 135 | 135 | * Process standard file uploads. |
| 136 | - * @param $file |
|
| 136 | + * @param boolean|string $file |
|
| 137 | 137 | * @internal param $fileName |
| 138 | 138 | * @return array Inclues the processed file name. |
| 139 | 139 | * @visible For testing. |
@@ -85,7 +85,7 @@ |
||
| 85 | 85 | /** |
| 86 | 86 | * Given a variable name, discover its type. |
| 87 | 87 | * |
| 88 | - * @param $name |
|
| 88 | + * @param string $name |
|
| 89 | 89 | * @param $item |
| 90 | 90 | * @return object The object from the item. |
| 91 | 91 | */ |
@@ -52,6 +52,10 @@ discard block |
||
| 52 | 52 | /** @var array $methods */ |
| 53 | 53 | private $methods; |
| 54 | 54 | |
| 55 | + /** |
|
| 56 | + * @param string $serviceName |
|
| 57 | + * @param string $resourceName |
|
| 58 | + */ |
|
| 55 | 59 | public function __construct($service, $serviceName, $resourceName, $resource) { |
| 56 | 60 | $this->service = $service; |
| 57 | 61 | $this->serviceName = $serviceName; |
@@ -60,7 +64,7 @@ discard block |
||
| 60 | 64 | } |
| 61 | 65 | |
| 62 | 66 | /** |
| 63 | - * @param $name |
|
| 67 | + * @param string $name |
|
| 64 | 68 | * @param $arguments |
| 65 | 69 | * @return Google_HttpRequest|array |
| 66 | 70 | * @throws Google_Exception |
@@ -22,6 +22,10 @@ |
||
| 22 | 22 | * @author Chirag Shah <[email protected]> |
| 23 | 23 | */ |
| 24 | 24 | class Google_Utils { |
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * @param string $data |
|
| 28 | + */ |
|
| 25 | 29 | public static function urlSafeB64Encode($data) { |
| 26 | 30 | $b64 = base64_encode($data); |
| 27 | 31 | $b64 = str_replace(array('+', '/', '\r', '\n', '='), |
@@ -135,6 +135,9 @@ discard block |
||
| 135 | 135 | } |
| 136 | 136 | } |
| 137 | 137 | |
| 138 | + /** |
|
| 139 | + * @param integer $name |
|
| 140 | + */ |
|
| 138 | 141 | Function CookieEncode($value, $name) |
| 139 | 142 | { |
| 140 | 143 | return($name ? str_replace("=", "%25", $value) : str_replace(";", "%3B", $value)); |
@@ -146,6 +149,10 @@ discard block |
||
| 146 | 149 | return($this->error=$error); |
| 147 | 150 | } |
| 148 | 151 | |
| 152 | + /** |
|
| 153 | + * @param string $error |
|
| 154 | + * @param integer $error_code |
|
| 155 | + */ |
|
| 149 | 156 | Function SetPHPError($error, &$php_error_message, $error_code = HTTP_CLIENT_ERROR_UNSPECIFIED_ERROR) |
| 150 | 157 | { |
| 151 | 158 | if(IsSet($php_error_message) |
@@ -154,6 +161,9 @@ discard block |
||
| 154 | 161 | return($this->SetError($error, $error_code)); |
| 155 | 162 | } |
| 156 | 163 | |
| 164 | + /** |
|
| 165 | + * @param string $error |
|
| 166 | + */ |
|
| 157 | 167 | Function SetDataAccessError($error,$check_connection=0) |
| 158 | 168 | { |
| 159 | 169 | $this->error=$error; |
@@ -264,6 +274,9 @@ discard block |
||
| 264 | 274 | return(1); |
| 265 | 275 | } |
| 266 | 276 | |
| 277 | + /** |
|
| 278 | + * @return string |
|
| 279 | + */ |
|
| 267 | 280 | Function ReadChunkSize() |
| 268 | 281 | { |
| 269 | 282 | if($this->remaining_chunk==0) |
@@ -289,6 +302,9 @@ discard block |
||
| 289 | 302 | return(""); |
| 290 | 303 | } |
| 291 | 304 | |
| 305 | + /** |
|
| 306 | + * @return string |
|
| 307 | + */ |
|
| 292 | 308 | Function ReadBytes($length) |
| 293 | 309 | { |
| 294 | 310 | if($this->use_curl) |
@@ -367,6 +383,9 @@ discard block |
||
| 367 | 383 | return(feof($this->connection)); |
| 368 | 384 | } |
| 369 | 385 | |
| 386 | + /** |
|
| 387 | + * @param string $server_type |
|
| 388 | + */ |
|
| 370 | 389 | Function Resolve($domain, &$ip, $server_type) |
| 371 | 390 | { |
| 372 | 391 | if(preg_match('/^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/',$domain)) |
@@ -385,6 +404,9 @@ discard block |
||
| 385 | 404 | return(''); |
| 386 | 405 | } |
| 387 | 406 | |
| 407 | + /** |
|
| 408 | + * @param boolean $ssl |
|
| 409 | + */ |
|
| 388 | 410 | Function Connect($host_name, $host_port, $ssl, $server_type = 'HTTP') |
| 389 | 411 | { |
| 390 | 412 | $domain=$host_name; |
@@ -569,6 +591,9 @@ discard block |
||
| 569 | 591 | |
| 570 | 592 | /* Public methods */ |
| 571 | 593 | |
| 594 | + /** |
|
| 595 | + * @return string |
|
| 596 | + */ |
|
| 572 | 597 | Function GetRequestArguments($url, &$arguments) |
| 573 | 598 | { |
| 574 | 599 | $this->error = ''; |
@@ -767,6 +792,9 @@ discard block |
||
| 767 | 792 | return($this->Disconnect()); |
| 768 | 793 | } |
| 769 | 794 | |
| 795 | + /** |
|
| 796 | + * @param integer $secure |
|
| 797 | + */ |
|
| 770 | 798 | Function PickCookies(&$cookies,$secure) |
| 771 | 799 | { |
| 772 | 800 | if(IsSet($this->cookies[$secure])) |
@@ -1439,6 +1467,11 @@ discard block |
||
| 1439 | 1467 | return(""); |
| 1440 | 1468 | } |
| 1441 | 1469 | |
| 1470 | + /** |
|
| 1471 | + * @param string $name |
|
| 1472 | + * |
|
| 1473 | + * @return string |
|
| 1474 | + */ |
|
| 1442 | 1475 | Function SetCookie($name, $value, $expires="" , $path="/" , $domain="" , $secure=0, $verbatim=0) |
| 1443 | 1476 | { |
| 1444 | 1477 | if(strlen($this->error)) |
@@ -1677,6 +1710,9 @@ discard block |
||
| 1677 | 1710 | return(""); |
| 1678 | 1711 | } |
| 1679 | 1712 | |
| 1713 | + /** |
|
| 1714 | + * @param integer $proxy |
|
| 1715 | + */ |
|
| 1680 | 1716 | Function Authenticate(&$headers, $proxy, &$proxy_authorization, &$user, &$password, &$realm, &$workstation) |
| 1681 | 1717 | { |
| 1682 | 1718 | if($proxy) |
@@ -1937,6 +1973,9 @@ discard block |
||
| 1937 | 1973 | return(""); |
| 1938 | 1974 | } |
| 1939 | 1975 | |
| 1976 | + /** |
|
| 1977 | + * @param integer $length |
|
| 1978 | + */ |
|
| 1940 | 1979 | Function ReadReplyBody(&$body,$length) |
| 1941 | 1980 | { |
| 1942 | 1981 | $body=""; |
@@ -1979,6 +2018,9 @@ discard block |
||
| 1979 | 2018 | return(""); |
| 1980 | 2019 | } |
| 1981 | 2020 | |
| 2021 | + /** |
|
| 2022 | + * @return string |
|
| 2023 | + */ |
|
| 1982 | 2024 | Function ReadWholeReplyBody(&$body) |
| 1983 | 2025 | { |
| 1984 | 2026 | $body = ''; |
@@ -596,6 +596,9 @@ discard block |
||
| 596 | 596 | return(false); |
| 597 | 597 | } |
| 598 | 598 | |
| 599 | + /** |
|
| 600 | + * @param string $error |
|
| 601 | + */ |
|
| 599 | 602 | Function SetPHPError($error, &$php_error_message) |
| 600 | 603 | { |
| 601 | 604 | if(IsSet($php_error_message) |
@@ -604,6 +607,9 @@ discard block |
||
| 604 | 607 | return($this->SetError($error)); |
| 605 | 608 | } |
| 606 | 609 | |
| 610 | + /** |
|
| 611 | + * @param string $message |
|
| 612 | + */ |
|
| 607 | 613 | Function OutputDebug($message) |
| 608 | 614 | { |
| 609 | 615 | if($this->debug) |
@@ -655,6 +661,9 @@ discard block |
||
| 655 | 661 | return(true); |
| 656 | 662 | } |
| 657 | 663 | |
| 664 | + /** |
|
| 665 | + * @param string $error |
|
| 666 | + */ |
|
| 658 | 667 | Function GetRequestError(&$error) |
| 659 | 668 | { |
| 660 | 669 | $error = (IsSet($_GET['error']) ? $_GET['error'] : null); |
@@ -849,6 +858,11 @@ discard block |
||
| 849 | 858 | return $array; |
| 850 | 859 | } |
| 851 | 860 | |
| 861 | + /** |
|
| 862 | + * @param string $function |
|
| 863 | + * @param string $data |
|
| 864 | + * @param string $key |
|
| 865 | + */ |
|
| 852 | 866 | Function HMAC($function, $data, $key) |
| 853 | 867 | { |
| 854 | 868 | switch($function) |
@@ -1146,6 +1160,10 @@ discard block |
||
| 1146 | 1160 | <do> |
| 1147 | 1161 | {/metadocument} |
| 1148 | 1162 | */ |
| 1163 | + /** |
|
| 1164 | + * @param string $url |
|
| 1165 | + * @param string $method |
|
| 1166 | + */ |
|
| 1149 | 1167 | Function CallAPI($url, $method, $parameters, $options, &$response) |
| 1150 | 1168 | { |
| 1151 | 1169 | if(!IsSet($options['Resource'])) |
@@ -1735,6 +1753,9 @@ discard block |
||
| 1735 | 1753 | <do> |
| 1736 | 1754 | {/metadocument} |
| 1737 | 1755 | */ |
| 1756 | + /** |
|
| 1757 | + * @param boolean $success |
|
| 1758 | + */ |
|
| 1738 | 1759 | Function Finalize($success) |
| 1739 | 1760 | { |
| 1740 | 1761 | return($success); |