Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 6e1e657

Browse files
committed
Merge branch 'docs/375'
Close #375
2 parents b59d466 + 2058373 commit 6e1e657

17 files changed

+31
-40
lines changed

docs/book/index.html

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/book/v1/api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Like the `Request` and `ServerRequest`, responses are immutable. Any methods tha
7575

7676
### HtmlResponse and JsonResponse
7777

78-
- Added in 1.1.0
78+
> Available since version 1.1.0
7979
8080
The most common use case in server-side applications for generating responses is to provide a string
8181
to use for the response, typically HTML or data to serialize as JSON. `Zend\Diactoros\Response\HtmlResponse` and `Zend\Diactoros\Response\JsonResponse` exist to facilitate these use cases:
@@ -128,9 +128,9 @@ $request = RequestFactory::fromGlobals(
128128
);
129129
```
130130

131-
### ServerRequestFactory helper functions
131+
### ServerRequestFactory Helper Functions
132132

133-
- Since 1.8.0
133+
> Available since version 1.8.0
134134
135135
In order to create the various artifacts required by a `ServerRequest` instance,
136136
Diactoros also provides a number of functions under the `Zend\Diactoros`

docs/book/v1/custom-responses.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Headers must be in the same format as you would provide to the
6060

6161
## XML Responses
6262

63-
- Since 1.7.0
63+
> Available since version 1.7.0
6464
6565
`Zend\Diactoros\Response\XmlResponse` allows specifying XML as a payload, and sets the
6666
`Content-Type` header to `application/xml` by default:
@@ -180,7 +180,7 @@ $uri = $request->getUri();
180180
$response = new RedirectResponse($uri->withPath('/login'));
181181
```
182182

183-
## Creating custom responses
183+
## Creating custom Responses
184184

185185
PHP allows constructor overloading. What this means is that constructors of extending classes can
186186
define completely different argument sets without conflicting with the parent implementation.

docs/book/v1/emitting-responses.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Emitting responses
1+
# Emitting Responses
22

3-
> ## Deprecated
3+
> ### Deprecated
44
>
55
> Emitters are deprecated from Diactoros starting with version 1.8.0. The
66
> functionality is now available for any PSR-7 implementation via the package
@@ -29,7 +29,7 @@ $emitter = new Zend\Diactoros\Response\SapiEmitter();
2929
$emitter->emit($response);
3030
```
3131

32-
## Emitting ranges of streamed files
32+
## Emitting Ranges of streamed Files
3333

3434
The `SapiStreamEmitter` is useful when you want to emit a `Content-Range`. As an
3535
example, to stream a range of bytes from a file to a client, the client can pass
@@ -53,8 +53,8 @@ $response = new Response($body);
5353
$response = $response->withHeader('Content-Range', $range);
5454
```
5555

56-
> Note: you will likely want to ensure the range specified falls within the
57-
> content size of the streamed body!
56+
(Note: you will likely want to ensure the range specified falls within the
57+
content size of the streamed body!)
5858

5959
The `SapiStreamEmitter` detects the `Content-Range` header and emits only the
6060
bytes specified.

docs/book/v1/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installation and Requirements
1+
# Installation
22

33
Install this library using composer:
44

docs/book/v1/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# zend-diactoros: HTTP Messages
1+
# Overview
22

33
`zend-diactoros` is a PHP package containing implementations of the [accepted PSR-7 HTTP message
44
interfaces](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-7-http-message.md), as

docs/book/v1/serialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ the following static methods:
3232
The deserialization methods (`fromArray()`) will raise exceptions if errors occur while parsing the
3333
message.
3434

35-
### Example usage
35+
### Example Usage
3636

3737
Array serialization can be usesful for log messages:
3838

docs/book/v1/usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ illustration of a possible implementation.)
6060
Server-side applications will need to marshal the incoming request based on superglobals, and will
6161
then populate and send a response.
6262

63-
### Marshaling an incoming request
63+
### Marshaling an incoming Request
6464

6565
PHP contains a plethora of information about the incoming request, and keeps that information in a
6666
variety of locations. `Zend\Diactoros\ServerRequestFactory::fromGlobals()` can simplify marshaling
@@ -94,7 +94,7 @@ in the name were renamed with underlines. By getting the cookies directly from t
9494
access to the original cookies in the way you set them in your application and they are send by the user
9595
agent.
9696

97-
### Manipulating the response
97+
### Manipulating the Response
9898

9999
Use the response object to add headers and provide content for the response. Writing to the body
100100
does not create a state change in the response, so it can be done without capturing the return
@@ -116,7 +116,7 @@ $response = $response
116116
->withAddedHeader('X-Show-Something', 'something');
117117
```
118118

119-
### "Serving" an application
119+
### "Serving" an Application
120120

121121
> ### Deprecated
122122
>

docs/book/v2/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ $request = RequestFactory::fromGlobals(
126126
);
127127
```
128128

129-
### ServerRequestFactory helper functions
129+
### ServerRequestFactory Helper Functions
130130

131131
In order to create the various artifacts required by a `ServerRequest` instance,
132132
Diactoros also provides a number of functions under the `Zend\Diactoros`

docs/book/v2/custom-responses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ $uri = $request->getUri();
210210
$response = new RedirectResponse($uri->withPath('/login'));
211211
```
212212

213-
## Creating custom responses
213+
## Creating custom Responses
214214

215215
PHP allows constructor overloading. What this means is that constructors of extending classes can
216216
define completely different argument sets without conflicting with the parent implementation.

0 commit comments

Comments
 (0)