PHP Class CakeDC\Users\Model\Behavior\RegisterBehavior

Inheritance: extends Behavior

Show file Open project: cakedc/users

Public Methods

Method	Description
activateUser ( Cake\Datasource\EntityInterface $user ) : mixed	Activates an user
buildValidator ( Cake\Event\Event $event, Cake\Validation\Validator $validator, string $name ) : Cake\Validation\Validator	buildValidator
getRegisterValidators ( array $options ) : Cake\Validation\Validator	Returns the list of validators
initialize ( array $config ) : void	Constructor hook method.
register ( Cake\Datasource\EntityInterface $user, array $data, array $options ) : boolean \| Cake\Datasource\EntityInterface	Registers an user.
validate ( type $token, null $callback = null ) : User	Validates token and return user

Protected Methods

Method	Description
_emailValidator ( Cake\Validation\Validator $validator, boolean $validateEmail ) : Cake\Validation\Validator	Email validator
_tosValidator ( Cake\Validation\Validator $validator ) : Cake\Validation\Validator	Tos validator

Method Details

_emailValidator() protected method

Email validator

protected _emailValidator ( Cake\Validation\Validator $validator, boolean $validateEmail ) : Cake\Validation\Validator
$validator	Cake\Validation\Validator	Validator instance.
$validateEmail	boolean	true when email needs to be required
return	Cake\Validation\Validator

_tosValidator() protected method

Tos validator

protected _tosValidator ( Cake\Validation\Validator $validator ) : Cake\Validation\Validator
$validator	Cake\Validation\Validator	Validator instance.
return	Cake\Validation\Validator

activateUser() public method

Activates an user

public activateUser ( Cake\Datasource\EntityInterface $user ) : mixed
$user	Cake\Datasource\EntityInterface	user object.
return	mixed	User entity or bool false if the user could not be activated

buildValidator() public method

buildValidator

public buildValidator ( Cake\Event\Event $event, Cake\Validation\Validator $validator, string $name ) : Cake\Validation\Validator
$event	Cake\Event\Event	event
$validator	Cake\Validation\Validator	validator
$name	string	name
return	Cake\Validation\Validator

getRegisterValidators() public method

Returns the list of validators

public getRegisterValidators ( array $options ) : Cake\Validation\Validator
$options	array	Array of options ['validate_email' => true/false, 'use_tos' => true/false]
return	Cake\Validation\Validator

initialize() public method

Constructor hook method.

public initialize ( array $config ) : void
$config	array	The configuration settings provided to this behavior.
return	void

register() public method

Registers an user.

public register ( Cake\Datasource\EntityInterface $user, array $data, array $options ) : boolean \| Cake\Datasource\EntityInterface
$user	Cake\Datasource\EntityInterface	User information
$data	array	User information
$options	array	['tokenExpiration]
return	boolean \| Cake\Datasource\EntityInterface

validate() public method

Validates token and return user

public validate ( type $token, null $callback = null ) : User
$token	type	toke to be validated.
$callback	null	function that will be returned.
return	CakeDC\Users\Model\Entity\User	$user