PHP Class PayPal\Auth\Openid\PPOpenIdUserinfo

Inheritance: extends PayPal\Common\PPModel
Show file Open project: paypal/sdk-core-php Class Usage Examples

Public Methods

Method Description
getAccountType ( ) : string Account type.
getAddress ( ) : PPOpenIdAddress End-User's preferred address.
getAgeRange ( ) : string Account holder age range.
getBirthday ( ) : string End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
getEmail ( ) : string End-User's preferred e-mail address.
getEmailVerified ( ) : boolean True if the End-User's e-mail address has been verified; otherwise false.
getFamilyName ( ) : string Surname(s) or last name(s) of the End-User.
getGender ( ) : string End-User's gender.
getGivenName ( ) : string Given name(s) or first name(s) of the End-User
getLanguage ( ) : string End-User's language.
getLocale ( ) : string End-User's locale.
getMiddleName ( ) : string Middle name(s) of the End-User.
getName ( ) : string End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
getPayerId ( ) : string Account payer identifier.
getPhoneNumber ( ) : string End-User's preferred telephone number.
getPicture ( ) : string URL of the End-User's profile picture.
getSub ( ) : string Subject - Identifier for the End-User at the Issuer.
getUserId ( ) : string Subject - Identifier for the End-User at the Issuer.
getUserinfo ( array $params, PPApiContext $apiContext = null ) : PPOpenIdUserinfo returns user details
getVerified ( ) : boolean End-User's verified status.
getVerifiedAccount ( ) : boolean Verified account status.
getZoneinfo ( ) : string Time zone database representing the End-User's time zone
setAccountType ( string $account_type ) Account type.
setAddress ( PPOpenIdAddress $address ) End-User's preferred address.
setAgeRange ( string $age_range ) Account holder age range.
setBirthday ( string $birthday ) End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
setEmail ( string $email ) End-User's preferred e-mail address.
setEmailVerified ( boolean $email_verified ) True if the End-User's e-mail address has been verified; otherwise false.
setFamilyName ( string $family_name ) Surname(s) or last name(s) of the End-User.
setGender ( string $gender ) End-User's gender.
setGivenName ( string $given_name ) Given name(s) or first name(s) of the End-User
setLanguage ( string $language ) End-User's language.
setLocale ( string $locale ) End-User's locale.
setMiddleName ( string $middle_name ) Middle name(s) of the End-User.
setName ( string $name ) End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
setPayerId ( string $payer_id ) Account payer identifier.
setPhoneNumber ( string $phone_number ) End-User's preferred telephone number.
setPicture ( string $picture ) URL of the End-User's profile picture.
setSub ( string $sub ) Subject - Identifier for the End-User at the Issuer.
setUserId ( string $user_id ) Subject - Identifier for the End-User at the Issuer.
setVerified ( boolean $verified ) End-User's verified status.
setVerifiedAccount ( boolean $verified_account ) Verified account status.
setZoneinfo ( string $zoneinfo ) Time zone database representing the End-User's time zone

Method Details

getAccountType() public method

Account type.
public getAccountType ( ) : string
return string

getAddress() public method

End-User's preferred address.
public getAddress ( ) : PPOpenIdAddress
return PPOpenIdAddress

getAgeRange() public method

Account holder age range.
public getAgeRange ( ) : string
return string

getBirthday() public method

End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
public getBirthday ( ) : string
return string

getEmail() public method

End-User's preferred e-mail address.
public getEmail ( ) : string
return string

getEmailVerified() public method

True if the End-User's e-mail address has been verified; otherwise false.
public getEmailVerified ( ) : boolean
return boolean

getFamilyName() public method

Surname(s) or last name(s) of the End-User.
public getFamilyName ( ) : string
return string

getGender() public method

End-User's gender.
public getGender ( ) : string
return string

getGivenName() public method

Given name(s) or first name(s) of the End-User
public getGivenName ( ) : string
return string

getLanguage() public method

End-User's language.
public getLanguage ( ) : string
return string

getLocale() public method

End-User's locale.
public getLocale ( ) : string
return string

getMiddleName() public method

Middle name(s) of the End-User.
public getMiddleName ( ) : string
return string

getName() public method

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
public getName ( ) : string
return string

getPayerId() public method

Account payer identifier.
public getPayerId ( ) : string
return string

getPhoneNumber() public method

End-User's preferred telephone number.
public getPhoneNumber ( ) : string
return string

getPicture() public method

URL of the End-User's profile picture.
public getPicture ( ) : string
return string

getSub() public method

Subject - Identifier for the End-User at the Issuer.
public getSub ( ) : string
return string

getUserId() public method

Subject - Identifier for the End-User at the Issuer.
public getUserId ( ) : string
return string

getUserinfo() public static method

returns user details
public static getUserinfo ( array $params, PPApiContext $apiContext = null ) : PPOpenIdUserinfo
$params array (allowed values are access_token) access_token - access token from the createFromAuthorizationCode / createFromRefreshToken calls
$apiContext PayPal\Common\PPApiContext Optional API Context
return PPOpenIdUserinfo

getVerified() public method

End-User's verified status.
public getVerified ( ) : boolean
return boolean

getVerifiedAccount() public method

Verified account status.
public getVerifiedAccount ( ) : boolean
return boolean

getZoneinfo() public method

Time zone database representing the End-User's time zone
public getZoneinfo ( ) : string
return string

setAccountType() public method

Account type.
public setAccountType ( string $account_type )
$account_type string

setAddress() public method

End-User's preferred address.
public setAddress ( PPOpenIdAddress $address )
$address PPOpenIdAddress

setAgeRange() public method

Account holder age range.
public setAgeRange ( string $age_range )
$age_range string

setBirthday() public method

End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
public setBirthday ( string $birthday )
$birthday string

setEmail() public method

End-User's preferred e-mail address.
public setEmail ( string $email )
$email string

setEmailVerified() public method

True if the End-User's e-mail address has been verified; otherwise false.
public setEmailVerified ( boolean $email_verified )
$email_verified boolean

setFamilyName() public method

Surname(s) or last name(s) of the End-User.
public setFamilyName ( string $family_name )
$family_name string

setGender() public method

End-User's gender.
public setGender ( string $gender )
$gender string

setGivenName() public method

Given name(s) or first name(s) of the End-User
public setGivenName ( string $given_name )
$given_name string

setLanguage() public method

End-User's language.
public setLanguage ( string $language )
$language string

setLocale() public method

End-User's locale.
public setLocale ( string $locale )
$locale string

setMiddleName() public method

Middle name(s) of the End-User.
public setMiddleName ( string $middle_name )
$middle_name string

setName() public method

End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
public setName ( string $name )
$name string

setPayerId() public method

Account payer identifier.
public setPayerId ( string $payer_id )
$payer_id string

setPhoneNumber() public method

End-User's preferred telephone number.
public setPhoneNumber ( string $phone_number )
$phone_number string

setPicture() public method

URL of the End-User's profile picture.
public setPicture ( string $picture )
$picture string

setSub() public method

Subject - Identifier for the End-User at the Issuer.
public setSub ( string $sub )
$sub string

setUserId() public method

Subject - Identifier for the End-User at the Issuer.
public setUserId ( string $user_id )
$user_id string

setVerified() public method

End-User's verified status.
public setVerified ( boolean $verified )
$verified boolean

setVerifiedAccount() public method

Verified account status.
public setVerifiedAccount ( boolean $verified_account )
$verified_account boolean

setZoneinfo() public method

Time zone database representing the End-User's time zone
public setZoneinfo ( string $zoneinfo )
$zoneinfo string