Login renderable class. More...

Inheritance diagram for core_auth\output\login:

Public Member Functions
	__construct (array $authsequence, $username='')
	Constructor.

	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.

	set_error ($error)
	Set the error message.

	set_info (string $info)
	Set the info message.

Public Attributes
bool	$autofocusform
	Whether to auto focus the form fields.

bool	$canloginasguest
	Whether we can login as guest.

bool	$canloginbyemail
	Whether we can login by e-mail.

bool	$cansignup
	Whether we can sign-up.

help_icon	$cookieshelpicon
	The cookies help icon.

string	$error
	The error message, if any.

moodle_url	$forgotpasswordurl
	Forgot password URL.

array	$identityproviders
	Additional identify providers, contains the keys 'url', 'name' and 'icon'.

string	$info
	The info message, if any.

string	$instructions
	Login instructions, if any.

string	$languagemenu
	The language selector menu.

string	$logintoken
	The csrf token to limit login to requests that come from the login form.

moodle_url	$loginurl
	The form action login URL.

string	$maintenance
	Maintenance message, if Maintenance is enabled.

string	$recaptcha
	ReCaptcha element HTML.

moodle_url	$signupurl
	The sign-up URL.

bool	$smallscreensonly
	Toggle the password visibility icon for small screens only.

bool	$togglepassword
	Toggle the password visibility icon.

string	$username
	The user name to pre-fill the form with.

Detailed Description

Login renderable class.

Constructor & Destructor Documentation

core_auth\output\login::__construct	(	array	$authsequence,
			$username = '' )

Constructor.

Parameters

array	$authsequence	The enabled sequence of authentication plugins.
string	$username	The username to display.

core_auth\output\login::export_for_template ( renderer_base $output )

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

No complex types - only stdClass, array, int, string, float, bool
Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base $output Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implements templatable.

core_auth\output\login::set_error ( $error )

Set the error message.

Parameters

string $error The error message.

core_auth\output\login::set_info ( string $info )

Set the info message.

Parameters

string $info The info message.

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