Documentation

Google_Service_PeopleService_Name extends Google_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

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.
$displayName  : mixed
$displayNameLastFirst  : mixed
$familyName  : mixed
$givenName  : mixed
$honorificPrefix  : mixed
$honorificSuffix  : mixed
$middleName  : mixed
$phoneticFamilyName  : mixed
$phoneticFullName  : mixed
$phoneticGivenName  : mixed
$phoneticHonorificPrefix  : mixed
$phoneticHonorificSuffix  : mixed
$phoneticMiddleName  : mixed
$unstructuredName  : mixed
$internal_gapi_mappings  : mixed
$metadataDataType  : mixed
$metadataType  : mixed
$modelData  : mixed
$processed  : mixed
__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
getDisplayNameLastFirst()  : mixed
getFamilyName()  : mixed
getGivenName()  : mixed
getHonorificPrefix()  : mixed
getHonorificSuffix()  : mixed
getMetadata()  : Google_Service_PeopleService_FieldMetadata
getMiddleName()  : mixed
getPhoneticFamilyName()  : mixed
getPhoneticFullName()  : mixed
getPhoneticGivenName()  : mixed
getPhoneticHonorificPrefix()  : mixed
getPhoneticHonorificSuffix()  : mixed
getPhoneticMiddleName()  : mixed
getUnstructuredName()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setDisplayName()  : mixed
setDisplayNameLastFirst()  : mixed
setFamilyName()  : mixed
setGivenName()  : mixed
setHonorificPrefix()  : mixed
setHonorificSuffix()  : mixed
setMetadata()  : mixed
setMiddleName()  : mixed
setPhoneticFamilyName()  : mixed
setPhoneticFullName()  : mixed
setPhoneticGivenName()  : mixed
setPhoneticHonorificPrefix()  : mixed
setPhoneticHonorificSuffix()  : mixed
setPhoneticMiddleName()  : mixed
setUnstructuredName()  : 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

$displayNameLastFirst

public mixed $displayNameLastFirst

$familyName

public mixed $familyName

$givenName

public mixed $givenName

$honorificPrefix

public mixed $honorificPrefix

$honorificSuffix

public mixed $honorificSuffix

$middleName

public mixed $middleName

$phoneticFamilyName

public mixed $phoneticFamilyName

$phoneticFullName

public mixed $phoneticFullName

$phoneticGivenName

public mixed $phoneticGivenName

$phoneticHonorificPrefix

public mixed $phoneticHonorificPrefix

$phoneticHonorificSuffix

public mixed $phoneticHonorificSuffix

$phoneticMiddleName

public mixed $phoneticMiddleName

$unstructuredName

public mixed $unstructuredName

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$metadataDataType

protected mixed $metadataDataType = ''

$metadataType

protected mixed $metadataType = 'Google_Service_PeopleService_FieldMetadata'

$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
Return values
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
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
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
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

getDisplayName()

public getDisplayName() : mixed
Return values
mixed —

getDisplayNameLastFirst()

public getDisplayNameLastFirst() : mixed
Return values
mixed —

getFamilyName()

public getFamilyName() : mixed
Return values
mixed —

getGivenName()

public getGivenName() : mixed
Return values
mixed —

getHonorificPrefix()

public getHonorificPrefix() : mixed
Return values
mixed —

getHonorificSuffix()

public getHonorificSuffix() : mixed
Return values
mixed —

getMiddleName()

public getMiddleName() : mixed
Return values
mixed —

getPhoneticFamilyName()

public getPhoneticFamilyName() : mixed
Return values
mixed —

getPhoneticFullName()

public getPhoneticFullName() : mixed
Return values
mixed —

getPhoneticGivenName()

public getPhoneticGivenName() : mixed
Return values
mixed —

getPhoneticHonorificPrefix()

public getPhoneticHonorificPrefix() : mixed
Return values
mixed —

getPhoneticHonorificSuffix()

public getPhoneticHonorificSuffix() : mixed
Return values
mixed —

getPhoneticMiddleName()

public getPhoneticMiddleName() : mixed
Return values
mixed —

getUnstructuredName()

public getUnstructuredName() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

setDisplayName()

public setDisplayName(mixed $displayName) : mixed
Parameters
$displayName : mixed
Return values
mixed —

setDisplayNameLastFirst()

public setDisplayNameLastFirst(mixed $displayNameLastFirst) : mixed
Parameters
$displayNameLastFirst : mixed
Return values
mixed —

setFamilyName()

public setFamilyName(mixed $familyName) : mixed
Parameters
$familyName : mixed
Return values
mixed —

setGivenName()

public setGivenName(mixed $givenName) : mixed
Parameters
$givenName : mixed
Return values
mixed —

setHonorificPrefix()

public setHonorificPrefix(mixed $honorificPrefix) : mixed
Parameters
$honorificPrefix : mixed
Return values
mixed —

setHonorificSuffix()

public setHonorificSuffix(mixed $honorificSuffix) : mixed
Parameters
$honorificSuffix : mixed
Return values
mixed —

setMiddleName()

public setMiddleName(mixed $middleName) : mixed
Parameters
$middleName : mixed
Return values
mixed —

setPhoneticFamilyName()

public setPhoneticFamilyName(mixed $phoneticFamilyName) : mixed
Parameters
$phoneticFamilyName : mixed
Return values
mixed —

setPhoneticFullName()

public setPhoneticFullName(mixed $phoneticFullName) : mixed
Parameters
$phoneticFullName : mixed
Return values
mixed —

setPhoneticGivenName()

public setPhoneticGivenName(mixed $phoneticGivenName) : mixed
Parameters
$phoneticGivenName : mixed
Return values
mixed —

setPhoneticHonorificPrefix()

public setPhoneticHonorificPrefix(mixed $phoneticHonorificPrefix) : mixed
Parameters
$phoneticHonorificPrefix : mixed
Return values
mixed —

setPhoneticHonorificSuffix()

public setPhoneticHonorificSuffix(mixed $phoneticHonorificSuffix) : mixed
Parameters
$phoneticHonorificSuffix : mixed
Return values
mixed —

setPhoneticMiddleName()

public setPhoneticMiddleName(mixed $phoneticMiddleName) : mixed
Parameters
$phoneticMiddleName : mixed
Return values
mixed —

setUnstructuredName()

public setUnstructuredName(mixed $unstructuredName) : mixed
Parameters
$unstructuredName : mixed
Return values
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
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
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
Return values
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
Return values
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.

Return values
void —

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
Return values
mixed —

getSimpleValue()

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

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

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

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results