PHP Class Webiny\Component\TwitterOAuth\TwitterOAuth

Inheritance: use trait Webiny\Component\StdLib\ComponentTrait
Afficher le fichier Open project: Webiny/Framework Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( Webiny\Component\TwitterOAuth\Bridge\TwitterOAuthInterface $instance ) Base constructor.
delete ( string $url, array $params = [] ) : string | array Make a DELETE request to Twitter API.
get ( string $url, array $params = [] ) : string | array GET wrapper for oAuthRequest.
getAccessToken ( ) : Array | boolean Returns the current access token.
getAuthorizeUrl ( string | array $requestToken ) : string Get the authorize url.
getRequestToken ( ) : string Get the request token.
getResponseCode ( ) : integer Get the response code in http format.
getUserDetails ( ) : TwitterOAuthUser Gets the user details for current authenticated user.
post ( string $url, array $params = [] ) : string | array Make a POST request to Twitter API.
requestAccessToken ( string $requestToken, string $requestTokenSecret, string $oauthToken, string $oauthTokenVerifier ) : string 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 méthode

Use the TwitterOAuthLoader::getInstance to get a TwitterOAuth instance.
public __construct ( Webiny\Component\TwitterOAuth\Bridge\TwitterOAuthInterface $instance )
$instance Webiny\Component\TwitterOAuth\Bridge\TwitterOAuthInterface

delete() public méthode

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

get() public méthode

GET wrapper for oAuthRequest.
public get ( string $url, array $params = [] ) : string | array
$url string Api url.
$params array Additional parameters.
Résultat string | array Api response (if json) it will be returned as array.

getAccessToken() public méthode

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

getAuthorizeUrl() public méthode

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

getRequestToken() public méthode

Get the request token.
public getRequestToken ( ) : string
Résultat string Request token.

getResponseCode() public méthode

Example return: 200
public getResponseCode ( ) : integer
Résultat integer Response code.

getUserDetails() public méthode

Gets the user details for current authenticated user.
public getUserDetails ( ) : TwitterOAuthUser
Résultat TwitterOAuthUser

post() public méthode

Make a POST request to Twitter API.
public post ( string $url, array $params = [] ) : string | array
$url string Api url.
$params array Additional parameters.
Résultat string | array Api response (if json) it will be returned as array.

requestAccessToken() public méthode

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 ) : string
$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.
Résultat string

setAccessToken() public méthode

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]
Résultat void