Documentation

User extends Model
in package

This class defines attributes, valid values, and usage which is generated from a given json schema.

http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5

Table of Contents

Constants

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google\Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

Properties

$displayName  : mixed
$emailAddress  : mixed
$kind  : mixed
$me  : mixed
$permissionId  : mixed
$photoLink  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed

Methods

__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
getDisplayName()  : mixed
getEmailAddress()  : mixed
getKind()  : mixed
getMe()  : mixed
getPermissionId()  : mixed
getPhotoLink()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setDisplayName()  : mixed
setEmailAddress()  : mixed
setKind()  : mixed
setMe()  : mixed
setPermissionId()  : mixed
setPhotoLink()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google\Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$displayName

public mixed $displayName

$emailAddress

public mixed $emailAddress

$kind

public mixed $kind

$permissionId

public mixed $permissionId

$photoLink

public mixed $photoLink

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Exception

Thrown if $obj isn't an array.

getDisplayName()

public getDisplayName() : mixed

getEmailAddress()

public getEmailAddress() : mixed

getKind()

public getKind() : mixed

getMe()

public getMe() : mixed

getPermissionId()

public getPermissionId() : mixed

getPhotoLink()

public getPhotoLink() : mixed

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed

setDisplayName()

public setDisplayName(mixed $displayName) : mixed
Parameters
$displayName : mixed

setEmailAddress()

public setEmailAddress(mixed $emailAddress) : mixed
Parameters
$emailAddress : mixed

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed

setMe()

public setMe(mixed $me) : mixed
Parameters
$me : mixed

setPermissionId()

public setPermissionId(mixed $permissionId) : mixed
Parameters
$permissionId : mixed

setPhotoLink()

public setPhotoLink(mixed $photoLink) : mixed
Parameters
$photoLink : mixed

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results