![]() |
App Engine PHP SDK
v1 rev.445
The PHP runtime is available as an experimental Preview feature.
|
Public Member Functions | |
__construct ($email=null, $federated_identity=null, $federated_provider=null, $user_id=null) | |
getNickname () | |
getEmail () | |
getUserId () | |
getAuthDomain () | |
getFederatedIdentity () | |
getFederatedProvider () | |
__toString () | |
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.
google\appengine\api\users\User::__construct | ( | $email = null , |
|
$federated_identity = null , |
|||
$federated_provider = null , |
|||
$user_id = null |
|||
) |
Constructor.
string | An optional string of the user's email address. It defaults to the current user's email address. | |
string | $federated_identity | The federated identity of user. It defaults to the current user's federated identity. |
string | $federated_provider | The federated provider url of user. |
InvalidArgumentException Thrown if both email and federated identity are empty. |
google\appengine\api\users\User::__toString | ( | ) |
Magic method that PHP uses when the object is treated like a string.
google\appengine\api\users\User::getAuthDomain | ( | ) |
Return this user's auth domain.
This method is internal and should not be used by client applications.
google\appengine\api\users\User::getEmail | ( | ) |
Return this user's email address.
google\appengine\api\users\User::getFederatedIdentity | ( | ) |
Return this user's federated identity, null if not a federated user.
google\appengine\api\users\User::getFederatedProvider | ( | ) |
Return this user's federated provider, null if not a federated user.
google\appengine\api\users\User::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.
google\appengine\api\users\User::getUserId | ( | ) |
Return either a permanent unique identifying string or null.
If the email address was set explicity, this will return null.