api/users/User.php
Classes
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\google\appengine\api\users\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
__construct(string $email = null, string $federated_identity = null, string $federated_provider = null, $user_id = null) : voidConstructor.
| Name | Type | Description |
|---|---|---|
| string | An optional string of the user's email address. It defaults to the current user's email address. | |
| $federated_identity | string | The federated identity of user. It defaults to the current user's federated identity. |
| $federated_provider | string | The federated provider url of user. |
| $user_id |
| Exception | Description |
|---|---|
| \InvalidArgumentException | Thrown if both email and federated identity are empty. |
__toString() : stringMagic method that PHP uses when the object is treated like a string.
| Type | Description |
|---|---|
| string | The attributes of this user. |
getAuthDomain() : stringReturn this user's auth domain.
This method is internal and should not be used by client applications.
| Type | Description |
|---|---|
| string | The user's authentication domain. |
getEmail() : stringReturn this user's email address.
| Type | Description |
|---|---|
| string | The user's email address. |
getFederatedIdentity() : stringReturn this user's federated identity, null if not a federated user.
| Type | Description |
|---|---|
| string | The user's federated identity. |
getFederatedProvider() : stringReturn this user's federated provider, null if not a federated user.
| Type | Description |
|---|---|
| string | The user's federated provider. |
getNickname() : stringReturn 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.
| Type | Description |
|---|---|
| string | The user's nickname. |
getUserId() : stringReturn either a permanent unique identifying string or null.
If the email address was set explicity, this will return null.
| Type | Description |
|---|---|
| string | The user's UserId. |