get-resources.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 16805838e72187b53a76df37a2dadc20ff6f00af Maintainer: jbnahan Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.get-resources" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_resources</refname>
  <refpurpose>Retourne les ressources active</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>get_resources</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>type</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Retourne un tableau de toutes les ressources <type>resource</type> actuellement actives,
   optionellement filtré par le type de ressource.
  </para>
  <note>
   <simpara>
    Cette fonction est destinée à des fins de débogage et de test. Elle n'est pas censée
    être utilisée dans des environnements de production, et surtout pas pour accéder ou même manipuler
    des ressources qui ne sont normalement pas accessibles (par exemple, la ressource
    de flux sous-jacente des instances de <classname>SplFileObject</classname>).
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       Si définis, ceci provoquera <function>get_resources</function> de ne
       retourner seulement les ressources du type donnée.
       <link linkend="resource">A list of resource types is available.</link>
      </para>
      <para>
       Si &string; <literal>Unknown</literal> est fournis pour le type,
       dans ce cas là seulement les ressources dont le type est inconnue
       seront retournées.
      </para>
      <para>
       Si omis, toutes les ressources seront retournées.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un &array; des ressources actuellement actives, indexé par le
   numéro de la ressource.
  </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.0.0</entry>
      <entry>
       <parameter>type</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>get_resources</function> non-filtré</title>
    <programlisting role="php">
<![CDATA[
<?php
$fp = tmpfile();
var_dump(get_resources());
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(1) {
  [1]=>
  resource(1) of type (stream)
}
]]>
    </screen>
   </example>
   <example>
    <title><function>get_resources</function> filtré</title>
    <programlisting role="php">
<![CDATA[
<?php
$fp = tmpfile();
var_dump(get_resources('stream'));
var_dump(get_resources('curl'));
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(1) {
  [1]=>
  resource(1) of type (stream)
}
array(0) {
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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