@@ -223,6 +223,9 @@ |
||
223 | 223 | * @param filter - the property to filter on |
224 | 224 | * @param limit - the number of items to get |
225 | 225 | * @param realtime - if the realtime api should be used |
226 | + * @param string $metric |
|
227 | + * @param string $startDate |
|
228 | + * @param string $endDate |
|
226 | 229 | * @return the specific metrics in array form |
227 | 230 | **/ |
228 | 231 | function getMetrics($metric, $startDate, $endDate, $dimensions = false, $sort = false, $filter = false, $limit = false, $realtime = false) |
@@ -27,6 +27,10 @@ discard block |
||
27 | 27 | private $privateKey; |
28 | 28 | |
29 | 29 | // Creates a new signer from a .p12 file. |
30 | + |
|
31 | + /** |
|
32 | + * @param string $password |
|
33 | + */ |
|
30 | 34 | function __construct($p12, $password) { |
31 | 35 | if (!function_exists('openssl_x509_read')) { |
32 | 36 | throw new Exception( |
@@ -57,6 +61,9 @@ discard block |
||
57 | 61 | } |
58 | 62 | } |
59 | 63 | |
64 | + /** |
|
65 | + * @param string $data |
|
66 | + */ |
|
60 | 67 | function sign($data) { |
61 | 68 | if(version_compare(PHP_VERSION, '5.3.0') < 0) { |
62 | 69 | throw new Google_AuthException( |
@@ -51,8 +51,8 @@ |
||
51 | 51 | * Verifies the signature on data. |
52 | 52 | * |
53 | 53 | * Returns true if the signature is valid, false otherwise. |
54 | - * @param $data |
|
55 | - * @param $signature |
|
54 | + * @param string $data |
|
55 | + * @param string $signature |
|
56 | 56 | * @throws Google_AuthException |
57 | 57 | * @return bool |
58 | 58 | */ |
@@ -37,6 +37,9 @@ discard block |
||
37 | 37 | return file_exists($storageFile . '.lock'); |
38 | 38 | } |
39 | 39 | |
40 | + /** |
|
41 | + * @param string $storageFile |
|
42 | + */ |
|
40 | 43 | private function createLock($storageFile) { |
41 | 44 | $storageDir = dirname($storageFile); |
42 | 45 | if (! is_dir($storageDir)) { |
@@ -57,6 +60,9 @@ discard block |
||
57 | 60 | @unlink($storageFile . '.lock'); |
58 | 61 | } |
59 | 62 | |
63 | + /** |
|
64 | + * @param string $storageFile |
|
65 | + */ |
|
60 | 66 | private function waitForLock($storageFile) { |
61 | 67 | // 20 x 250 = 5 seconds |
62 | 68 | $tries = 20; |
@@ -81,6 +87,9 @@ discard block |
||
81 | 87 | return $this->path . '/' . substr($hash, 0, 2); |
82 | 88 | } |
83 | 89 | |
90 | + /** |
|
91 | + * @param string $hash |
|
92 | + */ |
|
84 | 93 | private function getCacheFile($hash) { |
85 | 94 | return $this->getCacheDir($hash) . '/' . $hash; |
86 | 95 | } |
@@ -43,6 +43,9 @@ discard block |
||
43 | 43 | public static $reserved; |
44 | 44 | public static $reserved_pct; |
45 | 45 | |
46 | + /** |
|
47 | + * @param string $template |
|
48 | + */ |
|
46 | 49 | public function __construct($template) { |
47 | 50 | self::$reserved = array_merge(self::$gen_delims, self::$sub_delims); |
48 | 51 | self::$reserved_pct = array_merge(self::$gen_delims_pct, self::$sub_delims_pct); |
@@ -150,6 +153,9 @@ discard block |
||
150 | 153 | return $this->expansion; |
151 | 154 | } |
152 | 155 | |
156 | + /** |
|
157 | + * @param stdClass $exp |
|
158 | + */ |
|
153 | 159 | private function val_from_var($var, $exp) { |
154 | 160 | $val = ''; |
155 | 161 | if (is_array($var->data)) { |
@@ -108,6 +108,7 @@ discard block |
||
108 | 108 | |
109 | 109 | /** |
110 | 110 | * Add a service |
111 | + * @param string $service |
|
111 | 112 | */ |
112 | 113 | public function addService($service, $version = false) { |
113 | 114 | global $apiConfig; |
@@ -316,7 +317,7 @@ discard block |
||
316 | 317 | * token, if a token isn't provided. |
317 | 318 | * @throws Google_AuthException |
318 | 319 | * @param string|null $token The token (access token or a refresh token) that should be revoked. |
319 | - * @return boolean Returns True if the revocation was successful, otherwise False. |
|
320 | + * @return boolean|null Returns True if the revocation was successful, otherwise False. |
|
320 | 321 | */ |
321 | 322 | public function revokeToken($token = null) { |
322 | 323 | self::$auth->revokeToken($token); |
@@ -347,6 +348,7 @@ discard block |
||
347 | 348 | * so that you can ask for more or less permission in the auth flow |
348 | 349 | * Set this before you call authenticate() though! |
349 | 350 | * @param array $scopes, ie: array('https://www.googleapis.com/auth/plus.me', 'https://www.googleapis.com/auth/moderator') |
351 | + * @param string[] $scopes |
|
350 | 352 | */ |
351 | 353 | public function setScopes($scopes) { |
352 | 354 | $this->scopes = is_string($scopes) ? explode(" ", $scopes) : $scopes; |
@@ -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; |
@@ -140,6 +140,9 @@ |
||
140 | 140 | public function setOptions($options) { |
141 | 141 | } |
142 | 142 | |
143 | + /** |
|
144 | + * @return integer |
|
145 | + */ |
|
143 | 146 | private function getHttpResponseCode($response_headers) { |
144 | 147 | $header_count = count($response_headers); |
145 | 148 |
@@ -142,7 +142,7 @@ |
||
142 | 142 | |
143 | 143 | /** |
144 | 144 | * Prepares a standard file upload via cURL. |
145 | - * @param $file |
|
145 | + * @param boolean|string $file |
|
146 | 146 | * @param $mime |
147 | 147 | * @return array Includes the processed file name. |
148 | 148 | * @visible For testing. |