mirror of
https://github.com/php/doc-ja.git
synced 2026-04-30 03:23:23 +02:00
Yoshinari Takaoka
7713a279b6
https://github.com/php/doc-en/commit/946fbe44b60bd5fdc1d7b7a5f016be670425f5b4
262 lines
8.6 KiB
XML
262 lines
8.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 39a98b1f1776afd4c41f79ce528309c95f62b10a Maintainer: hirokawa Status: ready -->
|
|
<!-- Credits: mumumu -->
|
|
<refentry xml:id="function.fnmatch" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>fnmatch</refname>
|
|
<refpurpose>ファイル名がパターンにマッチするか調べる</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>fnmatch</methodname>
|
|
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>fnmatch</function>は<parameter>filename</parameter>
|
|
で指定された文字列が
|
|
<parameter>pattern</parameter>
|
|
で指定されたシェルワイルドカードにマッチするかどうかチェックします。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pattern</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
マッチさせるパターン。
|
|
通常、<parameter>pattern</parameter> には
|
|
<literal>'?'</literal> や <literal>'*'</literal>
|
|
のようなワイルドカードを含めます。
|
|
<table>
|
|
<title>
|
|
<parameter>pattern</parameter> で使えるワイルドカード
|
|
</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>ワイルドカード</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>
|
|
<literal>?</literal>
|
|
</entry>
|
|
<entry>
|
|
クエスチョンマークは、1文字にマッチします。
|
|
たとえば、
|
|
<literal>"file?.txt"</literal> は <literal>"file1.txt"</literal>
|
|
や <literal>"fileA.txt"</literal> にはマッチしますが、
|
|
<literal>"file10.txt"</literal> にはマッチしません。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>
|
|
<literal>*</literal>
|
|
</entry>
|
|
<entry>
|
|
アスタリスクは、0文字以上の文字にマッチします。
|
|
たとえば、
|
|
<literal>"foo*.xml"</literal> は
|
|
<literal>"foo.xml"</literal> や
|
|
<literal>"foobar.xml"</literal> にマッチします。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>
|
|
<literal>[ ]</literal>
|
|
</entry>
|
|
<entry>
|
|
角括弧は、アスキー文字のコードポイントや、
|
|
文字の集合を表すのに使います。
|
|
たとえば、<literal>"index.php[45]"</literal>
|
|
は <literal>"index.php4"</literal> や
|
|
<literal>"index.php5"</literal> にマッチしますが、
|
|
<literal>"index.phpt"</literal> にはマッチしません。
|
|
よく知られている文字の範囲として
|
|
<literal>[0-9]</literal>, <literal>[a-z]</literal>,
|
|
<literal>[A-Z]</literal> が挙げられます。
|
|
複数の集合や範囲は、同時に使うことができます。
|
|
たとえば <literal>[0-9a-zABC]</literal> のように使えます。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>
|
|
<literal>!</literal>
|
|
</entry>
|
|
<entry>
|
|
エクスクラメーションマークは、
|
|
角括弧内の文字を否定するのに使います。
|
|
たとえば、<literal>"[!A-Z]*.html"</literal> は
|
|
<literal>"demo.html"</literal> にマッチしますが、
|
|
<literal>"Demo.html"</literal> にはマッチしません。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>
|
|
<literal>\</literal>
|
|
</entry>
|
|
<entry>
|
|
バックスラッシュは、特別な文字をエスケープするのに使います。
|
|
たとえば、<literal>"Name\?"</literal> は
|
|
<literal>"Name?"</literal> にマッチしますが、
|
|
<literal>"Names"</literal> にはマッチしません。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
調べたい文字列。この機能は特にファイル名のマッチに便利ですが、
|
|
通常の文字列に関しても使用できます。
|
|
</para>
|
|
<para>
|
|
一般的なユーザーにとって、シェルパターンやあるいは少なくとも
|
|
<literal>'?'</literal>と<literal>'*'</literal>によるワイルドカードのほうが
|
|
慣れていると思われます。そのため、
|
|
<function>preg_match</function>
|
|
の代わりに <function>fnmatch</function>
|
|
をフロントエンドの検索表現として使うことは、
|
|
プログラマではないユーザーにとってより便利でしょう。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>flags</parameter> の値は、以下のフラグを
|
|
<link linkend="language.operators.bitwise">論理 OR (|) 演算子</link>
|
|
で連結した任意の組み合わせです。
|
|
<table>
|
|
<title>
|
|
<function>fnmatch</function> で使えるフラグ
|
|
</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry><parameter>フラグ</parameter></entry>
|
|
<entry>説明</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>FNM_NOESCAPE</constant></entry>
|
|
<entry>
|
|
バックスラッシュのエスケープを無効にする。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>FNM_PATHNAME</constant></entry>
|
|
<entry>
|
|
文字列内のスラッシュは、指定したパターン内のスラッシュにのみマッチする。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>FNM_PERIOD</constant></entry>
|
|
<entry>
|
|
文字列の先頭のピリオドは、指定したパターン内のピリオドにマッチしなければならない。
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>FNM_CASEFOLD</constant></entry>
|
|
<entry>
|
|
大文字小文字を区別しないマッチ。GNU 拡張の一部。
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
マッチした場合に &true;、それ以外の場合に &false; を返します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>シェルのワイルドカードパターンによる色の名前のチェック</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
if (fnmatch("*gr[ae]y", $color)) {
|
|
echo "some form of gray ...";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<warning>
|
|
<para>
|
|
今のところ、この機能は POSIX に準拠していないシステムで利用できません
|
|
(ただし、Windows では利用できます)。
|
|
</para>
|
|
</warning>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>glob</function></member>
|
|
<member><function>preg_match</function></member>
|
|
<member><function>sscanf</function></member>
|
|
<member><function>printf</function></member>
|
|
<member><function>sprintf</function></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
|
|
-->
|