mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
691a13900a
-- Provided by anonymous 51325 (liebelied7@gmail.com) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335489 c90b9560-bf6c-de11-be94-00142212c4b1
291 lines
6.9 KiB
XML
291 lines
6.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.getopt">
|
|
<refnamediv>
|
|
<refname>getopt</refname>
|
|
<refpurpose>Gets options from the command line argument list</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>getopt</methodname>
|
|
<methodparam><type>string</type><parameter>options</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>longopts</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Parses options passed to the script.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
Each character in this string will be used as option characters and
|
|
matched against options passed to the script starting with a single
|
|
hyphen (<literal>-</literal>).
|
|
</simpara>
|
|
<simpara>
|
|
For example, an option string <literal>"x"</literal> recognizes an
|
|
option <literal>-x</literal>.
|
|
</simpara>
|
|
<simpara>
|
|
Only a-z, A-Z and 0-9 are allowed.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>longopts</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
An array of options. Each element in this array will be used as option
|
|
strings and matched against options passed to the script starting with
|
|
two hyphens (<literal>--</literal>).
|
|
</simpara>
|
|
<simpara>
|
|
For example, an longopts element <literal>"opt"</literal> recognizes an
|
|
option <literal>--opt</literal>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
<para>
|
|
The <parameter>options</parameter> parameter may contain the following
|
|
elements:
|
|
<simplelist>
|
|
<member>Individual characters (do not accept values)</member>
|
|
<member>Characters followed by a colon (parameter requires value)</member>
|
|
<member>Characters followed by two colons (optional value)</member>
|
|
</simplelist>
|
|
Option values are the first argument after the string. If a value is required,
|
|
it does not matter whether the value has leading white space or not. See note.
|
|
<note>
|
|
<simpara>
|
|
Optional values do not accept <literal>" "</literal> (space) as a separator.
|
|
</simpara>
|
|
</note>
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The format for the <parameter>options</parameter> and
|
|
<parameter>longopts</parameter> is almost the same, the only difference is
|
|
that <parameter>longopts</parameter> takes an array of options (where each
|
|
element is the option) whereas <parameter>options</parameter> takes a
|
|
string (where each character is the option).
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
This function will return an array of option / argument pairs or &false; on
|
|
failure.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The parsing of options will end at the first non-option found, anything
|
|
that follows is discarded.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Added support for "=" as argument/value separator.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Added support for optional values (specified with "::").
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Parameter <parameter>longopts</parameter> is available on all systems.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
This function is no longer system dependent, and now works on Windows, too.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="getopt.examples-1">
|
|
<title><function>getopt</function> example: The basics</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Script example.php
|
|
$options = getopt("f:hp:");
|
|
var_dump($options);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<programlisting role="shell">
|
|
<![CDATA[
|
|
shell> php example.php -fvalue -h
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
array(2) {
|
|
["f"]=>
|
|
string(5) "value"
|
|
["h"]=>
|
|
bool(false)
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example xml:id="getopt.examples-2">
|
|
<title><function>getopt</function> example: Introducing long options</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Script example.php
|
|
$shortopts = "";
|
|
$shortopts .= "f:"; // Required value
|
|
$shortopts .= "v::"; // Optional value
|
|
$shortopts .= "abc"; // These options do not accept values
|
|
|
|
$longopts = array(
|
|
"required:", // Required value
|
|
"optional::", // Optional value
|
|
"option", // No value
|
|
"opt", // No value
|
|
);
|
|
$options = getopt($shortopts, $longopts);
|
|
var_dump($options);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<programlisting role="shell">
|
|
<![CDATA[
|
|
shell> php example.php -f "value for f" -v -a --required value --optional="optional value" --option
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
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)
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example xml:id="getopt.examples-3">
|
|
<title><function>getopt</function> example: Passing multiple options as one</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Script example.php
|
|
$options = getopt("abc");
|
|
var_dump($options);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<programlisting role="shell">
|
|
<![CDATA[
|
|
shell> php example.php -aaac
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
array(2) {
|
|
["a"]=>
|
|
array(3) {
|
|
[0]=>
|
|
bool(false)
|
|
[1]=>
|
|
bool(false)
|
|
[2]=>
|
|
bool(false)
|
|
}
|
|
["c"]=>
|
|
bool(false)
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><link linkend="reserved.variables.argv"><varname>$argv</varname></link></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|