PHP Class CakeDC\Users\Model\Behavior\RegisterBehavior

Inheritance: extends Behavior
Afficher le fichier Open project: cakedc/users

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode 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 méthode

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
Résultat Cake\Validation\Validator

_tosValidator() protected méthode

Tos validator
protected _tosValidator ( Cake\Validation\Validator $validator ) : Cake\Validation\Validator
$validator Cake\Validation\Validator Validator instance.
Résultat Cake\Validation\Validator

activateUser() public méthode

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

buildValidator() public méthode

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
Résultat Cake\Validation\Validator

getRegisterValidators() public méthode

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]
Résultat Cake\Validation\Validator

initialize() public méthode

Constructor hook method.
public initialize ( array $config ) : void
$config array The configuration settings provided to this behavior.
Résultat void

register() public méthode

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]
Résultat boolean | Cake\Datasource\EntityInterface

validate() public méthode

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.
Résultat CakeDC\Users\Model\Entity\User $user