derick Sat Jan 17 16:39:10 2004 EDT
Modified files:
/phpdoc/en/reference/mcrypt/functions mcrypt-get-block-size.xml
mcrypt-get-iv-size.xml
mcrypt-get-key-size.xml
Log:
- More mcrypt documentation adjustments
Index: phpdoc/en/reference/mcrypt/functions/mcrypt-get-block-size.xml
diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-get-block-size.xml:1.4
phpdoc/en/reference/mcrypt/functions/mcrypt-get-block-size.xml:1.5
--- phpdoc/en/reference/mcrypt/functions/mcrypt-get-block-size.xml:1.4 Mon Dec 15
11:52:01 2003
+++ phpdoc/en/reference/mcrypt/functions/mcrypt-get-block-size.xml Sat Jan 17
16:39:10 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.2 -->
<refentry id="function.mcrypt-get-block-size">
<refnamediv>
@@ -27,6 +27,11 @@
combination with an encryption mode).
</para>
<para>
+ It is more useful to use the <function>mcrypt_enc_get_block_size</function>
+ function as this uses the resource returned by
+ <function>mcrypt_module_open</function>.
+ </para>
+ <para>
This example shows how to use this function when linked against libmcrypt
2.4.x and 2.5.x.
<example>
@@ -44,7 +49,8 @@
</example>
</para>
<para>
- See also: <function>mcrypt_get_key_size</function> and
+ See also: <function>mcrypt_get_key_size</function>,
+ <function>mcrypt_enc_get_block_size</function> and
<function>mcrypt_encrypt</function>.
</para>
</refsect1>
Index: phpdoc/en/reference/mcrypt/functions/mcrypt-get-iv-size.xml
diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-get-iv-size.xml:1.8
phpdoc/en/reference/mcrypt/functions/mcrypt-get-iv-size.xml:1.9
--- phpdoc/en/reference/mcrypt/functions/mcrypt-get-iv-size.xml:1.8 Mon Dec 15
11:52:01 2003
+++ phpdoc/en/reference/mcrypt/functions/mcrypt-get-iv-size.xml Sat Jan 17 16:39:10
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
<refentry id="function.mcrypt-get-iv-size">
<refnamediv>
@@ -12,18 +12,10 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>mcrypt_get_iv_size</methodname>
- <methodparam><type>resource</type><parameter>td</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis>
- <type>int</type><methodname>mcrypt_get_iv_size</methodname>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
- The first prototype is when linked against libmcrypt 2.2.x, the
- second when linked against libmcrypt 2.4.x or higher.
- </para>
- <para>
<function>mcrypt_get_iv_size</function> returns the size of
the Initialisation Vector (IV) in bytes. On error the function
returns &false;. If the IV is ignored in the specified cipher/mode
@@ -41,18 +33,19 @@
decryption stages, otherwise your encryption will fail.
</para>
<para>
- <parameter>td</parameter> is the resource that is returned by
+ It is more useful to use the <function>mcrypt_enc_get_iv_size</function>
+ function as this uses the resource returned by
<function>mcrypt_module_open</function>.
</para>
<para>
<example>
- <title><function>mcrypt_create_iv</function> example</title>
+ <title><function>mcrypt_get_iv_size</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
- $size = mcrypt_get_iv_size(MCRYPT_CAST_256, MCRYPT_MODE_CFB);
+ echo mcrypt_get_iv_size(MCRYPT_CAST_256, MCRYPT_MODE_CFB) . "\n";
- $size = mcrypt_get_iv_size('des', 'ecb');
+ echo mcrypt_get_iv_size('des', 'ecb') . "\n";
?>
]]>
</programlisting>
@@ -60,7 +53,8 @@
</para>
<para>
See also
- <function>mcrypt_get_block_size</function>, and
+ <function>mcrypt_get_block_size</function>,
+ <function>mcrypt_enc_get_iv_size</function> and
<function>mcrypt_create_iv</function>.
</para>
</refsect1>
Index: phpdoc/en/reference/mcrypt/functions/mcrypt-get-key-size.xml
diff -u phpdoc/en/reference/mcrypt/functions/mcrypt-get-key-size.xml:1.5
phpdoc/en/reference/mcrypt/functions/mcrypt-get-key-size.xml:1.6
--- phpdoc/en/reference/mcrypt/functions/mcrypt-get-key-size.xml:1.5 Mon Dec 15
11:52:01 2003
+++ phpdoc/en/reference/mcrypt/functions/mcrypt-get-key-size.xml Sat Jan 17
16:39:10 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.2 -->
<refentry id="function.mcrypt-get-key-size">
<refnamediv>
@@ -28,7 +28,10 @@
</para>
<para>
This example shows how to use this function when linked against libmcrypt
- 2.4.x and 2.5.x.
+ 2.4.x and 2.5.x. It is more useful to use the
+ <function>mcrypt_enc_get_key_size</function> function as this uses the
+ resource returned by <function>mcrypt_module_open</function>.
+
<example>
<title><function>mcrypt_get_block_size</function> example</title>
<programlisting role="php">
@@ -44,7 +47,8 @@
</example>
</para>
<para>
- See also: <function>mcrypt_get_block_size</function> and
+ See also: <function>mcrypt_get_block_size</function>,
+ <function>mcrypt_end_get_key_size</function> and
<function>mcrypt_encrypt</function>.
</para>
