Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_auth\output\login Class Reference

Login renderable class. More...

Inheritance diagram for core_auth\output\login:
renderable templatable

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.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
array$authsequenceThe enabled sequence of authentication plugins.
string$usernameThe username to display.

Member Function Documentation

◆ export_for_template()

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:

  1. No complex types - only stdClass, array, int, string, float, bool
  2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
Parameters
renderer_base$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implements templatable.

◆ set_error()

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

Set the error message.

Parameters
string$errorThe error message.

◆ set_info()

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

Set the info message.

Parameters
string$infoThe info message.

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