mcrypt-list-modes.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 115560f445336d95d9fccdc1b8b2a90e210fbbd0 Maintainer: satoruyoshida Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.mcrypt-list-modes" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_list_modes</refname>
  <refpurpose> サポートされる全てのモードの配列を取得する</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>mcrypt_list_modes</methodname>
   <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter><initializer>ini_get("mcrypt.modes_dir")</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>lib_dir</parameter> にあるすべてのサポートするモードの一覧を取得します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>lib_dir</parameter></term>
     <listitem>
      <para>
       すべてのモードが存在するディレクトリを指定します。
       指定しない場合は、
       &php.ini; ディレクティブ <literal>mcrypt.modes_dir</literal> を使用します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   サポートするすべてのモードを配列で返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mcrypt_list_modes</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
    $modes = mcrypt_list_modes();

    foreach ($modes as $mode) {
        echo "$mode <br />\n";
    }
?>
]]>
    </programlisting>
    <para>
     上の例は、デフォルトのモードディレクトリにあるサポートされる
     全てのアルゴリズムの一覧を出力します。&php.ini; ディレクティブの
     <literal>mcrypt.modes_dir</literal> でこれが設定されていない場合、mcrypt の
     デフォルトディレクトリ(<filename>/usr/local/lib/libmcrypt</filename>)が使用されます。
    </para>
   </example>
  </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
-->