Après avoir déclaré les options que l'objet de Zend_Console_Getopt doit identifier, et fourni les arguments de la ligne de commande ou un tableau, vous pouvez interroger l'objet pour connaître les options indiquées par un utilisateur lors d'un appel à votre programme en ligne de commande. La classe implémente les méthodes magiques ainsi vous pouvez interroger directement par les noms d'options.
L'analyse des données est reportée jusqu'à ce que vous invoquiez pour la première fois l'objet Zend_Console_Getopt pour découvrir si une option était renseignée, l'objet exécute alors son analyse. Ceci permet plusieurs appels de méthode pour configurer les options, arguments, messages d'aide, et les options de configuration, avant que l'analyse ne soit lancée.
Si l'utilisateur a donné des options invalides sur la ligne de commande, la fonction d'analyse syntaxique lève une Zend_Console_Getopt_Exception. Vous devrez récupérer cette exception dans votre code d'application. Vous pouvez utiliser la méthode parse() pour forcer l'objet à analyser les arguments. C'est utile parce que vous pouvez invoquer parse() dans un bloc try. S'il passe, vous pouvez être sûrs que l'analyse syntaxique ne lèvera pas d'exception de nouveau. L'exception est lancée via une méthode personnalisée getUsageMessage(), qui retourne comme une chaîne de caractère l'ensemble formaté des messages d'utilisation pour toutes les options déclarées.
Exemple 6.3. Récupérer une exception Getopt
<?php
try {
$opts = new Zend_Console_Getopt('abp:');
$opts->parse();
} catch (Zend_Console_Getopt_Exception $e) {
echo $e->getUsageMessage();
exit;
}
?>
Les cas où l'analyse syntaxique lève, une exception, incluent :
L'option passée n'est pas reconnue
L'option nécessite un paramètre mais aucun n'est fourni
Le paramètre d'option n'a pas le bon type. Par exemple, une chaîne de caractères non-numérique quand un nombre entier a été exigé.
Vous pouvez employer la méthode getOption() pour connaître la valeur d'une option. Si l'option avait un paramètre, cette méthode retourne la valeur du paramètre. Si l'option n'avait aucun paramètre mais l'utilisateur l'indiquait sur dans la ligne de commande, la méthode retourne true. Autrement la méthode retourne null.
Exemple 6.4. Utiliser getOption()
<?php
$opts = new Zend_Console_Getopt('abp:');
$b = $opts->getOption('b');
$p_parameter = $opts->getOption('p');
?>
De manière alternative, vous pouvez employer la fonction magique __get() pour rechercher la valeur d'une option comme si c'était une variable de membre de classe. La méthode magique __isset() est également implémentée.
Exemple 6.5. Utiliser les méthodes magiques __get() and __isset()
<?php
$opts = new Zend_Console_Getopt('abp:');
if (isset($opts->b)) {
echo "J'ai recu l'option b.\n";
}
$p_parameter = $opts->p; // null si non fourni
?>
Si vos options sont déclarées avec des alias, vous pouvez employer n'importe quel alias de l'option dans les méthodes ci-dessus.
Il y a plusieurs méthodes pour rapporter l'ensemble complet des options fournies par l'utilisateur dans la ligne de commande courante.
Comme un chaîne de caractères : employer la méthode toString(). Les options sont retournées sous la forme d'une chaîne de caractère où les paires "drapeau=valeur" sont séparées par des espaces. La valeur d'une option qui n'a pas de paramètre est la chaîne "true".
Comme un tableau : employer la méthode toArray(). Les options sont retournées dans un tableau de chaînes de caractères indexé par des nombres, les chaînes de drapeau sont suivies par les chaînes de paramètres éventuels.
Comme une chaîne au format JSON : employer la méthode toJson().
Comme une chaîne au format XML : employer la méthode toXml().
Dans toutes les méthodes de déchargement ci-dessus, la chaîne du drapeau est la première chaîne dans la liste des alias correspondant. Par exemple, si les noms d'emprunt d'option étaient déclarés comme "verbose|v", alors la première chaîne, "verbose", est employé comme nom de l'option. Le nom du drapeau d'option n'inclut pas le tiret précédent.
Après que les arguments d'option et ainsi que les paramètres de la ligne de commande ont été analysés , il peut exister des arguments additionnels restants. Vous pouvez interroger ces arguments en utilisant la méthode de getRemainingArgs(). Cette méthode renvoie une tableau de chaîne qui ne fait partie d'aucune option.
Exemple 6.6. Utiliser getRemainingArgs()
<?php
$opts = new Zend_Console_Getopt('abp:');
$opts->setArguments(array('-p', 'p_parameter', 'nomdefichier'));
$args = $opts->getRemainingArgs(); // retourne array('nomdefichier')
?>
Zend_Console_Getopt supporte la convention GNU selon laquelle un argument se composant d'un double-tiret signifie la fin des options. Tous les arguments suivant celui-ci doivent être traités en tant qu'arguments sans option. C'est utile si vous avez un argument sans option qui commence par un tiret. Par exemple : "rm -- -nomdefichier-avec-tiret".