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

<!-- $Revision$ -->

<!-- EN-Revision: 89b506b5b654f9eac45d9fc65bfe78ad89254c2b Maintainer: hirokawa Status: ready -->

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

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

<refnamediv>

<refname>file</refname>

<refpurpose>ファイル全体を読み込んで配列に格納する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

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

<methodparam><type>string</type><parameter>filename</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

ファイル全体を配列に読み込みます。

</para>

<note>

<para>

ファイルの内容を文字列として返すには <function>file_get_contents</function>

を使用します。

</para>

</note>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>filename</parameter></term>

<listitem>

<para>

ファイルへのパス。

</para>

&tip.fopen-wrapper;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

オプションのパラメータ <parameter>flags</parameter>

は、以下の定数のうちのひとつ、あるいは複数の組み合わせとなります。

<variablelist>

<varlistentry>

<term>

<constant>FILE_USE_INCLUDE_PATH</constant>

</term>

<listitem>

<simpara>

<link linkend="ini.include-path">include_path</link> のファイルを探します。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term>

<constant>FILE_IGNORE_NEW_LINES</constant>

</term>

<listitem>

<simpara>

配列の各要素の最後の改行を省略します。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term>

<constant>FILE_SKIP_EMPTY_LINES</constant>

</term>

<listitem>

<simpara>

空行を読み飛ばします。

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term>

<constant>FILE_NO_DEFAULT_CONTEXT</constant>

</term>

<listitem>

<simpara>

デフォルトのストリームコンテキストを使いません。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>context</parameter></term>

<listitem>

&note.context-support;

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

ファイルを配列に入れて返します。

配列の各要素はファイルの各行に対応します。改行記号はついたままとなります。

失敗すると <function>file</function> は &false; を返します。

</para>

<note>

<para>

<constant>FILE_IGNORE_NEW_LINES</constant> を指定しない限り、

配列に取り込まれた各行は行末文字も含みます。

</para>

</note>

&note.line-endings;

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<simpara>

PHP 8.3.0 以降では、<parameter>flags</parameter> に不正な値、

たとえば <constant>FILE_APPEND</constant> のような値が含まれていた場合、

<exceptionname>ValueError</exceptionname> がスローされます。

</simpara>

<para>

ファイルが存在しない場合は <constant>E_WARNING</constant> レベルのエラーが発生します。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.3.0</entry>

<entry>

<parameter>flags</parameter> に不正な値が含まれている場合、

<exceptionname>ValueError</exceptionname> がスローされるようになりました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>file</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

// ファイルの内容を配列に取り込みます。

// この例ではHTTPを通してURL上のHTMLソースを取得します。

$lines = file('http://www.example.com/');

// 配列をループしてHTMLをHTMLソースとして表示し、行番号もつけます。

foreach ($lines as $line_num => $line) {

echo "Line #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br />\n";

}

// オプションのパラメータを使う

$trimmed = file('somefile.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

&warn.ssl-non-standard;

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>file_get_contents</function></member>

<member><function>readfile</function></member>

<member><function>fopen</function></member>

<member><function>fsockopen</function></member>

<member><function>popen</function></member>

<member><function>include</function></member>

<member><function>stream_context_create</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

-->