En poursuivant votre navigation sur ce site, vous acceptez l’utilisation de Cookies pour réaliser des statistiques de visites.

09 54 46 51 10

du lundi au vendredi de 08h à 19h

Classe: Field


Classe permettant de générer des champs pour des formulaires.


Variables

id

L'id du champ. Un id aléatoire sera défini si null.

name

Le name du champ. id sera utilisé si aucun "name" n’est défini.

title

Le label du champ. Sera utilisé comme "placeholder" si aucun placeholder n'est défini et que isInlineest true.

Si le format est title, le titre du champ.

format (défaut: 'text')

  • text
  • textarea
  • password
  • address
  • radio
  • checkbox
  • singleCheckbox
  • select
  • multiSelect
  • monthYearSelect
  • date
  • dateTime
  • time
  • country
  • captcha
  • button
  • submit
  • title
  • hidden

description

Une description qui sera affichée sous le champ.

placeholder

Un texte affiché dans le champ si aucune valeur n'est définie.

isRequired (défaut: false)

Définir à true si une valeur est requise pour la validation du formulaire. Un validator doit pour cela être défini.

validator

Détermine quel type de valeur le champ devrait avoir.

Options possibles :

  • text: texte non vide
  • textarea: texte non vide
  • phone: texte non vide + ^[0-9 .\/\+\-\(\)]*$
  • mail: texte non vide + ^([a-z0-9._-]+@[a-z0-9._-]{2,}\.[a-z]{2,4})$
  • date: Une date valide dans la langue affichée
  • dateTime: Une date/heure valide dans la langue affichée
  • time: Une heure valide dans la langue affichée
  • dateISO: ^([0-9]{4})-([0-9]{2})-([0-9]{2})$
  • address: Une adresse complète
  • number: texte non vide + ^([0-9]*)$

className

Le nom de la classe CSS à définir du champ.

labelSize (défaut: 4)

La taille du label. La taille du label et du champ doit au maximum être égale à 12.

inputSize (défaut: 8)

La taille du champ. la taille du label et du champ doit au maximum être égale à 12.

isInline (défaut: false)

Si le label doit être affiché dans le champ comme placeholder.

accesskey

tooltip

Une bulle d'information affichée au survol du label.

items

La liste des options possible pour les champs de type select, multiSelect, checkbox et radio.

Format:

{% set items = {'value': 'title', 'value2': 'title2'} %}

value

La valeur du champ

buttonType (défaut: default)

Le type de bouton pour les champs de type button et submit.

Valeurs possible :

  • default
  • primary
  • info
  • success
  • warning
  • danger

textareaRow (défaut: 5)

Le nombre de lignes pour les champs de type textarea.

canUnmaskPassword (défaut: true)

Si le mot de passe peut être affiché en clair pour les champs de type password.

singleCheckboxLabel

Le label pour les champs de type singleCheckbox.


Méthodes

renderFormGroup

Permets de générer un champ avec un label. Le champ sera généré avec la fonction renderInput. Toutes les options de renderInput peuvent donc être utilisées.

Arguments

  • options : Un objet contenant les variables de la classe.

Valeur de retour

Le code HTML permettant d'afficher le champ.

Exemple

{{ view.renderFormGroup({ name: 'message', title: 'Message'|trans, format: 'textarea', isRequired: true, validator: 'textaera', textareaRow: 5 }) }}

renderInput

Permets de générer un champ.

Arguments

  • options: Un objet pouvant contenir les variables suivantes :
    • id
    • name
    • title
    • value
    • format
    • textareaRow
    • items
    • singleCheckboxLabel
    • placeholder
    • description
    • prepend
    • append
    • canUnmaskPassword

Valeur de retour

Le code HTML permettant d'afficher le champ.

Exemple

{{ view.renderInput({ name: 'mail', format: 'text', labelSize: 3, inputSize: 8 }) }}

getFormattedValue

Permets de récupérer la valeur formatée d'un champ en vue de l'afficher.

Valeur de retour

La valeur du champ au format HTML.

Exemple

<b>{{ field.getFormattedValue }}</b>

{# ou #}

<b>{{ field.getFormattedValue() }}</b>

getValue

Permets de récupérer la valeur brute d'un champ.

Exemple

{% set fieldValue = field.getValue %}