<meta charset="utf-8">

<title>Class Codebird\Codebird</title>

<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">

<div id="left">

<div id="menu">

<a href="index.html" title="Overview"><span>Overview</span></a>

<div id="groups">

<h3>Namespaces</h3>

<ul>

<li class="active">

<a href="namespace-Codebird.html">

Codebird </a>

</li>

</ul>

</div>

<hr>

<div id="elements">

<h3>Classes</h3>

<ul>

<li class="active"><a href="class-Codebird.Codebird.html">Codebird</a></li>

</ul>

</div>

</div>

<div id="splitter"></div>

<div id="right">

<div id="rightInner">

<form id="search">

<input type="hidden" name="cx" value="">

<input type="hidden" name="ie" value="UTF-8">

<input type="text" name="q" class="text" placeholder="Search">

</form>

<div id="navigation">

<ul>

<li>

<a href="index.html" title="Overview"><span>Overview</span></a>

</li>

<li>

<a href="namespace-Codebird.html" title="Summary of Codebird"><span>Namespace</span></a>

</li>

<li class="active">

<span>Class</span> </li>

</ul>

<ul>

</ul>

<ul>

</ul>

</div>

<div id="content" class="class">

<h1>Class Codebird</h1>

<div class="description">

<p>A Twitter library in PHP.</p>

</div>

<div class="info">

<b>Namespace:</b> <a href="namespace-Codebird.html">Codebird</a><br>

<b>Package:</b> codebird-php<br>

<b>Located at</b> <a href="source-class-Codebird.Codebird.html#38-2584" title="Go to source code">codebird.php</a>

<br>

</div>

<table class="summary methods" id="methods">

<caption>Methods summary</caption>

<tr data-order="__construct" id="___construct">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#___construct">#</a>

<code><a href="source-class-Codebird.Codebird.html#176-185" title="Go to source code">__construct</a>( )</code>

<div class="description short">

</div>

<div class="description detailed hidden">

<p>Class constructor</p>

</div>

</div></td>

</tr>

<tr data-order="getInstance" id="_getInstance">

<td class="attributes"><code>

public static

<code><a href="class-Codebird.Codebird.html">Codebird\Codebird</a></code>

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_getInstance">#</a>

<code><a href="source-class-Codebird.Codebird.html#187-199" title="Go to source code">getInstance</a>( )</code>

<div class="description short">

<p>Returns singleton class instance

Always use this method unless you're working with multiple authenticated users at once</p>

</div>

<div class="description detailed hidden">

<p>Returns singleton class instance

Always use this method unless you're working with multiple authenticated users at once</p>

<h4>Returns</h4>

<div class="list">

<code><a href="class-Codebird.Codebird.html">Codebird\Codebird</a></code><br>The instance

</div>

</div>

</div></td>

</tr>

<tr data-order="setConsumerKey" id="_setConsumerKey">

<td class="attributes"><code>

public static

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setConsumerKey">#</a>

<code><a href="source-class-Codebird.Codebird.html#201-213" title="Go to source code">setConsumerKey</a>( <span>string <var>$key</var></span>, <span>string <var>$secret</var></span> )</code>

<div class="description short">

<p>Sets the OAuth consumer key and secret (App key)</p>

</div>

<div class="description detailed hidden">

<p>Sets the OAuth consumer key and secret (App key)</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$key</var></dt>

<dd>OAuth consumer key</dd>

<dt><var>$secret</var></dt>

<dd>OAuth consumer secret</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setBearerToken" id="_setBearerToken">

<td class="attributes"><code>

public static

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setBearerToken">#</a>

<code><a href="source-class-Codebird.Codebird.html#215-225" title="Go to source code">setBearerToken</a>( <span>string <var>$token</var></span> )</code>

<div class="description short">

<p>Sets the OAuth2 app-only auth bearer token</p>

</div>

<div class="description detailed hidden">

<p>Sets the OAuth2 app-only auth bearer token</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$token</var></dt>

<dd>OAuth2 bearer token</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="getVersion" id="_getVersion">

<td class="attributes"><code>

public

string

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_getVersion">#</a>

<code><a href="source-class-Codebird.Codebird.html#227-235" title="Go to source code">getVersion</a>( )</code>

<div class="description short">

<p>Gets the current Codebird version</p>

</div>

<div class="description detailed hidden">

<p>Gets the current Codebird version</p>

<h4>Returns</h4>

<div class="list">

string<br>The version number

</div>

</div>

</div></td>

</tr>

<tr data-order="setToken" id="_setToken">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setToken">#</a>

<code><a href="source-class-Codebird.Codebird.html#237-249" title="Go to source code">setToken</a>( <span>string <var>$token</var></span>, <span>string <var>$secret</var></span> )</code>

<div class="description short">

<p>Sets the OAuth request or access token and secret (User key)</p>

</div>

<div class="description detailed hidden">

<p>Sets the OAuth request or access token and secret (User key)</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$token</var></dt>

<dd>OAuth request or access token</dd>

<dt><var>$secret</var></dt>

<dd>OAuth request or access token secret</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="logout" id="_logout">

<td class="attributes"><code>

public

boolean

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_logout">#</a>

<code><a href="source-class-Codebird.Codebird.html#251-262" title="Go to source code">logout</a>( )</code>

<div class="description short">

<p>Forgets the OAuth request or access token and secret (User key)</p>

</div>

<div class="description detailed hidden">

<p>Forgets the OAuth request or access token and secret (User key)</p>

<h4>Returns</h4>

<div class="list">

boolean

</div>

</div>

</div></td>

</tr>

<tr data-order="setUseCurl" id="_setUseCurl">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setUseCurl">#</a>

<code><a href="source-class-Codebird.Codebird.html#264-278" title="Go to source code">setUseCurl</a>( <span>boolean <var>$use_curl</var></span> )</code>

<div class="description short">

<p>Sets if codebird should use cURL</p>

</div>

<div class="description detailed hidden">

<p>Sets if codebird should use cURL</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$use_curl</var></dt>

<dd>Request uses cURL or not</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setTimeout" id="_setTimeout">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setTimeout">#</a>

<code><a href="source-class-Codebird.Codebird.html#280-290" title="Go to source code">setTimeout</a>( <span>integer <var>$timeout</var></span> )</code>

<div class="description short">

<p>Sets request timeout in milliseconds</p>

</div>

<div class="description detailed hidden">

<p>Sets request timeout in milliseconds</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$timeout</var></dt>

<dd>Request timeout in milliseconds</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setConnectionTimeout" id="_setConnectionTimeout">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setConnectionTimeout">#</a>

<code><a href="source-class-Codebird.Codebird.html#292-302" title="Go to source code">setConnectionTimeout</a>( <span>integer <var>$timeout</var></span> )</code>

<div class="description short">

<p>Sets connection timeout in milliseconds</p>

</div>

<div class="description detailed hidden">

<p>Sets connection timeout in milliseconds</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$timeout</var></dt>

<dd>Connection timeout in milliseconds</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setRemoteDownloadTimeout" id="_setRemoteDownloadTimeout">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setRemoteDownloadTimeout">#</a>

<code><a href="source-class-Codebird.Codebird.html#304-314" title="Go to source code">setRemoteDownloadTimeout</a>( <span>integer <var>$timeout</var></span> )</code>

<div class="description short">

<p>Sets remote media download timeout in milliseconds</p>

</div>

<div class="description detailed hidden">

<p>Sets remote media download timeout in milliseconds</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$timeout</var></dt>

<dd>Remote media timeout in milliseconds</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setReturnFormat" id="_setReturnFormat">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setReturnFormat">#</a>

<code><a href="source-class-Codebird.Codebird.html#316-328" title="Go to source code">setReturnFormat</a>( <span>integer <var>$return_format</var></span> )</code>

<div class="description short">

<p>Sets the format for API replies</p>

</div>

<div class="description detailed hidden">

<p>Sets the format for API replies</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$return_format</var></dt>

<dd><p>One of these:

CODEBIRD_RETURNFORMAT_OBJECT (default)

CODEBIRD_RETURNFORMAT_ARRAY</p></dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setProxy" id="_setProxy">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setProxy">#</a>

<code><a href="source-class-Codebird.Codebird.html#330-342" title="Go to source code">setProxy</a>( <span>string <var>$host</var></span>, <span>integer <var>$port</var></span> )</code>

<div class="description short">

<p>Sets the proxy</p>

</div>

<div class="description detailed hidden">

<p>Sets the proxy</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$host</var></dt>

<dd>Proxy host</dd>

<dt><var>$port</var></dt>

<dd>Proxy port</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setProxyAuthentication" id="_setProxyAuthentication">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setProxyAuthentication">#</a>

<code><a href="source-class-Codebird.Codebird.html#344-354" title="Go to source code">setProxyAuthentication</a>( <span>string <var>$authentication</var></span> )</code>

<div class="description short">

<p>Sets the proxy authentication</p>

</div>

<div class="description detailed hidden">

<p>Sets the proxy authentication</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$authentication</var></dt>

<dd>Proxy authentication</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="setStreamingCallback" id="_setStreamingCallback">

<td class="attributes"><code>

public

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_setStreamingCallback">#</a>

<code><a href="source-class-Codebird.Codebird.html#356-369" title="Go to source code">setStreamingCallback</a>( <span>callable <var>$callback</var></span> )</code>

<div class="description short">

<p>Sets streaming callback</p>

</div>

<div class="description detailed hidden">

<p>Sets streaming callback</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$callback</var></dt>

<dd>The streaming callback</dd>

</dl></div>

</div>

</div></td>

</tr>

<tr data-order="getApiMethods" id="_getApiMethods">

<td class="attributes"><code>

public

array

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_getApiMethods">#</a>

<code><a href="source-class-Codebird.Codebird.html#371-767" title="Go to source code">getApiMethods</a>( )</code>

<div class="description short">

<p>Get allowed API methods, sorted by GET or POST

Watch out for multiple-method API methods!</p>

</div>

<div class="description detailed hidden">

<p>Get allowed API methods, sorted by GET or POST

Watch out for multiple-method API methods!</p>

<h4>Returns</h4>

<div class="list">

array<br>$apimethods

</div>

</div>

</div></td>

</tr>

<tr data-order="__call" id="___call">

<td class="attributes"><code>

public

string

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#___call">#</a>

<code><a href="source-class-Codebird.Codebird.html#770-812" title="Go to source code">__call</a>( <span>string <var>$fn</var></span>, <span>array <var>$params</var></span> )</code>

<div class="description short">

<p>Main API handler working on any requests you issue</p>

</div>

<div class="description detailed hidden">

<p>Main API handler working on any requests you issue</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$fn</var></dt>

<dd>The member function you called</dd>

<dt><var>$params</var></dt>

<dd>The parameters you sent along</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

string<br>The API reply encoded in the set return_format

</div>

</div>

</div></td>

</tr>

<tr data-order="_parseApiParams" id="__parseApiParams">

<td class="attributes"><code>

protected

array

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#__parseApiParams">#</a>

<code><a href="source-class-Codebird.Codebird.html#819-846" title="Go to source code">_parseApiParams</a>( <span>array|string <var>$params</var></span> )</code>

<div class="description short">

<p>Parse given params, detect query-style params</p>

</div>

<div class="description detailed hidden">

<p>Parse given params, detect query-style params</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$params</var></dt>

<dd>Parameters to parse</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

array<br>$apiparams

</div>

</div>

</div></td>

</tr>

<tr data-order="_stringifyNullBoolParams" id="__stringifyNullBoolParams">

<td class="attributes"><code>

protected

array

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#__stringifyNullBoolParams">#</a>

<code><a href="source-class-Codebird.Codebird.html#848-870" title="Go to source code">_stringifyNullBoolParams</a>( <span>array <var>$apiparams</var></span> )</code>

<div class="description short">

<p>Replace null and boolean parameters with their string representations</p>

</div>

<div class="description detailed hidden">

<p>Replace null and boolean parameters with their string representations</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$apiparams</var></dt>

<dd>Parameter array to replace in</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

array<br>$apiparams

</div>

</div>

</div></td>

</tr>

<tr data-order="_mapFnToApiMethod" id="__mapFnToApiMethod">

<td class="attributes"><code>

protected

string[]

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#__mapFnToApiMethod">#</a>

<code><a href="source-class-Codebird.Codebird.html#872-921" title="Go to source code">_mapFnToApiMethod</a>( <span>string <var>$fn</var></span>, <span>array <var>&amp; $apiparams</var></span> )</code>

<div class="description short">

<p>Maps called PHP magic method name to Twitter API method</p>

</div>

<div class="description detailed hidden">

<p>Maps called PHP magic method name to Twitter API method</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$fn</var></dt>

<dd>Function called</dd>

<dt><var>$apiparams</var></dt>

<dd>byref API parameters</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

string[]<br>(string method, string method_template)

</div>

</div>

</div></td>

</tr>

<tr data-order="_mapFnInsertSlashes" id="__mapFnInsertSlashes">

<td class="attributes"><code>

protected

string

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#__mapFnInsertSlashes">#</a>

<code><a href="source-class-Codebird.Codebird.html#923-936" title="Go to source code">_mapFnInsertSlashes</a>( <span>string <var>$fn</var></span> )</code>

<div class="description short">

<p>API method mapping: Replaces _ with / character</p>

</div>

<div class="description detailed hidden">

<p>API method mapping: Replaces _ with / character</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$fn</var></dt>

<dd>Function called</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

string<br>API method to call

</div>

</div>

</div></td>

</tr>

<tr data-order="_mapFnRestoreParamUnderscores" id="__mapFnRestoreParamUnderscores">

<td class="attributes"><code>

protected

string

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#__mapFnRestoreParamUnderscores">#</a>

<code><a href="source-class-Codebird.Codebird.html#938-959" title="Go to source code">_mapFnRestoreParamUnderscores</a>( <span>string <var>$method</var></span> )</code>

<div class="description short">

<p>API method mapping: Restore _ character in named parameters</p>

</div>

<div class="description detailed hidden">

<p>API method mapping: Restore _ character in named parameters</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$method</var></dt>

<dd>API method to call</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

string<br>API method with restored underscores

</div>

</div>

</div></td>

</tr>

<tr data-order="oauth_authenticate" id="_oauth_authenticate">

<td class="attributes"><code>

public

string

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_oauth_authenticate">#</a>

<code><a href="source-class-Codebird.Codebird.html#966-991" title="Go to source code">oauth_authenticate</a>( <span>optional <var>$force_login</var> = <span class="php-keyword1">NULL</span></span>, <span>optional <var>$screen_name</var> = <span class="php-keyword1">NULL</span></span>, <span>optional <var>$type</var> = <span class="php-quote">'authenticate'</span></span> )</code>

<div class="description short">

<p>Gets the OAuth authenticate URL for the current request token</p>

</div>

<div class="description detailed hidden">

<p>Gets the OAuth authenticate URL for the current request token</p>

<h4>Parameters</h4>

<div class="list"><dl>

<dt><var>$force_login</var></dt>

<dd>$force_login Whether to force the user to enter their login data</dd>

<dt><var>$screen_name</var></dt>

<dd>$screen_name Screen name to repopulate the user name with</dd>

<dt><var>$type</var></dt>

<dd>$type 'authenticate' or 'authorize', to avoid duplicate code</dd>

</dl></div>

<h4>Returns</h4>

<div class="list">

string<br>The OAuth authenticate/authorize URL

</div>

</div>

</div></td>

</tr>

<tr data-order="oauth_authorize" id="_oauth_authorize">

<td class="attributes"><code>

public

string

</code>

</td>

<td class="name"><div>

<a class="anchor" href="#_oauth_authorize">#</a>