From d491296ee5fbbbb7dfbaf819ecd1338c84c89541 Mon Sep 17 00:00:00 2001
From: Philip Olson <philip@php.net>
Date: Mon, 2 May 2011 21:25:27 +0000
Subject: [PATCH] Documented openssl_cipher_iv_length()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@310715 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/openssl-cipher-iv-length.xml    | 94 +++++++++++++++++++
 reference/openssl/versions.xml                |  1 +
 2 files changed, 95 insertions(+)
 create mode 100644 reference/openssl/functions/openssl-cipher-iv-length.xml

diff --git a/reference/openssl/functions/openssl-cipher-iv-length.xml b/reference/openssl/functions/openssl-cipher-iv-length.xml
new file mode 100644
index 0000000000..cdb5eee70c
--- /dev/null
+++ b/reference/openssl/functions/openssl-cipher-iv-length.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.openssl-cipher-iv-length" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>openssl_cipher_iv_length</refname>
+  <refpurpose>Gets the cipher iv length</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>integer</type><methodname>openssl_cipher_iv_length</methodname>
+   <methodparam><type>string</type><parameter>method</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Gets the cipher iv length.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>method</parameter></term>
+    <listitem>
+     <para>
+      The method.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the cipher length on success, or &false; on failure. 
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Emits an <constant>E_WARNING</constant> level error when the cipher algorithm
+   is unknown.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="openssl-cipher-iv-length.example.basic">
+   <title><function>openssl_cipher_iv_length</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$method = 'AES-128-CBC';
+$ivlen = openssl_cipher_iv_length($method);
+
+echo $ivlen;
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+16
+]]>
+   </screen>
+  </example>
+ </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
+-->
diff --git a/reference/openssl/versions.xml b/reference/openssl/versions.xml
index 8af51887a2..b373a58ea5 100644
--- a/reference/openssl/versions.xml
+++ b/reference/openssl/versions.xml
@@ -4,6 +4,7 @@
   Do NOT translate this file
 -->
 <versions>
+ <function name='openssl_cipher_iv_length' from='PHP 5 &gt;= PHP 5.3.3'/>
  <function name='openssl_csr_export' from='PHP 4 &gt;= 4.2.0, PHP 5'/>
  <function name='openssl_csr_export_to_file' from='PHP 4 &gt;= 4.2.0, PHP 5'/>
  <function name='openssl_csr_get_public_key' from='PHP 5 &gt;= 5.2.0'/>