Class APIProfile

Description

Stores API Profile information used for performing transactions on the PayPal API

Located in /PayPal/Profile/API.php (line 23)

Profile
   |
   --APIProfile
Variable Summary
Method Summary
APIProfile APIProfile (string $id,  &$handler, ProfileHandler $handler)
string getAPIPassword ()
string getAPIUsername ()
string getAuthSignature ()
string getAuthTimestamp ()
string getAuthToken ()
string getCertificateFile ()
void getInstance ( $id,  &$handler)
string getSignature ()
string getSubject ()
void setAPIPassword (string $password)
void setAPIUsername (string $username)
string setAuthSignature ( $AuthSignature)
string setAuthTimestamp ( $AuthTimestamp)
string setAuthToken ( $AuthToken)
void setCertificateFile (string $filename)
void setCertificatePassword (string $password)
void setSignature (string $signature)
void setSubject (string $subject)
mixed validate ()
Variables
mixed $_authSignature (line 85)
mixed $_authTimestamp (line 95)
mixed $_authToken (line 90)

Inherited Variables

Inherited from Profile

Profile::$_environment
Profile::$_handler
Profile::$_handler_id
Profile::$_validEnvironments
Methods
Constructor APIProfile (line 104)

Constructor

APIProfile APIProfile (string $id,  &$handler, ProfileHandler $handler)
  • string $id: A unique id for the profile.
  • ProfileHandler $handler: A handler object where the profile is stored.
  • &$handler
getAPIPassword (line 172)

Get the API password for the profile.

  • return: The password for the profile.
string getAPIPassword ()
getAPIUsername (line 152)

Returns the API username for the profile.

  • return: The API username.
string getAPIUsername ()
getAuthSignature (line 270)

get the AuthSignature of the associated profile.

Used for permissioning APIs

  • return: The subject associated with the profile.
string getAuthSignature ()
getAuthTimestamp (line 306)

get the Authtimestamp of the associated profile.

Used for permissioning APIs

  • return: The subject associated with the profile.
string getAuthTimestamp ()
getAuthToken (line 288)

get the Authtoken of the associated profile.

Used for permissioning APIs

  • return: The subject associated with the profile.
string getAuthToken ()
getCertificateFile (line 202)

Get the Certificate file associated with the profile.

  • return: The certificate file associated with the profile.
string getCertificateFile ()
getCertificatePassword (line 232)

Get the certificate password.

  • return: The certificate password.
string getCertificatePassword ()
getInstance (line 323)
void getInstance ( $id,  &$handler)
  • $id
  • &$handler

Redefinition of:
Profile::getInstance()
getSignature (line 192)

Get the 3-token signature.

  • return: The password for the profile.
string getSignature ()
getSubject (line 252)

Get the subject of the associated profile.

  • return: The subject associated with the profile.
string getSubject ()
setAPIPassword (line 162)

Sets the API password for the profile.

void setAPIPassword (string $password)
  • string $password: The password for the profile.
setAPIUsername (line 142)

Sets the API username for the profile.

void setAPIUsername (string $username)
  • string $username: The API username.
setAuthSignature (line 261)

set the AuthSignature of the associated profile.

Used for permissioning APIs

  • return: The subject associated with the profile.
string setAuthSignature ( $AuthSignature)
  • $AuthSignature
setAuthTimestamp (line 297)

set the Authtimestamp of the associated profile.

Used for permissioning APIs

  • return: The subject associated with the profile.
string setAuthTimestamp ( $AuthTimestamp)
  • $AuthTimestamp
setAuthToken (line 279)

set the Authtoken of the associated profile.

Used for permissioning APIs

  • return: The subject associated with the profile.
string setAuthToken ( $AuthToken)
  • $AuthToken
setCertificateFile (line 212)

Set the certificate file associated with the profile.

void setCertificateFile (string $filename)
  • string $filename: The certificate file associated with the profile.
setCertificatePassword (line 222)

Set the certificate password.

void setCertificatePassword (string $password)
  • string $password: The certificate password.
setSignature (line 182)

Sets the 3-token signature

void setSignature (string $signature)
  • string $signature: The password for the profile.
setSubject (line 242)

Set the subject associated with the profile.

void setSubject (string $subject)
  • string $subject: The subject of the profile.
validate (line 114)

Validates the profile data currently loaded before use.

  • return: true if the data is valid, or a PayPal_Error object on failure.
mixed validate ()
_getSerializeList (line 317)

Returns an array of member variables names which should be included when storing the profile.

  • return: An array of member variable names which should be included.
  • access: protected
array _getSerializeList ()

Redefinition of:
Profile::_getSerializeList()
Returns an array of member variables names which should be included when storing the profile.

Inherited Methods

Inherited From Profile

Profile::Profile()
Profile::getEnvironment()
Profile::getID()
Profile::getInstance()
Profile::getValidEnvironments()
Profile::loadEnvironments()
Profile::save()
Profile::setEnvironment()
Profile::_getSerializeList()

Documentation generated on Fri, 15 Oct 2010 06:20:55 +0000 by phpDocumentor 1.4.3