Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Auth_LoginTicket Class Reference

Public Member Functions

 __construct ($envelope, $payload)
 Creates a user based on the supplied token.
 
 getAttributes ()
 Returns attributes from the login ticket.
 
 getUserId ()
 Returns the numeric identifier for the user.
 

Public Attributes

const USER_ATTR = "sub"
 

Constructor & Destructor Documentation

◆ __construct()

Google_Auth_LoginTicket::__construct ( $envelope,
$payload )

Creates a user based on the supplied token.

Parameters
string$envelopeHeader from a verified authentication token.
string$payloadInformation from a verified authentication token.

Member Function Documentation

◆ getAttributes()

Google_Auth_LoginTicket::getAttributes ( )

Returns attributes from the login ticket.

This can contain various information about the user session.

Return values
array

◆ getUserId()

Google_Auth_LoginTicket::getUserId ( )

Returns the numeric identifier for the user.

Exceptions
Google_Auth_Exception
Return values

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