diff options
Diffstat (limited to 'lib/facebook-graph-sdk/README.md')
| -rw-r--r-- | lib/facebook-graph-sdk/README.md | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/lib/facebook-graph-sdk/README.md b/lib/facebook-graph-sdk/README.md new file mode 100644 index 0000000..7d60e6e --- /dev/null +++ b/lib/facebook-graph-sdk/README.md @@ -0,0 +1,89 @@ +# 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) + + +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. + +```json +{ + "require": { + "facebook/php-sdk-v4": "~5.0" + } +} +``` + + +## Usage + +> **Note:** This version of the Facebook SDK for PHP requires PHP 5.4 or greater. + +Simple GET example of a user's profile. + +```php +$fb = new Facebook\Facebook([ + 'app_id' => '{app-id}', + 'app_secret' => '{app-secret}', + 'default_graph_version' => 'v2.4', + //'default_access_token' => '{access-token}', // optional +]); + +// Use one of the helper classes to get a Facebook\Authentication\AccessToken entity. +// $helper = $fb->getRedirectLoginHelper(); +// $helper = $fb->getJavaScriptHelper(); +// $helper = $fb->getCanvasHelper(); +// $helper = $fb->getPageTabHelper(); + +try { + // 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) { + // When Graph returns an error + echo 'Graph returned an error: ' . $e->getMessage(); + exit; +} catch(Facebook\Exceptions\FacebookSDKException $e) { + // When validation fails or other local issues + echo 'Facebook SDK returned an error: ' . $e->getMessage(); + exit; +} + +$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) + + +## Tests + +1. [Composer](https://getcomposer.org/) is a prerequisite for running the tests. Install composer globally, then run `composer install` to install required files. +2. Create a test app on [Facebook Developers](https://developers.facebook.com), then create `tests/FacebookTestCredentials.php` from `tests/FacebookTestCredentials.php.dist` and edit it to add your credentials. +3. The tests can be executed by running this command from the root directory: + +```bash +$ ./vendor/bin/phpunit +``` + +By default the tests will send live HTTP requests to the Graph API. If you are without an internet connection you can skip these tests by excluding the `integration` group. + +```bash +$ ./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. + + +## License + +Please see the [license file](https://github.com/facebook/facebook-php-sdk-v4/blob/master/LICENSE) for more information. |