<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 4d02fe98ddc684a0d82a3921ef189a71b98f4f04 Maintainer: takagi Status: ready -->

<!-- CREDITS: hirokawa,mumumu -->

<refentry xml:id="function.getopt" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>getopt</refname>

<refpurpose>コマンドライン引数のリストからオプションを取得する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>false</type></type><methodname>getopt</methodname>

<methodparam><type>string</type><parameter>short_options</parameter></methodparam>

<methodparam choice="opt"><type>array</type><parameter>long_options</parameter><initializer>[]</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter role="reference">rest_index</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

スクリプトに渡されたオプションをパースします。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>short_options</parameter></term>

<listitem>

<simpara>

この文字列の各文字をオプション文字として使用し、

スクリプトにハイフンひとつ (<literal>-</literal>)

で始まるオプションとして渡された内容とマッチさせます。

</simpara>

<simpara>

たとえば、オプション文字列 <literal>"x"</literal> は

<literal>-x</literal> というオプションを認識します。

</simpara>

<simpara>

a-z、A-Z および 0-9 のみを認識します。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>long_options</parameter></term>

<listitem>

<simpara>

オプションの配列。

この配列の各要素をオプション文字列として使用し、

スクリプトにハイフンふたつ (<literal>--</literal>)

で始まるオプションとして渡された内容とマッチさせます。

</simpara>

<simpara>

たとえば、longopts の要素 <literal>"opt"</literal> は

<literal>--opt</literal> というオプションを認識します。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>rest_index</parameter></term>

<listitem>

<simpara>

<parameter>rest_index</parameter> パラメータが与えられると、

引数のパースを止めた時点のインデックスがこの変数に書き込まれます。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</para>

<para>

<parameter>short_options</parameter> パラメータに含まれる要素には次のようなものがあります。

<simplelist>

<member>単一の文字 (値を受け付けない)</member>

<member>文字の後にコロンをひとつ続けたもの (値が必須であるパラメータ)</member>

<member>文字の後にコロンをふたつ続けたもの (値がオプションであるパラメータ)</member>

</simplelist>

オプションの値は、文字列の後の最初の引数となります。

値が必須の場合、その前に空白があるかどうかは関係ありません。

<note>

<simpara>

オプションの値で、<literal>" "</literal> (空白) を区切り文字として使用することはできません。

</simpara>

</note>

</para>

<para>

<parameter>long_options</parameter> パラメータに含まれる要素には次のようなものがあります。

<simplelist>

<member>文字列 (値を受け付けない)</member>

<member>文字列の後にコロンをひとつ続けたもの (値が必須であるパラメータ)</member>

<member>文字列の後にコロンをふたつ続けたもの (値がオプションであるパラメータ)</member>

</simplelist>

</para>

<note>

<para>

<parameter>short_options</parameter> と

<parameter>long_options</parameter> の書式はほぼ同じです。唯一の違いは、

<parameter>long_options</parameter> はオプションの配列

(その各要素がオプションとなる) を受け取るけれども <parameter>short_options</parameter>

は文字列 (その各文字がオプションとなる) を受け取るということです。

</para>

</note>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

この関数はオプション/引数のペアを連想配列で返します。

&return.falseforfailure;。

</para>

<note>

<para>

オプション以外のものが見つかった時点でオプションのパースは終了し、

それ以降の内容は破棄されます。

</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>7.1.0</entry>

<entry>

<parameter>rest_index</parameter> パラメータが追加されました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example xml:id="getopt.examples-1">

<title><function>getopt</function> の例：基本編</title>

<programlisting role="php">

<![CDATA[

<?php

// スクリプト 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> の例：長いオプション</title>

<programlisting role="php">

<![CDATA[

<?php

// スクリプト example.php

$shortopts = "";

$shortopts .= "f:"; // 値が必須

$shortopts .= "v::"; // 値がオプション

$shortopts .= "abc"; // これらのオプションは値を受け取りません

$longopts = array(

"required:", // 値が必須

"optional::", // 値がオプション

"option", // 値なし

"opt", // 値なし

);

$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> の例：複数のオプションを一度に渡す</title>

<programlisting role="php">

<![CDATA[

<?php

// スクリプト 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>

<para>

<example xml:id="getopt.examples-4">

<title><function>getopt</function> の例: <parameter>rest_index</parameter> を使う</title>

<programlisting role="php">

<![CDATA[

<?php

// Script example.php

$rest_index = null;

$opts = getopt('a:b:', [], $rest_index);

$pos_args = array_slice($argv, $rest_index);

var_dump($pos_args);

]]>

</programlisting>

<programlisting role="shell">

<![CDATA[

shell> php example.php -a 1 -b 2 -- test

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

array(1) {

[0]=>

string(4) "test"

}

]]>

</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

-->