Edit File by line

<?php namespace flow\social;

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Twitter-API-PHP : Simple PHP wrapper for the v1.1 API

[3] Fix | Delete

[4] Fix | Delete

* PHP version 5.3.10

[5] Fix | Delete

[6] Fix | Delete

* @category Awesomeness

[7] Fix | Delete

* @package Twitter-API-PHP

[8] Fix | Delete

* @author James Mallison <me@j7mbo.co.uk>

[9] Fix | Delete

* @license MIT License

[10] Fix | Delete

* @version 1.0.4

[11] Fix | Delete

* @link http://github.com/j7mbo/twitter-api-php

[12] Fix | Delete

[13] Fix | Delete

class FFTwitterAPIExchange

[14] Fix | Delete

{

[15] Fix | Delete

/**

[16] Fix | Delete

* @var string

[17] Fix | Delete

[18] Fix | Delete

private $oauth_access_token;

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* @var string

[22] Fix | Delete

[23] Fix | Delete

private $oauth_access_token_secret;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* @var string

[27] Fix | Delete

[28] Fix | Delete

private $consumer_key;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* @var string

[32] Fix | Delete

[33] Fix | Delete

private $consumer_secret;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* @var array

[37] Fix | Delete

[38] Fix | Delete

private $postfields;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* @var string

[42] Fix | Delete

[43] Fix | Delete

private $getfield;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* @var mixed

[47] Fix | Delete

[48] Fix | Delete

protected $oauth;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* @var string

[52] Fix | Delete

[53] Fix | Delete

public $url;

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* @var string

[57] Fix | Delete

[58] Fix | Delete

public $requestMethod;

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Create the API access object. Requires an array of settings::

[62] Fix | Delete

* oauth access token, oauth access token secret, consumer key, consumer secret

[63] Fix | Delete

* These are all available by creating your own application on dev.twitter.com

[64] Fix | Delete

* Requires the cURL library

[65] Fix | Delete

[66] Fix | Delete

* @throws \Exception When cURL isn't installed or incorrect settings parameters are provided

[67] Fix | Delete

[68] Fix | Delete

* @param array $settings

[69] Fix | Delete

[70] Fix | Delete

public function __construct(array $settings)

[71] Fix | Delete

{

[72] Fix | Delete

if (!in_array('curl', get_loaded_extensions()))

[73] Fix | Delete

{

[74] Fix | Delete

throw new \Exception('You need to install cURL, see: http://curl.haxx.se/docs/install.html');

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

if (!isset($settings['oauth_access_token'])

[78] Fix | Delete

|| !isset($settings['oauth_access_token_secret'])

[79] Fix | Delete

|| !isset($settings['consumer_key'])

[80] Fix | Delete

|| !isset($settings['consumer_secret']))

[81] Fix | Delete

{

[82] Fix | Delete

throw new \Exception('Make sure you are passing in the correct parameters');

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

$this->oauth_access_token = $settings['oauth_access_token'];

[86] Fix | Delete

$this->oauth_access_token_secret = $settings['oauth_access_token_secret'];

[87] Fix | Delete

$this->consumer_key = $settings['consumer_key'];

[88] Fix | Delete

$this->consumer_secret = $settings['consumer_secret'];

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Set postfields array, example: array('screen_name' => 'J7mbo')

[93] Fix | Delete

[94] Fix | Delete

* @param array $array Array of parameters to send to API

[95] Fix | Delete

[96] Fix | Delete

* @throws \Exception When you are trying to set both get and post fields

[97] Fix | Delete

[98] Fix | Delete

* @return TwitterAPIExchange Instance of self for method chaining

[99] Fix | Delete

[100] Fix | Delete

public function setPostfields(array $array)

[101] Fix | Delete

{

[102] Fix | Delete

if (!is_null($this->getGetfield()))

[103] Fix | Delete

{

[104] Fix | Delete

throw new \Exception('You can only choose get OR post fields.');

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

if (isset($array['status']) && substr($array['status'], 0, 1) === '@')

[108] Fix | Delete

{

[109] Fix | Delete

$array['status'] = sprintf("\0%s", $array['status']);

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

foreach ($array as $key => &$value)

[113] Fix | Delete

{

[114] Fix | Delete

if (is_bool($value))

[115] Fix | Delete

{

[116] Fix | Delete

$value = ($value === true) ? 'true' : 'false';

[117] Fix | Delete

}

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

$this->postfields = $array;

[121] Fix | Delete

[122] Fix | Delete

// rebuild oAuth

[123] Fix | Delete

if (isset($this->oauth['oauth_signature'])) {

[124] Fix | Delete

$this->buildOauth($this->url, $this->requestMethod);

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

return $this;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

/**

[131] Fix | Delete

* Set getfield string, example: '?screen_name=J7mbo'

[132] Fix | Delete

[133] Fix | Delete

* @param string $string Get key and value pairs as string

[134] Fix | Delete

[135] Fix | Delete

* @throws \Exception

[136] Fix | Delete

[137] Fix | Delete

* @return FFTwitterAPIExchange Instance of self for method chaining

[138] Fix | Delete

[139] Fix | Delete

public function setGetfield($string)

[140] Fix | Delete

{

[141] Fix | Delete

if (!is_null($this->getPostfields()))

[142] Fix | Delete

{

[143] Fix | Delete

throw new \Exception('You can only choose get OR post fields.');

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

$getfields = preg_replace('/^\?/', '', explode('&', $string));

[147] Fix | Delete

$params = array();

[148] Fix | Delete

[149] Fix | Delete

foreach ($getfields as $field)

[150] Fix | Delete

{

[151] Fix | Delete

if ($field !== '')

[152] Fix | Delete

{

[153] Fix | Delete

list($key, $value) = explode('=', $field);

[154] Fix | Delete

$params[$key] = $value;

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

$this->getfield = '?' . http_build_query($params, null, "&");

[159] Fix | Delete

[160] Fix | Delete

return $this;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* Get getfield string (simple getter)

[165] Fix | Delete

[166] Fix | Delete

* @return string $this->getfields

[167] Fix | Delete

[168] Fix | Delete

public function getGetfield()

[169] Fix | Delete

{

[170] Fix | Delete

return $this->getfield;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Get postfields array (simple getter)

[175] Fix | Delete

[176] Fix | Delete

* @return array $this->postfields

[177] Fix | Delete

[178] Fix | Delete

public function getPostfields()

[179] Fix | Delete

{

[180] Fix | Delete

return $this->postfields;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

/**

[184] Fix | Delete

* Build the Oauth object using params set in construct and additionals

[185] Fix | Delete

* passed to this method. For v1.1, see: https://dev.twitter.com/docs/api/1.1

[186] Fix | Delete

[187] Fix | Delete

* @param string $url The API url to use. Example: https://api.twitter.com/1.1/search/tweets.json

[188] Fix | Delete

* @param string $requestMethod Either POST or GET

[189] Fix | Delete

[190] Fix | Delete

* @throws \Exception

[191] Fix | Delete

[192] Fix | Delete

* @return FFTwitterAPIExchange Instance of self for method chaining

[193] Fix | Delete

[194] Fix | Delete

public function buildOauth($url, $requestMethod)

[195] Fix | Delete

{

[196] Fix | Delete

if (!in_array(strtolower($requestMethod), array('post', 'get')))

[197] Fix | Delete

{

[198] Fix | Delete

throw new \Exception('Request method must be either POST or GET');

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

$consumer_key = $this->consumer_key;

[202] Fix | Delete

$consumer_secret = $this->consumer_secret;

[203] Fix | Delete

$oauth_access_token = $this->oauth_access_token;

[204] Fix | Delete

$oauth_access_token_secret = $this->oauth_access_token_secret;

[205] Fix | Delete

[206] Fix | Delete

$oauth = array(

[207] Fix | Delete

'oauth_consumer_key' => $consumer_key,

[208] Fix | Delete

'oauth_nonce' => time(),

[209] Fix | Delete

'oauth_signature_method' => 'HMAC-SHA1',

[210] Fix | Delete

'oauth_token' => $oauth_access_token,

[211] Fix | Delete

'oauth_timestamp' => time(),

[212] Fix | Delete

'oauth_version' => '1.0'

[213] Fix | Delete

);

[214] Fix | Delete

[215] Fix | Delete

$getfield = $this->getGetfield();

[216] Fix | Delete

[217] Fix | Delete

if (!is_null($getfield))

[218] Fix | Delete

{

[219] Fix | Delete

$getfields = str_replace('?', '', explode('&', $getfield));

[220] Fix | Delete

[221] Fix | Delete

foreach ($getfields as $g)

[222] Fix | Delete

{

[223] Fix | Delete

$split = explode('=', $g);

[224] Fix | Delete

[225] Fix | Delete

/** In case a null is passed through **/

[226] Fix | Delete

if (isset($split[1]))

[227] Fix | Delete

{

[228] Fix | Delete

$oauth[$split[0]] = urldecode($split[1]);

[229] Fix | Delete

}

[230] Fix | Delete

}

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

$postfields = $this->getPostfields();

[234] Fix | Delete

[235] Fix | Delete

if (!is_null($postfields)) {

[236] Fix | Delete

foreach ($postfields as $key => $value) {

[237] Fix | Delete

$oauth[$key] = $value;

[238] Fix | Delete

}

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

$base_info = $this->buildBaseString($url, $requestMethod, $oauth);

[242] Fix | Delete

$composite_key = rawurlencode($consumer_secret) . '&' . rawurlencode($oauth_access_token_secret);

[243] Fix | Delete

$oauth_signature = base64_encode(hash_hmac('sha1', $base_info, $composite_key, true));

[244] Fix | Delete

$oauth['oauth_signature'] = $oauth_signature;

[245] Fix | Delete

[246] Fix | Delete

$this->url = $url;

[247] Fix | Delete

$this->requestMethod = $requestMethod;

[248] Fix | Delete

$this->oauth = $oauth;

[249] Fix | Delete

[250] Fix | Delete

return $this;

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

/**

[254] Fix | Delete

* Perform the actual data retrieval from the API

[255] Fix | Delete

[256] Fix | Delete

* @param boolean $return If true, returns data. This is left in for backward compatibility reasons

[257] Fix | Delete

* @param array $curlOptions Additional Curl options for this request

[258] Fix | Delete

[259] Fix | Delete

* @throws \Exception

[260] Fix | Delete

[261] Fix | Delete

* @return string json If $return param is true, returns json data.

[262] Fix | Delete

[263] Fix | Delete

public function performRequest($return = true, $curlOptions = array())

[264] Fix | Delete

{

[265] Fix | Delete

if (!is_bool($return))

[266] Fix | Delete

{

[267] Fix | Delete

throw new \Exception('performRequest parameter must be true or false');

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

$header = array($this->buildAuthorizationHeader($this->oauth), 'Expect:');

[271] Fix | Delete

[272] Fix | Delete

$getfield = $this->getGetfield();

[273] Fix | Delete

$postfields = $this->getPostfields();

[274] Fix | Delete

[275] Fix | Delete

$options = array(

[276] Fix | Delete

CURLOPT_HTTPHEADER => $header,

[277] Fix | Delete

CURLOPT_HEADER => false,

[278] Fix | Delete

CURLOPT_URL => $this->url,

[279] Fix | Delete

CURLOPT_RETURNTRANSFER => true,

[280] Fix | Delete

CURLOPT_TIMEOUT => 10,

[281] Fix | Delete

CURLOPT_SSL_VERIFYPEER => false,

[282] Fix | Delete

) + $curlOptions;

[283] Fix | Delete

[284] Fix | Delete

if (!is_null($postfields))

[285] Fix | Delete

{

[286] Fix | Delete

$options[CURLOPT_POSTFIELDS] = http_build_query($postfields, null, "&");

[287] Fix | Delete

}

[288] Fix | Delete

else

[289] Fix | Delete

{

[290] Fix | Delete

if ($getfield !== '')

[291] Fix | Delete

{

[292] Fix | Delete

$options[CURLOPT_URL] .= $getfield;

[293] Fix | Delete

}

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

$feed = curl_init();

[297] Fix | Delete

curl_setopt_array($feed, $options);

[298] Fix | Delete

$json = curl_exec($feed);

[299] Fix | Delete

[300] Fix | Delete

if (($error = curl_error($feed)) !== '')

[301] Fix | Delete

{

[302] Fix | Delete

curl_close($feed);

[303] Fix | Delete

[304] Fix | Delete

throw new \Exception($error);

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

curl_close($feed);

[308] Fix | Delete

[309] Fix | Delete

return $json;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

/**

[313] Fix | Delete

* Private method to generate the base string used by cURL

[314] Fix | Delete

[315] Fix | Delete

* @param string $baseURI

[316] Fix | Delete

* @param string $method

[317] Fix | Delete

* @param array $params

[318] Fix | Delete

[319] Fix | Delete

* @return string Built base string

[320] Fix | Delete

[321] Fix | Delete

private function buildBaseString($baseURI, $method, $params)

[322] Fix | Delete

{

[323] Fix | Delete

$return = array();

[324] Fix | Delete

//ksort($params);

[325] Fix | Delete

[326] Fix | Delete

foreach($params as $key => $value)

[327] Fix | Delete

{

[328] Fix | Delete

$return[] = rawurlencode($key) . '=' . rawurlencode($value);

[329] Fix | Delete

}

[330] Fix | Delete

sort($return);

[331] Fix | Delete

[332] Fix | Delete

return $method . "&" . rawurlencode($baseURI) . '&' . rawurlencode(implode('&', $return));

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

/**

[336] Fix | Delete

* Private method to generate authorization header used by cURL

[337] Fix | Delete

[338] Fix | Delete

* @param array $oauth Array of oauth data generated by buildOauth()

[339] Fix | Delete

[340] Fix | Delete

* @return string $return Header used by cURL for request

[341] Fix | Delete

[342] Fix | Delete

private function buildAuthorizationHeader(array $oauth)

[343] Fix | Delete

{

[344] Fix | Delete

$return = 'Authorization: OAuth ';

[345] Fix | Delete

$values = array();

[346] Fix | Delete

[347] Fix | Delete

foreach($oauth as $key => $value)

[348] Fix | Delete

{

[349] Fix | Delete

if (in_array($key, array('oauth_consumer_key', 'oauth_nonce', 'oauth_signature',

[350] Fix | Delete

'oauth_signature_method', 'oauth_timestamp', 'oauth_token', 'oauth_version'))) {

[351] Fix | Delete

$values[] = "$key=\"" . rawurlencode($value) . "\"";

[352] Fix | Delete

}

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete

$return .= implode(', ', $values);

[356] Fix | Delete

return $return;

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

/**

[360] Fix | Delete

* Helper method to perform our request

[361] Fix | Delete

[362] Fix | Delete

* @param string $url

[363] Fix | Delete

* @param string $method

[364] Fix | Delete

* @param string $data

[365] Fix | Delete

* @param array $curlOptions

[366] Fix | Delete

[367] Fix | Delete

* @throws \Exception

[368] Fix | Delete

[369] Fix | Delete

* @return string The json response from the server

[370] Fix | Delete

[371] Fix | Delete

public function request($url, $method = 'get', $data = null, $curlOptions = array())

[372] Fix | Delete

{

[373] Fix | Delete

if (strtolower($method) === 'get')

[374] Fix | Delete

{

[375] Fix | Delete

$this->setGetfield($data);

[376] Fix | Delete

}

[377] Fix | Delete

else

[378] Fix | Delete

{

[379] Fix | Delete

$this->setPostfields($data);

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

return $this->buildOauth($url, $method)->performRequest(true, $curlOptions);

[383] Fix | Delete

}

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete