Class cPasswordRequest

Class for handling passwort recovery of backend users. If a user has set his e-mail address, this class generates a new password for user and submits to his e-mail address. Submitting a new Password is only possible every 30 minutes. Mailsender, Mailsendername and Mailserver are set into system properties. There it is also possible to deactivate this feature.

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo Trautmann
Located at classes/class.password.request.php

Methods summary
`public`	# `__construct( cDb $db, array $cfg )` Constructor to create an instance of this class. Constructor to create an instance of this class. Parameters `$db` `cDb` $db CONTENIDO database object `$cfg` `array` $cfg The CONTENIDO configuration array Throws `cDbException` `cException`
`public string`	# `renderForm( boolean $return = false )` Function displays form for password request, if password is submitted this function also starts the passwort reset request and sending process Function displays form for password request, if password is submitted this function also starts the passwort reset request and sending process Parameters `$return` `boolean` $return [optional] Return or print template Returns `string` rendered HTML code Throws `cDbException` `cException` `cInvalidArgumentException`
`protected`	# `_renderNewPwForm( )` Function to display form to set new password for user. Function to display form to set new password for user. Throws `cDbException` `cException` `cInvalidArgumentException`
`protected array`	# `_getCurrentRequests( )` Getter function to obtain an array of all current user password reset requests Getter function to obtain an array of all current user password reset requests Returns `array` Throws `cDbException` `cException`
`protected string`	# `_handleNewPassword( )` Function checks password request for errors and sends a mail using _submitMail() in case of valid requests Function checks password request for errors and sends a mail using _submitMail() in case of valid requests Returns `string` Throws `cDbException` `cException` `cInvalidArgumentException`
`protected`	# `_handleResetPw( )` Function checks password reset request for errors and sets a new password in case there is no error Function checks password reset request for errors and sets a new password in case there is no error Throws `cDbException` `cException` `cInvalidArgumentException`
`protected boolean`	# `_safePwResetRequest( string $token, DateTime $expiration )` Save request into db for future validity check Save request into db for future validity check Parameters `$token` `string` $token Token used to check for validity at user confirmation part `$expiration` `DateTime` $expiration Returns `boolean` whether password request could be safed successfully Throws `cDbException` `cException` `cInvalidArgumentException`
`protected boolean`	# `_submitMail( string $token )` Function submits new password to users mail address Function submits new password to users mail address Parameters `$token` `string` $token The token used to authorise password change Returns `boolean` true if successful Throws `cException`
`protected string`	# `_generateToken( )` Function generates new token Function generates new token Returns `string` The new token

Properties summary
`protected cDb`	`$_db`	# The CONTENIDO database object The CONTENIDO database object
`protected array`	`$_cfg`	# The CONTENIDO configuration array The CONTENIDO configuration array
`protected cTemplate`	`$_tpl`	# The CONTENIDO template object The CONTENIDO template object
`protected string`	`$_username`	# Username of user which requests password Username of user which requests password
`protected string`	`$_email`	# E-mail address of user which requests password E-mail address of user which requests password
`protected integer`	`$_reloadTime`	# Time in minutes after which user is allowed to request a new password Time in minutes after which user is allowed to request a new password
`protected integer`	`$_tokenLength`	# Length of validation token, which is generated automatically Length of validation token, which is generated automatically
`protected boolean`	`$_isEnabled`	# Defines if passwort request is enabled or disabled. Default: This feature is enabled Defines if passwort request is enabled or disabled. Default: This feature is enabled
`protected string`	`$_sendermail`	# E-mail address of the sender E-mail address of the sender
`protected string`	`$_sendername`	# Name of the sender Name of the sender

Packages

Classes

Functions

Class cPasswordRequest

Parameters

Throws

Parameters

Returns

Throws

Throws

Returns

Throws

Returns

Throws

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns