Properties

$userEntity

$userEntity : \Social\Options\User

Doctrine User Entity

Type

\Social\Options\User

$authenticationService

$authenticationService : \Social\Options\authentication

Type

\Social\Options\authentication — service to user

$registrationHeader

$registrationHeader : string

The social auth header text on registration page

Type

string

$loginHeader

$loginHeader : string

The social auth header text on login page NOTE that if login and or registration is enabled this header should reflect that

Type

string

$loginText

$loginText : string

The social auth paragraph text on login page NOTE that if login and or registration is enabled this header should reflect that

Type

string

$registrationText

$registrationText : string

The social auth paragraph text on registration page

Type

string

$__strictMode__

$__strictMode__ : 

Turn on strict options mode

Type

$availableProviders

$availableProviders : array

List of social auth providers that are available to the application not necessarily enabled

Type

array

$enabledProviders

$enabledProviders : array

List of providers to be populated based on social-config.global.php in autoload folder

Type

array

$clientIds

$clientIds : array

Associative array of client ids (values) with provider name as key NOTE some providers use different term for client id

Type

array

$secrets

$secrets : array

Associative array of client secrets (values) with provider name as keys NOTE some providers use different term for client secret

Type

array

Methods

__construct()

__construct(array  $options) 

Constructor

Parameters

array $options

__set()

__set(string  $key, string  $value) : null

Magic method that overrides AbstractOptions method call functions based on configuration keys in social-config files in autoload folder

Parameters

string $key
string $value

Throws

\Zend\Stdlib\Exception\BadMethodCallException

Returns

null —

so that exception is not thrown in strict mode

getEnabledProviders()

getEnabledProviders() : array

get an array of enabled providers

Returns

array

getClientId()

getClientId(string  $provider) : false|string

Get the client id for requested provider

Parameters

string $provider

Returns

false|string —

the client id

getConsumerKey()

getConsumerKey(string  $provider) : false|string

Alias for getClientId

Parameters

string $provider

name of social provider

Returns

false|string —

the consumer key

getSecret()

getSecret(string  $provider) : string

Get the client secret for requested provider

Parameters

string $provider

name of social provider

Returns

string

setFacebookEnabled()

setFacebookEnabled(boolean  $enabled) 

Set whether Facebook is enabled

Parameters

boolean $enabled

setFacebookClientId()

setFacebookClientId(string  $clientId) 

Set Facebook client ID

Parameters

string $clientId

facebook client id

setFacebookSecret()

setFacebookSecret(string  $secret) 

Set Facebook secret

Parameters

string $secret

Facebook secret

setFoursquareEnabled()

setFoursquareEnabled(boolean  $enabled) 

Set whether FOURSQUARE is enabled

Parameters

boolean $enabled

setFoursquareClientId()

setFoursquareClientId(string  $clientId) 

Set FOURSQUARE client ID

Parameters

string $clientId

FOURSQUARE client id

setFoursquareSecret()

setFoursquareSecret(string  $secret) 

Set FOURSQUARE secret

Parameters

string $secret

FOURSQUARE secret

setGoogleEnabled()

setGoogleEnabled(boolean  $enabled) 

Set whether GOOGLE is enabled

Parameters

boolean $enabled

setGoogleClientId()

setGoogleClientId(string  $clientId) 

Set GOOGLE client ID

Parameters

string $clientId

GOOGLE client id

setGoogleSecret()

setGoogleSecret(string  $secret) 

Set GOOGLE secret

Parameters

string $secret

GOOGLE secret

setGitHubEnabled()

setGitHubEnabled(boolean  $enabled) 

Set whether GITHUB is enabled

Parameters

boolean $enabled

setGitHubClientId()

setGitHubClientId(string  $clientId) 

Set GITHUB client ID

Parameters

string $clientId

GITHUB client id

setGitHubSecret()

setGitHubSecret(string  $secret) 

Set GITHUB secret

Parameters

string $secret

GITHUB secret

setLinkedInEnabled()

setLinkedInEnabled(boolean  $enabled) 

Set whether LINEKDIN is enabled

Parameters

boolean $enabled

setLinkedInClientId()

setLinkedInClientId(string  $clientId) 

Set LINEKDIN client ID

Parameters

string $clientId

LINEKDIN client id

setLinkedInSecret()

setLinkedInSecret(string  $secret) 

Set LINEKDIN secret

Parameters

string $secret

LINEKDIN secret

setLiveEnabled()

setLiveEnabled(boolean  $enabled) 

Set whether LIVE is enabled

Parameters

boolean $enabled

setLiveClientId()

setLiveClientId(string  $clientId) 

Set LIVE client ID

Parameters

string $clientId

LIVE client id

setLiveSecret()

setLiveSecret(string  $secret) 

Set LIVE secret

Parameters

string $secret

LIVE secret

setTwitterEnabled()

setTwitterEnabled(boolean  $enabled) 

Set whether TWITTER is enabled

Parameters

boolean $enabled

setTwitterConsumerKey()

setTwitterConsumerKey(string  $clientId) 

Set TWITTER client ID

Parameters

string $clientId

TWITTER client id

setTwitterConsumerSecret()

setTwitterConsumerSecret(string  $secret) 

Set TWITTER secret

Parameters

string $secret

TWITTER secret

setYahooEnabled()

setYahooEnabled(boolean  $enabled) 

Set whether YAHOO is enabled

Parameters

boolean $enabled

setYahooClientId()

setYahooClientId(string  $clientId) 

Set YAHOO client ID

Parameters

string $clientId

YAHOO client id

setYahooSecret()

setYahooSecret(string  $secret) 

Set YAHOO secret

Parameters

string $secret

YAHOO secret

setYandexEnabled()

setYandexEnabled(boolean  $enabled) 

Set whether YANDEX is enabled

Parameters

boolean $enabled

setYandexClientId()

setYandexClientId(string  $clientId) 

Set YANDEX client ID

Parameters

string $clientId

YANDEX client id

setYandexSecret()

setYandexSecret(string  $secret) 

Set YANDEX secret

Parameters

string $secret

YANDEX secret

setDoctrineUserEntity()

setDoctrineUserEntity(\Social\Options\User  $userEntity) 

Set the user entity object

Parameters

\Social\Options\User $userEntity

getDoctrineUserEntity()

getDoctrineUserEntity() : \Social\Options\User

Get the user entity object

Returns

\Social\Options\User —

user entity object

setAuthenticationService()

setAuthenticationService(\Social\Options\Zend\Authentication\AuthenticationService  $authenticationService) 

Set the Authentication Service

Parameters

\Social\Options\Zend\Authentication\AuthenticationService $authenticationService

getAuthenticationService()

getAuthenticationService() : \Social\Options\Zend\Authentication\AuthenticationService

Get the Authentication Service

Returns

\Social\Options\Zend\Authentication\AuthenticationService

setLoginHeader()

setLoginHeader(string  $loginHeader) 

Set login header

Parameters

string $loginHeader

getLoginHeader()

getLoginHeader() : string

Get login header

Returns

string

setLoginText()

setLoginText(string  $loginText) 

Set login text

Parameters

string $loginText

getLoginText()

getLoginText() : string

Get login text

Returns

string

setRegistrationHeader()

setRegistrationHeader(string  $registrationHeader) 

Set registration page header

Parameters

string $registrationHeader

getRegistrationHeader()

getRegistrationHeader() : string

Get registration page header

Returns

string

setRegistrationText()

setRegistrationText(string  $registrationText) 

Set registration page text

Parameters

string $registrationText

getRegistrationText()

getRegistrationText() : string

Get registration page text

Returns

string