Skip to content

Add instructions for HTTP redirecting #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clue merged 1 commit into from
Apr 29, 2022
Merged

Add instructions for HTTP redirecting #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api/app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ crawlers to update their index like this:
$app->redirect('/blog.html', '/blog', React\Http\Message\Response::STATUS_MOVED_PERMANENTLY);
```

See [response status codes](response.md#status-codes) for more details.
See [response status codes](response.md#status-codes) and [HTTP redirects](response.md#http-redirects)
for more details.

## Controllers

Expand Down
45 changes: 45 additions & 0 deletions docs/api/response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,51 @@ Hello wörld!
> });
> ```

## HTTP Redirects

To redirect incoming HTTP requests to a new location you can define your HTTP
response like this:

```php
<?php

// …

$app->get('/blog.html', function () {
return new React\Http\Message\Response(
React\Http\Message\Response::STATUS_FOUND,
[
'Location' => '/blog'
]
);
});
```

Redirect responses have a [status code](#status-codes) in the `3xx` range.
Here's a list with some of the most common HTTP redirect status codes:

* `301 Moved Permanently`
* `302 Found` (previously `302 Temporary Redirect`)
* `303 See Other`
* `307 Temporary Redirect`
* `308 Permanent Redirect`

Each status code can be referenced by its matching status code
constant name such as `React\Http\Message\Response::STATUS_MOVED_PERMANENTLY` or `React\Http\Message\Response::STATUS_FOUND`
or by its status code number.

The [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
response header holds the URL to redirect to. When a Browser or a search engine
crawler receives a redirect, they will automatically follow the new URL provided
in the `Location` header.

You can also use the [redirect helper method](app.md#redirects)
for simpler use cases:

```php
$app->redirect('/promo/reactphp', 'https://reactphp.org/');
```

## HTTP caching

HTTP caching can be used to significantly improve the performance of web
Expand Down