Skip to content

Commit 76b87f8

Browse files
committed
Update README docs
1 parent 367dd50 commit 76b87f8

File tree

1 file changed

+88
-25
lines changed

1 file changed

+88
-25
lines changed

README.md

Lines changed: 88 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -34,31 +34,31 @@ Base of Exceptions Representing The 4xx Class
3434
#### Method: BadRequestException->getHttpStatusCode
3535

3636
```php
37-
function getHttpStatusCode()
37+
function getHttpStatusCode() : int
3838
```
3939

4040
### Class: \Corpus\Http\Exceptions\ClientError\ForbiddenException
4141

4242
#### Method: ForbiddenException->getHttpStatusCode
4343

4444
```php
45-
function getHttpStatusCode()
45+
function getHttpStatusCode() : int
4646
```
4747

4848
### Class: \Corpus\Http\Exceptions\ClientError\NotFoundException
4949

5050
#### Method: NotFoundException->getHttpStatusCode
5151

5252
```php
53-
function getHttpStatusCode()
53+
function getHttpStatusCode() : int
5454
```
5555

5656
### Class: \Corpus\Http\Exceptions\ClientError\UnauthorizedException
5757

5858
#### Method: UnauthorizedException->getHttpStatusCode
5959

6060
```php
61-
function getHttpStatusCode()
61+
function getHttpStatusCode() : int
6262
```
6363

6464
### Class: \Corpus\Http\Exceptions\Redirection\AbstractLocationRedirectionHttpException
@@ -68,28 +68,19 @@ Base of 3xx Exceptions which include a "Location" header.
6868
#### Method: AbstractLocationRedirectionHttpException->__construct
6969

7070
```php
71-
function __construct($location [, $message = '' [, $previous = null]])
71+
function __construct(string $location [, $message = '' [, ?\Throwable $previous = null]])
7272
```
7373

7474
AbstractRedirectionHttpException constructor.
7575

7676
##### Parameters:
7777

78-
- ***string*** `$location`
7978
- ***string*** `$message`
8079
- ***\Throwable*** `$previous` - [optional] The previous throwable used for the exception chaining.
8180

8281
---
8382

84-
#### Method: AbstractLocationRedirectionHttpException->getLocation
85-
86-
```php
87-
function getLocation()
88-
```
89-
90-
##### Returns:
91-
92-
- ***string***
83+
#### Undocumented Method: `AbstractLocationRedirectionHttpException->getLocation()`
9384

9485
### Class: \Corpus\Http\Exceptions\Redirection\AbstractRedirectionHttpException
9586

@@ -100,15 +91,15 @@ Base of Exceptions Representing The 3xx Class
10091
#### Method: FoundException->getHttpStatusCode
10192

10293
```php
103-
function getHttpStatusCode()
94+
function getHttpStatusCode() : int
10495
```
10596

10697
### Class: \Corpus\Http\Exceptions\Redirection\SeeOtherException
10798

10899
#### Method: SeeOtherException->getHttpStatusCode
109100

110101
```php
111-
function getHttpStatusCode()
102+
function getHttpStatusCode() : int
112103
```
113104

114105
### Class: \Corpus\Http\Exceptions\ServerError\AbstractServerErrorException
@@ -120,7 +111,7 @@ Base of Exceptions Representing The 5xx Class
120111
#### Method: InternalServerErrorException->getHttpStatusCode
121112

122113
```php
123-
function getHttpStatusCode()
114+
function getHttpStatusCode() : int
124115
```
125116

126117
### Class: \Corpus\Http\Exceptions\Success\AbstractSuccessException
@@ -132,21 +123,93 @@ Base of Exceptions Representing The 2xx Class
132123
#### Method: NoContentException->getHttpStatusCode
133124

134125
```php
135-
function getHttpStatusCode()
126+
function getHttpStatusCode() : int
127+
```
128+
129+
### Class: \Corpus\Http\Status
130+
131+
```php
132+
<?php
133+
namespace Corpus\Http;
134+
135+
class Status {
136+
public const StatusContinue = 100;
137+
public const SwitchingProtocols = 101;
138+
public const Processing = 102;
139+
public const OK = 200;
140+
public const Created = 201;
141+
public const Accepted = 202;
142+
public const NonAuthoritativeInfo = 203;
143+
public const NoContent = 204;
144+
public const ResetContent = 205;
145+
public const PartialContent = 206;
146+
public const MultiStatus = 207;
147+
public const AlreadyReported = 208;
148+
public const IMUsed = 226;
149+
public const MultipleChoices = 300;
150+
public const MovedPermanently = 301;
151+
public const Found = 302;
152+
public const SeeOther = 303;
153+
public const NotModified = 304;
154+
public const UseProxy = 305;
155+
public const TemporaryRedirect = 307;
156+
public const PermanentRedirect = 308;
157+
public const BadRequest = 400;
158+
public const Unauthorized = 401;
159+
public const PaymentRequired = 402;
160+
public const Forbidden = 403;
161+
public const NotFound = 404;
162+
public const MethodNotAllowed = 405;
163+
public const NotAcceptable = 406;
164+
public const ProxyAuthRequired = 407;
165+
public const RequestTimeout = 408;
166+
public const Conflict = 409;
167+
public const Gone = 410;
168+
public const LengthRequired = 411;
169+
public const PreconditionFailed = 412;
170+
public const RequestEntityTooLarge = 413;
171+
public const RequestURITooLong = 414;
172+
public const UnsupportedMediaType = 415;
173+
public const RequestedRangeNotSatisfiable = 416;
174+
public const ExpectationFailed = 417;
175+
public const Teapot = 418;
176+
public const UnprocessableEntity = 422;
177+
public const Locked = 423;
178+
public const FailedDependency = 424;
179+
public const UpgradeRequired = 426;
180+
public const PreconditionRequired = 428;
181+
public const TooManyRequests = 429;
182+
public const RequestHeaderFieldsTooLarge = 431;
183+
public const UnavailableForLegalReasons = 451;
184+
public const InternalServerError = 500;
185+
public const NotImplemented = 501;
186+
public const BadGateway = 502;
187+
public const ServiceUnavailable = 503;
188+
public const GatewayTimeout = 504;
189+
public const HTTPVersionNotSupported = 505;
190+
public const VariantAlsoNegotiates = 506;
191+
public const InsufficientStorage = 507;
192+
public const LoopDetected = 508;
193+
public const NotExtended = 510;
194+
public const NetworkAuthenticationRequired = 511;
195+
public static $statusText = [self::StatusContinue => 'Continue', self::SwitchingProtocols => 'Switching Protocols', self::Processing => 'Processing', self::OK => 'OK', self::Created => 'Created', self::Accepted => 'Accepted', self::NonAuthoritativeInfo => 'Non-Authoritative Information', self::NoContent => 'No Content', self::ResetContent => 'Reset Content', self::PartialContent => 'Partial Content', self::MultiStatus => 'Multi-Status', self::AlreadyReported => 'Already Reported', self::IMUsed => 'IM Used', self::MultipleChoices => 'Multiple Choices', self::MovedPermanently => 'Moved Permanently', self::Found => 'Found', self::SeeOther => 'See Other', self::NotModified => 'Not Modified', self::UseProxy => 'Use Proxy', self::TemporaryRedirect => 'Temporary Redirect', self::PermanentRedirect => 'Permanent Redirect', self::BadRequest => 'Bad Request', self::Unauthorized => 'Unauthorized', self::PaymentRequired => 'Payment Required', self::Forbidden => 'Forbidden', self::NotFound => 'Not Found', self::MethodNotAllowed => 'Method Not Allowed', self::NotAcceptable => 'Not Acceptable', self::ProxyAuthRequired => 'Proxy Authentication Required', self::RequestTimeout => 'Request Timeout', self::Conflict => 'Conflict', self::Gone => 'Gone', self::LengthRequired => 'Length Required', self::PreconditionFailed => 'Precondition Failed', self::RequestEntityTooLarge => 'Request Entity Too Large', self::RequestURITooLong => 'Request URI Too Long', self::UnsupportedMediaType => 'Unsupported Media Type', self::RequestedRangeNotSatisfiable => 'Requested Range Not Satisfiable', self::ExpectationFailed => 'Expectation Failed', self::Teapot => 'I\'m a teapot', self::UnprocessableEntity => 'Unprocessable Entity', self::Locked => 'Locked', self::FailedDependency => 'Failed Dependency', self::UpgradeRequired => 'Upgrade Required', self::PreconditionRequired => 'Precondition Required', self::TooManyRequests => 'Too Many Requests', self::RequestHeaderFieldsTooLarge => 'Request Header Fields Too Large', self::UnavailableForLegalReasons => 'Unavailable For Legal Reasons', self::InternalServerError => 'Internal Server Error', self::NotImplemented => 'Not Implemented', self::BadGateway => 'Bad Gateway', self::ServiceUnavailable => 'Service Unavailable', self::GatewayTimeout => 'Gateway Timeout', self::HTTPVersionNotSupported => 'HTTP Version Not Supported', self::VariantAlsoNegotiates => 'Variant Also Negotiates', self::InsufficientStorage => 'Insufficient Storage', self::LoopDetected => 'Loop Detected', self::NotExtended => 'Not Extended', self::NetworkAuthenticationRequired => 'Network Authentication Required'];
196+
}
136197
```
137198

199+
#### Method: Status::statusText
138200

201+
```php
202+
function statusText(int $code) : ?string
203+
```
204+
205+
Return the text for an HTTP status code.
139206

140207
### Class: \Corpus\Http\StatusAwareInterface
141208

142209
#### Method: StatusAwareInterface->getHttpStatusCode
143210

144211
```php
145-
function getHttpStatusCode()
212+
function getHttpStatusCode() : int
146213
```
147214

148-
Get the HTTP Status Code the Exception Represents
149-
150-
##### Returns:
151-
152-
- ***int***
215+
Get the HTTP Status Code the Exception Represents

0 commit comments

Comments
 (0)