Add openssl_cipher_key_length description

Author: saundefined

reference/openssl/functions/openssl-cipher-key-length.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="function.openssl-cipher-key-length" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>v</refname>
+  <refpurpose>Gets the cipher key length</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type class="union"><type>int</type><type>false</type></type><methodname>openssl_cipher_key_length</methodname>
+   <methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Gets the cipher key length.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>cipher_algo</parameter></term>
+    <listitem>
+     <para>
+      The cipher method, see <function>openssl_get_cipher_methods</function> for a list of potential values.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the cipher length on success, &return.falseforfailure;. 
+  </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>
+   <title><function>openssl_cipher_key_length</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$method = 'AES-128-CBC';
+
+var_dump(openssl_cipher_key_length($method));
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+int(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
+-->

reference/openssl/versions.xml

@@ -5,6 +5,7 @@
 -->
 <versions>
  <function name="openssl_cipher_iv_length" from="PHP 5 &gt;= 5.3.3, PHP 7, PHP 8"/>
+ <function name="openssl_cipher_key_length" from="PHP 8 &gt;= 8.2.0"/>
  <function name="openssl_cms_decrypt" from="PHP 8"/>
  <function name="openssl_cms_encrypt" from="PHP 8"/>
  <function name="openssl_cms_read" from="PHP 8"/>