PHP Class Devise\Users\UserManager

Show file Open project: devisephp/cms Class Usage Examples

Public Properties

Property 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

Property Type Description
$DvsUser DvsUser DvsUser model to fetch database table
$Framework Devise\Support\Framework Framework components being used from Laravel's framework

Public Methods

Method 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 method

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

activate() public method

Activate instance of DvsUser
public activate ( DvsUser $user ) : boolean
$user DvsUser
return boolean

createRules() public method

Create rules for a new user
public createRules ( ) : array
return array

createUser() public method

Create a new user
public createUser ( array $input ) : DvsUser
$input array
return DvsUser

destroyUser() public method

Delete a user
public destroyUser ( integer $id ) : boolean
$id integer
return boolean

generateActivateCode() public method

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

registerUser() public method

Register new user
public registerUser ( array $input ) : boolean
$input array
return boolean

removeUnactivatedUsers() public method

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

updateRules() public method

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

updateUser() public method

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

Property Details

$DvsUser protected property

DvsUser model to fetch database table
protected DvsUser $DvsUser
return DvsUser

$Framework protected property

Framework components being used from Laravel's framework
protected Framework,Devise\Support $Framework
return Devise\Support\Framework

$errors public property

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

$messages public property

Messages which we can store why validation failed
public string $messages
return string