Captcha

Captcha

Installation

Mit Komponist:

{
    ...
    "require" : {
        "gregwar/captcha" : " 1.* "
    }
}

Verwendung

Sie können ein Captcha mit dem CaptchaBuilder erstellen:

 <?php

use Gregwar  Captcha  CaptchaBuilder ;

$ builder = new CaptchaBuilder ;
$ builder -> build ();

Anschließend können Sie es in einer Datei speichern:

 <?php

$ builder -> save ( ' out.jpg ' );

Oder direkt ausgeben:

 <?php

header ( ' Content-type: image/jpeg ' );
$ builder -> output ();

Oder integrieren Sie es direkt in die HTML-Seite:

<img src=" <?php echo $ builder->inline(); ?> " />

Sie können den Code abrufen und mit einer Benutzereingabe vergleichen:

 <?php

// Example: storing the phrase in the session to test for the user 
// input later
$ _SESSION [ ' phrase ' ] = $ builder -> getPhrase ();

Sie können den Satz mit Benutzereingaben vergleichen:

 if ( $ builder -> testPhrase ( $ userInput )) {
    // instructions if user phrase is good
}
else {
    // user phrase is wrong
}

API

Diese Funktionen können Sie nutzen:

• __construct($phrase = null) , erstellt den Builder mit der angegebenen Phrase. Wenn die Phrase null ist, wird eine zufällige Phrase generiert
• Mit getPhrase() können Sie den Phraseninhalt abrufen
• setDistortion($distortion) , aktivieren oder deaktivieren Sie die Verzerrung, rufen Sie sie vor build() auf
• isOCRReadable() gibt true zurück, wenn die OCR mit der ocrad -Software gelesen werden kann. Sie müssen Shell_exec aktiviert, Imagemagick und ocrad installiert haben
• buildAgainstOCR($width = 150, $height = 40, $font = null) erstellt einen Code, bis er für ocrad nicht mehr lesbar ist
• build($width = 150, $height = 40, $font = null) , erstellt einen Code mit der angegebenen $width, $height und $font. Standardmäßig wird eine zufällige Schriftart aus der Bibliothek verwendet
• save($filename, $quality = 80) , speichert das Captcha in einer JPEG-Datei im $filename, mit der angegebenen Qualität
• get($quality = 80) , gibt die JPEG-Daten zurück
• Output($quality = 80) , gibt den JPEG-Code direkt an einen Browser aus
• setBackgroundColor($r, $g, $b) , legt die Hintergrundfarbe fest, um sie zu erzwingen (dies deaktiviert viele Effekte und wird nicht empfohlen)
• setBackgroundImages(array($imagepath1, $imagePath2)) , Legt benutzerdefinierte Hintergrundbilder fest, die als Captcha-Hintergrund verwendet werden sollen. Es wird empfohlen, Bildeffekte zu deaktivieren, wenn benutzerdefinierte Bilder als Hintergrund übergeben werden (ignore_all_effects). Aus der übergebenen Liste wird ein zufälliges Bild ausgewählt, die vollständigen Pfade zu den Bilddateien müssen übergeben werden.
• setInterpolation($interpolate) , aktivieren oder deaktivieren Sie die Interpolation (standardmäßig aktiviert). Das Deaktivieren geht schneller, aber die Bilder sehen hässlicher aus
• setIgnoreAllEffects($ignoreAllEffects) , alle Effekte auf dem Captcha-Bild deaktivieren. Empfohlen für die Übergabe benutzerdefinierter Hintergrundbilder für das Captcha.
• testPhrase($phrase) gibt true zurück, wenn die angegebene Phrase gut ist
• setMaxBehindLines($lines) legt die maximale Anzahl von Zeilen hinter dem Code fest
• setMaxFrontLines($lines) legt die maximale Anzahl von Zeilen auf der Vorderseite des Codes fest

Wenn Sie die Anzahl der Zeichen ändern möchten, können Sie den Phrase Builder direkt über zusätzliche Parameter aufrufen:

 use Gregwar  Captcha  CaptchaBuilder ;
use Gregwar  Captcha  PhraseBuilder ;

// Will build phrases of 3 characters
$ phraseBuilder = new PhraseBuilder ( 4 );

// Will build phrases of 5 characters, only digits
$ phraseBuilder = new PhraseBuilder ( 5 , ' 0123456789 ' );

// Pass it as first argument of CaptchaBuilder, passing it the phrase
// builder
$ captcha = new CaptchaBuilder ( null , $ phraseBuilder );

Sie können den gewünschten Satz auch direkt an den Builder übergeben:

 // Building a Captcha with the "hello" phrase
$ captcha = new CaptchaBuilder ( ' hello ' );

Vollständiges Beispiel

Wenn Sie ein Beispiel sehen möchten, können Sie sich die demo/form.php ansehen, die demo/session.php verwendet, um ein Captcha zu rendern und es nach der Übermittlung zu überprüfen

Symfony-Bundle

Sie können sich das folgende Repository ansehen, um das Symfony 2-Bundle zu genießen, das diesen Captcha-Generator enthält: https://github.com/Gregwar/CaptchaBundle

Yii2-Erweiterung

Sie können die folgende Erweiterung für die Integration mit Yii2 Framework verwenden: https://github.com/juliardi/yii2-captcha

Lizenz

Diese Bibliothek steht unter MIT-Lizenz. Schauen Sie sich die LICENSE Datei an