finfo-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1160ec4e7d21a2619e9661d6afe3a6356267c6c2 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.finfo-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>finfo_open</refname>
  <refname>finfo::__construct</refname>
  <refpurpose>新しい fileinfo インスタンスを作成する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>finfo</type><type>false</type></type><methodname>finfo_open</methodname>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>magic_database</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>&style.oop; (コンストラクタ)</para>
  <constructorsynopsis role="finfo">
   <modifier>public</modifier> <methodname>finfo::__construct</methodname>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>magic_database</parameter><initializer>&null;</initializer></methodparam>
  </constructorsynopsis>
  <para>
   この関数は、magic データベースをオープンしてそのインスタンスを返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       ひとつあるいは複数の<link linkend="fileinfo.constants">Fileinfo
       定数</link>の組み合わせ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>magic_database</parameter></term>
     <listitem>
      <para>
       magic データベースファイルの名前。通常は
       <filename>/path/to/magic.mime</filename> のようになります。
       指定されなかった場合は、環境変数 <literal>MAGIC</literal>
       の値が使用されます。この環境変数も設定されていない場合は、
       PHP の組み込みの magic データベースを使います。
      </para>
      <para>
       &null; あるいは空文字列は、デフォルト値と同じ意味となります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に
   <classname>finfo</classname> クラスのインスタンスを返します。
   &return.falseforfailure;.
  </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.1.0</entry>
      <entry>
       <classname>finfo</classname>
       クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       &resource; を返していました。
      </entry>
     </row>
     <row>
      <entry>8.0.3</entry>
      <entry>
       <parameter>magic_database</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>&style.oop;</title>
   <programlisting role="php">
<![CDATA[
<?php
$finfo = new finfo(FILEINFO_MIME, "/usr/share/misc/magic"); // mime タイプを mimetype 拡張形式で返します

/* 指定したファイルの mime タイプを取得します */
$filename = "/usr/local/something.txt";
echo $finfo->file($filename);

?>
]]>
  </programlisting>
  </example>
  <example>
   <title>&style.procedural;</title>
   <programlisting role="php">
<![CDATA[
<?php
$finfo = finfo_open(FILEINFO_MIME, "/usr/share/misc/magic"); // mime タイプを mimetype 拡張形式で返します

if (!$finfo) {
    echo "fileinfo データベースのオープンに失敗しました";
    exit();
}

/* 指定したファイルの mime タイプを取得します */
$filename = "/usr/local/something.txt";
echo finfo_file($finfo, $filename);

/* 接続を閉じます */
finfo_close($finfo);
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
text/plain; charset=us-ascii
]]>
  </screen>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    一般的には、独自の magic データベースを使う必要がある場合を除いて、
    組み込みの magic データベースを使うのが一番いい方法です
    (<parameter>magic_database</parameter> を省略し、環境変数 <literal>MAGIC</literal>
    も設定しないようにします)。
   </para>
  </note>
 </refsect1>

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