Skip to content

Commit

Permalink
Added PHP style usage description in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tyrant88 committed Dec 8, 2016
1 parent 5cff5e1 commit 575a2b4
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 12 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Changelog
=========


Version 1.1.5 – 08.12.2016
--------------------------

* Added PHP style usage description in readme


Version 1.1.4 – 08.12.2016
--------------------------

Expand Down
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,22 @@ Mindestvoraussetzungen
Verwendung
----------

<pre>action|cr_recipient|emailfield|0/1/actionfield|anrede,titel,vorname,nachname,firma</pre>
<pre>action|cr_recipient|emailfield|0/1/actionfield|anrede,titel,vorname,nachname,firma|errormsg</pre>

bzw. per PHP:

<pre> &lt;?php $yform->setActionField('cr_recipient', array('emailfield', 1, 'anrede,titel,vorname,nachname,firma','Fehler bei der Registrierung')); ?></pre>

Parameter
----------

- `emailfeld` - gibt das Feld im Formular an, das die E-Mail-Adresse enthält.
- `0/1/actionfeld` - Hier wird die durchzuführende Aktion gewählt ( 0 = Abmelden, 1 = Anmelden)
bzw. ein Feld im Formular angegeben, das die entsprechenden Werte liefert, also z.B. ein Radio Feld
zur Auswahl durch den Benutzer.
- `anrede,titel,vorname,nachname,firma`
Eine komma-separierte Liste von Formularfeldern, die an cleverreach übermittelt werden soll.
* `emailfeld` - gibt das Feld im Formular an, das die E-Mail-Adresse enthält.
* `0/1/actionfeld` - Hier wird die durchzuführende Aktion gewählt ( 0 = Abmelden, 1 = Anmelden)
bzw. ein Feld im Formular angegeben, das die entsprechenden Werte liefert, also z.B. ein Radio Feld
zur Auswahl durch den Benutzer.
* `anrede,titel,vorname,nachname,firma`
Eine komma-separierte Liste von Formularfeldern, die an cleverreach übermittelt werden soll.
* `errormsg` - Hier können die Fehlermeldungen der **cleverreach-API** mit einer Endnutzerfreundlichen Variante überschrieben werden


Einstellungen:
Expand All @@ -35,10 +39,10 @@ Einstellungen:
Einstellungen müssen gemacht werden, die die Schnittstelle zu cleverreach benötigt.
Das sind:

1. API - Key (Schlüssel)
2. Eine Adressengruppe
3. Ein An- / Abmeldeformular
4. Ein Text, an dem man später erkennen kann, dass die Adressen über diese Website eingetragen wurden (optional)
1. API - Key (Schlüssel)
2. Eine Adressengruppe
3. Ein An- / Abmeldeformular
4. Ein Text, an dem man später erkennen kann, dass die Adressen über diese Website eingetragen wurden (optional)


Nach Eingabe des API-Schlüssels ( den Sie bei <a href="http://www.cleverreach.de/frontend/?rk=12968pvmjlnca" target="_blank">cleverreach</a> unter "Account --> Extras --> SOAP API mit Druck auf den Knopf "API Key erstellen" erzeugen können )
Expand Down
2 changes: 1 addition & 1 deletion package.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Alle hier gesetzten Werte können über $addon->getProperty($key) abgefragt werden

package: lus_cleverreach # Pflichtfeld
version: '1.1.4' # Pflichtfeld
version: '1.1.5' # Pflichtfeld
author: Laut und Schoen
supportpage: https://github.com/tyrant88/lus_cleverreach

Expand Down

0 comments on commit 575a2b4

Please sign in to comment.