Skip to content

Commit

Permalink
Fix api docs for httpserver ext.
Browse files Browse the repository at this point in the history
  • Loading branch information
dim-s committed May 5, 2018
1 parent 57db8ff commit bf87597
Show file tree
Hide file tree
Showing 27 changed files with 3,021 additions and 3 deletions.
17 changes: 16 additions & 1 deletion exts/jphp-httpserver-ext/api-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,19 @@ jppm add [email protected]
```

### API
**Classes**
**Classes**

#### `php\http`

- [`HttpAbstractHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.md)
- [`HttpCORSFilter`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpCORSFilter.md)
- [`HttpDownloadFileHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpDownloadFileHandler.md)- _Class HttpDownloadFileHandler_
- [`HttpGzipFilter`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpGzipFilter.md)
- [`HttpRedirectHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRedirectHandler.md)- _Class HttpDownloadFileHandler_
- [`HttpResourceHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpResourceHandler.md)
- [`HttpRouteFilter`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRouteFilter.md)
- [`HttpRouteHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRouteHandler.md)- _Class HttpRouteHandler_
- [`HttpServer`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpServer.md)- _Class HttpServer_
- [`HttpServerRequest`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpServerRequest.md)- _Class HttpServerRequest_
- [`HttpServerResponse`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpServerResponse.md)- _Class HttpServerResponse_
- [`WebSocketSession`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/WebSocketSession.md)
17 changes: 16 additions & 1 deletion exts/jphp-httpserver-ext/api-docs/README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,19 @@ jppm add [email protected]
```

### АПИ
**Классы**
**Классы**

#### `php\http`

- [`HttpAbstractHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.ru.md)
- [`HttpCORSFilter`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpCORSFilter.ru.md)
- [`HttpDownloadFileHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpDownloadFileHandler.ru.md)- _Class HttpDownloadFileHandler_
- [`HttpGzipFilter`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpGzipFilter.ru.md)
- [`HttpRedirectHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRedirectHandler.ru.md)- _Class HttpDownloadFileHandler_
- [`HttpResourceHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpResourceHandler.ru.md)
- [`HttpRouteFilter`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRouteFilter.ru.md)
- [`HttpRouteHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRouteHandler.ru.md)- _Class HttpRouteHandler_
- [`HttpServer`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpServer.ru.md)- _Class HttpServer_
- [`HttpServerRequest`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpServerRequest.ru.md)- _Class HttpServerRequest_
- [`HttpServerResponse`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpServerResponse.ru.md)- _Class HttpServerResponse_
- [`WebSocketSession`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/WebSocketSession.ru.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# HttpAbstractHandler

- **class** `HttpAbstractHandler` (`php\http\HttpAbstractHandler`)
- **package** `http`
- **source** `php/http/HttpAbstractHandler.php`

**Child Classes**

> [HttpCORSFilter](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpCORSFilter.md), [HttpDownloadFileHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpDownloadFileHandler.md), [HttpGzipFilter](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpGzipFilter.md), [HttpRedirectHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRedirectHandler.md), [HttpResourceHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpResourceHandler.md), [HttpRouteFilter](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRouteFilter.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# HttpAbstractHandler

- **класс** `HttpAbstractHandler` (`php\http\HttpAbstractHandler`)
- **пакет** `http`
- **исходники** `php/http/HttpAbstractHandler.php`

**Классы наследники**

> [HttpCORSFilter](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpCORSFilter.ru.md), [HttpDownloadFileHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpDownloadFileHandler.ru.md), [HttpGzipFilter](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpGzipFilter.ru.md), [HttpRedirectHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRedirectHandler.ru.md), [HttpResourceHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpResourceHandler.ru.md), [HttpRouteFilter](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpRouteFilter.ru.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# HttpCORSFilter

- **class** `HttpCORSFilter` (`php\http\HttpCORSFilter`) **extends** [`HttpAbstractHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.md)
- **package** `http`
- **source** `php/http/HttpCORSFilter.php`

---

#### Methods

- `->`[`__construct()`](#method-__construct) - _HttpCORSFilter constructor._
- `->`[`allowDomains()`](#method-allowdomains)
- `->`[`allowMethods()`](#method-allowmethods)
- `->`[`allowHeaders()`](#method-allowheaders)
- `->`[`allowCredentials()`](#method-allowcredentials)
- `->`[`maxAge()`](#method-maxage)
- `->`[`handleOptions()`](#method-handleoptions) - _Handle OPTIONS query._
- `->`[`__invoke()`](#method-__invoke)
- See also in the parent class [HttpAbstractHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.md)

---
# Methods

<a name="method-__construct"></a>

### __construct()
```php
__construct(array $allowedDomains, array $allowedMethods, array $allowedHeaders, bool $allowedCredentials, int $maxAge): void
```
HttpCORSFilter constructor.

---

<a name="method-allowdomains"></a>

### allowDomains()
```php
allowDomains(): array
```

---

<a name="method-allowmethods"></a>

### allowMethods()
```php
allowMethods(): array
```

---

<a name="method-allowheaders"></a>

### allowHeaders()
```php
allowHeaders(): array
```

---

<a name="method-allowcredentials"></a>

### allowCredentials()
```php
allowCredentials(): bool
```

---

<a name="method-maxage"></a>

### maxAge()
```php
maxAge(): int
```

---

<a name="method-handleoptions"></a>

### handleOptions()
```php
handleOptions(php\http\HttpServerRequest $request, php\http\HttpServerResponse $response): void
```
Handle OPTIONS query.

---

<a name="method-__invoke"></a>

### __invoke()
```php
__invoke(php\http\HttpServerRequest $request, php\http\HttpServerResponse $response): bool
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# HttpCORSFilter

- **класс** `HttpCORSFilter` (`php\http\HttpCORSFilter`) **унаследован от** [`HttpAbstractHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.ru.md)
- **пакет** `http`
- **исходники** `php/http/HttpCORSFilter.php`

---

#### Методы

- `->`[`__construct()`](#method-__construct) - _HttpCORSFilter constructor._
- `->`[`allowDomains()`](#method-allowdomains)
- `->`[`allowMethods()`](#method-allowmethods)
- `->`[`allowHeaders()`](#method-allowheaders)
- `->`[`allowCredentials()`](#method-allowcredentials)
- `->`[`maxAge()`](#method-maxage)
- `->`[`handleOptions()`](#method-handleoptions) - _Handle OPTIONS query._
- `->`[`__invoke()`](#method-__invoke)
- См. также в родительском классе [HttpAbstractHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.ru.md)

---
# Методы

<a name="method-__construct"></a>

### __construct()
```php
__construct(array $allowedDomains, array $allowedMethods, array $allowedHeaders, bool $allowedCredentials, int $maxAge): void
```
HttpCORSFilter constructor.

---

<a name="method-allowdomains"></a>

### allowDomains()
```php
allowDomains(): array
```

---

<a name="method-allowmethods"></a>

### allowMethods()
```php
allowMethods(): array
```

---

<a name="method-allowheaders"></a>

### allowHeaders()
```php
allowHeaders(): array
```

---

<a name="method-allowcredentials"></a>

### allowCredentials()
```php
allowCredentials(): bool
```

---

<a name="method-maxage"></a>

### maxAge()
```php
maxAge(): int
```

---

<a name="method-handleoptions"></a>

### handleOptions()
```php
handleOptions(php\http\HttpServerRequest $request, php\http\HttpServerResponse $response): void
```
Handle OPTIONS query.

---

<a name="method-__invoke"></a>

### __invoke()
```php
__invoke(php\http\HttpServerRequest $request, php\http\HttpServerResponse $response): bool
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# HttpDownloadFileHandler

- **class** `HttpDownloadFileHandler` (`php\http\HttpDownloadFileHandler`) **extends** [`HttpAbstractHandler`](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.md)
- **package** `http`
- **source** `php/http/HttpDownloadFileHandler.php`

**Description**

Class HttpDownloadFileHandler

---

#### Methods

- `->`[`__construct()`](#method-__construct) - _HttpDownloadFileHandler constructor._
- `->`[`file()`](#method-file)
- `->`[`fileName()`](#method-filename)
- `->`[`contentType()`](#method-contenttype)
- `->`[`reset()`](#method-reset)
- `->`[`__invoke()`](#method-__invoke)
- See also in the parent class [HttpAbstractHandler](https://github.com/jphp-compiler/jphp/blob/master/exts/jphp-httpserver-ext/api-docs/classes/php/http/HttpAbstractHandler.md)

---
# Methods

<a name="method-__construct"></a>

### __construct()
```php
__construct(string|File $file, string|null $fileName, string|null $contentType): void
```
HttpDownloadFileHandler constructor.

---

<a name="method-file"></a>

### file()
```php
file(): php\io\File
```

---

<a name="method-filename"></a>

### fileName()
```php
fileName(): string
```

---

<a name="method-contenttype"></a>

### contentType()
```php
contentType(): string
```

---

<a name="method-reset"></a>

### reset()
```php
reset(string|File $file, string|null $fileName, string|null $contentType): void
```

---

<a name="method-__invoke"></a>

### __invoke()
```php
__invoke(php\http\HttpServerRequest $request, php\http\HttpServerResponse $response): bool
```
Loading

0 comments on commit bf87597

Please sign in to comment.