get-resource-type.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/var.xml, last change in rev 1.75 -->
<refentry xml:id="function.get-resource-type" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_resource_type</refname>
  <refpurpose>
   Returns the resource type
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>get_resource_type</methodname>
   <methodparam><type>resource</type><parameter>resource</parameter></methodparam>
  </methodsynopsis>
  <para>
   This function gets the type of the given resource.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>resource</parameter></term>
     <listitem>
      <para>
       The evaluated resource handle.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   If the given <parameter>resource</parameter> is a resource, this function
   will return a string representing its type. If the type is not identified
   by this function, the return value will be the string 
   <literal>Unknown</literal>.
  </para>
  <para>
   This function will return &null; and generate an error if 
   <parameter>resource</parameter> is not a <type>resource</type>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>get_resource_type</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$fp = fopen("foo", "w");
echo get_resource_type($fp) . "\n";

// As of PHP 8.0.0, the following does not work anymore. The curl_init function returns a CurlHandle object now.
$c = curl_init();
echo get_resource_type($c) . "\n";
?>
]]>
    </programlisting>
    &example.outputs.7;
    <screen role="php">
<![CDATA[
stream
curl
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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