get-resources.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 16805838e72187b53a76df37a2dadc20ff6f00af Maintainer: satoruyoshida Status: ready -->
<refentry xml:id="function.get-resources" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_resources</refname>
  <refpurpose>アクティブなリソースを返す</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>
   現在アクティブなすべての <type>resource</type> の配列を返します。 
   オプションでリソース型によってフィルタリングされます。
  </para>
  <note>
   <simpara>
    この関数は、デバッグやテストの用途に使うものです。
    本番環境で使う用途を想定していません。
    特に、通常のやり方ではアクセスできないリソース
    (例: <classname>SplFileObject</classname>
    インスタンスのストリームリソース)
    にアクセスしたり、管理する用途に使ってはいけません。
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       定義された場合、<function>get_resources</function> は、指定された型のリソースのみを返すようになります。
       <link linkend="resource">リソース型の一覧が使用できます。</link>
      </para>
      <para>
       <type>string</type> <literal>Unknown</literal> が型として指定された場合、
       不明な型のリソースのみが返されます。
      </para>
      <para>
       省略した場合、すべてのリソースが返されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   現在アクティブなリソースの <type>array</type> を返します。
   リソース番号でインデックス付けされます。
  </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> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>フィルタリングされていない <function>get_resources</function></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></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
-->