Извлечение параметров из списка аргументов командной строки


(PHP 4 >= 4.3.0, PHP 5)

getopt Извлечение параметров из списка аргументов командной строки

Описание

array getopt ( string $options [, array $longopts ] )

Анализирует параметры переданные в скрипт.

Список параметров

options
Каждый символ в этой строке будет рассматриваться как параметр и сравниваться с символами, переданными в скрипт, перед которыми будет стоять дефис (-). Например, строка параметров "x" распознается, как параметр -x. Допускаются только символы a-z, A-Z и 0-9.
longopts
Массив параметров. Каждый элемент массива будет использоваться как строковый параметр и сравниваться с параметрами, переданными в скрипт, перед которыми будет стоять двойной дефис (--). Например, элемент longopts "opt" будет расшифровываться как --opt.

Аргумент options может содержать следующие элементы:

  • Отдельные символы (не имеющие значений)
  • Символы, за которыми следует двоеточие (после двоеточия должно быть значение параметра)
  • Символы, за которыми следует два двоеточия (значение параметра необязательно)
Значения параметров идут сразу за строкой параметра (символом). Если требуется значение, то нет разницы, есть между ними пробел или нет.

Замечание: Необязательные значения нельзя отделять от других пробелом " ".

Замечание:

Форматы options и longopts практически совпадают. Различие состоит только в том, что longopts принимает массив параметров (в котором каждый элемент является параметром) в то время, как options принимает строку (где параметром является каждый символ).

Возвращаемые значения

Функция вернет массив параметров / пар аргументов или FALSE в случае неудачи.

Замечание:

Как только встретится первый символ, не являющийся параметром, разбор строки команды будет завершен, а оставшаяся часть строки будет проигнорирована.

Список изменений

Версия Описание
5.3.0 Добавлена поддержка "=" в качестве разделителя параметр/значение.
5.3.0 Добвалена поддержка необязательных значений параметров, (задаваемая "::").
5.3.0 Аргумент longopts доступен на всех системах.
5.3.0 Функция больше не зависит от системы, теперь работает в и на Windows.

Примеры

Пример #1 Пример использования getopt(): основное

<?php
// Скрипт example.php
$options getopt("f:hp:");
var_dump($options);
?>
shell> php example.php -fvalue -h

Результат выполнения данного примера:

 array(2) {   ["f"]=>   string(5) "value"   ["h"]=>   bool(false) } 

Пример #2 Пример использования getopt(): добавление длинных опций

<?php
// Скрипт example.php
$shortopts  "";
$shortopts .= "f:";  // Обязательное значение
$shortopts .= "v::"// Необязательное значение
$shortopts .= "abc"// Эти параметры не принимают никаких значений

$longopts  = array(
    
"required:",     // Обязательное значение
    
"optional::",    // Необязательное значение
    
"option",        // Нет значения
    
"opt",           // Нет значения
);
$options getopt($shortopts$longopts);
var_dump($options);
?>
shell> php example.php -f "value for f" -v -a --required value --optional="optional value" --option

Результат выполнения данного примера:

 array(6) {   ["f"]=>   string(11) "value for f"   ["v"]=>   bool(false)   ["a"]=>   bool(false)   ["required"]=>   string(5) "value"   ["optional"]=>   string(14) "optional value"   ["option"]=>   bool(false) } 

Пример #3 Пример использования getopt(): Передача нескольких параметров как одного

<?php
// Скрипт example.php
$options getopt("abc");
var_dump($options);
?>
shell> php example.php -aaac

Результат выполнения данного примера:

 array(2) {   ["a"]=>   array(3) {     [0]=>     bool(false)     [1]=>     bool(false)     [2]=>     bool(false)   }   ["c"]=>   bool(false) } 

Смотрите также