(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
getopt — Получает параметры из списка аргументов командной строки
Анализирует параметры переданные в скрипт.
short_options-).
Например, строка параметров "x" распознается, как
параметр -x.
Допускаются только символы a-z, A-Z и 0-9.
long_options--).
Например, элемент longopts "opt" будет расшифровываться
как --opt.
rest_indexrest_index, то индекс, на котором
остановился разбор, будет записан в него.
Аргумент short_options может содержать следующие элементы:
Замечание: Необязательные значения нельзя отделять от других пробелом
" ".
Значения массива long_options могут содержать:
Замечание:
Форматы
short_optionsиlong_optionsпрактически совпадают. Различие состоит только в том, чтоlong_optionsпринимает массив параметров (в котором каждый элемент является параметром) в то время, какshort_optionsпринимает строку (где параметром является каждый символ).
Функция вернёт массив пар параметров / аргументов или false, если возникла ошибка.
Замечание:
Как только встретится первый символ, не являющийся параметром, разбор строки команды будет завершён, а оставшаяся часть строки будет проигнорирована.
| Версия | Описание |
|---|---|
| 7.1.0 |
Добавлен параметр rest_index.
|
Пример #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)
}
Пример #4 Пример getopt() с параметром rest_index
<?php
// Скрипт example.php
$rest_index = null;
$opts = getopt('a:b:', [], $rest_index);
$pos_args = array_slice($argv, $rest_index);
var_dump($pos_args);shell> php example.php -a 1 -b 2 -- test
Результат выполнения приведённого примера:
array(1) {
[0]=>
string(4) "test"
}