Docs For Class EWPProfile

## Class EWPProfile

Description

Stores EWP Profile information used for encrypting buttons and PayPal forms.

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

    Profile
       |
       --EWPProfile

Method Summary
EWPProfile EWPProfile (mixed $id, ProfileHandler &$handler)
string getButtonImage ()
string getCertificateFile ()
string getCertificateId ()
object A getInstance (string $id, object A &$handler)
string getPrivateKeyFile ()
string getPrivateKeyPassword ()
string getUrl ()
void setButtonImage (string $url)
void setCertificateFile (string $filename)
void setCertificateId (string $filename)
mixed setPrivateKeyFile (string $filename)
void setPrivateKeyPassword (string $password)
void setUrl (string $url)
mixed validate ()
array _getSerializeList ()
Variables

#### Inherited Variables

Inherited from Profile

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

Methods
Constructor EWPProfile (line 69)

Class constructor

EWPProfile EWPProfile (mixed $id, ProfileHandler &$handler)

- ProfileHandler &$handler: A handler where the profile should be stored.

getButtonImage (line 149)

Returns the URL where the button image is

- return: The URL to the button image

string getButtonImage ()
getCertificateFile (line 125)

Get the merchant certificate file associated with the profile

- return: The certificate file associated with the profile

string getCertificateFile ()
getCertificateId (line 105)

Get the merchant certificate id associated with the profile

- return: The certificate id associated with the profile

string getCertificateId ()
getInstance (line 251)

Factory for creating instances of the EWPProfile. Used when providing an existing Profile ID to load from

- return: new instance of EWPProfile for the given ID or a PayPal error object on failure

object A getInstance (string $id, object A &$handler)

- string $id: The Profile ID of this instance
- object A &$handler: valid Profile Handler instance

Redefinition of:

Profile::getInstance()

getPrivateKeyFile (line 206)

Get the merchant private key file associated with the profile

- return: The merchant private key file associated with the profile

string getPrivateKeyFile ()
getPrivateKeyPassword (line 226)

Get the merchant private key password

- return: The private key password.

string getPrivateKeyPassword ()
getUrl (line 169)

Returns the URL where the button will post to

- return: The URL where the button will post to

string getUrl ()
setButtonImage (line 159)

Set the URL where the button image is

void setButtonImage (string $url)

- string $url: The URL to the button image

setCertificateFile (line 135)

Set the merchant certificate file associated with the profile

void setCertificateFile (string $filename)

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

setCertificateId (line 115)

Set the merchant certificate id associated with the profile

void setCertificateId (string $filename)

- string $filename: The certificate id associated with the profile

setPrivateKeyFile (line 190)

Set the Merchant private key file

- return: True on success, a PayPal error object on faliure

mixed setPrivateKeyFile (string $filename)

- string $filename: The Merchant Private Key File

setPrivateKeyPassword (line 216)

Set the merchant private key password

void setPrivateKeyPassword (string $password)

- string $password: The private key password

setUrl (line 179)

Sets the URL where the button will post to

void setUrl (string $url)

- string $url: The URL where the button should post to

validate (line 79)

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

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:13 -0400 by phpDocumentor 1.3.0RC3