Documentation

Google_Service_PeopleService_Person extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

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.
$ageRange  : mixed
$etag  : mixed
$resourceName  : mixed
$addressesDataType  : mixed
$addressesType  : mixed
$ageRangesDataType  : mixed
$ageRangesType  : mixed
$biographiesDataType  : mixed
$biographiesType  : mixed
$birthdaysDataType  : mixed
$birthdaysType  : mixed
$braggingRightsDataType  : mixed
$braggingRightsType  : mixed
$calendarUrlsDataType  : mixed
$calendarUrlsType  : mixed
$clientDataDataType  : mixed
$clientDataType  : mixed
$collection_key  : mixed
$coverPhotosDataType  : mixed
$coverPhotosType  : mixed
$emailAddressesDataType  : mixed
$emailAddressesType  : mixed
$eventsDataType  : mixed
$eventsType  : mixed
$externalIdsDataType  : mixed
$externalIdsType  : mixed
$fileAsesDataType  : mixed
$fileAsesType  : mixed
$gendersDataType  : mixed
$gendersType  : mixed
$imClientsDataType  : mixed
$imClientsType  : mixed
$interestsDataType  : mixed
$interestsType  : mixed
$internal_gapi_mappings  : mixed
$localesDataType  : mixed
$localesType  : mixed
$locationsDataType  : mixed
$locationsType  : mixed
$membershipsDataType  : mixed
$membershipsType  : mixed
$metadataDataType  : mixed
$metadataType  : mixed
$miscKeywordsDataType  : mixed
$miscKeywordsType  : mixed
$modelData  : mixed
$namesDataType  : mixed
$namesType  : mixed
$nicknamesDataType  : mixed
$nicknamesType  : mixed
$occupationsDataType  : mixed
$occupationsType  : mixed
$organizationsDataType  : mixed
$organizationsType  : mixed
$phoneNumbersDataType  : mixed
$phoneNumbersType  : mixed
$photosDataType  : mixed
$photosType  : mixed
$processed  : mixed
$relationsDataType  : mixed
$relationshipInterestsDataType  : mixed
$relationshipInterestsType  : mixed
$relationshipStatusesDataType  : mixed
$relationshipStatusesType  : mixed
$relationsType  : mixed
$residencesDataType  : mixed
$residencesType  : mixed
$sipAddressesDataType  : mixed
$sipAddressesType  : mixed
$skillsDataType  : mixed
$skillsType  : mixed
$taglinesDataType  : mixed
$taglinesType  : mixed
$urlsDataType  : mixed
$urlsType  : mixed
$userDefinedDataType  : mixed
$userDefinedType  : 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.
count()  : mixed
current()  : mixed
getAddresses()  : Google_Service_PeopleService_Address
getAgeRange()  : mixed
getAgeRanges()  : Google_Service_PeopleService_AgeRangeType
getBiographies()  : Google_Service_PeopleService_Biography
getBirthdays()  : Google_Service_PeopleService_Birthday
getBraggingRights()  : Google_Service_PeopleService_BraggingRights
getCalendarUrls()  : Google_Service_PeopleService_CalendarUrl
getClientData()  : Google_Service_PeopleService_ClientData
getCoverPhotos()  : Google_Service_PeopleService_CoverPhoto
getEmailAddresses()  : Google_Service_PeopleService_EmailAddress
getEtag()  : mixed
getEvents()  : Google_Service_PeopleService_Event
getExternalIds()  : Google_Service_PeopleService_ExternalId
getFileAses()  : Google_Service_PeopleService_FileAs
getGenders()  : Google_Service_PeopleService_Gender
getImClients()  : Google_Service_PeopleService_ImClient
getInterests()  : Google_Service_PeopleService_Interest
getLocales()  : Google_Service_PeopleService_Locale
getLocations()  : Google_Service_PeopleService_Location
getMemberships()  : Google_Service_PeopleService_Membership
getMetadata()  : Google_Service_PeopleService_PersonMetadata
getMiscKeywords()  : Google_Service_PeopleService_MiscKeyword
getNames()  : Google_Service_PeopleService_Name
getNicknames()  : Google_Service_PeopleService_Nickname
getOccupations()  : Google_Service_PeopleService_Occupation
getOrganizations()  : Google_Service_PeopleService_Organization
getPhoneNumbers()  : Google_Service_PeopleService_PhoneNumber
getPhotos()  : Google_Service_PeopleService_Photo
getRelations()  : Google_Service_PeopleService_Relation
getRelationshipInterests()  : Google_Service_PeopleService_RelationshipInterest
getRelationshipStatuses()  : Google_Service_PeopleService_RelationshipStatus
getResidences()  : Google_Service_PeopleService_Residence
getResourceName()  : mixed
getSipAddresses()  : Google_Service_PeopleService_SipAddress
getSkills()  : Google_Service_PeopleService_Skill
getTaglines()  : Google_Service_PeopleService_Tagline
getUrls()  : Google_Service_PeopleService_Url
getUserDefined()  : Google_Service_PeopleService_UserDefined
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAddresses()  : mixed
setAgeRange()  : mixed
setAgeRanges()  : mixed
setBiographies()  : mixed
setBirthdays()  : mixed
setBraggingRights()  : mixed
setCalendarUrls()  : mixed
setClientData()  : mixed
setCoverPhotos()  : mixed
setEmailAddresses()  : mixed
setEtag()  : mixed
setEvents()  : mixed
setExternalIds()  : mixed
setFileAses()  : mixed
setGenders()  : mixed
setImClients()  : mixed
setInterests()  : mixed
setLocales()  : mixed
setLocations()  : mixed
setMemberships()  : mixed
setMetadata()  : mixed
setMiscKeywords()  : mixed
setNames()  : mixed
setNicknames()  : mixed
setOccupations()  : mixed
setOrganizations()  : mixed
setPhoneNumbers()  : mixed
setPhotos()  : mixed
setRelations()  : mixed
setRelationshipInterests()  : mixed
setRelationshipStatuses()  : mixed
setResidences()  : mixed
setResourceName()  : mixed
setSipAddresses()  : mixed
setSkills()  : mixed
setTaglines()  : mixed
setUrls()  : mixed
setUserDefined()  : 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.
valid()  : mixed
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
coerceType()  : mixed
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

$ageRange

public mixed $ageRange

$resourceName

public mixed $resourceName

$addressesDataType

protected mixed $addressesDataType = 'array'

$addressesType

protected mixed $addressesType = 'Google_Service_PeopleService_Address'

$ageRangesDataType

protected mixed $ageRangesDataType = 'array'

$ageRangesType

protected mixed $ageRangesType = 'Google_Service_PeopleService_AgeRangeType'

$biographiesDataType

protected mixed $biographiesDataType = 'array'

$biographiesType

protected mixed $biographiesType = 'Google_Service_PeopleService_Biography'

$birthdaysDataType

protected mixed $birthdaysDataType = 'array'

$birthdaysType

protected mixed $birthdaysType = 'Google_Service_PeopleService_Birthday'

$braggingRightsDataType

protected mixed $braggingRightsDataType = 'array'

$braggingRightsType

protected mixed $braggingRightsType = 'Google_Service_PeopleService_BraggingRights'

$calendarUrlsDataType

protected mixed $calendarUrlsDataType = 'array'

$calendarUrlsType

protected mixed $calendarUrlsType = 'Google_Service_PeopleService_CalendarUrl'

$clientDataDataType

protected mixed $clientDataDataType = 'array'

$clientDataType

protected mixed $clientDataType = 'Google_Service_PeopleService_ClientData'

$collection_key

protected mixed $collection_key = 'userDefined'

$coverPhotosDataType

protected mixed $coverPhotosDataType = 'array'

$coverPhotosType

protected mixed $coverPhotosType = 'Google_Service_PeopleService_CoverPhoto'

$emailAddressesDataType

protected mixed $emailAddressesDataType = 'array'

$emailAddressesType

protected mixed $emailAddressesType = 'Google_Service_PeopleService_EmailAddress'

$eventsDataType

protected mixed $eventsDataType = 'array'

$eventsType

protected mixed $eventsType = 'Google_Service_PeopleService_Event'

$externalIdsDataType

protected mixed $externalIdsDataType = 'array'

$externalIdsType

protected mixed $externalIdsType = 'Google_Service_PeopleService_ExternalId'

$fileAsesDataType

protected mixed $fileAsesDataType = 'array'

$fileAsesType

protected mixed $fileAsesType = 'Google_Service_PeopleService_FileAs'

$gendersDataType

protected mixed $gendersDataType = 'array'

$gendersType

protected mixed $gendersType = 'Google_Service_PeopleService_Gender'

$imClientsDataType

protected mixed $imClientsDataType = 'array'

$imClientsType

protected mixed $imClientsType = 'Google_Service_PeopleService_ImClient'

$interestsDataType

protected mixed $interestsDataType = 'array'

$interestsType

protected mixed $interestsType = 'Google_Service_PeopleService_Interest'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$localesDataType

protected mixed $localesDataType = 'array'

$localesType

protected mixed $localesType = 'Google_Service_PeopleService_Locale'

$locationsDataType

protected mixed $locationsDataType = 'array'

$locationsType

protected mixed $locationsType = 'Google_Service_PeopleService_Location'

$membershipsDataType

protected mixed $membershipsDataType = 'array'

$membershipsType

protected mixed $membershipsType = 'Google_Service_PeopleService_Membership'

$metadataDataType

protected mixed $metadataDataType = ''

$metadataType

protected mixed $metadataType = 'Google_Service_PeopleService_PersonMetadata'

$miscKeywordsDataType

protected mixed $miscKeywordsDataType = 'array'

$miscKeywordsType

protected mixed $miscKeywordsType = 'Google_Service_PeopleService_MiscKeyword'

$modelData

protected mixed $modelData = array()

$namesDataType

protected mixed $namesDataType = 'array'

$namesType

protected mixed $namesType = 'Google_Service_PeopleService_Name'

$nicknamesDataType

protected mixed $nicknamesDataType = 'array'

$nicknamesType

protected mixed $nicknamesType = 'Google_Service_PeopleService_Nickname'

$occupationsDataType

protected mixed $occupationsDataType = 'array'

$occupationsType

protected mixed $occupationsType = 'Google_Service_PeopleService_Occupation'

$organizationsDataType

protected mixed $organizationsDataType = 'array'

$organizationsType

protected mixed $organizationsType = 'Google_Service_PeopleService_Organization'

$phoneNumbersDataType

protected mixed $phoneNumbersDataType = 'array'

$phoneNumbersType

protected mixed $phoneNumbersType = 'Google_Service_PeopleService_PhoneNumber'

$photosDataType

protected mixed $photosDataType = 'array'

$photosType

protected mixed $photosType = 'Google_Service_PeopleService_Photo'

$processed

protected mixed $processed = array()

$relationsDataType

protected mixed $relationsDataType = 'array'

$relationshipInterestsDataType

protected mixed $relationshipInterestsDataType = 'array'

$relationshipInterestsType

protected mixed $relationshipInterestsType = 'Google_Service_PeopleService_RelationshipInterest'

$relationshipStatusesDataType

protected mixed $relationshipStatusesDataType = 'array'

$relationshipStatusesType

protected mixed $relationshipStatusesType = 'Google_Service_PeopleService_RelationshipStatus'

$relationsType

protected mixed $relationsType = 'Google_Service_PeopleService_Relation'

$residencesDataType

protected mixed $residencesDataType = 'array'

$residencesType

protected mixed $residencesType = 'Google_Service_PeopleService_Residence'

$sipAddressesDataType

protected mixed $sipAddressesDataType = 'array'

$sipAddressesType

protected mixed $sipAddressesType = 'Google_Service_PeopleService_SipAddress'

$skillsDataType

protected mixed $skillsDataType = 'array'

$skillsType

protected mixed $skillsType = 'Google_Service_PeopleService_Skill'

$taglinesDataType

protected mixed $taglinesDataType = 'array'

$taglinesType

protected mixed $taglinesType = 'Google_Service_PeopleService_Tagline'

$urlsDataType

protected mixed $urlsDataType = 'array'

$urlsType

protected mixed $urlsType = 'Google_Service_PeopleService_Url'

$userDefinedDataType

protected mixed $userDefinedDataType = 'array'

$userDefinedType

protected mixed $userDefinedType = 'Google_Service_PeopleService_UserDefined'

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 —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getAgeRange()

public getAgeRange() : mixed
Return values
mixed —

getEtag()

public getEtag() : mixed
Return values
mixed —

getResourceName()

public getResourceName() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : 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 —

rewind()

public rewind() : mixed
Return values
mixed —

setAddresses()

public setAddresses(mixed $addresses) : mixed
Parameters
$addresses : mixed
Return values
mixed —

setAgeRange()

public setAgeRange(mixed $ageRange) : mixed
Parameters
$ageRange : mixed
Return values
mixed —

setAgeRanges()

public setAgeRanges(mixed $ageRanges) : mixed
Parameters
$ageRanges : mixed
Return values
mixed —

setBiographies()

public setBiographies(mixed $biographies) : mixed
Parameters
$biographies : mixed
Return values
mixed —

setBirthdays()

public setBirthdays(mixed $birthdays) : mixed
Parameters
$birthdays : mixed
Return values
mixed —

setBraggingRights()

public setBraggingRights(mixed $braggingRights) : mixed
Parameters
$braggingRights : mixed
Return values
mixed —

setCalendarUrls()

public setCalendarUrls(mixed $calendarUrls) : mixed
Parameters
$calendarUrls : mixed
Return values
mixed —

setClientData()

public setClientData(mixed $clientData) : mixed
Parameters
$clientData : mixed
Return values
mixed —

setCoverPhotos()

public setCoverPhotos(mixed $coverPhotos) : mixed
Parameters
$coverPhotos : mixed
Return values
mixed —

setEmailAddresses()

public setEmailAddresses(mixed $emailAddresses) : mixed
Parameters
$emailAddresses : mixed
Return values
mixed —

setEtag()

public setEtag(mixed $etag) : mixed
Parameters
$etag : mixed
Return values
mixed —

setEvents()

public setEvents(mixed $events) : mixed
Parameters
$events : mixed
Return values
mixed —

setExternalIds()

public setExternalIds(mixed $externalIds) : mixed
Parameters
$externalIds : mixed
Return values
mixed —

setFileAses()

public setFileAses(mixed $fileAses) : mixed
Parameters
$fileAses : mixed
Return values
mixed —

setGenders()

public setGenders(mixed $genders) : mixed
Parameters
$genders : mixed
Return values
mixed —

setImClients()

public setImClients(mixed $imClients) : mixed
Parameters
$imClients : mixed
Return values
mixed —

setInterests()

public setInterests(mixed $interests) : mixed
Parameters
$interests : mixed
Return values
mixed —

setLocales()

public setLocales(mixed $locales) : mixed
Parameters
$locales : mixed
Return values
mixed —

setLocations()

public setLocations(mixed $locations) : mixed
Parameters
$locations : mixed
Return values
mixed —

setMemberships()

public setMemberships(mixed $memberships) : mixed
Parameters
$memberships : mixed
Return values
mixed —

setMiscKeywords()

public setMiscKeywords(mixed $miscKeywords) : mixed
Parameters
$miscKeywords : mixed
Return values
mixed —

setNames()

public setNames(mixed $names) : mixed
Parameters
$names : mixed
Return values
mixed —

setNicknames()

public setNicknames(mixed $nicknames) : mixed
Parameters
$nicknames : mixed
Return values
mixed —

setOccupations()

public setOccupations(mixed $occupations) : mixed
Parameters
$occupations : mixed
Return values
mixed —

setOrganizations()

public setOrganizations(mixed $organizations) : mixed
Parameters
$organizations : mixed
Return values
mixed —

setPhoneNumbers()

public setPhoneNumbers(mixed $phoneNumbers) : mixed
Parameters
$phoneNumbers : mixed
Return values
mixed —

setPhotos()

public setPhotos(mixed $photos) : mixed
Parameters
$photos : mixed
Return values
mixed —

setRelations()

public setRelations(mixed $relations) : mixed
Parameters
$relations : mixed
Return values
mixed —

setRelationshipInterests()

public setRelationshipInterests(mixed $relationshipInterests) : mixed
Parameters
$relationshipInterests : mixed
Return values
mixed —

setRelationshipStatuses()

public setRelationshipStatuses(mixed $relationshipStatuses) : mixed
Parameters
$relationshipStatuses : mixed
Return values
mixed —

setResidences()

public setResidences(mixed $residences) : mixed
Parameters
$residences : mixed
Return values
mixed —

setResourceName()

public setResourceName(mixed $resourceName) : mixed
Parameters
$resourceName : mixed
Return values
mixed —

setSipAddresses()

public setSipAddresses(mixed $sipAddresses) : mixed
Parameters
$sipAddresses : mixed
Return values
mixed —

setSkills()

public setSkills(mixed $skills) : mixed
Parameters
$skills : mixed
Return values
mixed —

setTaglines()

public setTaglines(mixed $taglines) : mixed
Parameters
$taglines : mixed
Return values
mixed —

setUrls()

public setUrls(mixed $urls) : mixed
Parameters
$urls : mixed
Return values
mixed —

setUserDefined()

public setUserDefined(mixed $userDefined) : mixed
Parameters
$userDefined : 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 —

valid()

public valid() : 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 —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

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