Gitee
\
Acme
addons
adminlte
controller
command
controller
library
crontab
controller
database
controller
library
example
controller
freecode
controller
loginbg
controller
loginbgindex
controller
simditor
summernote
controller
test
controller
tinymce
controller
app
admin
behavior
command
Api
library
controller
auth
example
forum
general
user
library
traits
model
forum
validate
forum
api
controller
library
common
behavior
controller
library
token
driver
model
index
controller
model
Composer
Autoload
Cron
Tests
Doctrine
Common
Cache
Tests
Common
Cache
EasyWeChat
Broadcast
Card
Comment
Core
Exceptions
Device
Encryption
Foundation
ServiceProviders
Fundamental
Js
Material
Menu
Message
MiniProgram
Core
Encryption
Material
Notice
QRCode
Server
Sns
Staff
Stats
Notice
OpenPlatform
Api
EventHandlers
Payment
CashCoupon
LuckyMoney
MerchantPay
POI
QRCode
Reply
Semantic
Server
ShakeAround
Staff
Stats
Store
Support
Traits
Url
User
Endroid
QrCode
Bundle
Controller
DependencyInjection
Twig
Extension
Exceptions
Factory
Tests
Bundle
Controller
Tests
QrCode
fast
GatewayWorker
Lib
Protocols
GuzzleHttp
Cookie
Exception
Handler
Promise
Psr7
League
OAuth2
Client
Provider
Monolog
Formatter
Handler
Curl
FingersCrossed
Slack
SyslogUdp
Processor
Overtrue
Pinyin
Socialite
Providers
Pimple
Exception
Psr11
Tests
Fixtures
Psr11
Psr
Container
Http
Message
Log
Test
Symfony
Bridge
PsrHttpMessage
Factory
Tests
Factory
Fixtures
Component
HttpFoundation
Exception
File
Exception
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
Tests
File
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
OptionsResolver
Debug
Exception
Tests
Debug
Polyfill
Mbstring
Php70
think
addons
cache
driver
captcha
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
controller
db
builder
connector
exception
debug
exception
helper
hash
log
driver
model
relation
paginator
driver
process
exception
pipes
response
session
driver
template
driver
taglib
view
driver
traits
controller
model
think
Workerman
Connection
Events
React
Lib
Protocols

\Overtrue\Socialite\ProvidersFacebookProvider

Class FacebookProvider.

Summary

Methods
Properties
Constants
__construct()
redirect()
user()
setRedirectUrl()
withRedirectUrl()
getRedirectUrl()
setAccessToken()
getAccessToken()
scopes()
setRequest()
getRequest()
stateless()
with()
getName()
fields()
asPopup()
No public properties found
No constants found
getAuthUrl()
getTokenUrl()
getUserByToken()
mapUserToObject()
buildAuthUrlFromBase()
getCodeFields()
formatScopes()
hasInvalidState()
getTokenFields()
parseAccessToken()
getCode()
getHttpClient()
usesState()
isStateless()
arrayItem()
makeState()
$name
$request
$clientId
$clientSecret
$accessToken
$redirectUrl
$parameters
$scopes
$scopeSeparator
$encodingType
$stateless
$graphUrl
$version
$fields
$popup
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Provider name.

Type

string

$clientId

$clientId : string

The client ID.

Type

string

$clientSecret

$clientSecret : string

The client secret.

Type

string

$redirectUrl

$redirectUrl : string

The redirect URL.

Type

string

$parameters

$parameters : array

The custom parameters to be sent with the request.

Type

array

$scopes

$scopes : array

The scopes being requested.

Type

array

$scopeSeparator

$scopeSeparator : string

The separating character for the requested scopes.

Type

string

$encodingType

$encodingType : integer

The type of the encoding in the query.

Type

integer — Can be either PHP_QUERY_RFC3986 or PHP_QUERY_RFC1738

$stateless

$stateless : boolean

Indicates if the session state should be utilized.

Type

boolean

$graphUrl

$graphUrl : string

The base Facebook Graph URL.

Type

string

$version

$version : string

The Graph API version for the request.

Type

string

$fields

$fields : array

The user fields being requested.

Type

array

$popup

$popup : boolean

Display the dialog in a popup view.

Type

boolean

Methods

__construct()

__construct(\Symfony\Component\HttpFoundation\Request  $request, string  $clientId, string  $clientSecret, string|null  $redirectUrl = null)

Create a new provider instance.

Parameters

\Symfony\Component\HttpFoundation\Request $request
string $clientId
string $clientSecret
string|null $redirectUrl

redirect()

redirect(string  $redirectUrl = null) : \Symfony\Component\HttpFoundation\RedirectResponse

Redirect the user of the application to the provider's authentication screen.

Parameters

string $redirectUrl

Returns

\Symfony\Component\HttpFoundation\RedirectResponse

setRedirectUrl()

setRedirectUrl(string  $redirectUrl) : $this

Set redirect url.

Parameters

string $redirectUrl

Returns

$this

withRedirectUrl()

withRedirectUrl(string  $redirectUrl) : $this

Set redirect url.

Parameters

string $redirectUrl

Returns

$this

getRedirectUrl()

getRedirectUrl() : string

Return the redirect url.

Returns

string

getAccessToken()

getAccessToken(string  $code) : \Overtrue\Socialite\AccessToken

Get the access token for the given code.

Parameters

string $code

Returns

\Overtrue\Socialite\AccessToken

scopes()

scopes(array  $scopes) : $this

Set the scopes of the requested access.

Parameters

array $scopes

Returns

$this

stateless()

stateless() : $this

Indicates that the provider should operate as stateless.

Returns

$this

with()

with(array  $parameters) : $this

Set the custom parameters of the request.

Parameters

array $parameters

Returns

$this

getName()

getName() : string

Returns

string

fields()

fields(array  $fields) : $this

Set the user fields to request from Facebook.

Parameters

array $fields

Returns

$this

asPopup()

asPopup() : $this

Set the dialog to be displayed as a popup.

Returns

$this

getAuthUrl()

getAuthUrl(string  $state) : string

Get the authentication URL for the provider.

Parameters

string $state

Returns

string

getTokenUrl()

getTokenUrl() : string

Get the token URL for the provider.

Returns

string

getUserByToken()

getUserByToken(\Overtrue\Socialite\AccessTokenInterface  $token) : array

Get the raw user for the given access token.

Parameters

\Overtrue\Socialite\AccessTokenInterface $token

Returns

array

mapUserToObject()

mapUserToObject(array  $user) : \Overtrue\Socialite\User

Map the raw user array to a Socialite User instance.

Parameters

array $user

Returns

\Overtrue\Socialite\User

buildAuthUrlFromBase()

buildAuthUrlFromBase(string  $url, string  $state) : string

Get the authentication URL for the provider.

Parameters

string $url
string $state

Returns

string

getCodeFields()

getCodeFields(string|null  $state = null) : array

Get the GET parameters for the code request.

Parameters

string|null $state

Returns

array

formatScopes()

formatScopes(array  $scopes, string  $scopeSeparator) : string

Format the given scopes.

Parameters

array $scopes
string $scopeSeparator

Returns

string

hasInvalidState()

hasInvalidState() : boolean

Determine if the current request / session has a mismatching "state".

Returns

boolean

getTokenFields()

getTokenFields(string  $code) : array

Get the POST fields for the token request.

Parameters

string $code

Returns

array

getCode()

getCode() : string

Get the code from the request.

Returns

string

getHttpClient()

getHttpClient() : \GuzzleHttp\Client

Get a fresh instance of the Guzzle HTTP client.

Returns

\GuzzleHttp\Client

usesState()

usesState() : boolean

Determine if the provider is operating with state.

Returns

boolean

isStateless()

isStateless() : boolean

Determine if the provider is operating as stateless.

Returns

boolean

arrayItem()

arrayItem(array  $array, string  $key, mixed  $default = null) : mixed

Return array item by key.

Parameters

array $array
string $key
mixed $default

Returns

mixed

makeState()

makeState() : string|boolean

Put state to session storage and return it.

Returns

string|boolean