Source of: /manual/en/function.finfo-open.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.fileinfo.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.finfo-open.php',
1 => 'finfo_open',
),
'up' =>
array (
0 => 'ref.fileinfo.php',
1 => 'Fileinfo Functions',
),
'prev' =>
array (
0 => 'function.finfo-file.php',
1 => 'finfo_file',
),
'next' =>
array (
0 => 'function.finfo-set-flags.php',
1 => 'finfo_set_flags',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.finfo-open" class="refentry">
<div class="refnamediv">
<h1 class="refname">finfo_open</h1>
<h1 class="refname">finfo->__construct</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL fileinfo >= 0.1.0)</p><p class="refpurpose"><span class="refname">finfo_open</span> -- <span class="refname">finfo->__construct</span> — <span class="dc-title">Create a new fileinfo resource</span></p>
</div>
<a name="function.finfo-open.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<p class="para">Procedural style</p>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><b>finfo_open</b></span>
([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$options</tt><span class="initializer"> = FILEINFO_NONE</span></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$magic_file</tt><span class="initializer"> = NULL</span></span>
]] )</div>
<p class="para rdfs-comment">Object oriented style (constructor):</p>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">finfo</b></div>
<div class="constructorsynopsis dc-description">
<span class="methodname"><b>__construct</b></span>
([ <span class="methodparam"><span class="type">int</span> <tt class="parameter">$options</tt><span class="initializer"> = FILEINFO_NONE</span></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$magic_file</tt><span class="initializer"> = NULL</span></span>
]] )</div>
</div>
<p class="para">
This function opens a magic database and returns its resource.
</p>
</div>
<a name="function.finfo-open.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">options</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
One or disjunction of more <a href="fileinfo.constants.php" class="link">Fileinfo
constants</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">magic_file</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Name of a magic database file, usually something like
<var class="filename">/path/to/magic.mime</var>. If not specified,
the <i>MAGIC</i> environment variable is used. If this variable
is not set either, <var class="filename">/usr/share/misc/magic</var> is used by default.
A <i>.mime</i> and/or <i>.mgc</i> suffix is added if
needed.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.finfo-open.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a magic database resource on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.finfo-open.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<div class="example">
<p><b>Example #1 Object oriented style</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$finfo </span><span style="color: #007700">= new </span><span style="color: #0000BB">finfo</span><span style="color: #007700">(</span><span style="color: #0000BB">FILEINFO_MIME</span><span style="color: #007700">, </span><span style="color: #DD0000">"/usr/share/misc/magic"</span><span style="color: #007700">); </span><span style="color: #FF8000">// return mime type ala mimetype extension<br /><br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">$finfo</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Opening fileinfo database failed"</span><span style="color: #007700">;<br /> exit();<br />}<br /><br /></span><span style="color: #FF8000">/* get mime-type for a specific file */<br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">"/usr/local/something.txt"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">$finfo</span><span style="color: #007700">-></span><span style="color: #0000BB">file</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example">
<p><b>Example #2 Procedural style</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$finfo </span><span style="color: #007700">= </span><span style="color: #0000BB">finfo_open</span><span style="color: #007700">(</span><span style="color: #0000BB">FILEINFO_MIME</span><span style="color: #007700">, </span><span style="color: #DD0000">"/usr/share/misc/magic"</span><span style="color: #007700">); </span><span style="color: #FF8000">// return mime type ala mimetype extension<br /><br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">$finfo</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Opening fileinfo database failed"</span><span style="color: #007700">;<br /> exit();<br />}<br /><br /></span><span style="color: #FF8000">/* get mime-type for a specific file */<br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">"/usr/local/something.txt"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">finfo_file</span><span style="color: #007700">(</span><span style="color: #0000BB">$finfo</span><span style="color: #007700">, </span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* close connection */<br /></span><span style="color: #0000BB">finfo_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$finfo</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<p class="para">The above example will output:</p>
<div class="example-contents screen">
<div class="cdata"><pre>
text/plain; charset=us-ascii
</pre></div>
</div>
</div>
<a name="function.finfo-open.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.finfo-close.php" class="function" rel="rdfs-seeAlso">finfo_close()</a> - Close fileinfo resource</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
