Skip to content

Commit ea080e4

Browse files
committed
Rename CliRequest to SAPI
1 parent c4007c9 commit ea080e4

File tree

5 files changed

+27
-15
lines changed

5 files changed

+27
-15
lines changed

.docs/README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Content
44

55
- [Curl - provides CurlExtension and simple cURL client](#curl)
6-
- [CliRequest - provides CliRequestExtension, URL in console (SAPI) mode](#clirequest)
6+
- [SAPI - provides SapiRequestExtension (fake request in console mode)](#sapi)
77
- [URL - extra methods](#url)
88

99
## Curl
@@ -19,21 +19,31 @@ extensions:
1919
2020
Extension registers by automatic [`Contributte\Http\Curl\CurlClient`](https://github.com/contributte/http/blob/master/src/Curl/CurlClient.php) as a service.
2121

22-
## CliRequest
22+
## SAPI
23+
24+
Every modern PHP application needs sometimes run a few console commands. Let's say sending newsletter campaigns. There is
25+
a tiny problem, there is no request/URL in console/SAPI (Server API) mode. Don't worry, just use our fake request -
26+
`SapiRequestExtension`.
27+
28+
Easies ways is to register extension without any parameters.
2329

2430
```yaml
2531
extensions:
26-
cli: Contributte\Http\CliRequestExtension
32+
sapi: Contributte\Http\SAPI\DI\SapiRequestExtension
2733
```
2834

35+
Otherwise, you can pass directly URL address.
36+
2937
```yaml
3038
extensions:
31-
cli: Contributte\Http\CliRequestExtension(https://contributte.org)
39+
sapi: Contributte\Http\SAPI\DI\SapiRequestExtension(https://contributte.org)
3240
```
3341

42+
List of all options:
43+
3444
```yaml
35-
cli:
36-
url: contributte.org
45+
sapi:
46+
url: https://contributte.org
3747
# other params
3848
query: NULL
3949
post: NULL

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ composer require contributte/http
2727
## Overview
2828

2929
- [Simple cURL client (CurlExtension)](https://github.com/contributte/http/blob/master/.docs/README.md#curl)
30-
- [URL in SAPI mode (CliRequestExtension)](https://github.com/contributte/http/blob/master/.docs/README.md#clirequest)
30+
- [URL in console / SAPI mode (CliRequestExtension)](https://github.com/contributte/http/blob/master/.docs/README.md#clirequest)
31+
- Collection of Utils:
32+
- [Url](https://github.com/contributte/http/blob/master/.docs/README.md#url)
3133

3234
-----
3335

composer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
],
1414
"require": {
1515
"php": ">= 5.6",
16-
"nette/http": "^2.4.2"
16+
"nette/http": "^2.4.3"
1717
},
1818
"require-dev": {
1919
"ninjify/qa": "^0.3.3",
2020
"ninjify/nunjuck": "^0.1.4",
21-
"nette/di": "^2.4.4"
21+
"nette/di": "^2.4.5"
2222
},
2323
"suggest": {
24-
"nette/di": "to use CurlExtension[CompilerExtension]"
24+
"nette/di": "to use CurlExtension or SapiRequestExtesion [CompilerExtension]"
2525
},
2626
"autoload": {
2727
"psr-4": {
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22

3-
namespace Contributte\Http\CliRequest\DI;
3+
namespace Contributte\Http\SAPI\DI;
44

55
use Nette\DI\CompilerExtension;
66
use Nette\DI\Statement;
@@ -11,7 +11,7 @@
1111
/**
1212
* @author Milan Felix Sulc <[email protected]>
1313
*/
14-
class CliRequestExtension extends CompilerExtension
14+
class SapiRequestExtension extends CompilerExtension
1515
{
1616

1717
/** @var array */

tests/cases/CliRequest/DI/CliRequestExtension.phpt renamed to tests/cases/SAPI/DI/SapiRequestExtension.phpt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?php
22

33
/**
4-
* Test: CliRequest\DI\CliRequestExtension
4+
* Test: SAPI\DI\SapiRequestExtension
55
*/
66

7-
use Contributte\Http\CliRequest\DI\CliRequestExtension;
7+
use Contributte\Http\SAPI\DI\SapiRequestExtension;
88
use Nette\Bridges\HttpDI\HttpExtension;
99
use Nette\DI\Compiler;
1010
use Nette\DI\Container;
@@ -18,7 +18,7 @@ test(function () {
1818
$loader = new ContainerLoader(TEMP_DIR, TRUE);
1919
$class = $loader->load(function (Compiler $compiler) {
2020
$compiler->addExtension('http', new HttpExtension(TRUE));
21-
$compiler->addExtension('cli', new CliRequestExtension('https://contributte.org'));
21+
$compiler->addExtension('sapi', new SapiRequestExtension('https://contributte.org'));
2222
}, 1);
2323

2424
/** @var Container $container */

0 commit comments

Comments
 (0)