Class Profile

Description

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

  • abstract:

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


	
			
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
Method Summary
Profile Profile (string $id, object An &$handler)
string getEnvironment ()
void getID ()
void getInstance ( $id,  &$handler)
mixed loadEnvironments ()
mixed save ()
void setEnvironment (string $environment)
Variables
mixed $_environment (line 28)

Which environment should API calls be made against?

mixed $_handler (line 43)

The ProfileHandler instance associated with this Profile.

  • access: protected
mixed $_handler_id (line 50)

The ProfileHandler ID.

  • access: protected
mixed $_validEnvironments = array() (line 36)

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

  • access: protected
Methods
Constructor Profile (line 59)

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

Get the environment associated with the profile.

  • return: The environment associated with the profile.
string getEnvironment ()
getID (line 105)
void getID ()
getInstance (line 110)
void getInstance ( $id,  &$handler)
  • $id
  • &$handler

Redefined in descendants as:
getValidEnvironments (line 213)

Returns an array of valid Environments

  • return: An array of valid environment names
array getValidEnvironments ()
loadEnvironments (line 120)

Loads the environment names from the endpoint map.

  • return: True on success or a PayPal error object on failure
mixed loadEnvironments ()
save (line 147)

Saves the profile data to the defined handler.

  • return: true on success or a PayPal_Error object on failure
  • final:
mixed save ()
setEnvironment (line 181)

Set the environment associated with this profile.

void setEnvironment (string $environment)
  • string $environment: True on success, a Paypal error object on failure
_getSerializeList (line 171)

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:

Documentation generated on Fri, 15 Oct 2010 06:21:13 +0000 by phpDocumentor 1.4.3