Documentation for examples

Author: clue

examples/copy.php

@@ -24,7 +24,7 @@
 
 $tar = new Decoder();
 
-// use caret notation for any control characters expect \t, \r and \n
+// use caret notation for any control characters except \t, \r and \n
 $caret = new Encoder("\t\r\n");
 
 $tar->on('entry', function ($header, ReadableStreamInterface $file) use ($caret) {

examples/info.php

@@ -1,4 +1,5 @@
 <?php
+// this simple example displays system wide information from Docker as a simple JSON
 
 require __DIR__ . '/../vendor/autoload.php';
 
@@ -10,6 +11,8 @@
 $factory = new Factory($loop);
 $client = $factory->createClient();
 
-$client->info()->then('var_dump', 'var_dump');
+$client->info()->then(function ($info) {
+    echo json_encode($info, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) . PHP_EOL;
+}, 'printf');
 
 $loop->run();

examples/push.php

@@ -16,11 +16,8 @@
 $factory = new Factory($loop);
 $client = $factory->createClient();
 
-$client->imagePush($image, null, null, $auth)->then(
-    function ($response) {
-        echo 'response: ' . json_encode($response) . PHP_EOL;
-    },
-    'var_dump'
-);
+$client->imagePush($image, null, null, $auth)->then(function ($result) {
+    echo json_encode($result, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES) . PHP_EOL;
+}, 'printf');
 
 $loop->run();

examples/resize.php

@@ -1,4 +1,6 @@
 <?php
+// this example tries to adjust the TTY size of the given container to 10x10.
+// you can check this via "docker logs".
 
 require __DIR__ . '/../vendor/autoload.php';