Inheritance diagram for FacebookApiException:

Collaboration diagram for FacebookApiException:

Public Member Functions
	__construct ($result)
	Make a new API Exception with the given result. More...

	getResult ()
	Return the associated result object returned by the API server. More...

	getType ()
	Returns the associated type for the error. More...

	__toString ()
	To make debugging easier. More...

Protected Attributes
	$result
	The result from the API server that represents the exception information. More...

Detailed Description

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Thrown when an API call returns an exception.

Author: Naitik Shah naiti.nosp@m.k@fa.nosp@m.ceboo.nosp@m.k.co.nosp@m.m

Definition at line 30 of file base_facebook.php.

Constructor & Destructor Documentation

◆ __construct()

FacebookApiException::__construct ( $result )

Make a new API Exception with the given result.

Parameters

array $result The result from the API server

Definition at line 42 of file base_facebook.php.

References $code, and $result.

                                        {
     $this->result = $result;
 
     $code = isset($result['error_code']) ? $result['error_code'] : 0;
 
     if (isset($result['error_description'])) {
       // OAuth 2.0 Draft 10 style
       $msg = $result['error_description'];
     } else if (isset($result['error']) && is_array($result['error'])) {
       // OAuth 2.0 Draft 00 style
       $msg = $result['error']['message'];
     } else if (isset($result['error_msg'])) {
       // Rest server style
       $msg = $result['error_msg'];
     } else {
       $msg = 'Unknown Error. Check getResult()';
     }
 
     parent::__construct($msg, $code);
   }

Member Function Documentation

◆ __toString()

FacebookApiException::__toString ( )

To make debugging easier.

Returns: string The string representation of the error

Definition at line 100 of file base_facebook.php.

References $message, and getType().

                                {
     $str = $this->getType() . ': ';
     if ($this->code != 0) {
       $str .= $this->code . ': ';
     }
     return $str . $this->message;
   }

Here is the call graph for this function:

◆ getResult()

FacebookApiException::getResult ( )

Return the associated result object returned by the API server.

Returns: array The result from the API server

Definition at line 68 of file base_facebook.php.

References $result.

                               {
     return $this->result;
   }

◆ getType()

FacebookApiException::getType ( )

Returns the associated type for the error.

This will default to 'Exception' when a type is not available.

Returns: string

Definition at line 78 of file base_facebook.php.

References $error.

Referenced by __toString().

                             {
     if (isset($this->result['error'])) {
       $error = $this->result['error'];
       if (is_string($error)) {
         // OAuth 2.0 Draft 10 style
         return $error;
       } else if (is_array($error)) {
         // OAuth 2.0 Draft 00 style
         if (isset($error['type'])) {
           return $error['type'];
         }
       }
     }
 
     return 'Exception';
   }

Here is the caller graph for this function:

Field Documentation

◆ $result

FacebookApiException::$result

protected

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

Definition at line 35 of file base_facebook.php.

Referenced by __construct(), BaseFacebook\_graph(), BaseFacebook\_restserver(), getResult(), BaseFacebook\makeRequest(), and BaseFacebook\throwAPIException().

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authfacebook/extlibinc/base_facebook.php

Public Member Functions

Protected Attributes