Ubiquity\controllers\auth\AuthControllerVariablesTrait

Complexity

Total Complexity

30

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Test Coverage

Coverage

73.32%

Importance

Changes	3
Bugs	0	Features	2

30 Methods

Rating	Name	Duplication	Size	Complexity
A	badLoginMessage()	0	1	1
A	disconnectedMessage()	0	1	1
A	noAccessMessage()	0	1	1
A	terminateMessage()	0	1	1
A	attemptsNumberMessage()	0	1	1
A	newTwoFACodeMessage()	0	1	1
A	canCreateAccountMessage()	0	1	1
A	createAccountMessage()	0	1	1
A	twoFAMessage()	0	1	1
A	twoFABadCodeMessage()	0	1	1
A	createAccountErrorMessage()	0	1	1
A	passwordConfLabel()	0	2	1
A	attemptsTimeout()	0	2	1
A	hasAccountCreation()	0	2	1
A	hasEmailValidation()	0	2	1
A	towFACodePrefix()	0	2	1
A	emailValidationSuccess()	0	1	1
A	_getBodySelector()	0	2	1
A	_displayInfoAsString()	0	2	1
A	generate2FACode()	0	2	1
A	_checkConnectionTimeout()	0	2	1
A	rememberCaption()	0	2	1
A	attemptsNumber()	0	2	1
A	_getPasswordInputName()	0	2	1
A	loginLabel()	0	2	1
A	emailValidationDuration()	0	2	1
A	_getLoginInputName()	0	2	1
A	has2FA()	0	2	1
A	emailValidationError()	0	1	1
A	passwordLabel()	0	2	1

<?php

namespace Ubiquity\controllers\auth;

use Ubiquity\utils\flash\FlashMessage;

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) {

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

	}
	
	/**
	 * To override for modifying the account creation message information.
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function canCreateAccountMessage(FlashMessage $fMessage) {

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

	}
	
	/**
	 * To override for modifying the error for account creation.
	 *
	 * @param FlashMessage $fMessage
	 */
	protected function createAccountErrorMessage(FlashMessage $fMessage) {

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

	}
	
	/**
	 * To override for modifying the 2FA panel message.
	 * @param FlashMessage $fMessage
	 */
	protected function twoFAMessage(FlashMessage $fMessage){

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

		
	}
	/**
	 * To override
	 * @param FlashMessage $fMessage
	 */
	protected function newTwoFACodeMessage(FlashMessage $fMessage){

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

		
	}
	
	/**
	 * To override for modifying the message displayed if the 2FA code is bad.
	 * @param FlashMessage $fMessage
	 */
	protected function twoFABadCodeMessage(FlashMessage $fMessage){

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

		
	}
	
	/**
	 * To override 
	 * Displayed when email is valid.
	 * @param FlashMessage $fMessage
	 */
	protected function emailValidationSuccess(FlashMessage $fMessage){

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

		
	}
	
	/**
	 * To override
	 * Displayed when email is invalid or if an error occurs.
	 * @param FlashMessage $fMessage
	 */
	protected function emailValidationError(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 info is displayed as string
	 * if set to true, use _infoUser var in views to display user info
	 */
	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: body
	 *
	 * @return string
	 */
	public function _getBodySelector() {
		return 'body';
	}

	protected function rememberCaption() {
		return 'Remember me';
	}
	/**
	 * Returns true for account creation.
	 * @return boolean
	 */
	protected function hasAccountCreation():bool{
		return false;
	}
	
	/**
	 * 
	 * @return bool
	 */
	protected function hasEmailValidation():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{

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

		return false;
	}
	
	/**
	 * 
	 * @return string
	 */
	protected function generate2FACode():string{
		return \substr(\md5(\uniqid(\rand(), true)), 6, 6);
	}
	
	protected function towFACodePrefix():string{
		return 'U-';
	}
	
	protected function emailValidationDuration():\DateInterval{
		return new \DateInterval('PT24H');
	}
	
}