getoptObtiene las opciones de la lista de argumentos de la línea de comandos
&reftitle.description;
arraygetoptstringoptionsarraylongopts
Analiza las opciones pasadas al script.
&reftitle.parameters;
options
Cada carácter de esta cadena de texto se usará como un carácter de opción
y se comparará con aquellas opciones pasadas al script que comiencen con un
guión simple (-).
Por ejemplo, el string de opciones "x" reconocerá
la opción -x.
Sólo se permiten a-z, A-Z y 0-9.
longopts
Matriz de opciones. Cada elemento de este array se usará como texto de opciones
y se compararán con aquellas opciones pasadas al script que comiencen con
dos guiones (--).
Por ejemplo, longopts tuviera un elemento con "opt", reconocería la
opción --opt.
El parámetro options puede contener los siguientes
elementos:
Caracteres individuales (no acepta valores)Caracteres seguidos por dos puntos (el parámetro exije un valor)Caracteres seguidos dos veces por dos puntos (valor opcional)
Los valores de opción serán el primer argumento tras el string. Si se requiere un valor,
no importa si este tiene espacios en blanco delante o no. Véase la nota.
Los valores opcionales no aceptan un " " (espacio) como separador.
El formato de options y de
longopts es casi igual. La única diferencia es que
longopts contiene un array de opciones (donde cada elemento
es la opción) mientras que options contiene un string
(donde cada carácter es la opción).
&reftitle.returnvalues;
Esta función devolverá un array de parejas opciones / argumentos, &return.falseforfailure;.
El análisis de opciones finalizará cuando se encuentre alguna no-opción. Todo lo que haya
a continuación será descartado.
&reftitle.changelog;
&Version;&Description;5.3.0
Añadido soporte para usar "=" como separador de argumento/valor.
5.3.0
Añadido soporte para valores opcionales (especificado mediante "::").
5.3.0
El parámetro longopts está disponible en todos los sistemas.
5.3.0
Esta función ya no depende del sistema y funciona también en Windows.
&reftitle.examples;
Ejemplo de getopt: Lo básico
]]>
php example.php -fvalue -h
]]>
&example.outputs;
string(5) "value"
["h"]=>
bool(false)
}
]]>
Ejemplo de getopt: Introducir opciones long
]]>
php example.php -f "value for f" -v -a --required value --optional="optional value" --option
]]>
&example.outputs;
string(11) "value for f"
["v"]=>
bool(false)
["a"]=>
bool(false)
["required"]=>
string(5) "value"
["optional"]=>
string(14) "optional value"
["option"]=>
bool(false)
}
]]>
Ejemplo de getopt: Pasar varias opciones como una
]]>
php example.php -aaac
]]>
&example.outputs;
array(3) {
[0]=>
bool(false)
[1]=>
bool(false)
[2]=>
bool(false)
}
["c"]=>
bool(false)
}
]]>
&reftitle.seealso;
$argv