Docs For Class APIProfile

## 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

Method Summary
APIProfile APIProfile (string $id, ProfileHandler &$handler)
string getAPIPassword ()
string getAPIUsername ()
string getCertificateFile ()
string getCertificatePassword ()
void getInstance (mixed $id, mixed &$handler)
string getSignature ()
string getSubject ()
void setAPIPassword (string $password)
void setAPIUsername (string $username)
void setCertificateFile (string $filename)
void setCertificatePassword (string $password)
void setSignature (string $signature)
void setSubject (string $subject)
mixed validate ()
array _getSerializeList ()
Variables

#### Inherited Variables

Inherited from Profile

> Profile::$_environment
> Profile::$_handler
> Profile::$_handler_id
> Profile::$_validEnvironments

Methods
Constructor APIProfile (line 88)

Constructor

APIProfile APIProfile (string $id, ProfileHandler &$handler)

- string $id: A unique id for the profile.
- ProfileHandler $handler: A handler object where the profile is stored.

getAPIPassword (line 154)

Get the API password for the profile.

- return: The password for the profile.

string getAPIPassword ()
getAPIUsername (line 134)

Returns the API username for the profile.

- return: The API username.

string getAPIUsername ()
getCertificateFile (line 184)

Get the Certificate file associated with the profile.

- return: The certificate file associated with the profile.

string getCertificateFile ()
getCertificatePassword (line 214)

Get the certificate password.

- return: The certificate password.

string getCertificatePassword ()
getInstance (line 252)
void getInstance (mixed $id, mixed &$handler)

Redefinition of:

Profile::getInstance()

getSignature (line 174)

Get the 3-token signature.

- return: The password for the profile.

string getSignature ()
getSubject (line 234)

Get the subject of the associated profile.

- return: The subject associated with the profile.

string getSubject ()
setAPIPassword (line 144)

Sets the API password for the profile.

void setAPIPassword (string $password)

- string $password: The password for the profile.

setAPIUsername (line 124)

Sets the API username for the profile.

void setAPIUsername (string $username)

- string $username: The API username.

setCertificateFile (line 194)

Set the certificate file associated with the profile.

void setCertificateFile (string $filename)

- string $filename: The certificate file associated with the profile.

setCertificatePassword (line 204)

Set the certificate password.

void setCertificatePassword (string $password)

- string $password: The certificate password.

setSignature (line 164)

Sets the 3-token signature

void setSignature (string $signature)

- string $signature: The password for the profile.

setSubject (line 224)

Set the subject associated with the profile.

void setSubject (string $subject)

- string $subject: The subject of the profile.

validate (line 98)

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 246)

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 Thu, 11 May 2006 22:39:07 -0400 by phpDocumentor 1.3.0RC3