mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
147cfbfe1a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166209 c90b9560-bf6c-de11-be94-00142212c4b1
72 lines
2.3 KiB
XML
72 lines
2.3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.10 $ -->
|
|
<refentry id="function.getopt">
|
|
<refnamediv>
|
|
<refname>getopt</refname>
|
|
<refpurpose>Gets options from the command line argument list</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<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>
|
|
Returns an associative array of option / argument pairs based on the
|
|
options format specified in <parameter>options</parameter>, or &false;
|
|
on an error.
|
|
</para>
|
|
<para>
|
|
On platforms that have the C function getopt_long, long options can be
|
|
specified with the parameter <parameter>longopts</parameter> (as of PHP 4.3.0).
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// parse the command line ($GLOBALS['argv'])
|
|
$options = getopt("f:hp:");
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</informalexample>
|
|
</para>
|
|
<para>
|
|
The <parameter>options</parameter> parameter may contain the following
|
|
elements: individual characters, and characters followed by a colon to
|
|
indicate an option argument is to follow. For example, an option string
|
|
<literal>x</literal> recognizes an option <literal>-x</literal>, and an
|
|
option string <literal>x:</literal> recognizes an option and argument
|
|
<literal>-x argument</literal>. It does not matter if an argument has
|
|
leading white space.
|
|
</para>
|
|
<para>
|
|
This function will return an array of option / argument pairs. If an
|
|
option does not have an argument, the value will be set to &false;.
|
|
</para>
|
|
¬e.no-windows;
|
|
</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:"../../../../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
|
|
-->
|