Docs For Class FacebookApiException

Class FacebookApiException

Description

Thrown when an API call returns an exception.

author: Naitik Shah <naitik@facebook.com>

Located in /vendors/facebook/src/facebook.php (line 15)

Exception
   |
   --FacebookApiException

Variable Summary

mixed $result

Method Summary

FacebookApiException __construct (Array $result)

Array getResult ()

String getType ()

String __toString ()

Variables

mixed $result (line 20)

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

access: protected

Inherited Variables

Inherited from Exception (Internal Class)

$code
$file
$line
$message
$string
$trace

Methods

Constructor __construct (line 27)

Make a new API Exception with the given result.

access: public

FacebookApiException __construct (Array $result)

Array $result: the result from the API server

Redefinition of:

Exception::constructor __construct ( [$message = ], [$code = ] )

getResult (line 53)

Return the associated result object returned by the API server.

return: the result from the API server
access: public

Array getResult ()

getType (line 63)

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

access: public

String getType ()

__toString (line 84)

To make debugging easier.

return: the string representation of the error
access: public

String __toString ()

Redefinition of:

Exception::__toString ( )

Inherited Methods

Inherited From Exception (Internal Class)

constructor __construct ( [$message = ], [$code = ] )
constructor __construct ( [$message = ], [$code = ] )
getCode ( )
getCode ( )
getFile ( )
getFile ( )
getLine ( )
getLine ( )
getMessage ( )
getMessage ( )
getTrace ( )
getTrace ( )
getTraceAsString ( )
getTraceAsString ( )
__clone ( )
__clone ( )
__toString ( )
__toString ( )

Documentation generated on Mon, 29 Nov 2010 23:20:59 -0500 by phpDocumentor 1.4.3