Add documentation about LSformRule :: callable

This commit is contained in:
Benjamin Renard 2017-08-22 15:06:47 +02:00
parent bf5fcf3244
commit e0641191b7
3 changed files with 26 additions and 0 deletions

View file

@ -45,6 +45,7 @@ règles.</para>
</variablelist>
&conf-LSattribute-check-data-alphanumeric;
&conf-LSattribute-check-data-callable;
&conf-LSattribute-check-data-date;
&conf-LSattribute-check-data-email;
&conf-LSattribute-check-data-filesize;

View file

@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!ENTITY conf-LSattribute-check-data-alphanumeric SYSTEM "alphanumeric.docbook">
<!ENTITY conf-LSattribute-check-data-callable SYSTEM "callable.docbook">
<!ENTITY conf-LSattribute-check-data-date SYSTEM "date.docbook">
<!ENTITY conf-LSattribute-check-data-email SYSTEM "email.docbook">
<!ENTITY conf-LSattribute-check-data-filesize SYSTEM "filesize.docbook">

View file

@ -0,0 +1,24 @@
<sect4 id="config-LSattribute-check-data-callable">
<title>callable</title>
<para>Cette règle vérifie que la valeur saisie est correcte en utilisant une
fonction personnalisée. Cette fonction devra prendre en paramètres la valeur à
valider, le tableau des paramètres de la règle ainsi qu'un pointeur sur l'objet
<emphasis>LSformElement</emphasis>. Sur la base de ses informations, elle devra
valider la valeur et retourner <literal>True</literal> si la valeur est valide
et <literal>False</literal> sinon.</para>
<variablelist>
<title>Paramètres de configuration</title>
<varlistentry>
<term>callable</term>
<listitem>
<simpara>Le nom de la fonction (ou tout autre <literal>callable</literal> au sens PHP)
de validation.</simpara>
</listitem>
</varlistentry>
</variablelist>
</sect4>