SPIP

[ar] [ast] [bg] [br] [ca] [co] [cpf] [cs] [da] [de] [en] [eo] [es] [eu] [fa] [fon] [fr] [gl] [id] [it] [ja] [lb] [nl] [oc] [pl] [pt] [ro] [ru] [sk] [sv] [tr] [uk] [vi] [zh] Espace de traduction

Download

Bijvoorbeeld CVT formulieren

Een contactformulier in 4 stappen

17 februari

Alle versies van dit artikel:

CVT betekent Charger-Vérifier-Traiter, ofwel laden-verifiëren-verwerken en is een programmeermethode voor formulieren in SPIP.


Stap 1: We maken het skelet voor het formulier

In de submap formulaires/ van je map squelettes/ zet je een bestand met de naam contact.html dat de HTML voor het formulier gaat bevatten. Bijvoorbeeld:

  1. <form action='#ENV{action}' method='post'>
  2.         #ACTION_FORMULAIRE{#ENV{action}}
  3.         <label>Je emailadres</label>
  4.         <input type='text' name='email' value='#ENV{email}' />
  5.         <br />
  6.         <label>Je bericht</label>
  7.         <textarea name='message'>#ENV{message}</textarea>
  8.         <input type='submit' name='ok' value='ok' />
  9. </form>

Zoals je ziet bevat het slechts enkele opvallende onderdelen:

  • het attribuut action van de tag <form> bevat #ENV{action} wat de URL is waarnaar het formulier zal worden verzonden;
  • #ACTION_FORMULAIRE{#ENV{action}} vertelt SPIP de gegevens te verzenden volgens de CVT methode en deze gegevens eventueel via de URL door te geven. Vanaf SPIP 2.1 is #ENV{action} In feite nutteloos, omdat het de standaardmethode is geworden;
  • elke input, textarea of select bevat de waarde #ENV{xxx} waarbij xxx overeen komt met het attribuut name.

In dit stadium kan het formulier al in een skelet worden weergegeven met het baken #FORMULAIRE_CONTACT of direct in de tekst van een artikel met <formulaire|contact>. Je kunt het formulier testen en aanpassen zoner één regel PHP te hebben geschreven.

Maar druk je op de knop OK, dan gebeurt er niet en je vindt je invoer nergens terug.

Stap 2: De functie laden

We gaan nu aangeven welke velden de bezoeker kan invullen.

Maak hiervoor een bestand contact.php in de submap formulaires/, naast je skelet contact.html, waarin je de volgende code opneemt:

  1. <?php
  2.  
  3. function formulaires_contact_charger_dist(){
  4.         $valeurs = array('email'=>'','message'=>'');
  5.        
  6.         return $valeurs;
  7. }
  8. ?>

Wat doet deze code?

Het declareert de functie charger van het formulier contact in de map formulaires hierna genoemd formulaires_contact_charger.
De suffix _dist duidt aan dat het om een functie (charger) gaat die standaard voor dit formulier moet worden geladen, maar ze kan eventueel worden aangepast (zie hiervoor programmer.spip.org).

Deze functie beschrijft in de variabele $valeurs de invoervelden van het formulier en voor ieder veld de standaardwaarde.
De functie formulaires_contact_charger_dist verstuurt dus deze lijst van velden.

Test het formulier opnieuw: vul je de velden in en op de OK knop klikt, zie je dat de gegevens nu in het formulier blijven staan (maar verder gebeurt er nog niets).

In dit voorbeeld zijn alle velden standaard leeg. We kunnen dit verbeteren door automatisch het emailveld in te vullen wanneer de bezoeker is aangemeld.
we doen het met de volgende code:

  1. function formulaires_contact_charger_dist(){
  2.         $valeurs = array('email'=>'','message'=>'');
  3.         if (isset($GLOBALS['visiteur_session']['email']))
  4.                 $valeurs['email'] = $GLOBALS['visiteur_session']['email'];
  5.         return $valeurs;
  6. }

Test je nu het formulier, dan zul je (omdat je bent aangemeld) zien:

  • dat het veld voor het emailadres al is ingevuld;
  • dat de ingevoerde waardes worden bewaard na validatie.

Stap 3: De ingevoerde gegevens verifiëren

Voordat we de ingevoerde gegevens willen toepassen, gaan we eerst controleren of die gegevens wel correct zijn.

We gaan de volgende voorwaarden stellen:

  • de velden email en message zijn verplicht;
  • het emailadres moet worden gevalideerd.

Om de invoer te verifiëren gaan we de functie formulaires_contact_verifier_dist opnemen (in hetzelfde model als de functie charger) en ook in het bestand contact.php:

  1. function formulaires_contact_verifier_dist(){
  2.         $erreurs = array();
  3.         // verifieer of de verplichte velden zijn ingevoerd:
  4.         foreach(array('email','message') as $obligatoire)
  5.                 if (!_request($obligatoire)) $erreurs[$obligatoire] = 'Dit veld is verplicht';
  6.        
  7.         // verifieer de geldigheid van het emailadres:
  8.         include_spip('inc/filtres');
  9.         if (_request('email') AND !email_valide(_request('email')))
  10.                 $erreurs['email'] = 'Dit emailadres is niet geldig';
  11.  
  12.         if (count($erreurs))
  13.                 $erreurs['message_erreur'] = 'Je invoer bevat fouten!';
  14.         return $erreurs;
  15. }

Opmerking: het gebruik van _request() wordt uitgelegd op de site programmer.spip.org

De functie verifier zendt een lijst van velden met fouten, met voor ieder veld de bijbehorende foutboodschap.

Op dit punt zie je, wanneer je het formulier test, nog geen enkel verschil: je formulier contact.html geeft nog geen foutboodschappen. We moeten hun plaats namelijk nog op het formulier aangeven:

  1. [<p class='formulaire_erreur'>(#ENV*{message_erreur})</p>]
  2. <form action='#ENV{action}' method='post'>
  3.         #ACTION_FORMULAIRE{#ENV{action}}
  4.         <label>Je emailadres</label>
  5.         [<span class='erreur'>(#ENV**{erreurs}|table_valeur{email})</span>]
  6.         <input type='text' name='email' value='#ENV{email}' />
  7.         <br />
  8.         <label>Je bericht</label>
  9.         [<span class='erreur'>(#ENV**{erreurs}|table_valeur{message})</span>]
  10.         <textarea name='message'>#ENV{message}</textarea>
  11.         <input type='submit' name='ok' value='ok' />
  12. </form>

Merk op:

  • de weergave van de algemene foutboodschap die wordt verzonden door de functie verifier:
    [<p class='reponse_formulaire reponse_formulaire_erreur'>(#ENV*{message_erreur})</p>]
  • de foutboodschappen vóór ieder veld:
    [<span class='erreur_message'>(#ENV**{erreurs}|table_valeur{email})</span>].

Test je formulier nu opnieuw met een onjuist emailadres of laat een veld leeg: de interactie met je bezoeker is een feit!

Stap 4: Verwerken!

Wanneer de functie verifier geen fout verzendt, zal SPIP automatisch de functie traiter starten. Deze functie formulaires_contact_traiter_dist (nog altijd in het bestand contact.php moet een mail naar de webmaster gaan verzenden:

  1. function formulaires_contact_traiter_dist(){
  2.         $envoyer_mail = charger_fonction('envoyer_mail','inc');
  3.         $email_to = $GLOBALS['meta']['email_webmaster'];
  4.         $email_from = _request('email');
  5.         $sujet = 'Contactformulier';
  6.         $message = _request('message');
  7.         $envoyer_mail($email_to,$sujet,$message,$email_from);
  8.         return array('message_ok'=>'Je bericht werd verzonden. We zorgen zo spoedig mogelijk voor een antwoord!');
  9. }

Je ziet dat de functie traiter geen enkele verificatie doet: dat is allemaal al gebeurd. De functie wordt immers pas aangeroepen wanneer er geen fouten zijn gevonden.

De functie traiter verzend een bevestiging, « message_ok », in tabelvorm. Net als voor de foutboodschappen, moeten we hier een plaats voor reserveren op ons formulier. Dat doen we alsvolgt:

  1. [<p class='formulaire_ok'>(#ENV*{message_ok})</p>]
  2. [<p class='formulaire_erreur'>(#ENV*{message_erreur})</p>]
  3. [(#EDITABLE|oui)
  4.         <form action='#ENV{action}' method='post'>
  5.                 #ACTION_FORMULAIRE{#ENV{action}}
  6.                 <label>Je emailadres</label>
  7.                 [<span class='erreur'>(#ENV**{erreurs}|table_valeur{email})</span>]
  8.                 <input type='text' name='email' value='#ENV{email}' />
  9.                 <br />
  10.                 <label>Je bericht</label>
  11.                 [<span class='erreur'>(#ENV**{erreurs}|table_valeur{message})</span>]
  12.                 <textarea name='message'>#ENV{message}</textarea>
  13.                 <input type='submit' name='ok' value='ok' />
  14.         </form>
  15. ]

Merk op:

  • de succesboodschap aan het begin:
    [<p class="formulaire_message">(#ENV*{message_ok})</p>]
  • de conditionele weergave van het formulier in functie van het baken #EDITABLE: na de invoer is het beter om de invoer niet meer te tonen, maar wel de succesboodschapaprès la saisie. #EDITABLE zorgt daar voor.

Tip: In sommige gevallen wil je een lus (BOUCLE) in het formulier opnemen (om bijvoorbeeld een selectie uit de database voor te stellen). Het gebruik van #EDITABLE en deze lus genereert een fout. De oplossing is om een lus CONDITION Toe te voegen zoals hieronder getoond:

  1.     [<p class='formulaire_ok'>(#ENV*{message_ok})</p>]
  2.     [<p class='formulaire_erreur'>(#ENV*{message_erreur})</p>]
  3.     <BOUCLE_editable(CONDITION){si #ENV{editable}|oui}>
  4.             <form action='#ENV{action}' method='post'>
  5.                     #ACTION_FORMULAIRE{#ENV{action}}
  6.                    <BOUCLE_article(ARTICLES}{0,1}>#TITRE</BOUCLE_article>
  7.              <label>Je emailadres</label>
  8.                     [<span class='erreur'>(#ENV**{erreurs}|table_valeur{email})</span>]
  9.                     <input type='text' name='email' value='#ENV{email}' />
  10.                     <br />
  11.                     <label>Je bericht</label>
  12.                     [<span class='erreur'>(#ENV**{erreurs}|table_valeur{message})</span>]
  13.                     <textarea name='message'>#ENV{message}</textarea>
  14.                     <input type='submit' name='ok' value='ok' />
  15.             </form>
  16.     </BOUCLE_editable>

Klaar! Je kunt het contactformulier gebruiken.

De bonus

Wil je de interactie wat versnellen en niet steeds opnieuw de gehele pagina laden?

Dat kan dankzij de ajax functionaliteit. Het resultaat is een snellere interactie, maar de implementatie vraagt normaal veel tijd en testen. In SPIP kun je dankzij de CVT-methode je formulieren vrij eenvoudig omzetten in ajax.

je moet daarvoor het formulier in een div met class=ajax insluiten:

  1. <div class='ajax'>
  2. #FORMULAIRE_CONTACT
  3. </div>

En dat is alles!

Nog een stap verder

-  Het formulier in dit voorbeeld ziet er niet geweldig uit. Voor een meer esthetisch resultaat kun je de aanbevelingen in Structure HTML des formulaires de SPIP op al je formulieren toepassen;
-  Alles over de functie charger(): De functie charger() van een CVT-formulier
-  Alles over de functie verifier(): De functie verifier() van een CVT-formulier
-  Alles over de functie traiter(): De functie traiter() van een CVT-formulier


Het skelet van deze bladzijde zien Site gebouwd met SPIP | Vertaalruimte | Privé-site