PHP Class Webiny\Component\TwitterOAuth\Bridge\League\TwitterOAuth

Inheritance: implements Webiny\Component\TwitterOAuth\Bridge\TwitterOAuthInterface
Show file Open project: Webiny/Framework

Protected Properties

Property Type Description
$accessToken
$clientId string OAuth2 Client ID.
$clientSecret string Client secret for defined Client ID.

Public Methods

Method Description
__construct ( string $clientId, string $clientSecret, string $redirectUri ) Base constructor.
delete ( string $url, array $headers = [], array $params = [] ) : string | array Make a DELETE request to Twitter API.
get ( string $url, array $headers = [], array $params = [] ) : string | array Make a GET request to Twitter API.
getAccessToken ( ) : Array | boolean Returns the current access token.
getAuthorizeUrl ( string | array $requestToken ) : string Get the authorize url.
getClientId ( ) : string Get client id.
getClientSecret ( ) : string Get client secret.
getRedirectUri ( ) : string Get redirect uri.
getRequestToken ( ) : array Get the request token (temporary credentials).
getUserDetails ( ) : TwitterOAuthUser Returns an instance of TwitterOAuthUser.
post ( string $url, array $postBody, array $headers = [], array $params = [] ) : string | array Make a POST request to Twitter API.
requestAccessToken ( string $requestToken, string $requestTokenSecret, string $oauthToken, string $oauthTokenVerifier ) : array[oauth_token, Once we have token, we can run the authorization which than give us the option to request the access token.
setAccessToken ( array $accessToken ) : void Sets the access token.

Method Details

__construct() public method

Base constructor.
public __construct ( string $clientId, string $clientSecret, string $redirectUri )
$clientId string Client id.
$clientSecret string Client secret.
$redirectUri string Target url where to redirect after authentication.

delete() public method

Make a DELETE request to Twitter API.
public delete ( string $url, array $headers = [], array $params = [] ) : string | array
$url string Api url.
$headers array Request headers.
$params array Additional parameters.
return string | array Api response (if json) it will be returned as array.

get() public method

Make a GET request to Twitter API.
public get ( string $url, array $headers = [], array $params = [] ) : string | array
$url string Api url.
$headers array Request headers.
$params array Additional parameters.
return string | array Api response (if json) it will be returned as array.

getAccessToken() public method

Returns the current access token.
public getAccessToken ( ) : Array | boolean
return Array | boolean False is returned if the access token is not set.

getAuthorizeUrl() public method

Get the authorize url.
public getAuthorizeUrl ( string | array $requestToken ) : string
$requestToken string | array Request token returned by Twitter OAuth server.
return string

getClientId() public method

Get client id.
public getClientId ( ) : string
return string Client id.

getClientSecret() public method

Get client secret.
public getClientSecret ( ) : string
return string Client secret.

getRedirectUri() public method

Get redirect uri.
public getRedirectUri ( ) : string
return string Redirect uri.

getRequestToken() public method

Get the request token (temporary credentials).
public getRequestToken ( ) : array
return array Request token [oauth_token, oauth_token_secret].

getUserDetails() public method

Returns an instance of TwitterOAuthUser.
public getUserDetails ( ) : TwitterOAuthUser
return Webiny\Component\TwitterOAuth\TwitterOAuthUser

post() public method

Make a POST request to Twitter API.
public post ( string $url, array $postBody, array $headers = [], array $params = [] ) : string | array
$url string Api url.
$postBody array Post body.
$headers array Request headers.
$params array Additional parameters.
return string | array Api response (if json) it will be returned as array.

requestAccessToken() public method

Once we have token, we can run the authorization which than give us the option to request the access token.
public requestAccessToken ( string $requestToken, string $requestTokenSecret, string $oauthToken, string $oauthTokenVerifier ) : array[oauth_token,
$requestToken string Request token returned by getRequestToken method.
$requestTokenSecret string Request token secret returned by getRequestToken method.
$oauthToken string OAuth token returned by Twitter OAuth server.
$oauthTokenVerifier string OAuth token verifier returned by Twitter OAuth server.
return array[oauth_token,

setAccessToken() public method

Should throw an exception if it's unable to set the access token.
public setAccessToken ( array $accessToken ) : void
$accessToken array Array[oauth_token, oauth_token_secret]
return void

Property Details

$accessToken protected property

protected $accessToken

$clientId protected property

OAuth2 Client ID.
protected string $clientId
return string

$clientSecret protected property

Client secret for defined Client ID.
protected string $clientSecret
return string