php-doc-en/reference/password/functions/password-algos.xml
Christoph Michael Becker c9596f7576 Fix #79565: Documentation missing for password_algos()
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349903 c90b9560-bf6c-de11-be94-00142212c4b1
2020-05-17 12:05:19 +00:00

79 lines
1.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.password-algos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>password_algos</refname>
<refpurpose>Get available password hashing algorithm IDs</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>password_algos</methodname>
<void />
</methodsynopsis>
<para>
Returns a complete list of all registered password hashing algorithm IDs as an &array; of &string;s.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the available password hashing algorithm IDs.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="password-algos.example.basic">
<title>Basic <function>password</function> usage</title>
<programlisting role="php">
<![CDATA[
<?php
print_r(password_algos());
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[0] => 2y
[1] => argon2i
[2] => argon2id
)
]]>
</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
-->