Payment_PayPal_SOAP
[ class tree: Payment_PayPal_SOAP ] [ index: Payment_PayPal_SOAP ] [ all elements ]

Class: Payment_PayPal_SOAP_Error

Source Location: /Payment_PayPal_SOAP-0.5.1/Payment/PayPal/SOAP/Error.php

Class Overview


Error raised by the PayPal SOAP API


Author(s):

Copyright:

  • 2012 silverorange

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 57]
Error raised by the PayPal SOAP API

Errors are aggregated by the Payment_PayPal_SOAP_ErrorException exception class.



[ Top ]


Class Variables

$code =  0

[line 92]

Error code as specified in the PayPal API error codes

Type:   integer


[ Top ]

$message =  ''

[line 82]

Error message

Type:   string


[ Top ]

$severity =  Payment_PayPal_SOAP::ERROR_UNKNOWN

[line 108]

Error severity

One of:


Type:   integer


[ Top ]

$type =  Payment_PayPal_SOAP_Error::TYPE_DEFAULT

[line 123]

Error type

One of:


Type:   integer


[ Top ]



Method Detail

__construct (Constructor)   [line 136]

Payment_PayPal_SOAP_Error __construct( string $message, integer $code, integer $severity, integer $type)

Creates a new error object
  • Access: public

Parameters:

string   $message     the message of this error.
integer   $code     the code of this error.
integer   $severity     the severity of this error.
integer   $type     the type of this error.

[ Top ]

getCode   [line 242]

integer getCode( )

Gets the code of this error
  • Return: the code of this error.
  • Access: public

[ Top ]

getMessage   [line 229]

string getMessage( )

Gets the message of this error
  • Return: the message of this error.
  • Access: public

[ Top ]

getSeverity   [line 255]

integer getSeverity( )

Gets the severity of this error
  • Return: the severity of this error.
  • Access: public

[ Top ]

getType   [line 268]

integer getType( )

Gets the type of this error
  • Return: the type of this error.
  • Access: public

[ Top ]

setCode   [line 172]

Payment_PayPal_SOAP_Error setCode( integer $code)

Sets the code of this error

Should be a valid API error code as specified in the PayPal SOAP API.

  • Return: this object, for fluent interface.
  • Access: public

Parameters:

integer   $code     the code of this error.

[ Top ]

setMessage   [line 154]

Payment_PayPal_SOAP_Error setMessage( string $message)

Sets the message of this error
  • Return: this object, for fluent interface.
  • Access: public

Parameters:

string   $message     the message of this error.

[ Top ]

setSeverity   [line 194]

Payment_PayPal_SOAP_Error setSeverity( integer $severity)

Sets the severity of this error

Valid severities are:

  • Return: this object, for fluent interface.
  • Access: public

Parameters:

integer   $severity     the severity of this error.

[ Top ]

setType   [line 215]

Payment_PayPal_SOAP_Error setType( integer $type)

Sets the type of this error

Valid types are:

  • Return: this object, for fluent interface.
  • Access: public

Parameters:

integer   $type     the type of this error.

[ Top ]


Documentation generated on Tue, 25 Sep 2012 14:30:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.