Skip to content

Commit e4270f4

Browse files
nayafiaSammyK
nayafia
authored and
SammyK
committed
first round of changes from review
1 parent 97ed3ee commit e4270f4

File tree

7 files changed

+52
-53
lines changed

7 files changed

+52
-53
lines changed

‎docs/examples/access_token_from_javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This example covers obtaining an access token and signed request from the Facebo
66

77
In order to have the JavaScript SDK set a cookie containing a signed request (which contains information about the logged in user), you must first initialize the JavaScript SDK with the `{cookie: true}` option.
88

9-
```
9+
```html
1010
<html>
1111
<body>
1212

‎docs/examples/upload_video.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ try {
3636
echo 'Video ID: ' . $response['video_id'];
3737
```
3838

39-
See more about the [`uploadVideo()` method](..reference/Facebook.md#uploadvideo).
39+
See more about the [`uploadVideo()` method](../reference/Facebook.md#uploadvideo).
4040

4141
For versions of Graph before v2.3, videos had to be uploaded in one request.
4242

‎docs/getting_started.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,12 @@ There are two methods to install the Facebook SDK for PHP. The recommended insta
2222

2323
[Composer](https://getcomposer.org/) is the recommended way to install the Facebook SDK for PHP. Simply run the following in the root of your project.
2424

25-
```php
25+
```
2626
composer require facebook/php-sdk-v4
27+
```
2728

28-
> content: "The Facebook SDK starting adhering to [SemVer](http://semver.org/) with version 5. Previous to version 5, the SDK did not follow SemVer.",
29-
> type: 'info',
29+
> The Facebook SDK starting adhering to [SemVer](http://semver.org/) with version 5. Previous to version 5, the SDK did not follow SemVer.
3030
31-
```
3231

3332
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.
3433

‎docs/reference.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ These classes are at the core of the Facebook SDK for PHP.
88

99
| Class name | Description |
1010
| ------------- | ------------- |
11-
| [`Facebook\\Facebook`](reference/Facebook.md) | The main service object that helps tie all the SDK components together. |
12-
| [`Facebook\\FacebookApp`](reference/FacebookApp.md) | An entity that represents a Facebook app and is required to send requests to Graph. |
11+
| [`Facebook\Facebook`](reference/Facebook.md) | The main service object that helps tie all the SDK components together. |
12+
| [`Facebook\FacebookApp`](reference/FacebookApp.md) | An entity that represents a Facebook app and is required to send requests to Graph. |
1313

1414
# Authentication
1515

1616
These classes facilitate authenticating a Facebook user with OAuth 2.0.
1717

1818
| Class name | Description |
1919
| ------------- | ------------- |
20-
| [`Facebook\\Helpers\\FacebookRedirectLoginHelper`](reference/FacebookRedirectLoginHelper.md) | An OAuth 2.0 service to obtain a user access token from a redirect using a "Log in with Facebook" link. |
21-
| [`Facebook\\Authentication\\AccessToken`](reference/AccessToken.md) | An entity that represents an access token. |
22-
| `Facebook\\Authentication\\AccessTokenMetadata` | An entity that represents metadata from an access token. |
23-
| `Facebook\\Authentication\\OAuth2Client` | An OAuth 2.0 client that sends and receives HTTP requests related to user authentication. |
20+
| [`Facebook\Helpers\FacebookRedirectLoginHelper`](reference/FacebookRedirectLoginHelper.md) | An OAuth 2.0 service to obtain a user access token from a redirect using a "Log in with Facebook" link. |
21+
| [`Facebook\Authentication\AccessToken`](reference/AccessToken.md) | An entity that represents an access token. |
22+
| `Facebook\Authentication\AccessTokenMetadata` | An entity that represents metadata from an access token. |
23+
| `Facebook\Authentication\OAuth2Client` | An OAuth 2.0 client that sends and receives HTTP requests related to user authentication. |
2424

2525
# Requests and Responses
2626

2727
These classes are used in a Graph API request/response cycle.
2828

2929
| Class name | Description |
3030
| ------------- | ------------- |
31-
| [`Facebook\\FacebookRequest`](reference/FacebookRequest.md) | An entity that represents an HTTP request to be sent to Graph. |
32-
| [`Facebook\\FacebookResponse`](reference/FacebookResponse.md) | An entity that represents an HTTP response from Graph. |
33-
| [`Facebook\\FacebookBatchRequest`](reference/FacebookBatchRequest.md) | An entity that represents an HTTP batch request to be sent to Graph. |
34-
| [`Facebook\\FacebookBatchResponse`](reference/FacebookBatchResponse.md) | An entity that represents an HTTP response from Graph after sending a batch request. |
35-
| [`Facebook\\FacebookClient`](reference/FacebookClient.md) | A service object that sends HTTP requests and receives HTTP responses to and from the Graph API. |
31+
| [`Facebook\FacebookRequest`](reference/FacebookRequest.md) | An entity that represents an HTTP request to be sent to Graph. |
32+
| [`Facebook\FacebookResponse`](reference/FacebookResponse.md) | An entity that represents an HTTP response from Graph. |
33+
| [`Facebook\FacebookBatchRequest`](reference/FacebookBatchRequest.md) | An entity that represents an HTTP batch request to be sent to Graph. |
34+
| [`Facebook\FacebookBatchResponse`](reference/FacebookBatchResponse.md) | An entity that represents an HTTP response from Graph after sending a batch request. |
35+
| [`Facebook\FacebookClient`](reference/FacebookClient.md) | A service object that sends HTTP requests and receives HTTP responses to and from the Graph API. |
3636

3737

3838
# Signed Requests
@@ -41,19 +41,19 @@ Classes to help obtain and manage signed requests.
4141

4242
| Class name | Description |
4343
| ------------- | ------------- |
44-
| [`Facebook\\Helpers\\FacebookJavaScriptHelper`](reference/FacebookJavaScriptHelper.md) | Used to obtain an access token or signed request from the cookie set by the JavaScript SDK. |
45-
| [`Facebook\\Helpers\\FacebookCanvasHelper`](reference/FacebookCanvasHelper.md) | Used to obtain an access token or signed request from within the context of an app canvas. |
46-
| [`Facebook\\Helpers\\FacebookPageTabHelper`](reference/FacebookPageTabHelper.md) | Used to obtain an access token or signed request from within the context of a page tab. |
47-
| [`Facebook\\SignedRequest`](reference/SignedRequest.md) | An entity that represents a signed request. |
44+
| [`Facebook\Helpers\FacebookJavaScriptHelper`](reference/FacebookJavaScriptHelper.md) | Used to obtain an access token or signed request from the cookie set by the JavaScript SDK. |
45+
| [`Facebook\Helpers\FacebookCanvasHelper`](reference/FacebookCanvasHelper.md) | Used to obtain an access token or signed request from within the context of an app canvas. |
46+
| [`Facebook\Helpers\FacebookPageTabHelper`](reference/FacebookPageTabHelper.md) | Used to obtain an access token or signed request from within the context of a page tab. |
47+
| [`Facebook\SignedRequest`](reference/SignedRequest.md) | An entity that represents a signed request. |
4848

4949
# Core Exceptions
5050

5151
These are the core exceptions that the SDK will throw when an error occurs.
5252

5353
| Class name | Description |
5454
| ------------- | ------------- |
55-
| [`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. |
56-
| [`Facebook\\Exceptions\\FacebookResponseException`](reference/FacebookResponseException.md) | The base exception to all Graph error responses. This exception is never thrown directly. |
55+
| [`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. |
56+
| [`Facebook\Exceptions\FacebookResponseException`](reference/FacebookResponseException.md) | The base exception to all Graph error responses. This exception is never thrown directly. |
5757

5858

5959
# Graph Nodes and Edges
@@ -62,14 +62,14 @@ Graph nodes are collections that represent nodes returned by the Graph API. And
6262

6363
| Class name | Description |
6464
| ------------- | ------------- |
65-
| [`Facebook\\GraphNodes\\GraphNode`](reference/GraphNode.md) | The base collection object that represents a generic node. |
66-
| [`Facebook\\GraphNodes\\GraphEdge`](reference/GraphEdge.md) | A collection of GraphNode\'s with special methods to help paginate over the edge. |
67-
| [`Facebook\\GraphNodes\\GraphAchievement`](reference/GraphNode.md#graphachievement-instance-methods) | A collection that represents an Achievement node. |
68-
| [`Facebook\\GraphNodes\\GraphAlbum`](reference/GraphNode.md#graphalbum-instance-methods) | A collection that represents an Album node. |
69-
| [`Facebook\\GraphNodes\\GraphLocation`](reference/GraphNode.md#graphlocation-instance-methods) | A collection that represents a Location node. |
70-
| [`Facebook\\GraphNodes\\GraphPage`](reference/GraphNode.md#graphpage-instance-methods) | A collection that represents a Page node. |
71-
| [`Facebook\\GraphNodes\\GraphPicture`](reference/GraphNode.md#graphpicture-instance-methods) | A collection that represents a Picture node. |
72-
| [`Facebook\\GraphNodes\\GraphUser`](reference/GraphNode.md#graphuser-instance-methods) | A collection that represents a User node. |
65+
| [`Facebook\GraphNodes\GraphNode`](reference/GraphNode.md) | The base collection object that represents a generic node. |
66+
| [`Facebook\GraphNodes\GraphEdge`](reference/GraphEdge.md) | A collection of GraphNode\'s with special methods to help paginate over the edge. |
67+
| [`Facebook\GraphNodes\GraphAchievement`](reference/GraphNode.md#graphachievement-instance-methods) | A collection that represents an Achievement node. |
68+
| [`Facebook\GraphNodes\GraphAlbum`](reference/GraphNode.md#graphalbum-instance-methods) | A collection that represents an Album node. |
69+
| [`Facebook\GraphNodes\GraphLocation`](reference/GraphNode.md#graphlocation-instance-methods) | A collection that represents a Location node. |
70+
| [`Facebook\GraphNodes\GraphPage`](reference/GraphNode.md#graphpage-instance-methods) | A collection that represents a Page node. |
71+
| [`Facebook\GraphNodes\GraphPicture`](reference/GraphNode.md#graphpicture-instance-methods) | A collection that represents a Picture node. |
72+
| [`Facebook\GraphNodes\GraphUser`](reference/GraphNode.md#graphuser-instance-methods) | A collection that represents a User node. |
7373

7474

7575
# File Uploads
@@ -78,17 +78,17 @@ These are entities that represent files to be uploaded with a Graph request.
7878

7979
| Class name | Description |
8080
| ------------- | ------------- |
81-
| [`Facebook\\FileUpload\\FacebookFile`](reference/FacebookFile.md) | Represents a generic file to be uploaded to the Graph API. |
82-
| [`Facebook\\FileUpload\\FacebookVideo`](reference/FacebookVideo.md) | Represents a video file to be uploaded to the Graph API. |
81+
| [`Facebook\FileUpload\FacebookFile`](reference/FacebookFile.md) | Represents a generic file to be uploaded to the Graph API. |
82+
| [`Facebook\FileUpload\FacebookVideo`](reference/FacebookVideo.md) | Represents a video file to be uploaded to the Graph API. |
8383

8484
# Extensibility
8585

8686
You can overwrite certain functionality of the SDK by coding to an interface and injecting an instance of your custom functionality.
8787

8888
| Interface name | Description |
8989
| ------------- | ------------- |
90-
| `Facebook\\HttpClients\\ FacebookHttpClientInterface` | An interface to code your own HTTP client implementation. |
91-
| `Facebook\\Http\\GraphRawResponse` | An entity that is returned from an instance of a `FacebookHttpClientInterface` that represents a raw HTTP response from the Graph API. |
92-
| [`Facebook\\PersistentData\\PersistentDataInterface`](reference/PersistentDataInterface.md) | An interface to code your own persistent data storage implementation. |
93-
| [`Facebook\\Url\\UrlDetectionInterface`](reference/UrlDetectionInterface.md) | An interface to code your own URL detection logic. |
94-
| [`Facebook\\PseudoRandomString\\ PseudoRandomStringGeneratorInterface`](reference/PseudoRandomStringGeneratorInterface.md) | An interface to code your own cryptographically secure pseudo-random string generator. |
90+
| `Facebook\HttpClients\ FacebookHttpClientInterface` | An interface to code your own HTTP client implementation. |
91+
| `Facebook\Http\GraphRawResponse` | An entity that is returned from an instance of a `FacebookHttpClientInterface` that represents a raw HTTP response from the Graph API. |
92+
| [`Facebook\PersistentData\PersistentDataInterface`](reference/PersistentDataInterface.md) | An interface to code your own persistent data storage implementation. |
93+
| [`Facebook\Url\UrlDetectionInterface`](reference/UrlDetectionInterface.md) | An interface to code your own URL detection logic. |
94+
| [`Facebook\PseudoRandomString\ PseudoRandomStringGeneratorInterface`](reference/PseudoRandomStringGeneratorInterface.md) | An interface to code your own cryptographically secure pseudo-random string generator. |

‎docs/reference/FacebookApp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In order to make requests to the Graph API, you need to [create a Facebook app](/apps) and obtain the app ID and the app secret. The `Facebook\FacebookApp` entity represents the Facebook app that is making the requests to the Graph API.
44

5-
> content: "It is quite uncommon to work with the `FacebookApp` entity directly since the `Facebook\\Facebook` service handles injecting it into the required classes for you.",
5+
> content: "It is quite uncommon to work with the `FacebookApp` entity directly since the `Facebook\Facebook` service handles injecting it into the required classes for you.",
66
> type: 'warning',
77
88
## Facebook\FacebookApp

‎docs/reference/FacebookResponseException.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ try {
1919

2020
| Class name | Description |
2121
| ------------- | ------------- |
22-
| `Facebook\\Exceptions\\FacebookAuthenticationException` | Thrown when Graph returns an authentication error. |
23-
| `Facebook\\Exceptions\\FacebookAuthorizationException` | Thrown when Graph returns a user permissions error. |
24-
| `Facebook\\Exceptions\\FacebookClientException` | Thrown when Graph returns a duplicate post error. |
25-
| `Facebook\\Exceptions\\FacebookOtherException` | Thrown when Graph returns an error that is unknown to the SDK. |
26-
| `Facebook\\Exceptions\\FacebookServerException` | Thrown when Graph returns a server error. |
27-
| `Facebook\\Exceptions\\FacebookThrottleException` | Thrown when Graph returns a throttle error. |
22+
| `Facebook\Exceptions\FacebookAuthenticationException` | Thrown when Graph returns an authentication error. |
23+
| `Facebook\Exceptions\FacebookAuthorizationException` | Thrown when Graph returns a user permissions error. |
24+
| `Facebook\Exceptions\FacebookClientException` | Thrown when Graph returns a duplicate post error. |
25+
| `Facebook\Exceptions\FacebookOtherException` | Thrown when Graph returns an error that is unknown to the SDK. |
26+
| `Facebook\Exceptions\FacebookServerException` | Thrown when Graph returns a server error. |
27+
| `Facebook\Exceptions\FacebookThrottleException` | Thrown when Graph returns a throttle error. |
2828

2929
These exceptions are derived from the [error responses from the Graph API](https://developers.facebook.com/docs/graph-api/using-graph-api#errors).
3030

‎docs/reference/GraphNode.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ The following properties on the `GraphUser` collection will get automatically ca
100100

101101
| Property | GraphNode subtype |
102102
| ------------- | ------------- |
103-
| `hometown` | [`Facebook\\GraphNodes\\GraphPage`](#page-instance-methods) |
104-
| `location` | [`Facebook\\GraphNodes\\GraphPage`](#page-instance-methods) |
105-
| `significant_other` | [`Facebook\\GraphNodes\\GraphUser`](#user-instance-methods) |
103+
| `hometown` | [`Facebook\GraphNodes\GraphPage`](#page-instance-methods) |
104+
| `location` | [`Facebook\GraphNodes\GraphPage`](#page-instance-methods) |
105+
| `significant_other` | [`Facebook\GraphNodes\GraphUser`](#user-instance-methods) |
106106

107107
All getter methods return `null` if the property does not exist on the node.
108108

@@ -176,9 +176,9 @@ The following properties on the `GraphPage` collection will get automatically ca
176176

177177
| Property | GraphNode subtype |
178178
| ------------- | ------------- |
179-
| `best_page` | [`Facebook\\GraphNodes\\GraphPage`](#page-instance-methods) |
180-
| `global_brand_parent_page` | [`Facebook\\GraphNodes\\GraphPage`](#page-instance-methods) |
181-
| `location` | [`Facebook\\GraphNodes\\GraphLocation`](#location-instance-methods) |
179+
| `best_page` | [`Facebook\GraphNodes\GraphPage`](#page-instance-methods) |
180+
| `global_brand_parent_page` | [`Facebook\GraphNodes\GraphPage`](#page-instance-methods) |
181+
| `location` | [`Facebook\GraphNodes\GraphLocation`](#location-instance-methods) |
182182

183183

184184
All getter methods return `null` if the property does not exist on the node.
@@ -241,8 +241,8 @@ The following properties on the `GraphAlbum` collection will get automatically c
241241

242242
| Property | GraphNode subtype |
243243
| ------------- | ------------- |
244-
| `from` | [`Facebook\\GraphNodes\\GraphUser`](#user-instance-methods) |
245-
| `place` | [`Facebook\\GraphNodes\\GraphPage`](#page-instance-methods) |
244+
| `from` | [`Facebook\GraphNodes\GraphUser`](#user-instance-methods) |
245+
| `place` | [`Facebook\GraphNodes\GraphPage`](#page-instance-methods) |
246246

247247
All getter methods return `null` if the property does not exist on the node.
248248

0 commit comments

Comments
 (0)