Clean up examples

SimonFrings · SimonFrings · commit 0703ddaa3729 · 2020-09-08T12:20:37.000+02:00
diff --git a/examples/01-http-request.php b/examples/01-http-request.php
@@ -5,16 +5,21 @@
 //
 // $ php leproxy-latest.php
 //
-// To run the example, go to the project root and run:
+// The proxy defaults to localhost:8080.
+// To run the example go to the project root and run:
 //
 // $ php examples/01-http-requests.php
 //
-// The proxy can be given as first argument and defaults to localhost:8080 otherwise.
-use React\HTTP\Browser;
+// If you want to run the same example with any other proxy URL, just use:
+//
+// $ http_proxy=127.0.0.1:8181 php examples/01-http-requests.php
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$url = isset($argv[1]) ? $argv[1] : '127.0.0.1:8080';
+$url = getenv('http_proxy');
+if ($url === false) {
+    $url = '127.0.0.1:8080';
+}
 
 $loop = React\EventLoop\Factory::create();
 $proxy = new Clue\React\HttpProxy\ProxyConnector($url, new React\Socket\Connector($loop));
diff --git a/examples/02-optional-proxy-http-request.php b/examples/02-optional-proxy-http-request.php
@@ -5,9 +5,13 @@
 //
 // $ php examples/02-optional-proxy-http-request.php
 //
+// If you chose the optional route, you can use any kind of proxy, for example https://github.com/leproxy/leproxy and execute it like this:
+//
+// $ php leproxy-latest.php
+//
 // To run the same example with your proxy, the proxy URL can be given as an environment variable:
 //
-// $ http_proxy=127.0.0.1.8181 php examples/02-optional-proxy-http-request.php
+// $ http_proxy=127.0.0.1:8181 php examples/02-optional-proxy-http-request.php
 
 require __DIR__ . '/../vendor/autoload.php';
 
diff --git a/examples/11-proxy-raw-https-protocol.php b/examples/11-proxy-raw-https-protocol.php
@@ -5,22 +5,28 @@
 //
 // $ php leproxy-latest.php
 //
+// The proxy defaults to localhost:8080.
 // To run the example, go to the project root and run:
 //
 // $ php examples/11-proxy-raw-https-protocol.php
 //
-// The proxy can be given as first argument and defaults to localhost:8080 otherwise.
+// If you want to run the same example with any other proxy URL, just use:
+//
+// $ http_proxy=127.0.0.1:8181 php examples/11-proxy-raw-https-protocol.php
 //
 // For illustration purposes only. If you want to send HTTP requests in a real
-// world project, take a look at example #01 and https://github.com/reactphp/http#client-usage.
+// world project, take a look at example #01, example #02 and https://github.com/reactphp/http#client-usage.
 
 use Clue\React\HttpProxy\ProxyConnector;
 use React\Socket\Connector;
 use React\Socket\ConnectionInterface;
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$url = isset($argv[1]) ? $argv[1] : '127.0.0.1:8080';
+$url = getenv('http_proxy');
+if ($url === false) {
+    $url = '127.0.0.1:8080';
+}
 
 $loop = React\EventLoop\Factory::create();
 
diff --git a/examples/12-optional-proxy-raw-https-protocol.php b/examples/12-optional-proxy-raw-https-protocol.php
@@ -1,18 +1,24 @@
 <?php
 
-// A simple example which requests https://google.com/ either directly or through
-// an HTTP CONNECT proxy.
+// A simple example which requests https://google.com/ directly (optional: Through an HTTP CONNECT proxy.)
 // To run the example, go to the project root and run:
 //
 // $ php examples/12-optional-proxy-raw-https-protocol.php
 //
-// The Proxy can be given as first argument or does not use a proxy otherwise.
+// If you chose the optional route, you can use any kind of proxy, for example https://github.com/leproxy/leproxy and execute it like this:
+//
+// $ php leproxy-latest.php
+//
+// To run the same example with your proxy, the proxy URL can be given as an environment variable:
+//
+// $ http_proxy=127.0.0.1:8181 php examples/12-optional-proxy-raw-https-protocol.php
+//
 // This example highlights how changing from direct connection to using a proxy
 // actually adds very little complexity and does not mess with your actual
 // network protocol otherwise.
 //
 // For illustration purposes only. If you want to send HTTP requests in a real
-// world project, take a look at example #01 and https://github.com/reactphp/http#client-usage.
+// world project, take a look at example #01, example #02 and https://github.com/reactphp/http#client-usage.
 
 use Clue\React\HttpProxy\ProxyConnector;
 use React\Socket\Connector;
@@ -24,9 +30,9 @@
 
 $connector = new Connector($loop);
 
-// first argument given? use this as the proxy URL
-if (isset($argv[1])) {
-    $proxy = new ProxyConnector($argv[1], $connector);
+$url = getenv('http_proxy');
+if ($url !== false) {
+    $proxy = new ProxyConnector($url, $connector);
     $connector = new Connector($loop, array(
         'tcp' => $proxy,
         'timeout' => 3.0,
diff --git a/examples/13-custom-proxy-headers.php b/examples/13-custom-proxy-headers.php
@@ -5,22 +5,28 @@
 //
 // $ php leproxy-latest.php
 //
+// The proxy defaults to localhost:8080.
 // To run the example, go to the project root and run:
 //
 // $ php examples/13-custom-proxy-headers.php
 //
-// The proxy can be given as first argument and defaults to localhost:8080 otherwise.
+// If you want to run the same example with any other proxy URL, just use:
+//
+// $ http_proxy=127.0.0.1:8181 php examples/13-custom-proxy-headers.php
 //
 // For illustration purposes only. If you want to send HTTP requests in a real
-// world project, take a look at example #01 and https://github.com/reactphp/http#client-usage.
+// world project, take a look at example #01, example #02 and https://github.com/reactphp/http#client-usage.
 
 use Clue\React\HttpProxy\ProxyConnector;
 use React\Socket\Connector;
 use React\Socket\ConnectionInterface;
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$url = isset($argv[1]) ? $argv[1] : '127.0.0.1:8080';
+$url = getenv('http_proxy');
+if ($url === false) {
+    $url = '127.0.0.1:8080';
+}
 
 $loop = React\EventLoop\Factory::create();
 
diff --git a/examples/21-proxy-raw-smtp-protocol.php b/examples/21-proxy-raw-smtp-protocol.php
@@ -5,11 +5,15 @@
 //
 // $ php leproxy-latest.php
 //
+// The proxy defaults to localhost:8080.
 // To run the example, go to the project root and run:
 //
 // $ php examples/21-proxy-raw-smtp-protocol.php
 //
-// The proxy can be given as first argument and defaults to localhost:8080 otherwise.
+// If you want to run the same example with any other proxy URL, just use:
+//
+// $ http_proxy=127.0.0.1:8181 php examples/21-proxy-raw-smtp-protocol.php
+//
 // Please note that MANY public proxies do not allow SMTP connections, YMMV.
 
 use Clue\React\HttpProxy\ProxyConnector;
@@ -18,7 +22,10 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$url = isset($argv[1]) ? $argv[1] : '127.0.0.1:8080';
+$url = getenv('http_proxy');
+if ($url === false) {
+    $url = '127.0.0.1:8080';
+}
 
 $loop = React\EventLoop\Factory::create();
 
diff --git a/examples/22-proxy-raw-smtps-protocol.php b/examples/22-proxy-raw-smtps-protocol.php
@@ -5,11 +5,15 @@
 //
 // $ php leproxy-latest.php
 //
+// The proxy defaults to localhost:8080.
 // To run the example, go to the project root and run:
 //
 // $ php examples/22-proxy-raw-smtps-protocol.php
 //
-// The proxy can be given as first argument and defaults to localhost:8080 otherwise.
+// If you want to run the same example with any other proxy URL, just use:
+//
+// $ http_proxy=127.0.0.1:8181 php examples/22-proxy-raw-smtps-protocol.php
+//
 // This example highlights how changing from plain connections (see previous
 // example) to using a secure connection actually adds very little complexity
 // and does not mess with your actual network protocol otherwise.
@@ -21,7 +25,10 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$url = isset($argv[1]) ? $argv[1] : '127.0.0.1:8080';
+$url = getenv('http_proxy');
+if ($url === false) {
+    $url = '127.0.0.1:8080';
+}
 
 $loop = React\EventLoop\Factory::create();
 
