PageRenderTime 18ms CodeModel.GetById 11ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/languages/fr/modules/zend.console.getopt.rules.rst

https://github.com/Xerkus/zf2-documentation
ReStructuredText | 90 lines | 60 code | 30 blank | 0 comment | 0 complexity | 6d9d27c5156a0e83038da726bf20b40c MD5 | raw file
 1.. EN-Revision: none
 2.. _zend.console.getopt.rules:
 3
 4Déclarer les règles Getopt
 5==========================
 6
 7Le constructeur de la classe ``Zend\Console\Getopt`` prend un à trois arguments. Le premier argument déclare
 8quelles options sont supportées par votre application. Cette classe supporte des formes de syntaxe alternatives
 9pour déclarer les options. Voir les sections ci-dessous pour le format et l'utilisation de ces formes de syntaxe.
10
11Le constructeur prend deux arguments supplémentaires, qui sont facultatifs. Le deuxième argument peut contenir
12les arguments de la ligne de commande. La valeur par défaut est ``$_SERVER['argv']``.
13
14Le troisième argument du constructeur peut contenir des options de configuration pour adapter le comportement de
15``Zend\Console\Getopt``. Voir la section :ref:`Ajouter une configuration
16<zend.console.getopt.configuration.config>` pour la référence des options disponibles.
17
18.. _zend.console.getopt.rules.short:
19
20Déclarer des options avec la syntaxe courte
21-------------------------------------------
22
23``Zend\Console\Getopt`` supporte une syntaxe compacte semblable à cela employée par *GNU* Getopt (voir
24http://www.gnu.org/software/libc/manual/html_node/Getopt.html). Cette syntaxe supporte seulement des drapeaux
25courts (1 seul caractère). Dans une chaîne de caractère unique, vous entrez chacune des lettres qui
26correspondent aux drapeaux supportés par votre application. Une lettre suivie d'un caractère deux points
27("**:**") indique un drapeau qui exige un paramètre.
28
29.. _zend.console.getopt.rules.short.example:
30
31.. rubric:: Utiliser la syntaxe courte
32
33.. code-block:: php
34   :linenos:
35
36   $opts = new Zend\Console\Getopt('abp:');
37
38L'exemple ci-dessus montre l'utilisation de ``Zend\Console\Getopt`` pour déclarer que des options peuvent être
39données en tant que "``-a``", "``-b``" ou "``-p``". Le dernier drapeau exige un paramètre.
40
41La syntaxe courte est limitée aux drapeaux courts (1 seul caractère). Les alias, les types des paramètres, et
42les messages d'aide ne sont pas supportés dans la syntaxe courte.
43
44.. _zend.console.getopt.rules.long:
45
46Déclarer des options avec la syntaxe longue
47-------------------------------------------
48
49Une syntaxe différente avec plus de possibilités est également disponible. Cette syntaxe permet d'indiquer des
50alias pour les drapeaux, les types de paramètres d'option, et aussi des messages d'aide pour décrire
51l'utilisation à l'utilisateur. Au lieu d'utiliser une chaîne de caractère unique comme pour la syntaxe courte,
52la syntaxe longue emploie un tableau associatif comme premier argument du constructeur pour déclarer les options.
53
54La clé de chaque élément du tableau associatif est une chaîne avec un format qui nomme le drapeau, avec tous
55ses alias, séparés par le symbole "**|**". Après la série des alias, si l'option exige un paramètre, il y a un
56symbole égal ("**=**") avec une lettre qui représente le **type** du paramètre :
57
58- "**=s**" pour un paramètre de type chaîne de caractère.
59
60- "**=w**" pour un paramètre de type mot (une chaîne de caractère qui ne contient pas d'espace).
61
62- "**=i**" pour un paramètre de type entier (integer).
63
64Si le paramètre est optionnel, on utilise le tiret ("**-**") au lieu du symbole égal.
65
66La valeur de chaque élément dans le tableau associatif est un message d'aide pour décrire à l'utilisateur
67comment employer votre programme.
68
69.. _zend.console.getopt.rules.long.example:
70
71.. rubric:: Utiliser la syntaxe longue
72
73.. code-block:: php
74   :linenos:
75
76   $opts = new Zend\Console\Getopt(
77     array(
78       'abricot|a'  => 'option abricot, sans paramètres',
79       'banane|b=i' => 'option banane, avec un paramètre entier obligatoire',
80       'pear|p-s'   => 'option pear, avec un paramètre chaîne optionel'
81     )
82   );
83
84Dans l'exemple ci-dessus, il y a trois options. "``--abricot``" et "``-a``" sont des alias l'un pour l'autre et
85l'option ne prend pas de paramètres. "``--banane``" et "``-b``" sont des alias l'un pour l'autre et l'option prend
86un paramètre obligatoire de type entier. Enfin, "``--pear``" et "``-p``" sont des alias l'un pour l'autre et
87l'option prend un paramètre optionnel de type chaîne de caractère.
88
89
90