PHP Class CakeDC\Users\Model\Behavior\SocialBehavior

Inheritance: extends Behavior, use trait CakeDC\Users\Traits\RandomStringTrait
Show file Open project: cakedc/users

Public Methods

Method Description
generateUniqueUsername ( string $username ) : string Checks if username exists and generate a new one
socialLogin ( array $data, array $options ) : boolean | Cake\Datasource\EntityInterface | mixed Performs social login

Protected Methods

Method Description
_createSocialUser ( array $data, array $options = [] ) : boolean | Cake\Datasource\EntityInterface | mixed Creates social user, populate the user data based on the social login data first and save it
_populateUser ( array $data, Cake\Datasource\EntityInterface $existingUser, string $useEmail, string $validateEmail, string $tokenExpiration ) : Cake\Datasource\EntityInterface Build new user entity either by using an existing user or extracting the data from the social login data to create a new one

Method Details

_createSocialUser() protected method

Creates social user, populate the user data based on the social login data first and save it
protected _createSocialUser ( array $data, array $options = [] ) : boolean | Cake\Datasource\EntityInterface | mixed
$data array Array social user.
$options array Array option data.
return boolean | Cake\Datasource\EntityInterface | mixed result of the save operation

_populateUser() protected method

Build new user entity either by using an existing user or extracting the data from the social login data to create a new one
protected _populateUser ( array $data, Cake\Datasource\EntityInterface $existingUser, string $useEmail, string $validateEmail, string $tokenExpiration ) : Cake\Datasource\EntityInterface
$data array Array social login.
$existingUser Cake\Datasource\EntityInterface user data.
$useEmail string email to use.
$validateEmail string email to validate.
$tokenExpiration string token_expires data.
return Cake\Datasource\EntityInterface

generateUniqueUsername() public method

Checks if username exists and generate a new one
public generateUniqueUsername ( string $username ) : string
$username string username data.
return string

socialLogin() public method

Performs social login
public socialLogin ( array $data, array $options ) : boolean | Cake\Datasource\EntityInterface | mixed
$data array Array social login.
$options array Array option data.
return boolean | Cake\Datasource\EntityInterface | mixed