mpyw / cowitter

src/ClientInterface.php

Doc Comments +84 added lines, -14 removed lines

@@ -30,14 +30,19 @@ 
      *       e.g. [CURLOPT_USERAGENT => 'abc'],
      *            ['CURLOPT_USERAGENT' => 'abc']
      *
-     * @param bool $assoc
-     *     Use Assoc-style or not.
      *
-     * @param bool $stringify
-     *     Stringify CURLOPT_* constant names or not.
+     * @return void
      */
     public function __construct(array $credentials, array $options = []);
+
+    /**
+     * @return Traits\BaseClientTrait
+     */
     public function withCredentials(array $credentails); // : ClientInterface
+
+    /**
+     * @return Traits\BaseClientTrait
+     */
     public function withOptions(array $options); // : ClientInterface
     public function getCredentials($assoc = false); // : array
     public function getOptions($stringify = false); // : array
@@ -46,15 +51,12 @@ 
      * Retrive part of credentials using magic methods or ArrayAccess interface.
      *
      * @param string $key
-     * @param string $offset
-     *
-     *       e.g.
-     *           $a = $client->consumer_key;
-     *           $b = $client['consumer_secret'];
-     *           $c = $client[2];
-     *           $d = $client->tokenSecret;
      */
     public function __get($key); // : string
+
+    /**
+     * @return boolean
+     */
     public function __isset($key); // : boolean
     public function offsetGet($offset); // : string
     public function offsetExists($offset); // : boolean
@@ -72,18 +74,31 @@ 
      * login() uses scraping.
      *
      * @param string|null $oauth_callback Callback URL or "oob".
-     * @param string      $oauth_verifier
-     * @param string      $username       Username or email.
-     * @param string      $password
      * @throws HttpExceptionInterface
      */
     public function oauthForRequestToken($oauth_callback = null); // : ClientInterface
     public function oauthForAccessToken($oauth_verifier); // : ClientInterface
     public function xauthForAccessToken($username, $password); // : ClientInterface
     public function login($username, $password); // : ClientInterface
+
+    /**
+     * @return \Generator
+     */
     public function oauthForRequestTokenAsync($oauth_callback = null); // : \Generator<ClientInterface>
+
+    /**
+     * @return \Generator
+     */
     public function oauthForAccessTokenAsync($oauth_verifier); // : \Generator<ClientInterface>
+
+    /**
+     * @return \Generator
+     */
     public function xauthForAccessTokenAsync($username, $password); // : \Generator<ClientInterface>
+
+    /**
+     * @return \Generator
+     */
     public function loginAsync($username, $password); // : \Generator<ClientInterface>
 
     /**
@@ -108,8 +123,20 @@ 
     public function get($endpoint, array $params = [], $return_response_object = false); // : \stdClass|array|MediaInterface|ResponseInterface
     public function post($endpoint, array $params = [], $return_response_object = false); // : \stdClass|ResponseInterface
     public function postMultipart($endpoint, array $params = [], $return_response_object = false); // : \stdClass|ResponseInterface
+
+    /**
+     * @return \Generator
+     */
     public function getAsync($endpoint, array $params = [], $return_response_object = false); // : \Generator<\stdClass|array|MediaInterface|ResponseInterface
+
+    /**
+     * @return \Generator
+     */
     public function postAsync($endpoint, array $params = [], $return_response_object = false); // : \Generator<\stdClass|ResponseInterface>
+
+    /**
+     * @return \Generator
+     */
     public function postMultipartAsync($endpoint, array $params = [], $return_response_object = false); // : \Generator<\stdClass|ResponseInterface>
 
     /**
@@ -133,8 +160,20 @@ 
     public function getOut($url, array $params = [], $return_response_object = false); // : \stdClass|array|ResponseInterface
     public function postOut($url, array $params = [], $return_response_object = false); // : \stdClass|ResponseInterface
     public function postMultipartOut($url, array $params = [], $return_response_object = false); // : \stdClass|ResponseInterface
+
+    /**
+     * @return \Generator
+     */
     public function getOutAsync($url, array $params = [], $return_response_object = false); // : \Generator<\stdClass|array|ResponseInterface
+
+    /**
+     * @return \Generator
+     */
     public function postOutAsync($url, array $params = [], $return_response_object = false); // : \Generator<\stdClass|ResponseInterface>
+
+    /**
+     * @return \Generator
+     */
     public function postMultipartOutAsync($url, array $params = [], $return_response_object = false); // : \Generator<\stdClass|ResponseInterface>
 
     /**
@@ -163,8 +202,13 @@ 
      *       Signature: function (ResponseInterface $response);
      *
      * @throws HttpExceptionInterface
+     * @return void
      */
     public function streaming($endpoint, callable $event_handler, array $params = [], callable $header_response_handler = null); // : null
+
+    /**
+     * @return \Generator
+     */
     public function streamingAsync($endpoint, callable $event_handler, array $params = [], callable $header_response_handler = null); // : \Generator<null>
 
     /**
@@ -188,10 +232,23 @@ 
      *     File data is split into chunks with specified size.
      *
      * @throws HttpExceptionInterface
+     * @return \Generator
      */
     public function uploadAsync(\SplFileObject $file, $media_category = null, callable $on_uploading = null, callable $on_processing = null, $chunk_size = 300000); // : \Generator<\stdClass>
+
+    /**
+     * @return \Generator
+     */
     public function uploadImageAsync(\SplFileObject $file, callable $on_uploading = null, callable $on_processing = null, $chunk_size = 300000); // : \Generator<\stdClass>
+
+    /**
+     * @return \Generator
+     */
     public function uploadAnimeGifAsync(\SplFileObject $file, callable $on_uploading = null, callable $on_processing = null, $chunk_size = 300000); // : \Generator<\stdClass>
+
+    /**
+     * @return \Generator
+     */
     public function uploadVideoAsync(\SplFileObject $file, callable $on_uploading = null, callable $on_processing = null, $chunk_size = 300000); // : \Generator<\stdClass>
 
     /**
@@ -200,14 +257,23 @@ 
      * @throws HttpExceptionInterface
      */
     public function oauthForBearerToken(); // : ClientInterface
+
+    /**
+     * @return \Generator
+     */
     public function oauthForBearerTokenAsync(); // : \Generator<ClientInterface>
 
     /**
      * Invalidate OAuth 2.0 token.
      *
      * @throws HttpExceptionInterface
+     * @return void
      */
     public function invalidateBearerToken(); // : null
+
+    /**
+     * @return \Generator
+     */
     public function invalidateBearerTokenAsync(); // : \Generator<null>
 
     /**
@@ -228,5 +294,9 @@ 
      * @throws HttpExceptionInterface
      */
     public function get2($endpoint, array $params = [], $return_response_object = false); // : \stdClass|array|ResponseInterface
+
+    /**
+     * @return \Generator
+     */
     public function get2Async($endpoint, array $params = [], $return_response_object = false); // : \Generator<\stdClass|array|ResponseInterface>
 }