diff options
Diffstat (limited to 'lib/facebook-graph-sdk/README.md')
| -rw-r--r-- | lib/facebook-graph-sdk/README.md | 50 |
1 files changed, 26 insertions, 24 deletions
diff --git a/lib/facebook-graph-sdk/README.md b/lib/facebook-graph-sdk/README.md index 7d60e6e..05506d8 100644 --- a/lib/facebook-graph-sdk/README.md +++ b/lib/facebook-graph-sdk/README.md @@ -1,25 +1,24 @@ -# Facebook SDK for PHP - -[](https://travis-ci.org/facebook/facebook-php-sdk-v4) -[](https://scrutinizer-ci.com/g/facebook/facebook-php-sdk-v4/?branch=master) -[](https://packagist.org/packages/facebook/php-sdk-v4) +# Facebook SDK for PHP (v5) +[](https://travis-ci.org/facebook/php-graph-sdk) +[](https://scrutinizer-ci.com/g/facebook/facebook-php-sdk-v4/?branch=5.x) +[](https://packagist.org/packages/facebook/graph-sdk) This repository contains the open source PHP SDK that allows you to access the Facebook Platform from your PHP app. - ## Installation -The Facebook PHP SDK can be installed with [Composer](https://getcomposer.org/). Add the Facebook PHP SDK package to your `composer.json` file. +The Facebook PHP SDK can be installed with [Composer](https://getcomposer.org/). Run this command: -```json -{ - "require": { - "facebook/php-sdk-v4": "~5.0" - } -} +```sh +composer require facebook/graph-sdk ``` +Please be aware, that there are issues when using the Facebook SDK together with [Guzzle](https://github.com/guzzle/guzzle) 6.x. php-graph-sdk v5.x only works with Guzzle 5.x out of the box. However, [there is a workaround to make it work with Guzzle 6.x](https://www.sammyk.me/how-to-inject-your-own-http-client-in-the-facebook-php-sdk-v5#writing-a-guzzle-6-http-client-implementation-from-scratch). + +## Upgrading to v5.x + +Upgrading from v4.x? Facebook PHP SDK v5.x introduced breaking changes. Please [read the upgrade guide](https://www.sammyk.me/upgrading-the-facebook-php-sdk-from-v4-to-v5) before upgrading. ## Usage @@ -28,10 +27,12 @@ The Facebook PHP SDK can be installed with [Composer](https://getcomposer.org/). Simple GET example of a user's profile. ```php -$fb = new Facebook\Facebook([ +require_once __DIR__ . '/vendor/autoload.php'; // change path as needed + +$fb = new \Facebook\Facebook([ 'app_id' => '{app-id}', 'app_secret' => '{app-secret}', - 'default_graph_version' => 'v2.4', + 'default_graph_version' => 'v2.10', //'default_access_token' => '{access-token}', // optional ]); @@ -42,14 +43,14 @@ $fb = new Facebook\Facebook([ // $helper = $fb->getPageTabHelper(); try { - // Get the Facebook\GraphNodes\GraphUser object for the current user. + // Get the \Facebook\GraphNodes\GraphUser object for the current user. // If you provided a 'default_access_token', the '{access-token}' is optional. $response = $fb->get('/me', '{access-token}'); -} catch(Facebook\Exceptions\FacebookResponseException $e) { +} catch(\Facebook\Exceptions\FacebookResponseException $e) { // When Graph returns an error echo 'Graph returned an error: ' . $e->getMessage(); exit; -} catch(Facebook\Exceptions\FacebookSDKException $e) { +} catch(\Facebook\Exceptions\FacebookSDKException $e) { // When validation fails or other local issues echo 'Facebook SDK returned an error: ' . $e->getMessage(); exit; @@ -59,8 +60,7 @@ $me = $response->getGraphUser(); echo 'Logged in as ' . $me->getName(); ``` -Complete documentation, installation instructions, and examples are available at: [https://developers.facebook.com/docs/php](https://developers.facebook.com/docs/php) - +Complete documentation, installation instructions, and examples are available [here](docs/). ## Tests @@ -78,12 +78,14 @@ By default the tests will send live HTTP requests to the Graph API. If you are w $ ./vendor/bin/phpunit --exclude-group integration ``` - ## Contributing -For us to accept contributions you will have to first have signed the [Contributor License Agreement](https://developers.facebook.com/opensource/cla). Please see [CONTRIBUTING](https://github.com/facebook/facebook-php-sdk-v4/blob/master/CONTRIBUTING.md) for details. - +For us to accept contributions you will have to first have signed the [Contributor License Agreement](https://developers.facebook.com/opensource/cla). Please see [CONTRIBUTING](https://github.com/facebook/php-graph-sdk/blob/master/CONTRIBUTING.md) for details. ## License -Please see the [license file](https://github.com/facebook/facebook-php-sdk-v4/blob/master/LICENSE) for more information. +Please see the [license file](https://github.com/facebook/php-graph-sdk/blob/master/LICENSE) for more information. + +## Security Vulnerabilities + +If you have found a security issue, please contact the maintainers directly at [me@sammyk.me](mailto:me@sammyk.me). |