OAuth2Exception Class Reference

List of all members.

Public Member Functions
	__construct ($result)
	getResult ()
	getType ()
	__toString ()
Protected Attributes
	$result

---

Detailed Description

OAuth2.0 draft v10 exception handling.

Author:

Originally written by Naitik Shah <naitik@facebook.com>.

Update to draft v10 by Edison Wong <hswong3i@pantarei-design.com>.

See also:

Facebook PHP SDK.

Definition at line 11 of file OAuth2Exception.inc.

---

Constructor & Destructor Documentation

__construct

(

$

result

)

Make a new API Exception with the given result.

Parameters:

$result

The result from the API server.

Definition at line 24 of file OAuth2Exception.inc.

References $result.

---

Member Function Documentation

__toString

(

)

To make debugging easier.

Returns:

The string representation of the error.

Definition at line 78 of file OAuth2Exception.inc.

References getType().

getResult

(

)

Return the associated result object returned by the API server.

Returns:

The result from the API server.

Definition at line 50 of file OAuth2Exception.inc.

getType

(

)

Returns the associated type for the error. This will default to 'Exception' when a type is not available.

Returns:

The type for the error.

Definition at line 61 of file OAuth2Exception.inc.

Referenced by __toString().

---

Member Data Documentation

$result [protected]

The result from the API server that represents the exception information.

Definition at line 16 of file OAuth2Exception.inc.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• lib/OAuth2Exception.inc