User
class User (View source)
A user.
We provide the email address, nickname, and id for a user.
A nickname is a human-readable string which uniquely identifies a Google user, akin to a username. It will be an email address for some users, but not all.
A user could be a Google Accounts user or a federated login user.
Federated identity and federated provider are only avaliable for federated users.
Methods
Constructor.
Return this user's nickname.
Return this user's email address.
Return either a permanent unique identifying string or null.
Return this user's auth domain.
Return this user's federated identity, null if not a federated user.
Return this user's federated provider, null if not a federated user.
Magic method that PHP uses when the object is treated like a string.
Details
at line 55
__construct($email = null, $federated_identity = null, $federated_provider = null, $user_id = null)
Constructor.
at line 85
string
getNickname()
Return this user's nickname.
The nickname will be a unique, human readable identifier for this user with respect to this application. It will be an email address for some users, part of the email address for some users, and the federated identity for federated users who have not asserted an email address.
at line 102
string
getEmail()
Return this user's email address.
at line 113
string
getUserId()
Return either a permanent unique identifying string or null.
If the email address was set explicity, this will return null.
at line 124
string
getAuthDomain()
Return this user's auth domain.
This method is internal and should not be used by client applications.
at line 133
string
getFederatedIdentity()
Return this user's federated identity, null if not a federated user.
at line 142
string
getFederatedProvider()
Return this user's federated provider, null if not a federated user.
at line 151
string
__toString()
Magic method that PHP uses when the object is treated like a string.