PHP Class Devise\Users\UserManager

Afficher le fichier Open project: devisephp/cms Class Usage Examples

Méthodes publiques

Свойство Type Description
$errors array Errors are kept in an array and can be used later if validation fails and we want to know why
$messages string Messages which we can store why validation failed

Protected Properties

Свойство Type Description
$DvsUser DvsUser DvsUser model to fetch database table
$Framework Devise\Support\Framework Framework components being used from Laravel's framework

Méthodes publiques

Méthode Description
__construct ( DvsUser $DvsUser, Framework $Framework ) Construct a new user manager
activate ( DvsUser $user ) : boolean Activate instance of DvsUser
createRules ( ) : array Create rules for a new user
createUser ( array $input ) : DvsUser Create a new user
destroyUser ( integer $id ) : boolean Delete a user
generateActivateCode ( DvsUser $user, integer $length = 42 ) : void Generate a random "activate_code" string
registerUser ( array $input ) : boolean Register new user
removeUnactivatedUsers ( $daysOutstanding = 30 ) : boolean Removes users which have been awaiting activation (after registering). Currently, default is 30 days outstanding
updateRules ( integer $id, array $input ) : array These are update rules for a user
updateUser ( integer $id, array $input ) : DvsUser Update a new user

Method Details

__construct() public méthode

Construct a new user manager
public __construct ( DvsUser $DvsUser, Framework $Framework )
$DvsUser DvsUser
$Framework Devise\Support\Framework

activate() public méthode

Activate instance of DvsUser
public activate ( DvsUser $user ) : boolean
$user DvsUser
Résultat boolean

createRules() public méthode

Create rules for a new user
public createRules ( ) : array
Résultat array

createUser() public méthode

Create a new user
public createUser ( array $input ) : DvsUser
$input array
Résultat DvsUser

destroyUser() public méthode

Delete a user
public destroyUser ( integer $id ) : boolean
$id integer
Résultat boolean

generateActivateCode() public méthode

Generate a random "activate_code" string
public generateActivateCode ( DvsUser $user, integer $length = 42 ) : void
$user DvsUser
$length integer
Résultat void

registerUser() public méthode

Register new user
public registerUser ( array $input ) : boolean
$input array
Résultat boolean

removeUnactivatedUsers() public méthode

Removes users which have been awaiting activation (after registering). Currently, default is 30 days outstanding
public removeUnactivatedUsers ( $daysOutstanding = 30 ) : boolean
Résultat boolean

updateRules() public méthode

These are update rules for a user
public updateRules ( integer $id, array $input ) : array
$id integer
$input array
Résultat array

updateUser() public méthode

Update a new user
public updateUser ( integer $id, array $input ) : DvsUser
$id integer
$input array
Résultat DvsUser

Property Details

$DvsUser protected_oe property

DvsUser model to fetch database table
protected DvsUser $DvsUser
Résultat DvsUser

$Framework protected_oe property

Framework components being used from Laravel's framework
protected Framework,Devise\Support $Framework
Résultat Devise\Support\Framework

$errors public_oe property

Errors are kept in an array and can be used later if validation fails and we want to know why
public array $errors
Résultat array

$messages public_oe property

Messages which we can store why validation failed
public string $messages
Résultat string