@@ -500,7 +500,7 @@ discard block |
||
| 500 | 500 | * @param [$issuer] the expected issues, defaults to Google |
| 501 | 501 | * @param [$max_expiry] the max lifetime of a token, defaults to MAX_TOKEN_LIFETIME_SECS |
| 502 | 502 | * @throws Google_Auth_Exception |
| 503 | - * @return mixed token information if valid, false if not |
|
| 503 | + * @return Google_Auth_LoginTicket token information if valid, false if not |
|
| 504 | 504 | */ |
| 505 | 505 | public function verifySignedJwtWithCerts( |
| 506 | 506 | $jwt, |
@@ -626,6 +626,7 @@ discard block |
||
| 626 | 626 | |
| 627 | 627 | /** |
| 628 | 628 | * Add a parameter to the auth params if not empty string. |
| 629 | + * @param string $name |
|
| 629 | 630 | */ |
| 630 | 631 | private function maybeAddParam($params, $name) |
| 631 | 632 | { |
@@ -129,6 +129,9 @@ discard block |
||
| 129 | 129 | ); |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | + /** |
|
| 133 | + * @param string $file |
|
| 134 | + */ |
|
| 132 | 135 | private function getWriteableCacheFile($file) |
| 133 | 136 | { |
| 134 | 137 | return $this->getCacheFile($file, true); |
@@ -139,6 +142,9 @@ discard block |
||
| 139 | 142 | return $this->getCacheDir($file, $forWrite) . '/' . md5($file); |
| 140 | 143 | } |
| 141 | 144 | |
| 145 | + /** |
|
| 146 | + * @param boolean $forWrite |
|
| 147 | + */ |
|
| 142 | 148 | private function getCacheDir($file, $forWrite) |
| 143 | 149 | { |
| 144 | 150 | // use the first 2 characters of the hash as a directory prefix |
@@ -157,11 +163,17 @@ discard block |
||
| 157 | 163 | return $storageDir; |
| 158 | 164 | } |
| 159 | 165 | |
| 166 | + /** |
|
| 167 | + * @param string $storageFile |
|
| 168 | + */ |
|
| 160 | 169 | private function acquireReadLock($storageFile) |
| 161 | 170 | { |
| 162 | 171 | return $this->acquireLock(LOCK_SH, $storageFile); |
| 163 | 172 | } |
| 164 | 173 | |
| 174 | + /** |
|
| 175 | + * @param string $storageFile |
|
| 176 | + */ |
|
| 165 | 177 | private function acquireWriteLock($storageFile) |
| 166 | 178 | { |
| 167 | 179 | $rc = $this->acquireLock(LOCK_EX, $storageFile); |
@@ -175,6 +187,9 @@ discard block |
||
| 175 | 187 | return $rc; |
| 176 | 188 | } |
| 177 | 189 | |
| 190 | + /** |
|
| 191 | + * @param integer $type |
|
| 192 | + */ |
|
| 178 | 193 | private function acquireLock($type, $storageFile) |
| 179 | 194 | { |
| 180 | 195 | $mode = $type == LOCK_EX ? "w" : "r"; |
@@ -197,6 +212,9 @@ discard block |
||
| 197 | 212 | return true; |
| 198 | 213 | } |
| 199 | 214 | |
| 215 | + /** |
|
| 216 | + * @param string $storageFile |
|
| 217 | + */ |
|
| 200 | 218 | public function unlock($storageFile) |
| 201 | 219 | { |
| 202 | 220 | if ($this->fh) { |
@@ -191,7 +191,7 @@ discard block |
||
| 191 | 191 | |
| 192 | 192 | /** |
| 193 | 193 | * @throws Google_Auth_Exception |
| 194 | - * @return array |
|
| 194 | + * @return string |
|
| 195 | 195 | * @visible For Testing |
| 196 | 196 | */ |
| 197 | 197 | public function prepareScopes() |
@@ -490,7 +490,7 @@ discard block |
||
| 490 | 490 | * @param $audience string the expected consumer of the token |
| 491 | 491 | * @param $issuer string the expected issuer, defaults to Google |
| 492 | 492 | * @param [$max_expiry] the max lifetime of a token, defaults to MAX_TOKEN_LIFETIME_SECS |
| 493 | - * @return mixed token information if valid, false if not |
|
| 493 | + * @return Google_Auth_LoginTicket token information if valid, false if not |
|
| 494 | 494 | */ |
| 495 | 495 | public function verifySignedJwt($id_token, $cert_location, $audience, $issuer, $max_expiry = null) |
| 496 | 496 | { |
@@ -512,6 +512,7 @@ discard block |
||
| 512 | 512 | * Will remove any previously configured scopes. |
| 513 | 513 | * @param array $scopes, ie: array('https://www.googleapis.com/auth/plus.login', |
| 514 | 514 | * 'https://www.googleapis.com/auth/moderator') |
| 515 | + * @param string[] $scopes |
|
| 515 | 516 | */ |
| 516 | 517 | public function setScopes($scopes) |
| 517 | 518 | { |
@@ -79,7 +79,7 @@ discard block |
||
| 79 | 79 | |
| 80 | 80 | /** |
| 81 | 81 | * Set the base URL that path and query parameters will be added to. |
| 82 | - * @param $baseComponent string |
|
| 82 | + * @param string $baseComponent string |
|
| 83 | 83 | */ |
| 84 | 84 | public function setBaseComponent($baseComponent) |
| 85 | 85 | { |
@@ -132,7 +132,7 @@ discard block |
||
| 132 | 132 | |
| 133 | 133 | /** |
| 134 | 134 | * Set a new query parameter. |
| 135 | - * @param $key - string to set, does not need to be URL encoded |
|
| 135 | + * @param string $key - string to set, does not need to be URL encoded |
|
| 136 | 136 | * @param $value - string to set, does not need to be URL encoded |
| 137 | 137 | */ |
| 138 | 138 | public function setQueryParam($key, $value) |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | } |
| 142 | 142 | |
| 143 | 143 | /** |
| 144 | - * @return string HTTP Response Code. |
|
| 144 | + * @return integer HTTP Response Code. |
|
| 145 | 145 | */ |
| 146 | 146 | public function getResponseHttpCode() |
| 147 | 147 | { |
@@ -261,7 +261,7 @@ discard block |
||
| 261 | 261 | /** |
| 262 | 262 | * Logs with an arbitrary level. |
| 263 | 263 | * |
| 264 | - * @param mixed $level The log level |
|
| 264 | + * @param string $level The log level |
|
| 265 | 265 | * @param string $message The log message |
| 266 | 266 | * @param array $context The log context |
| 267 | 267 | */ |
@@ -380,7 +380,7 @@ discard block |
||
| 380 | 380 | /** |
| 381 | 381 | * Converts a given log level to the integer form. |
| 382 | 382 | * |
| 383 | - * @param mixed $level The logging level |
|
| 383 | + * @param integer $level The logging level |
|
| 384 | 384 | * @return integer $level The normalized level |
| 385 | 385 | * @throws Google_Logger_Exception If $level is invalid |
| 386 | 386 | */ |
@@ -221,7 +221,7 @@ discard block |
||
| 221 | 221 | /** |
| 222 | 222 | * Given a variable name, discover its type. |
| 223 | 223 | * |
| 224 | - * @param $name |
|
| 224 | + * @param string $name |
|
| 225 | 225 | * @param $item |
| 226 | 226 | * @return object The object from the item. |
| 227 | 227 | */ |
@@ -278,6 +278,9 @@ discard block |
||
| 278 | 278 | return $key . "Type"; |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | + /** |
|
| 282 | + * @param string $key |
|
| 283 | + */ |
|
| 281 | 284 | protected function dataType($key) |
| 282 | 285 | { |
| 283 | 286 | return $key . "DataType"; |
@@ -435,7 +435,7 @@ discard block |
||
| 435 | 435 | * (accounts.patch) |
| 436 | 436 | * |
| 437 | 437 | * @param int $id The account id |
| 438 | - * @param Google_Account $postBody |
|
| 438 | + * @param Google_Service_AdExchangeBuyer_Account $postBody |
|
| 439 | 439 | * @param array $optParams Optional parameters. |
| 440 | 440 | * @return Google_Service_AdExchangeBuyer_Account |
| 441 | 441 | */ |
@@ -450,7 +450,7 @@ discard block |
||
| 450 | 450 | * Updates an existing account. (accounts.update) |
| 451 | 451 | * |
| 452 | 452 | * @param int $id The account id |
| 453 | - * @param Google_Account $postBody |
|
| 453 | + * @param Google_Service_AdExchangeBuyer_Account $postBody |
|
| 454 | 454 | * @param array $optParams Optional parameters. |
| 455 | 455 | * @return Google_Service_AdExchangeBuyer_Account |
| 456 | 456 | */ |
@@ -539,7 +539,7 @@ discard block |
||
| 539 | 539 | * updated. |
| 540 | 540 | * @param string $billingId The billing id associated with the budget being |
| 541 | 541 | * updated. |
| 542 | - * @param Google_Budget $postBody |
|
| 542 | + * @param Google_Service_AdExchangeBuyer_Budget $postBody |
|
| 543 | 543 | * @param array $optParams Optional parameters. |
| 544 | 544 | * @return Google_Service_AdExchangeBuyer_Budget |
| 545 | 545 | */ |
@@ -559,7 +559,7 @@ discard block |
||
| 559 | 559 | * updated. |
| 560 | 560 | * @param string $billingId The billing id associated with the budget being |
| 561 | 561 | * updated. |
| 562 | - * @param Google_Budget $postBody |
|
| 562 | + * @param Google_Service_AdExchangeBuyer_Budget $postBody |
|
| 563 | 563 | * @param array $optParams Optional parameters. |
| 564 | 564 | * @return Google_Service_AdExchangeBuyer_Budget |
| 565 | 565 | */ |
@@ -601,7 +601,7 @@ discard block |
||
| 601 | 601 | /** |
| 602 | 602 | * Submit a new creative. (creatives.insert) |
| 603 | 603 | * |
| 604 | - * @param Google_Creative $postBody |
|
| 604 | + * @param Google_Service_AdExchangeBuyer_Creative $postBody |
|
| 605 | 605 | * @param array $optParams Optional parameters. |
| 606 | 606 | * @return Google_Service_AdExchangeBuyer_Creative |
| 607 | 607 | */ |
@@ -762,7 +762,7 @@ discard block |
||
| 762 | 762 | * |
| 763 | 763 | * @param string $accountId The account id to insert the pretargeting config |
| 764 | 764 | * for. |
| 765 | - * @param Google_PretargetingConfig $postBody |
|
| 765 | + * @param Google_Service_AdExchangeBuyer_PretargetingConfig $postBody |
|
| 766 | 766 | * @param array $optParams Optional parameters. |
| 767 | 767 | * @return Google_Service_AdExchangeBuyer_PretargetingConfig |
| 768 | 768 | */ |
@@ -795,7 +795,7 @@ discard block |
||
| 795 | 795 | * @param string $accountId The account id to update the pretargeting config |
| 796 | 796 | * for. |
| 797 | 797 | * @param string $configId The specific id of the configuration to update. |
| 798 | - * @param Google_PretargetingConfig $postBody |
|
| 798 | + * @param Google_Service_AdExchangeBuyer_PretargetingConfig $postBody |
|
| 799 | 799 | * @param array $optParams Optional parameters. |
| 800 | 800 | * @return Google_Service_AdExchangeBuyer_PretargetingConfig |
| 801 | 801 | */ |
@@ -812,7 +812,7 @@ discard block |
||
| 812 | 812 | * @param string $accountId The account id to update the pretargeting config |
| 813 | 813 | * for. |
| 814 | 814 | * @param string $configId The specific id of the configuration to update. |
| 815 | - * @param Google_PretargetingConfig $postBody |
|
| 815 | + * @param Google_Service_AdExchangeBuyer_PretargetingConfig $postBody |
|
| 816 | 816 | * @param array $optParams Optional parameters. |
| 817 | 817 | * @return Google_Service_AdExchangeBuyer_PretargetingConfig |
| 818 | 818 | */ |
@@ -89,7 +89,7 @@ |
||
| 89 | 89 | * Insert Mail into Google's Gmail backends (mail.insert) |
| 90 | 90 | * |
| 91 | 91 | * @param string $userKey The email or immutable id of the user |
| 92 | - * @param Google_MailItem $postBody |
|
| 92 | + * @param Google_Service_Admin_MailItem $postBody |
|
| 93 | 93 | * @param array $optParams Optional parameters. |
| 94 | 94 | */ |
| 95 | 95 | public function insert($userKey, Google_Service_Admin_MailItem $postBody, $optParams = array()) |
@@ -790,7 +790,7 @@ discard block |
||
| 790 | 790 | * |
| 791 | 791 | * @param string $accountId Account which will contain the ad unit. |
| 792 | 792 | * @param string $adClientId Ad client into which to insert the ad unit. |
| 793 | - * @param Google_AdUnit $postBody |
|
| 793 | + * @param Google_Service_AdSenseHost_AdUnit $postBody |
|
| 794 | 794 | * @param array $optParams Optional parameters. |
| 795 | 795 | * @return Google_Service_AdSenseHost_AdUnit |
| 796 | 796 | */ |
@@ -832,7 +832,7 @@ discard block |
||
| 832 | 832 | * @param string $accountId Account which contains the ad client. |
| 833 | 833 | * @param string $adClientId Ad client which contains the ad unit. |
| 834 | 834 | * @param string $adUnitId Ad unit to get. |
| 835 | - * @param Google_AdUnit $postBody |
|
| 835 | + * @param Google_Service_AdSenseHost_AdUnit $postBody |
|
| 836 | 836 | * @param array $optParams Optional parameters. |
| 837 | 837 | * @return Google_Service_AdSenseHost_AdUnit |
| 838 | 838 | */ |
@@ -849,7 +849,7 @@ discard block |
||
| 849 | 849 | * |
| 850 | 850 | * @param string $accountId Account which contains the ad client. |
| 851 | 851 | * @param string $adClientId Ad client which contains the ad unit. |
| 852 | - * @param Google_AdUnit $postBody |
|
| 852 | + * @param Google_Service_AdSenseHost_AdUnit $postBody |
|
| 853 | 853 | * @param array $optParams Optional parameters. |
| 854 | 854 | * @return Google_Service_AdSenseHost_AdUnit |
| 855 | 855 | */ |
@@ -1044,7 +1044,7 @@ discard block |
||
| 1044 | 1044 | * |
| 1045 | 1045 | * @param string $adClientId Ad client to which the new custom channel will be |
| 1046 | 1046 | * added. |
| 1047 | - * @param Google_CustomChannel $postBody |
|
| 1047 | + * @param Google_Service_AdSenseHost_CustomChannel $postBody |
|
| 1048 | 1048 | * @param array $optParams Optional parameters. |
| 1049 | 1049 | * @return Google_Service_AdSenseHost_CustomChannel |
| 1050 | 1050 | */ |
@@ -1083,7 +1083,7 @@ discard block |
||
| 1083 | 1083 | * @param string $adClientId Ad client in which the custom channel will be |
| 1084 | 1084 | * updated. |
| 1085 | 1085 | * @param string $customChannelId Custom channel to get. |
| 1086 | - * @param Google_CustomChannel $postBody |
|
| 1086 | + * @param Google_Service_AdSenseHost_CustomChannel $postBody |
|
| 1087 | 1087 | * @param array $optParams Optional parameters. |
| 1088 | 1088 | * @return Google_Service_AdSenseHost_CustomChannel |
| 1089 | 1089 | */ |
@@ -1099,7 +1099,7 @@ discard block |
||
| 1099 | 1099 | * |
| 1100 | 1100 | * @param string $adClientId Ad client in which the custom channel will be |
| 1101 | 1101 | * updated. |
| 1102 | - * @param Google_CustomChannel $postBody |
|
| 1102 | + * @param Google_Service_AdSenseHost_CustomChannel $postBody |
|
| 1103 | 1103 | * @param array $optParams Optional parameters. |
| 1104 | 1104 | * @return Google_Service_AdSenseHost_CustomChannel |
| 1105 | 1105 | */ |
@@ -1185,7 +1185,7 @@ discard block |
||
| 1185 | 1185 | * |
| 1186 | 1186 | * @param string $adClientId Ad client to which the new URL channel will be |
| 1187 | 1187 | * added. |
| 1188 | - * @param Google_UrlChannel $postBody |
|
| 1188 | + * @param Google_Service_AdSenseHost_UrlChannel $postBody |
|
| 1189 | 1189 | * @param array $optParams Optional parameters. |
| 1190 | 1190 | * @return Google_Service_AdSenseHost_UrlChannel |
| 1191 | 1191 | */ |