AuthFiles Class Reference

Ubiquity\controllers\auth$AuthFiles This class is part of Ubiquity. More...

Public Member Functions
	__construct ()
	getViewIndex ()
	To override The login view.
	getViewInfo ()
	To override The info view, displays the connected user and a logout button.
	getViewCreate ()
	To override Displays the form for a new account.
	getViewStepTwo ()
	To override Displays the form for step two.
	getViewBadTwoFACode ()
	To override Displays the message if the 2FA code is bad.
	getViewNoAccess ()
	To override.
	getViewBaseTemplate ()
	Returns the base template for all Auth actions if getBaseTemplate return a base template filename.
	getViewDisconnected ()
	To override.
	getViewMessage ()
	getViewInitRecovery ()
	To override.
	getViewRecovery ()
	To override.
	getBaseTemplate ()
	To override Returns the base template filename, default : null.

Protected Attributes
string	$viewBase

Detailed Description

Ubiquity\controllers\auth$AuthFiles This class is part of Ubiquity.

Author

jc

Version

1.0.0

Definition at line 13 of file AuthFiles.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Definition at line 16 of file AuthFiles.php.

Member Function Documentation

getBaseTemplate()

getBaseTemplate

(

)

To override Returns the base template filename, default : null.

Returns

string|null

Definition at line 126 of file AuthFiles.php.

getViewBadTwoFACode()

getViewBadTwoFACode

(

)

To override Displays the message if the 2FA code is bad.

Returns

string

Definition at line 66 of file AuthFiles.php.

getViewBaseTemplate()

getViewBaseTemplate

(

)

Returns the base template for all Auth actions if getBaseTemplate return a base template filename.

Returns

string

Definition at line 84 of file AuthFiles.php.

getViewCreate()

getViewCreate

(

)

To override Displays the form for a new account.

Returns

string

Definition at line 46 of file AuthFiles.php.

getViewDisconnected()

getViewDisconnected

(

)

To override.

Returns

string

Definition at line 93 of file AuthFiles.php.

getViewIndex()

getViewIndex

(

)

To override The login view.

Returns

string

Definition at line 26 of file AuthFiles.php.

getViewInfo()

getViewInfo

(

)

To override The info view, displays the connected user and a logout button.

Returns

string

Definition at line 36 of file AuthFiles.php.

getViewInitRecovery()

getViewInitRecovery

(

)

To override.

Returns

string

Definition at line 109 of file AuthFiles.php.

getViewMessage()

getViewMessage

(

)

Returns

string

Definition at line 101 of file AuthFiles.php.

getViewNoAccess()

getViewNoAccess

(

)

To override.

Returns

string

Definition at line 75 of file AuthFiles.php.

getViewRecovery()

getViewRecovery

(

)

To override.

Returns

string

Definition at line 117 of file AuthFiles.php.

getViewStepTwo()

getViewStepTwo

(

)

To override Displays the form for step two.

Returns

string

Definition at line 56 of file AuthFiles.php.

Field Documentation

$viewBase

string $viewBase

protected

Definition at line 14 of file AuthFiles.php.

---

The documentation for this class was generated from the following file:

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity/src/Ubiquity/controllers/auth/AuthFiles.php