mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
0d604bbc9d
PhD uses this context for decisions about links and similar. It also simplifies the XML git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322205 c90b9560-bf6c-de11-be94-00142212c4b1
140 lines
4 KiB
XML
140 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
|
|
<refentry xml:id="function.finfo-file" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>finfo_file</refname>
|
|
<refname>finfo::file</refname>
|
|
<refpurpose>Return information about a file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>&style.procedural;</para>
|
|
<methodsynopsis role="procedural">
|
|
<type>string</type><methodname>finfo_file</methodname>
|
|
<methodparam><type>resource</type><parameter>finfo</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>file_name</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
|
|
<methodparam choice="opt"><type>resource</type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>&style.oop;</para>
|
|
<methodsynopsis role="oop">
|
|
<type>string</type><methodname>finfo::file</methodname>
|
|
<methodparam><type>string</type><parameter>file_name</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
|
|
<methodparam choice="opt"><type>resource</type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
This function is used to get information about a file.
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>finfo</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Fileinfo resource returned by <function>finfo_open</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>file_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a file to be checked.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One or disjunction of more <link linkend="fileinfo.constants">Fileinfo
|
|
constants</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>context</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
For a description of <literal>contexts</literal>, refer to <xref
|
|
linkend="ref.stream"/>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a textual description of the contents of the
|
|
<parameter>filename</parameter> argument, or &false; if an error occurred.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>finfo_file</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$finfo = finfo_open(FILEINFO_MIME_TYPE); // return mime type ala mimetype extension
|
|
foreach (glob("*") as $filename) {
|
|
echo finfo_file($finfo, $filename) . "\n";
|
|
}
|
|
finfo_close($finfo);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
text/html
|
|
image/gif
|
|
application/vnd.ms-excel
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>finfo_buffer</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
|
|
-->
|