Initial documentation. This also closes bug #20850

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@112362 c90b9560-bf6c-de11-be94-00142212c4b1

reference/strings/functions/str-shuffle.xml

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.str-shuffle">
+   <refnamediv>
+    <refname>str_shuffle</refname>
+    <refpurpose>Randomly shuffles a string</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>string</type><methodname>str_shuffle</methodname>
+      <methodparam><type>string</type><parameter>str</parameter></methodparam>
+     </methodsynopsis>
+    <simpara>
+     <function>str_shuffle</function> shuffles a string.  One permutation 
+     of all possible is created.
+    </simpara>
+    <para>
+     <example>
+      <title><function>str_shuffle</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$str = 'abcdef';
+$shuffled = str_shuffle($str);
+
+// This will print something like: bfdaec
+print $shuffled;
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <simpara>
+     See also <function>shuffle</function> and <function>rand</function>.
+    </simpara>
+   </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:"../../../../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
+-->