ZF Zend Framework

Vous pouvez ajouter de nouvelles règles d'option en complément de celles indiquées dans le constructeur de Zend_Console_Getopt, en utilisant la méthode addRules(). L'argument d'addRules() est identique au premier argument du constructeur de classe. C'est soit une chaîne dans le format d'options de syntaxe courte, soit un tableau associatif dans le format d'options de syntaxe longue. Voir "Déclarer les règles Getopt" pour les détails sur la syntaxe de déclaration des options.

$opts = new Zend_Console_Getopt('abp:');
$opts->addRules(
  array(
    'verbose|v' => 'Print verbose output'
  )
);

L'exemple au-dessus montre comment ajouter l'option "--verbose" avec l'alias "-v" à un ensemble d'options définies dans l'appel au constructeur. Notez que vous pouvez mélanger des options de syntaxe courte et de syntaxe longue dans la même instance de Zend_Console_Getopt.

En plus d'indiquer les messages d'aide en déclarant les règles d'option dans le long format, vous pouvez associer des messages d'aide aux règles d'option en utilisant la méthode setHelp(). L'argument de la méthode setHelp() est un tableau associatif, dans laquelle la clé est un drapeau, et la valeur est le message d'aide correspondant.

$opts = new Zend_Console_Getopt('abp:');
$opts->setHelp(
    array(
        'a' => 'option abricot, sans parametres',
        'b' => 'option banane, avec un parametre obligatoire de type entier',
        'p' => 'option pear, avec un parametre optionel de type chaine de caracteres'
    )
);

Si vous déclarez des options avec des alias, vous pouvez employer n'importe quel alias comme clé du tableau associatif.

La méthode setHelp() est la seule manière de définir des messages d'aide si vous déclarez les options en utilisant la syntaxe courte.

Vous pouvez déclarer des alias pour des options en utilisant la méthode setAliases(). L'argument est un tableau associatif, dont la clé est une chaîne de drapeau déclaré auparavant, et dont la valeur est un nouvel alias pour ce drapeau. Ces alias sont fusionnés avec tous les alias existants. En d'autres termes, les alias que vous avez déclarés plus tôt sont toujours actifs.

Un alias ne peut être déclaré qu'une seule fois. Si vous essayez de redéfinir un alias, une Zend_Console_Getopt_Exception est levée.

$opts = new Zend_Console_Getopt('abp:');
$opts->setAliases(
    array(
        'a' => 'apple',
        'a' => 'apfel',
        'p' => 'pear'
    )
);

Dans l'exemple ci-dessus, après leurs déclarations, "-a", "--apple" et "--apfel" sont des alias les un pour les autres. En outre "-p" et "--pear" sont des alias l'un pour l'autre.

La méthode setAliases() est la seule manière de définir des alias si vous déclarez les options en utilisant la syntaxe courte.

Par défaut, Zend_Console_Getopt utilise $_SERVER['argv'] comme tableau des arguments de ligne de commande à analyser. De manière alternative, vous pouvez indiquer le tableau d'arguments comme deuxième argument de constructeur. En conclusion, vous pouvez ajouter de nouveaux d'arguments à ceux déjà utilisés en utilisant la méthode addArguments(), ou vous pouvez remplacer le choix courant d'arguments en utilisant la méthode setArguments(). Dans les deux cas, le paramètre de ces méthodes est un simple tableau de chaîne. L'ancienne méthode ajoutait le tableau aux arguments courants, et la nouvelle méthode substitue le tableau aux arguments courants.

// Par défaut, le constructeur utilise $_SERVER['argv']
$opts = new Zend_Console_Getopt('abp:');

// Ajoute un tableau aux arguments existants
$opts->addArguments(array('-a', '-p', 'p_parameter', 'non_option_arg'));

// Remplace les arguments existants par un nouveau tableau
$opts->setArguments(array('-a', '-p', 'p_parameter', 'non_option_arg'));

Le troisième paramètre du constructeur de Zend_Console_Getopt est un tableau d'options de configuration qui affectent le comportement de l'instance d'objet retournée. Vous pouvez également indiquer des options de configuration en utilisant la méthode setOptions(), ou vous pouvez placer une option individuelle en utilisant la méthode setOption().

	Clarifier le terme "option"
	Le terme "option" est employé pour la configuration de la classe Zend_Console_Getopt afin de correspondre à la terminologie utilisée dans le reste du Zend Framework. Ce n'est pas la même chose que les options de la ligne de commande qui sont analysées par la classe Zend_Console_Getopt.

Les options actuellement supportées ont des définitions de constantes dans la classe. Les options, leurs constantes (avec des valeurs littérales entre parenthèses) sont énumérées ci-dessous :

Plus d'options de configuration pourront être ajoutées en tant que futurs perfectionnements de cette classe.

Les deux arguments de la méthode setOption() sont un nom d'option de configuration et une valeur d'option.

$opts = new Zend_Console_Getopt('abp:');
$opts->setOption('ignoreCase', true);

L'argument de la méthode setOptions() est un tableau associatif. Les clés de ce tableau sont les noms d'option de configuration, et les valeurs sont des valeurs de configuration. C'est également le format de tableau utilisé par le constructeur de classe. Les valeurs de configuration que vous indiquez sont fusionnées avec la configuration courante ; vous n'avez pas à énumérer toutes les options.

$opts = new Zend_Console_Getopt('abp:');
$opts->setOptions(
    array(
        'ignoreCase' => true,
        'dashDash'   => false
    )
);