php-doc-en/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml
Christoph Michael Becker 1c08f29ab7 Mcrypt is deprecated as of PHP 7.1.0
The original patch has been provided by Leigh. I made some minor improvements.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341620 c90b9560-bf6c-de11-be94-00142212c4b1
2017-01-07 15:28:16 +00:00

78 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mcrypt-module-is-block-algorithm-mode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mcrypt_module_is_block_algorithm_mode</refname>
<refpurpose>Returns if the specified module is a block algorithm or not</refpurpose>
</refnamediv>
<refsynopsisdiv>
&warn.deprecated.function-7-1-0;
</refsynopsisdiv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mcrypt_module_is_block_algorithm_mode</methodname>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
This function returns &true; if the mode is for use with block
algorithms, otherwise it returns &false;. (e.g. &false; for stream, and
&true; for cbc, cfb, ofb).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The mode to check.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
The optional <parameter>lib_dir</parameter> parameter can contain the
location where the algorithm module is on the system.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns &true; if the mode is for use with block
algorithms, otherwise it returns &false;. (e.g. &false; for stream, and
&true; for cbc, cfb, ofb).
</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
-->