JFacebookOAuth
Extends \JOAuth2ClientJoomla Platform class for generating Facebook API access token.
since |
3.2.0 |
---|---|
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JHttp $http = null, \JInput $input = null, \JApplicationWeb $application = null)
since |
3.1.4 |
---|
Arguments
- $options
\Joomla\Registry\Registry
JOAuth2Client options object- $http
\JHttp
The HTTP client object- $input
\JInput
The input object- $application
\JApplicationWeb
The application object
authenticate
Get the access token or redict to the authentication URL.
authenticate() : string
since |
3.1.4 |
---|---|
throws |
|
Response
string
The access token
createUrl
Create the URL for authentication.
createUrl() : \JHttpResponse
since |
3.1.4 |
---|---|
throws |
|
Response
\JHttpResponse
The HTTP response
getOption
Get an option from the JOAuth2Client instance.
getOption(string $key) : mixed
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to get
Response
mixed
The option value
getScope
Method to get the current scope
getScope() : string
since |
3.2.0 |
---|
Response
string
Comma separated list of permissions.
getToken
Get the access token from the JOAuth2Client instance.
getToken() : array
since |
3.1.4 |
---|
Response
array
The access token
isAuthenticated
Verify if the client has been authenticated
isAuthenticated() : boolean
since |
3.1.4 |
---|
Response
boolean
Is authenticated
query
Send a signed Oauth request.
query(string $url, mixed $data = null, array $headers = array(), string $method = 'get', integer $timeout = null) : string
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $url
string
The URL for the request.- $data
mixed
The data to include in the request- $headers
array
The headers to send with the request- $method
string
The method with which to send the request- $timeout
integer
The timeout for the request
Response
string
The URL.
refreshToken
Refresh the access token instance.
refreshToken(string $token = null) : array
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $token
string
The refresh token
Response
array
The new access token
setOption
Set an option for the JOAuth2Client instance.
setOption(string $key, mixed $value) : \JOAuth2Client
since |
3.1.4 |
---|
Arguments
- $key
string
The name of the option to set- $value
mixed
The option value to set
Response
\JOAuth2Client
This object for method chaining
setScope
Method used to set permissions.
setScope(string $scope) : \JFacebookOauth
since |
3.2.0 |
---|
Arguments
- $scope
string
Comma separated list of permissions.
Response
\JFacebookOauth
This object for method chaining
setToken
Set an option for the JOAuth2Client instance.
setToken(array $value) : \JOAuth2Client
since |
3.1.4 |
---|
Arguments
- $value
array
The access token
Response
\JOAuth2Client
This object for method chaining
Properties
options
Options for the JOAuth2Client object.
http
The HTTP client object to use in sending HTTP requests.
since |
3.1.4 |
---|
Type(s)
\JHttp
input
The input object to use in retrieving GET/POST data.
since |
3.1.4 |
---|
Type(s)
\JInput
application
The application object to send HTTP headers for redirects.
since |
3.1.4 |
---|
Type(s)
\JApplicationWeb