ZFResource^beta

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.

<?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 :

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 que l'utilisateur en indiquait sur dans la ligne de commande, la méthode retournerait true. Sinon la méthode retournerait null.

<?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.

<?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 extraire l'ensemble complet des options fournies par l'utilisateur dans la ligne de commande courante.

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 correspondants. Par exemple, si les noms d'alias 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 getRemainingArgs(). Cette méthode renvoie un tableau de chaîne qui ne fait partie d'aucune option.

<?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 options. C'est utile si vous avez un argument sans options qui commence par un tiret. Par exemple : "rm -- -nomdefichier-avec-tiret".