Benutzer Handbuch

Erforderliche Konfiguration

  1. Du musst deine Seite registrieren um ein API-Schlüsselpaar für reCAPTCHA zu erhalten: http://www.google.com/recaptcha/admin
  2. Trage diese Schlüssel in TypoScript ein:
1
2
3
4
5
6
7
8
plugin.tx_jhcaptcha {
    settings {
        reCaptcha {
            siteKey =
            secretKey =
        }
    }
}

Optionale Konfiguration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
plugin.tx_jhcaptcha {
    settings {
        reCaptcha {
            # Beschreibung: Farbe des Captchas
            # Optionen: dark | light
            # Standard: light
            theme = light
            # Beschreibung: Der Typ des Captchas
            # Optionen: audio | image
            # Standard: image
            type = image
            # Beschreibung: Die Sprache des Captchas
            # Optionen: https://developers.google.com/recaptcha/docs/language
            # Standard: en
            lang = en
            # Beschreibung: Die Größe des Captchas
            # Optionen: normal | compact
            # Standard: normal
            size = normal
        }
    }
}

Verwendung in Powermail

Das reCAPTCHA kann leicht in der Erweiterung Powermail verwendet werden. Folgende Schritte sind dafür notwendig:

Note

Bitte beachte, dass die Verwendung nur in den Powermail Versionen 2.2 - 3.11 getestet wurde! Höchstwahrscheinlich läuft es auch mit neueren Versionen.

1. Seiten-TSconfig

Zuerst muss ein neues Feld in Powermail für das reCAPTCHA erstellt werden. Füge dazu folgende Zeile im Seiten-TSconfig ein.

1
tx_powermail.flexForm.type.addFieldOptions.jhcaptcharecaptcha = reCAPTCHA (jh_captcha)

2. TypoScript

Nun muss Powermail noch mitgeteilt werden, wo das zugehörige Partial gefunden werden kann:

1
2
3
4
5
6
7
8
plugin.tx_powermail.view {
    partialRootPath >
    partialRootPaths >
    partialRootPaths {
        10 = EXT:powermail/Resources/Private/Partials/
        20 = EXT:jh_captcha/Resources/Private/Powermail/Partials/Jhcaptcharecaptcha
    }
}

3. Formular

Jetzt kannst du das reCAPTCHA in deinem Formular verwenden.

  1. Erstelle dazu in deinem Formular ein neues Feld, vergebe eine Bezeichnung (z.B. “Captcha”) und wähle den Typ “reCAPTCHA (jh_captcha)” aus.
../_images/Form1.jpg
  1. Wechsel nun in den Reiter “Erweitert”. Setze im Bereich “Feldüberprüfung” einen Haken bei “Pflichtfeld” und lasse das Feld “Überprüfung” leer.
../_images/Form2.jpg

Jetzt ist das reCAPTCHA einsatzbereit!

Verwendung in Formhandler

Das reCAPTCHA kann leicht in der Erweiterung Formhandler verwendet werden. Folgende Schritte sind dafür notwendig:

Note

Bitte beachte, dass die Verwendung nur in den Formhandler Versionen 2.0 und 2.3 - 2.4 getestet wurde! Versionen 2.1 und 2.2 funktionieren nicht, weil es dort einen Bug im error check gibt (behoben mit 2.3 http://www.typo3-formhandler.com/footer/history/release-notes/version-230/ )! Höchstwahrscheinlich läuft es auch mit neueren Versionen.

1. Mastertemplate

Zuerst muss das Captcha im Mastertemplate aufgenommen werden. Beispiel:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<!-- ###master_spamprotection-jh_captcha_recaptcha### -->
<div class="row">
    <div class="large-3 columns">
            <label class="###is_error_jh_captcha_recaptcha###">###LLL:jh_captcha_recaptcha### ###required_jh_captcha_recaptcha###</label>
    </div>
    <div class="large-9 columns">
            ###jh_captcha_recaptcha###
            ###error_jh_captcha_recaptcha###
    </div>
</div>
<!-- ###master_spamprotection-jh_captcha_recaptcha### -->

2. Template

Jetzt kann der Marker im Formular-Template verwendet werden:

1
###master_spamprotection-jh_captcha_recaptcha###

3. TypoScript

Danach müssen die Validatoren für das Captcha-Feld zugewiesen werden:

Formhandler 2.0:

1
2
3
4
5
6
7
8
[...]
validators.1.config.fieldConf {
    jh_captcha_recaptcha.errorCheck {
        1 = required
        2 = Tx_JhCaptcha_ErrorCheck_ReCaptcha
    }
}
[...]

Formhandler 2.3 - 2.4:

1
2
3
4
5
6
7
8
    [...]
    validators.1.config.fieldConf {
        jh_captcha_recaptcha.errorCheck {
            1 = required
            2 = \Haffner\JhCaptcha\Validation\ErrorCheck\ReCaptcha
        }
    }
    [...]

4. Sprachdatei

Zum Schluss muss noch das Label sowie die Fehlermeldungen definiert werden. Beispiel:

1
2
3
<label index="jh_captcha_recaptcha">reCAPTCHA</label>
<label index="error_jh_captcha_recaptcha_required">reCAPTCHA ist ein Pflichtfeld.</label>
<label index="error_jh_captcha_recaptcha_Tx_JhCaptcha_ErrorCheck_ReCaptcha">Fehler beim Validieren des reCAPTCHA.</label>

Anschließend ist das reCAPTCHA einsatzbereit.