Ubiquity\controllers\auth\AuthControllerVariablesTrait

Complexity

Total Complexity

42

Size/Duplication

Total Lines	325
Duplicated Lines	0 %

Test Coverage

Coverage

42.37%

Importance

Changes	7
Bugs	1	Features	4

42 Methods

Rating	Name	Duplication	Size	Complexity
A	badLoginMessage()	0	1	1
A	passwordConfLabel()	0	2	1
A	attemptsTimeout()	0	2	1
A	hasAccountRecovery()	0	2	1
A	disconnectedMessage()	0	1	1
A	hasAccountCreation()	0	2	1
A	noAccessMessage()	0	1	1
A	resetPasswordSuccessMessage()	0	1	1
A	hasEmailValidation()	0	2	1
A	towFACodePrefix()	0	2	1
A	terminateMessage()	0	1	1
A	recoveryEmailErrorMessage()	0	1	1
A	emailValidationSuccess()	0	1	1
A	newTwoFACodeMessage()	0	1	1
A	accountRecoveryDuration()	0	2	1
A	recoveryInitMessage()	0	1	1
A	canCreateAccountMessage()	0	1	1
A	_getBodySelector()	0	2	1
A	createAccountMessage()	0	1	1
A	_displayInfoAsString()	0	2	1
A	twoFAMessage()	0	1	1
A	generate2FACode()	0	2	1
A	_checkConnectionTimeout()	0	2	1
A	hasRecoveryAccount()	0	2	1
A	rememberCaption()	0	2	1
A	attemptsNumber()	0	2	1
A	twoFABadCodeMessage()	0	1	1
A	_getPasswordInputName()	0	2	1
A	resetPasswordErrorMessage()	0	1	1
A	loginLabel()	0	2	1
A	emailValidationDuration()	0	2	1
A	getTokenSize()	0	2	1
A	emailAccountRecoveryError()	0	1	1
A	_getLoginInputName()	0	2	1
A	twoFACodeDuration()	0	2	1
A	has2FA()	0	2	1
A	emailAccountRecoverySuccess()	0	1	1
A	emailValidationError()	0	1	1
A	recoveryEmailSendMessage()	0	1	1
A	attemptsNumberMessage()	0	1	1
A	passwordLabel()	0	2	1
A	createAccountErrorMessage()	0	1	1

<?php

namespace Ubiquity\controllers\auth;

use Ubiquity\utils\flash\FlashMessage;

/**
 * 
 * Ubiquity\controllers\auth$AuthControllerVariablesTrait
 * This class is part of Ubiquity
 * @author jc
 * @version 1.0.0
 *
 */
trait AuthControllerVariablesTrait {

	/**
	 * Override for modifying the noAccess message
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function noAccessMessage(FlashMessage $fMessage) {
	}

	/**
	 * Override for modifying attempts message
	 * You can use {_timer} and {_attemptsCount} variables in message content
	 *
	 * @param FlashMessage $fMessage
	 * @param int $attempsCount
	 */
	protected function attemptsNumberMessage(FlashMessage $fMessage, $attempsCount) {
	}

	/**
	 * To override for modifying the bad login message
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function badLoginMessage(FlashMessage $fMessage) {
	}

	/**
	 * To override for modifying the logout message
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function terminateMessage(FlashMessage $fMessage) {
	}

	/**
	 * To override for modifying the disconnect message
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function disconnectedMessage(FlashMessage $fMessage) {
	}
	
	/**
	 * To override for modifying the account creation message.
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function createAccountMessage(FlashMessage $fMessage) {
	}
	
	/**
	 * To override for modifying the account creation message information.
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function canCreateAccountMessage(FlashMessage $fMessage) {
	}
	
	/**
	 * To override for modifying the error for account creation.
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function createAccountErrorMessage(FlashMessage $fMessage) {
	}
	
	/**
	 * To override for modifying the 2FA panel message.
	 * @param FlashMessage $fMessage
	 */
	protected function twoFAMessage(FlashMessage $fMessage){
		
	}
	/**
	 * To override
	 * @param FlashMessage $fMessage
	 */
	protected function newTwoFACodeMessage(FlashMessage $fMessage){
		
	}
	
	/**
	 * To override for modifying the message displayed if the 2FA code is bad.
	 * @param FlashMessage $fMessage
	 */
	protected function twoFABadCodeMessage(FlashMessage $fMessage){
		
	}
	
	/**
	 * To override 
	 * Displayed when email is valid.
	 * @param FlashMessage $fMessage
	 */
	protected function emailValidationSuccess(FlashMessage $fMessage){
		
	}
	
	/**
	 * To override
	 * Displayed when email is invalid or if an error occurs.
	 * @param FlashMessage $fMessage
	 */
	protected function emailValidationError(FlashMessage $fMessage){
		
	}

	/**
	 * To override
	 * Displayed when an account recovery operation is initiated.
	 * @param FlashMessage $fMessage
	 */
	protected function recoveryInitMessage(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Displayed when email is sent for a recovery account operation.
	 * @param FlashMessage $fMessage
	 */
	protected function recoveryEmailSendMessage(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Displayed when email is not associated with an existing account.
	 * @param FlashMessage $fMessage
	 */
	protected function recoveryEmailErrorMessage(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Displayed when a new password is set with recovery account.
	 * @param FlashMessage $fMessage
	 */
	protected function resetPasswordSuccessMessage(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Displayed when an error occurs when a new password is set with recovery account.
	 * @param FlashMessage $fMessage
	 */
	protected function resetPasswordErrorMessage(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Displayed when the account recovery link is valid.
	 * @param FlashMessage $fMessage
	 */
	protected function emailAccountRecoverySuccess(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Displayed when the account recovery link is not valid.
	 * @param FlashMessage $fMessage
	 */
	protected function emailAccountRecoveryError(FlashMessage $fMessage){

The parameter $fMessage is not used and could be removed.

	}

	/**
	 * To override
	 * Returns the maximum number of allowed login attempts.
	 */
	protected function attemptsNumber() {
		return;
	}

	/**
	 * To override
	 * Returns the time before trying to connect again
	 * Effective only if attemptsNumber return a number.
	 *
	 * @return number
	 */
	protected function attemptsTimeout() {
		return 3 * 60;
	}

	/**
	 * Override to define if user info is displayed as string.
	 * If set to true, use {{ _infoUser| raw }} in views to display user info.
	 * Remember to use $this->jquery->renderView instead of $this->loadView for the javascript generation.
	 */
	public function _displayInfoAsString() {
		return false;
	}

	public function _checkConnectionTimeout() {
		return;
	}

	public function _getLoginInputName() {
		return 'email';
	}

	protected function loginLabel() {
		return \ucfirst ( $this->_getLoginInputName () );
	}

	public function _getPasswordInputName() {
		return 'password';
	}

	protected function passwordLabel() {
		return \ucfirst ( $this->_getPasswordInputName () );
	}
	
	protected function passwordConfLabel() {
		return \ucfirst ( $this->_getPasswordInputName () ).' confirmation';
	}

	/**
	 * Returns the body selector (jquery selector used for replacing the content of the page).
	 * default: main .container
	 *
	 * @return string
	 */
	public function _getBodySelector():string {
		return 'main .container';
	}

	protected function rememberCaption():string {
		return 'Remember me';
	}
	/**
	 * Returns true for account creation.
	 * @return boolean
	 */
	protected function hasAccountCreation():bool{
		return false;
	}
	
	/**
	 * 
	 * @return bool
	 */
	protected function hasEmailValidation():bool{
		return false;
	}

	/**
	 * @return bool
	 */
	protected function hasAccountRecovery():bool{
		return false;
	}
	
	/**
	 * To override
	 * Returns true for a two factor authentification for this account.
	 * @param mixed $accountValue
	 * @return bool
	 */
	protected function has2FA($accountValue=null):bool{
		return false;
	}

	/**
	 * To override
	 * Returns the default size for generated tokens.
	 * @return int
	 */
	protected function getTokenSize():int{
		return 6;
	}

	/**
	 * Generates a new random 2FA code.
	 * You have to override this basic implementation.
	 * @return string
	 * @throws \Exception
	 */
	protected function generate2FACode():string{
		return \bin2hex ( \random_bytes ($this->getTokenSize()));
	}

	/**
	 * Returns the code prefix (which should not be entered by the user). 
	 * @return string
	 */
	protected function towFACodePrefix():string{
		return 'U-';
	}

	/**
	 * Returns the default validity duration of a mail validation link.
	 * @return \DateInterval
	 */
	protected function emailValidationDuration():\DateInterval{
		return new \DateInterval('PT24H');
	}

	/**
	 * Returns the default validity duration of a generated 2FA code.
	 * @return \DateInterval
	 */
	protected function twoFACodeDuration():\DateInterval{
		return new \DateInterval('PT5M');
	}

	/**
	 * @return bool
	 */
	public function hasRecoveryAccount():bool{
		return false;
	}
	/**
	 * Returns the default validity duration for an email account recovery.
	 * @return \DateInterval
	 */
	protected function accountRecoveryDuration():\DateInterval{
		return new \DateInterval('PT30M');
	}
	
}