Adding a complete example

eshcrow · Aug 13, 2018 · 6d612ea · 6d612ea
1 parent a96d8df
commit 6d612ea
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,12 @@ You can also pass directly the wanted phrase to the builder:
 $captcha = new CaptchaBuilder('hello');
 ```
 
+Complete example
+================
+
+If you want to see an example you can have a look at he ``demo/form.php``, which uses ``demo/session.php`` to
+render a captcha and check it after the submission
+
 Symfony Bundle
 ================
 

diff --git a/demo/form.php b/demo/form.php
@@ -0,0 +1,29 @@
+<?php
+// We need the session to check the phrase after submitting
+session_start();
+?>
+
+<html>
+<?php
+    if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+        // Checking that the posted phrase match the phrase stored in the session
+        if (isset($_SESSION['phrase']) && $_SESSION['phrase'] === $_POST['phrase']) {
+            echo "<h1>Captcha is valid !</h1>";
+        } else {
+            echo "<h1>Captcha is not valid!</h1>";
+        }
+        // The phrase can't be used twice
+        unset($_SESSION['phrase']);
+    }
+?>
+    <form method="post">
+        Copy the CAPTCHA:
+        <?php 
+            // See session.php, where the captcha is actually rendered and the session phrase
+            // is set accordingly to the image displayed
+        ?>
+        <img src="session.php" />
+        <input type="text" name="phrase" />
+        <input type="submit" />
+    </form>
+</html>
diff --git a/demo/session.php b/demo/session.php
@@ -0,0 +1,22 @@
+<?php
+// We need the session to store the correct phrase for later check
+session_start();
+
+// Including the autoload (you need to composer install in the main directory)
+require_once __DIR__.'/../vendor/autoload.php';
+
+use Gregwar\Captcha\CaptchaBuilder;
+
+// Creating the captcha instance and setting the phrase in the session to store
+// it for check when the form is submitted
+$captcha = new CaptchaBuilder;
+$_SESSION['phrase'] = $captcha->getPhrase();
+
+// Setting the header to image jpeg because we here render an image
+header('Content-Type: image/jpeg');
+
+// Running the actual rendering of the captcha image
+$captcha
+    ->build()
+    ->output()
+;