Skip to content

Commit 6897150

Browse files
nayafiaSammyK
nayafia
authored andcommitted
update links
1 parent 792df43 commit 6897150

19 files changed

+74
-74
lines changed

docs/examples/retrieve_user_profile.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This example covers getting profile information for the current user and printing their name, using the Graph API and the Facebook SDK for PHP.
44

5-
It assumes that you've already obtained an access token from one of the helpers found [here](/docs/php/sdk_reference#helpers).
5+
It assumes that you've already obtained an access token from one of the helpers found [here](../reference.md).
66

7-
For more information, see the documentation for [`Facebook\Facebook`](/docs/php/Facebook), [`Facebook\FacebookResponse`](/docs/php/FacebookResponse), [`Facebook\GraphNodes\GraphUser`](/docs/php/GraphNode#user-instance-methods), [`Facebook\Exceptions\FacebookSDKException`](/docs/php/FacebookSDKException) and [`Facebook\Exceptions\FacebookResponseException`](/docs/php/FacebookResponseException).
7+
For more information, see the documentation for [`Facebook\Facebook`](../reference/Facebook.md), [`Facebook\FacebookResponse`](../reference/FacebookResponse.md), [`Facebook\GraphNodes\GraphUser`](../reference/GraphNode.md#graphuser-instance-methods), [`Facebook\Exceptions\FacebookSDKException`](../reference/FacebookSDKException.md) and [`Facebook\Exceptions\FacebookResponseException`](../reference/FacebookResponseException.md).
88

99
## Example
1010

docs/examples/upload_photo.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This example covers uploading a photo to the current User's profile using the Graph API and the Facebook SDK for PHP.
44

5-
It assumes that you've already acquired an access token using one of the helper classes found [here](/docs/php/sdk_reference#helpers). The access token must have the `publish_actions` permission for this to work.
5+
It assumes that you've already acquired an access token using one of the helper classes found [here](../reference.md). The access token must have the `publish_actions` permission for this to work.
66

7-
For more information, see the documentation for [`Facebook\Facebook`](/docs/php/Facebook), [`Facebook\FileUpload\FacebookFile`](/docs/php/FacebookFile), [`Facebook\FacebookResponse`](/docs/php/FacebookResponse), [`Facebook\GraphNodes\GraphNode`](/docs/php/GraphNode), [`Facebook\Exceptions\FacebookSDKException`](/docs/php/FacebookSDKException) and [`Facebook\Exceptions\FacebookResponseException`](/docs/php/FacebookResponseException).
7+
For more information, see the documentation for [`Facebook\Facebook`](../reference/Facebook.md), [`Facebook\FileUpload\FacebookFile`](,,/reference/FacebookFile.md), [`Facebook\FacebookResponse`](../reference/FacebookResponse.md), [`Facebook\GraphNodes\GraphNode`](../reference/GraphNode.md), [`Facebook\Exceptions\FacebookSDKException`](../reference/FacebookSDKException.md) and [`Facebook\Exceptions\FacebookResponseException`](../reference/FacebookResponseException.md).
88

99
## Example
1010

docs/examples/upload_video.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This example covers uploading & posting a video to a user's timeline with the Fa
77
> content: "Before you upload, check out the [video publishing options & requirements](https://developers.facebook.com/docs/graph-api/reference/video#publishing) for the specific video endpoint you want to publish to.",
88
> type: 'warning',
99
10-
The following example will upload a video in chunks using the [resumable upload](/docs/graph-api/video-uploads#resumable) feature added in Graph v2.3.
10+
The following example will upload a video in chunks using the [resumable upload](https://developers.facebook.com/docs/graph-api/video-uploads#resumable) feature added in Graph v2.3.
1111

1212
```
1313
$fb = new Facebook\Facebook([
@@ -36,7 +36,7 @@ try {
3636
echo 'Video ID: ' . $response['video_id'];
3737
```
3838

39-
See more about the [`uploadVideo()` method](/docs/php/Facebook#upload-video).
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/reference/Facebook.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ The secret of your Facebook app (required).
6666
The default fallback access token to use if one is not explicitly provided. The value can be of type `string` or `Facebook\AccessToken`. If any other value is provided an `InvalidArgumentException` will be thrown. Defaults to `null`.
6767

6868
### `enable_beta_mode`
69-
Enable [beta mode](/docs/support/beta-tier/) so that request are made to the [https://graph.beta.facebook.com](https://graph.beta.facebook.com/) endpoint. Set to boolean `true` to enable or `false` to disable. Defaults to `false`.
69+
Enable [beta mode](https://developers.facebook.com/docs/apps/beta-tier) so that request are made to the [https://graph.beta.facebook.com](https://graph.beta.facebook.com/) endpoint. Set to boolean `true` to enable or `false` to disable. Defaults to `false`.
7070

7171
### `default_graph_version`
72-
Allows you to overwrite the default Graph version number set in `Facebook\Facebook::DEFAULT_GRAPH_VERSION`. Set this as a string as it would appear in the Graph url, e.g. `v2.8`. Defaults to the [latest version of Graph](/docs/apps/changelog).
72+
Allows you to overwrite the default Graph version number set in `Facebook\Facebook::DEFAULT_GRAPH_VERSION`. Set this as a string as it would appear in the Graph url, e.g. `v2.8`. Defaults to the [latest version of Graph](https://developers.facebook.com/docs/apps/changelog).
7373

7474
### `http_client_handler`
7575
Allows you to overwrite the default HTTP client.
@@ -78,7 +78,7 @@ By default, the SDK will try to use cURL as the HTTP client. If a cURL implement
7878

7979
If you wish to use Guzzle, you can set this value to `guzzle`, but it requires that you [install Guzzle](http://docs.guzzlephp.org/en/latest/) with composer.
8080

81-
If you wish to write your own HTTP client, you can code your HTTP client to the `[Facebook\HttpClients\FacebookHttpClientInterface](/docs/php/FacebookHttpClientInterface)` and set this value to an instance of your custom client.
81+
If you wish to write your own HTTP client, you can code your HTTP client to the `Facebook\HttpClients\FacebookHttpClientInterface` and set this value to an instance of your custom client.
8282

8383
```
8484
$fb = new Facebook([
@@ -93,7 +93,7 @@ Allows you to overwrite the default persistent data store.
9393

9494
By default, the SDK will try to use the native PHP session for the persistent data store. There is also an in-memory persistent data handler which is useful when running your script from the command line for example. You can force either implementation by setting this value to `session` or `memory`.
9595

96-
If you wish to write your own persistent data handler, you can code your persistent data handler to the `[Facebook\PersistentData\PersistentDataInterface](/docs/php/PersistentDataInterface)` and set the value of `persistent_data_handler` to an instance of your custom handler.
96+
If you wish to write your own persistent data handler, you can code your persistent data handler to the [`Facebook\PersistentData\PersistentDataInterface`](PersistentDataInterface.md) and set the value of `persistent_data_handler` to an instance of your custom handler.
9797

9898
```
9999
$fb = new Facebook([
@@ -106,7 +106,7 @@ If any other value is provided an `InvalidArgumentException` will be thrown.
106106
### `url_detection_handler`
107107
Allows you to overwrite the default URL detection logic.
108108

109-
The SDK will do its best to detect the proper current URL but this can sometimes get tricky if you have a very customized environment. You can write your own URL detection logic that implements the `[Facebook\Url\UrlDetectionInterface](/docs/php/UrlDetectionInterface)` and set the value of `url_detection_handler` to an instance of your custom URL detector.
109+
The SDK will do its best to detect the proper current URL but this can sometimes get tricky if you have a very customized environment. You can write your own URL detection logic that implements the ['Facebook\Url\UrlDetectionInterface'](UrlDetectionInterface.md)` and set the value of `url_detection_handler` to an instance of your custom URL detector.
110110

111111
```
112112
$fb = new Facebook([
@@ -129,7 +129,7 @@ $fb = new Facebook([
129129
]);
130130
```
131131

132-
You can write your own CSPRSG that implements the `[Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface](/docs/php/PseudoRandomStringGeneratorInterface)` and set the value of `pseudo_random_string_generator` to an instance of your custom generator.
132+
You can write your own CSPRSG that implements the [`Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface`](PseudoRandomStringGeneratorInterface.md) and set the value of `pseudo_random_string_generator` to an instance of your custom generator.
133133

134134
```
135135
$fb = new Facebook([
@@ -161,13 +161,13 @@ Returns the instance of `Facebook\FacebookApp` for the instantiated service.
161161
```
162162
public Facebook\FacebookClient getClient()
163163
```
164-
Returns the instance of [`Facebook\FacebookClient`](/docs/php/FacebookClient) for the instantiated service.
164+
Returns the instance of [`Facebook\FacebookClient`](FacebookClient.md) for the instantiated service.
165165

166166
## getOAuth2Client()
167167
```
168168
public Facebook\Authentication\OAuth2Client getOAuth2Client()
169169
```
170-
Returns an instance of [`Facebook\Authentication\OAuth2Client`](/docs/php/OAuth2Client).
170+
Returns an instance of `Facebook\Authentication\OAuth2Client`.
171171

172172
## getLastResponse()
173173
```
@@ -179,19 +179,19 @@ Returns the last response received from the Graph API in the form of a `Facebook
179179
```
180180
public Facebook\Url\UrlDetectionInterface getUrlDetectionHandler()
181181
```
182-
Returns an instance of [`Facebook\Url\UrlDetectionInterface`](/docs/php/UrlDetectionInterface).
182+
Returns an instance of [`Facebook\Url\UrlDetectionInterface`](UrlDetectionInterface.md).
183183

184184
## getDefaultAccessToken()
185185
```
186186
public Facebook\Authentication\AccessToken|null getDefaultAccessToken()
187187
```
188-
Returns the default fallback [`AccessToken`](/docs/php/AccessToken) entity that is being used with every request to Graph. This value can be set with the configuration option `default_access_token` or by using `setDefaultAccessToken()`.
188+
Returns the default fallback [`AccessToken`](AccessToken.md) entity that is being used with every request to Graph. This value can be set with the configuration option `default_access_token` or by using `setDefaultAccessToken()`.
189189

190190
## setDefaultAccessToken()
191191
```
192192
public setDefaultAccessToken(string|Facebook\AccessToken $accessToken)
193193
```
194-
Sets the default fallback access token to be use with all requests sent to Graph. The access token can be a string or an instance of [`AccessToken`](/docs/php/AccessToken).
194+
Sets the default fallback access token to be use with all requests sent to Graph. The access token can be a string or an instance of [`AccessToken`](AccessToken.md).
195195

196196
```
197197
$fb->setDefaultAccessToken('{my-access-token}');
@@ -233,7 +233,7 @@ $fb->get('/me');
233233
The access token (as a string or `AccessToken` entity) to use for the request. If none is provided, the SDK will assume the value from the `default_access_token` configuration option if it was set.
234234

235235
`$eTag`
236-
[Graph supports eTags](/docs/reference/ads-api/etags-reference/). Set this to the eTag from a previous request to get a `304 Not Modified` response if the data has not changed.
236+
[Graph supports eTags](https://developers.facebook.com/docs/marketing-api/etags). Set this to the eTag from a previous request to get a `304 Not Modified` response if the data has not changed.
237237

238238
`$graphVersion`
239239
This will overwrite the Graph version that was set in the `default_graph_version` configuration option.
@@ -336,7 +336,7 @@ The `$accessToken` and `$graphVersion` arguments are the same as `get()` above.
336336
`$requests`
337337
An array of `Facebook\FacebookRequest` entities. This can be a numeric or associative array but every value of the array has to be an instance of `Facebook\FacebookRequest`.
338338

339-
If the requests are sent as an associative array, the key will be used as the `name` of the request so that it can be referenced by another request. See more on [batch request naming and using JSONPath](/docs/graph-api/making-multiple-requests/#operations).
339+
If the requests are sent as an associative array, the key will be used as the `name` of the request so that it can be referenced by another request. See more on [batch request naming and using JSONPath](https://developers.facebook.com/docs/graph-api/making-multiple-requests).
340340

341341
```
342342
$requests = [
@@ -347,14 +347,14 @@ $requests = [
347347
$batchResponse = $fb->sendBatchRequest($requests);
348348
```
349349

350-
[See a full batch example](/docs/php/howto/example_batch_request).
350+
[See a full batch example](../examples/batch_request.md).
351351

352352
## getRedirectLoginHelper()
353353
```
354354
public Facebook\Helpers\FacebookRedirectLoginHelper getRedirectLoginHelper()
355355
```
356356

357-
Returns a [`Facebook\Helpers\FacebookRedirectLoginHelper`](/docs/php/FacebookRedirectLoginHelper) which is used to generate a "Login with Facebook" link and obtain an access token from a redirect.
357+
Returns a [`Facebook\Helpers\FacebookRedirectLoginHelper`](FacebookRedirectLoginHelper.md) which is used to generate a "Login with Facebook" link and obtain an access token from a redirect.
358358

359359
```
360360
$helper = $fb->getRedirectLoginHelper();
@@ -365,7 +365,7 @@ $helper = $fb->getRedirectLoginHelper();
365365
public Facebook\Helpers\FacebookJavaScriptHelper getJavaScriptHelper()
366366
```
367367

368-
Returns a [`Facebook\Helpers\FacebookJavaScriptHelper`](/docs/php/FacebookJavaScriptHelper) which is used to access the signed request stored in the cookie set by the SDK for JavaScript.
368+
Returns a [`Facebook\Helpers\FacebookJavaScriptHelper`](FacebookJavaScriptHelper.md) which is used to access the signed request stored in the cookie set by the SDK for JavaScript.
369369

370370
```
371371
$helper = $fb->getJavaScriptHelper();
@@ -376,7 +376,7 @@ $helper = $fb->getJavaScriptHelper();
376376
public Facebook\Helpers\FacebookCanvasHelper getCanvasHelper()
377377
```
378378

379-
Returns a [`Facebook\Helpers\FacebookCanvasHelper`](/docs/php/FacebookCanvasHelper) which is used to access the signed request that is `POST`ed to canvas apps.
379+
Returns a [`Facebook\Helpers\FacebookCanvasHelper`](FacebookCanvasHelper.md) which is used to access the signed request that is `POST`ed to canvas apps.
380380

381381
```
382382
$helper = $fb->getCanvasHelper();
@@ -387,7 +387,7 @@ $helper = $fb->getCanvasHelper();
387387
public Facebook\Helpers\FacebookPageTabHelper getPageTabHelper()
388388
```
389389

390-
Returns a [`Facebook\Helpers\FacebookPageTabHelper`](/docs/php/FacebookPageTabHelper) which is used to access the signed request that is `POST`ed to canvas apps and provides a number of helper methods useful for apps living in a page tab context.
390+
Returns a [`Facebook\Helpers\FacebookPageTabHelper`](FacebookPageTabHelper.md) which is used to access the signed request that is `POST`ed to canvas apps and provides a number of helper methods useful for apps living in a page tab context.
391391

392392
```
393393
$helper = $fb->getPageTabHelper();
@@ -398,7 +398,7 @@ $helper = $fb->getPageTabHelper();
398398
public Facebook\GraphNodes\GraphEdge|null next(Facebook\GraphNodes\GraphEdge $graphEdge)
399399
```
400400

401-
Requests and returns the next page of results in a [`Facebook\GraphNodes\GraphEdge`](/docs/php/GraphEdge) collection. If the next page returns no results, `null` will be returned.
401+
Requests and returns the next page of results in a [`Facebook\GraphNodes\GraphEdge`](GraphEdge.md) collection. If the next page returns no results, `null` will be returned.
402402

403403
```
404404
// Iterate over 5 pages max
@@ -499,7 +499,7 @@ public array videoToUpload(
499499
)
500500
```
501501

502-
Functionality to [upload video files in chunks](/docs/graph-api/video-uploads#resumable) was added to the Graph API in v2.3. The `uploadVideo()` method provides an easy API to take advantage of this new feature.
502+
Functionality to [upload video files in chunks](https://developers.facebook.com/docs/graph-api/video-uploads#resumable) was added to the Graph API in v2.3. The `uploadVideo()` method provides an easy API to take advantage of this new feature.
503503

504504
### Parameters
505505

@@ -510,13 +510,13 @@ The ID or alias of the target node. This can be a user ID, page ID, event ID, gr
510510
The absolute or relative path to the video file to upload.
511511

512512
`$metadata`
513-
All the metadata associated with the [Video node](/docs/graph-api/reference/video/).
513+
All the metadata associated with the [Video node](https://developers.facebook.com/docs/graph-api/reference/video).
514514

515515
`$accessToken`
516516
The access token to use for this request. Falls back to the default access token if one exists.
517517

518518
`$maxTransferTries`
519-
During the [transfer phase](/docs/graph-api/video-uploads#transfer) an upload can fail for a number of reasons. If the Graph API responds with an error that is resumable, the PHP SDK will retry uploading the chunk automatically. By default the PHP SDK will try to upload each chunk five times before throwing a `FacebookResponseException`.
519+
During the [transfer phase](https://developers.facebook.com/docs/graph-api/video-uploads#transfer) an upload can fail for a number of reasons. If the Graph API responds with an error that is resumable, the PHP SDK will retry uploading the chunk automatically. By default the PHP SDK will try to upload each chunk five times before throwing a `FacebookResponseException`.
520520

521521
`$graphVersion`
522522
The version of the Graph API to use. The resumable upload feature did not become available until Graph v2.3.

docs/reference/FacebookApp.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To instantiate a new `Facebook\FacebookApp` entity, pass the app ID and app secr
1313
$fbApp = new Facebook\FacebookApp('{app-id}', '{app-secret}');
1414
```
1515

16-
Alternatively you can obtain the `Facebook\FacebookApp` entity from the [`Facebook\Facebook`](/docs/php/Facebook) super service class.
16+
Alternatively you can obtain the `Facebook\FacebookApp` entity from the [`Facebook\Facebook`](Facebook.md) super service class.
1717

1818
```
1919
$fb = new Facebook\Facebook([/* . . . */]);
@@ -28,7 +28,7 @@ You'll rarely be using the `FacebookApp` entity directly unless you're doing som
2828
```
2929
public Facebook\Authentication\AccessToken getAccessToken()
3030
```
31-
Returns an app access token in the form of an [`AccessToken`](/docs/php/AccessToken) entity.
31+
Returns an app access token in the form of an [`AccessToken`](AccessToken.md) entity.
3232

3333
## getId()
3434
```

docs/reference/FacebookBatchRequest.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ $request = new FacebookBatchRequest(
1717
);
1818
```
1919

20-
The `$requests` array is an array of [`Facebook\FacebookRequest`'s](/docs/php/FacebookRequest) to be sent as a batch request.
20+
The `$requests` array is an array of [`Facebook\FacebookRequest`'s](FacebookRequest.md) to be sent as a batch request.
2121

22-
The `FacebookBatchRequest` entity does not actually make any calls to the Graph API, but instead just represents a batch request that can be sent to the Graph API later. The batch request can be sent by using [`Facebook\Facebook::sendBatchRequest()`](/docs/php/Facebook#send-batch-request) or [`Facebook\FacebookClient::sendBatchRequest()`](/docs/php/FacebookClient#send-batch-request).
22+
The `FacebookBatchRequest` entity does not actually make any calls to the Graph API, but instead just represents a batch request that can be sent to the Graph API later. The batch request can be sent by using [`Facebook\Facebook::sendBatchRequest()`](Facebook.md#sendbatchrequest) or [`Facebook\FacebookClient::sendBatchRequest()`](FacebookClient.md#sendbatchrequest.md).
2323

2424
Usage:
2525

@@ -56,7 +56,7 @@ foreach ($batchResponse as $key => $response) {
5656

5757
## Instance Methods
5858

59-
Since the `Facebook\FacebookBatchRequest` is extended from the [`Facebook\FacebookRequest`](/docs/php/FacebookRequest) entity, all the methods are inherited.
59+
Since the `Facebook\FacebookBatchRequest` is extended from the [`Facebook\FacebookRequest`](FacebookRequest.md) entity, all the methods are inherited.
6060

6161
### add()
6262
```
@@ -65,15 +65,15 @@ public add(
6565
string|null $name
6666
)
6767
```
68-
Adds a request to be sent in the batch request. The `$request` can be a single [`Facebook\FacebookRequest`](/docs/php/FacebookRequest) or an array of `Facebook\FacebookRequest`'s.
68+
Adds a request to be sent in the batch request. The `$request` can be a single [`Facebook\FacebookRequest`](FacebookRequest.md) or an array of `Facebook\FacebookRequest`'s.
6969

7070
The `$name` argument is optional and is used to identify the request in the batch.
7171

7272
### getRequests()
7373
```
7474
public array getRequests()
7575
```
76-
Returns the array of [`Facebook\FacebookRequest`'s](/docs/php/FacebookRequest) to be sent in the batch request.
76+
Returns the array of [`Facebook\FacebookRequest`'s](FacebookRequest.md) to be sent in the batch request.
7777

7878
## Array Access
7979

0 commit comments

Comments
 (0)