is-readable.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871a231f4a1caa5fb258ae53b1bb7d1fb2a0f949 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.is-readable">
 <refnamediv>
  <refname>is_readable</refname>
  <refpurpose>ファイルが存在し、読み込み可能であるかどうかを知る</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>is_readable</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   ファイルが存在し、読み込み可能であるかどうかを調べます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       ファイルへのパス。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>filename</parameter>
   で指定したファイルあるいはディレクトリが存在し、
   それが読み込み可能であれば &true;、それ以外の場合に
   &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &fs.emits.warning.on.failure;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>is_readable</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$filename = 'test.txt';
if (is_readable($filename)) {
    echo 'このファイルは読み込み可能です';
} else {
    echo 'このファイルは読み込み可能ではありません';
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <para>
   PHP は、Web サーバーを実行しているユーザー ID (たいていは 'nobody')
   でファイルにアクセスすることを覚えておいてください。
  </para>
  &note.clearstatcache;
  &tip.fopen-wrapper.stat;
  <note>
   <para>
    チェックは、実効ユーザーではなく実ユーザーの UID/GID
    で行います。
   </para>
  </note>
  <para>
   この関数は、ディレクトリに対しても &true; を返すかもしれません。
   ファイルとディレクトリを区別するには <function>is_dir</function> を使いましょう。
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_writable</function></member>
    <member><function>file_exists</function></member>
    <member><function>fgets</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
-->