Docs For Class Profile

## Class Profile

Description

Base class for PayPal Profiles, managaes interaction with handlers, etc.

- abstract:

Located in /PayPal/Profile.php (line 20)

Direct descendents

Class | Description
--- | ---
APIProfile | Stores API Profile information used for performing transactions on the PayPal API
EWPProfile | Stores EWP Profile information used for encrypting buttons and PayPal forms.

Variable Summary
mixed $_environment
mixed $_handler
mixed $_handler_id
mixed $_validEnvironments
Method Summary
Profile Profile (string $id, object An &$handler)
string getEnvironment ()
void getID ()
void getInstance (mixed $id, mixed &$handler)
array getValidEnvironments ()
mixed loadEnvironments ()
mixed save ()
void setEnvironment (string $environment)
array _getSerializeList ()
Variables
mixed $_environment (line 29)

Which environment should API calls be made against?

- access: protected
- see: Profile::$_validEnvironments

mixed $_handler (line 44)

The ProfileHandler instance associated with this Profile.

- access: protected

mixed $_handler_id (line 51)

The ProfileHandler ID.

- access: protected

mixed $_validEnvironments = array() (line 37)

The list of valid environments that API calls can be executed against.

- access: protected

Methods
Constructor Profile (line 60)

Base constructor which creates a default handler if none was provided.

Profile Profile (string $id, object An &$handler)

- string $id: The name of the profile
- object An &$handler: optional handler to store the profile in

getEnvironment (line 204)

Get the environment associated with the profile.

- return: The environment associated with the profile.

string getEnvironment ()
getID (line 106)
void getID ()
getInstance (line 111)
void getInstance (mixed $id, mixed &$handler)

Redefined in descendants as:

- APIProfile::getInstance()
- EWPProfile::getInstance() : Factory for creating instances of the EWPProfile. Used when providing an existing Profile ID to load from

getValidEnvironments (line 214)

Returns an array of valid Environments

- return: An array of valid environment names

array getValidEnvironments ()
loadEnvironments (line 121)

Loads the environment names from the endpoint map.

- return: True on success or a PayPal error object on failure

mixed loadEnvironments ()
save (line 148)

Saves the profile data to the defined handler.

- return: true on success or a PayPal_Error object on failure
- final:

mixed save ()
setEnvironment (line 182)

Set the environment associated with this profile.

void setEnvironment (string $environment)

- string $environment: True on success, a Paypal error object on failure

_getSerializeList (line 172)

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

Redefined in descendants as:

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

Documentation generated on Thu, 11 May 2006 22:39:19 -0400 by phpDocumentor 1.3.0RC3