Merge pull request #912 from carusogabriel/docs

Clean up documentation files

Author: yguedidi

CHANGELOG.md

@@ -2,7 +2,6 @@
 
 Starting with version 5, the Facebook PHP SDK follows [SemVer](http://semver.org/).
 
-
 ## 5.x
 
 Version 5 of the Facebook PHP SDK is a complete refactor of version 4. It comes loaded with lots of new features and a friendlier API.
@@ -87,12 +86,10 @@ Version 5 of the Facebook PHP SDK is a complete refactor of version 4. It comes
     - Added `ext-mbstring` to composer require
     - Added this CHANGELOG. Hi! :)
 
-
 ## 4.1-dev
 
 Since the Facebook PHP SDK didn't follow SemVer in version 4.x, the master branch was going to be released as 4.1. However, the SDK switched to SemVer in v5.0. So any references on the internet to version 4.1 can be assumed to be an alias to version `5.0.0`
 
-
 ## 4.0.x
 
 Version 4.0 of the Facebook PHP SDK did not follow [SemVer](http://semver.org/). The versioning format used was as follows: `4.MAJOR.(MINOR|PATCH)`. The `MINOR` and `PATCH` versions were squashed together.

CONTRIBUTING.md

@@ -14,7 +14,6 @@ The v5 (`5.x` branch) is maintained only for bug fixes, node/edge updates or doc
 ## Code of Conduct
 The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 
-
 ## Pull Requests
 
 - **Sign the CLA** - For us to accept contributions you will have to first have signed the
@@ -38,14 +37,12 @@ The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
 
 - **Ensure no coding standards violations** - Please [run PHP Code Sniffer](#running-php-code-sniffer) using the PSR-2 standard before submitting your pull request. A violation will cause the build to fail, so please make sure there are no violations. We can't accept a patch if the build fails.
 
-
 ## Running Tests
 
 ``` bash
 $ ./vendor/bin/phpunit
 ```
 
-
 ## Running PHP Code Sniffer
 
 You can install [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) globally with composer.

README.md

@@ -4,10 +4,8 @@
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/facebook/facebook-php-sdk-v4/badges/quality-score.png?b=5.x)](https://scrutinizer-ci.com/g/facebook/facebook-php-sdk-v4/?branch=5.x)
 [![Latest Stable Version](http://img.shields.io/badge/Latest%20Stable-5.6.2-blue.svg)](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/). Run this command:
@@ -16,13 +14,12 @@ The Facebook PHP SDK can be installed with [Composer](https://getcomposer.org/).
 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). 
+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
 
 > **Note:** This version of the Facebook SDK for PHP requires PHP 5.4 or greater.
@@ -65,7 +62,6 @@ echo 'Logged in as ' . $me->getName();
 
 Complete documentation, installation instructions, and examples are available [here](docs/).
 
-
 ## Tests
 
 1. [Composer](https://getcomposer.org/) is a prerequisite for running the tests. Install composer globally, then run `composer install` to install required files.
@@ -82,17 +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/php-graph-sdk/blob/master/CONTRIBUTING.md) for details.
 
-
 ## License
 
 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).

docs/getting_started.md

@@ -27,7 +27,6 @@ composer require facebook/graph-sdk
 
 > The Facebook SDK starting adhering to [SemVer](http://semver.org/) with version 5. Previous to version 5, the SDK did not follow SemVer.
 
-
 Once you do this, composer will edit your `composer.json` file and download the latest version of the SDK and put it in the `/vendor/` directory.
 
 Make sure to include the Composer autoloader at the top of your script.
@@ -50,7 +49,6 @@ require_once __DIR__ . '/path/to/php-graph-sdk/src/Facebook/autoload.php';
 
 The autoloader should be able to auto-detect the proper location of the source code.
 
-
 ### Keeping things tidy
 
 The source code includes myriad files that aren't necessary for use in a production environment. If you'd like to strip out everything except the core files, follow this example.
@@ -102,7 +100,6 @@ The SDK can be used to support logging a Facebook user into your site using Face
 
 Most all request made to the Graph API require an access token. We can obtain user access tokens with the SDK using the [helper classes](reference.md).
 
-
 ### Obtaining an access token from redirect
 
 For most websites, you'll use the [`Facebook\Helpers\FacebookRedirectLoginHelper`](reference/FacebookRedirectLoginHelper.md) to generate a login URL with the `getLoginUrl()` method. The link will take the user to an app authorization screen and upon approval, will redirect them back to a URL that you specified. On the redirect callback page we can obtain the user access token as an [`AccessToken`](reference/AccessToken.md) entity.
@@ -148,7 +145,6 @@ if (isset($accessToken)) {
 }
 ```
 
-
 ### Obtaining an access token from a Facebook Canvas context
 
 If your app is on Facebook Canvas, use the `getAccessToken()` method on [`Facebook\Helpers\FacebookCanvasHelper`](reference/FacebookCanvasHelper.md) to get an [`AccessToken`](reference/AccessToken.md) entity for the user.
@@ -179,7 +175,6 @@ if (isset($accessToken)) {
 
 > If your app exists within the context of a Page tab, you can obtain an access token using the example above since a Page tab is very similar to a Facebook Canvas app. But if you'd like to use a Page-tab-specific helper, you can use the [`Facebook\Helpers\FacebookPageTabHelper`](reference/FacebookPageTabHelper.md)
 
-
 ### Obtaining an access token from the SDK for JavaScript
 
 If you're already using the Facebook SDK for JavaScript to authenticate users, you can obtain the access token with PHP by using the [FacebookJavaScriptHelper](reference/FacebookJavaScriptHelper.md). The `getAccessToken()` method will return an [`AccessToken`](reference/AccessToken.md) entity.

docs/reference.md

@@ -34,7 +34,6 @@ These classes are used in a Graph API request/response cycle.
 | [`Facebook\FacebookBatchResponse`](reference/FacebookBatchResponse.md)  | An entity that represents an HTTP response from Graph after sending a batch request.  |
 | [`Facebook\FacebookClient`](reference/FacebookClient.md)  | A service object that sends HTTP requests and receives HTTP responses to and from the Graph API.  |
 
-
 # Signed Requests
 
 Classes to help obtain and manage signed requests.
@@ -55,7 +54,6 @@ These are the core exceptions that the SDK will throw when an error occurs.
 | [`Facebook\Exceptions\FacebookSDKException`](reference/FacebookSDKException.md) | The base exception to all exceptions thrown by the SDK. Thrown when there is a non-Graph-response-related error.  |
 | [`Facebook\Exceptions\FacebookResponseException`](reference/FacebookResponseException.md)  | The base exception to all Graph error responses. This exception is never thrown directly.  |
 
-
 # Graph Nodes and Edges
 
 Graph nodes are collections that represent nodes returned by the Graph API. And Graph edges are a collection of nodes returned from an edge on the Graph API.
@@ -71,7 +69,6 @@ Graph nodes are collections that represent nodes returned by the Graph API. And
 | [`Facebook\GraphNodes\GraphPicture`](reference/GraphNode.md#graphpicture-instance-methods)  | A collection that represents a Picture node. |
 | [`Facebook\GraphNodes\GraphUser`](reference/GraphNode.md#graphuser-instance-methods)  | A collection that represents a User node. |
 
-
 # File Uploads
 
 These are entities that represent files to be uploaded with a Graph request.

docs/reference/FacebookRedirectLoginHelper.md

@@ -6,7 +6,6 @@ The most commonly used helper is the `FacebookRedirectLoginHelper` which allows
 
 Facebook Login is achieved via OAuth 2.0. But you don't really have to know much about OAuth 2.0 since the SDK for PHP does all the heavy lifting for you.
 
-
 ### Obtaining an instance of FacebookRedirectLoginHelper
 
 You can obtain an instance of the `FacebookRedirectLoginHelper` from the `getRedirectLoginHelper()` method on the `Facebook\Facebook` service.
@@ -116,19 +115,16 @@ If no authorization code could be found from the `code` param in the URL, this m
 
 The `FacebookRedirectLoginHelper` has to orchestrate a number of components from the hosting environment to make the OAuth 2.0 authorization process as easy as possible to integrate. Out of the box it auto-detects all the things it needs, but sometimes you'll want to control these components.
 
-
 ### Sessions (persistent data)
 
 In order to prevent [CSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery)'s, a unique value is generated with each login link and stored in a session.
 
 Most modern web frameworks have custom session handlers that allow you to manage your sessions with something other than the default flat-file storage. You can integrate your framework's custom session handling by coding to the [`PersistentDataInterface`](PersistentDataInterface.md).
 
-
 ### CSPRNG
 
 The CSRF value that the `getLoginUrl()`, `getReRequestUrl()`, and `getReAuthenticationUrl()` methods generate are all _cryptographically secure_ random strings. PHP's native support of CSPRNG's is spotty at best. The PHP SDK goes to great lengths to to detect a suitable CSPRNG but in rare cases, it might not find a suitable one. The [`PseudoRandomStringGeneratorInterface`](PseudoRandomStringGeneratorInterface.md) allows you to inject your own custom CSPRNG.
 
-
 ### URL detection
 
 In order to not make you pass the callback URL to the `getAccessToken()` method, the SDK will do its best to detect the callback's URL for you. Most modern web frameworks have URL detection built-in. You can code your specific web framework's URL detection logic by coding to the [`UrlDetectionInterface`](UrlDetectionInterface.md).

docs/reference/FacebookRequest.md

@@ -9,7 +9,7 @@ You can instantiate a new `FacebookRequest` entity directly by sending the argum
 ```php
 use Facebook\FacebookRequest;
 
-$request = new FacebookRequest(  
+$request = new FacebookRequest(
   Facebook\FacebookApp $app,
   string $accessToken,
   string $method,

docs/reference/FacebookResponseException.md

@@ -33,23 +33,23 @@ These exceptions are derived from the [error responses from the Graph API](https
 `FacebookResponseException` extends from the base `\Exception` class, so `getCode()` and `getMessage()` are available by default.
 
 ### getHttpStatusCode
-`getHttpStatusCode()`  
+`getHttpStatusCode()`
 Returns the HTTP status code returned with this exception.
 
 ### getSubErrorCode
-`getSubErrorCode()`  
+`getSubErrorCode()`
 Returns the numeric sub-error code returned from the Graph API.
 
 ### getErrorType
-`getErrorType()`  
+`getErrorType()`
 Returns the type of error as a string.
 
 ### getResponseData
 `getResponseData()`
 Returns the decoded response body used to create the exception as an array.
 
 ### getRawResponse
-`getRawResponse()`  
+`getRawResponse()`
 Returns the raw response body used to create the exception as a string.
 
 ### getResponse

docs/reference/GraphNode.md

@@ -63,29 +63,24 @@ $total = count($graphNode);
 
 ## GraphNode Instance Methods
 
-
 ### asArray
-`asArray()`  
+`asArray()`
 Returns the raw representation (associative arrays, nested) of the node's underlying data.
 
-
 ### asJson
 `asJson()`
 Returns the data as a JSON string.
 
-
 ### getField
 `getField(string $name, string $default = 'foo')`
 Gets the value from the field of a Graph node.  If the value is a scalar (string, number, etc.) it will be returned.  If it's an associative array, it will be returned as a GraphNode.
 
 The second argument lets you define a default value to return if the field doesn't exist.
 
-
 ### getFieldNames
 `getFieldNames()`
 Returns an array with the names of all fields present on the graph node.
 
-
 ### map
 `map(Closure $callback)`
 Provides a way to map over the data within the collection just like `array_map()`.
@@ -180,7 +175,6 @@ The following properties on the `GraphPage` collection will get automatically ca
 | `global_brand_parent_page`  | [`Facebook\GraphNodes\GraphPage`](graph#page-instance-methods) |
 | `location`  | [`Facebook\GraphNodes\GraphLocation`](#graphlocation-instance-methods)  |
 
-
 All getter methods return `null` if the property does not exist on the node.
 
 ### getId()
@@ -394,7 +388,6 @@ Returns the `id` property for the achievement as a string if present.
 
 All getter methods return `null` if the property does not exist on the node.
 
-
 ### getId()
 ```php
 public string|null getId()