lpirir
diff --git a/‎CHANGELOG
Lines changed: 3 additions & 0 deletions b/‎CHANGELOG
Lines changed: 3 additions & 0 deletions
diff --git a/‎README.md
Lines changed: 41 additions & 29 deletions b/‎README.md
Lines changed: 41 additions & 29 deletions
diff --git a/‎src/codebird.php
Lines changed: 42 additions & 0 deletions b/‎src/codebird.php
Lines changed: 42 additions & 0 deletions
@@ -1,6 +1,9 @@
 codebird-php - changelog
 ========================
 
+2.5.0 (not yet released)
++ Option to set cURL timeout
+
 2.4.2 (not yet released)
 + Add section about cacert.pem to README
 
 
@@ -204,13 +204,13 @@ You can find it within the return object’s ```httpstatus``` property.
 
 ### 5.1 Dealing with rate-limits
 
-Basically, Codebird leaves it up to you to handle Twitter’s rate limit.  
+Basically, Codebird leaves it up to you to handle Twitter’s rate limit.
 The library returns the response HTTP status code, so you can detect rate limits.
 
-I suggest you to check if the ```$reply->httpstatus``` property is ```400``` 
-and check with the Twitter API to find out if you are currently being 
-rate-limited. 
-See the [Rate Limiting FAQ](https://dev.twitter.com/docs/rate-limiting-faq) 
+I suggest you to check if the ```$reply->httpstatus``` property is ```400```
+and check with the Twitter API to find out if you are currently being
+rate-limited.
+See the [Rate Limiting FAQ](https://dev.twitter.com/docs/rate-limiting-faq)
 for more information.
 
 6. Return formats
@@ -277,7 +277,7 @@ First retrieve the user object using
 
 with ```$username``` being the username of the account you wish to retrieve the profile image from.
 
-Then get the value from the index ```profile_image_url``` or ```profile_image_url_https``` of the user object previously retrieved. 
+Then get the value from the index ```profile_image_url``` or ```profile_image_url_https``` of the user object previously retrieved.
 
 
 For example:
@@ -289,7 +289,7 @@ For example:
 
 When the user returns from the authentication screen, you need to trade
 the obtained request token for an access token, using the OAuth verifier.
-As discussed in the section ‘Usage example,’ you use a call to 
+As discussed in the section ‘Usage example,’ you use a call to
 ```oauth/access_token``` to do that.
 
 The API reply to this method call tells you details about the user that just logged in.
@@ -305,29 +305,29 @@ stdClass Object
     [user_id] => 14648265
     [screen_name] => mynetx
     [httpstatus] => 200
-) 
+)
 ```
 
-If you need to get more details, such as the user’s latest tweet, 
-you should fetch the complete User Entity.  The simplest way to get the 
-user entity of the currently authenticated user is to use the 
+If you need to get more details, such as the user’s latest tweet,
+you should fetch the complete User Entity.  The simplest way to get the
+user entity of the currently authenticated user is to use the
 ```account/verify_credentials``` API method.  In Codebird, it works like this:
 
 ```php
 $reply = $cb->account_verifyCredentials();
 print_r($reply);
 ```
 
-I suggest to cache the User Entity after obtaining it, as the 
-```account/verify_credentials``` method is rate-limited by 15 calls per 15 minutes. 
+I suggest to cache the User Entity after obtaining it, as the
+```account/verify_credentials``` method is rate-limited by 15 calls per 15 minutes.
 
 …walk through cursored results?
 -------------------------------
 
-The Twitter REST API utilizes a technique called ‘cursoring’ to paginate 
-large result sets. Cursoring separates results into pages of no more than 
-5000 results at a time, and provides a means to move backwards and 
-forwards through these pages. 
+The Twitter REST API utilizes a technique called ‘cursoring’ to paginate
+large result sets. Cursoring separates results into pages of no more than
+5000 results at a time, and provides a means to move backwards and
+forwards through these pages.
 
 Here is how you can walk through cursored results with Codebird.
 
@@ -348,11 +348,11 @@ $nextCursor = $result1->next_cursor_str;
     }
 ```
 
-To navigate back instead of forth, use the field ```$resultX->previous_cursor_str``` 
+To navigate back instead of forth, use the field ```$resultX->previous_cursor_str```
 instead of ```next_cursor_str```.
 
-It might make sense to use the cursors in a loop.  Watch out, though, 
-not to send more than the allowed number of requests to ```followers/list``` 
+It might make sense to use the cursors in a loop.  Watch out, though,
+not to send more than the allowed number of requests to ```followers/list```
 per rate-limit timeframe, or else you will hit your rate-limit.
 
 …use xAuth with Codebird?
@@ -370,9 +370,9 @@ $reply = $cb->oauth_accessToken(array(
 ));
 ```
 
-Are you getting a strange error message?  If the user is enrolled in 
-login verification, the server will return a HTTP 401 error with a custom body. 
-If you are using the send_error_codes parameter, you will receive the 
+Are you getting a strange error message?  If the user is enrolled in
+login verification, the server will return a HTTP 401 error with a custom body.
+If you are using the send_error_codes parameter, you will receive the
 following error message in the response body:
 
 ```xml
 User must verify login
 ```
 
-When this error occurs, advise the user to 
+When this error occurs, advise the user to
 [generate a temporary password](https://twitter.com/settings/applications)
 on twitter.com and use that to complete signing in to the application.
 
 …know what cacert.pem is for?
 -----------------------------
 
-Connections to the Twitter API are done over a secured SSL connection. 
-Since 2.4.0, codebird-php checks if the Twitter API server has a valid 
-SSL certificate. Valid certificates have a correct signature-chain. 
-The cacert.pem file contains a list of all public certificates for root 
-certificate authorities. You can find more information about this file 
+Connections to the Twitter API are done over a secured SSL connection.
+Since 2.4.0, codebird-php checks if the Twitter API server has a valid
+SSL certificate. Valid certificates have a correct signature-chain.
+The cacert.pem file contains a list of all public certificates for root
+certificate authorities. You can find more information about this file
 at http://curl.haxx.se/docs/caextract.html.
+
+…set the timeout for requests to the Twitter API?
+-------------------------------------------------
+
+For connecting to Twitter, Codebird uses the cURL library.
+You can specify both the connection timeout and the request timeout,
+in milliseconds:
+
+```php
+$cb->setConnectionTimeout(2000);
+$cb->setTimeout(5000);
+```
@@ -109,6 +109,16 @@ class Codebird
      */
     protected $_version = '2.4.2-dev';
 
+    /**
+     * Request timeout
+     */
+    protected $_timeout;
+
+    /**
+     * Connection timeout
+     */
+    protected $_connectionTimeout;
+
     /**
      * Returns singleton class instance
      * Always use this method unless you're working with multiple authenticated users at once
@@ -173,6 +183,30 @@ public function setToken($token, $secret)
         $this->_oauth_token_secret = $secret;
     }
 
+    /**
+     * Sets request timeout in milliseconds
+     *
+     * @param int $timeout Request timeout in milliseconds
+     *
+     * @return void
+     */
+    public function setTimeout($timeout)
+    {
+        $this->_timeout = (int) $timeout;
+    }
+
+    /**
+     * Sets connection timeout in milliseconds
+     *
+     * @param int $timeout Connection timeout in milliseconds
+     *
+     * @return void
+     */
+    public function setConnectionTimeout($timeout)
+    {
+        $this->_connectionTimeout = (int) $timeout;
+    }
+
     /**
      * Sets the format for API replies
      *
@@ -905,6 +939,14 @@ protected function _callApi($httpmethod, $method, $method_template, $params = ar
         curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
         curl_setopt($ch, CURLOPT_CAINFO, __DIR__ . '/cacert.pem');
 
+        if (isset($this->_timeout)) {
+            curl_setopt($ch, CURLOPT_TIMEOUT_MS, $this->_timeout);
+        }
+
+        if (isset($this->_connectionTimeout)) {
+            curl_setopt($ch, CURLOPT_CONNECTTIMEOUT_MS, $this->_connectionTimeout);
+        }
+
         $reply = curl_exec($ch);
 
         // certificate validation results