<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.random-engine" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The Random\Engine interface</title>
 <titleabbrev>Random\Engine</titleabbrev>

 <partintro>

<!-- {{{ Random\Engine intro -->
  <section xml:id="random-engine.intro">
   &reftitle.intro;
   <para>
    A <classname>Random\Engine</classname> provides a low-level source of randomness by
    returning random bytes that are consumed by high-level APIs to perform their operations.
    The <classname>Random\Engine</classname> interface allows swapping out the algorithm
    used to generate randomness, because each algorithm makes different tradeoffs to fit
    specific use-cases. Some algorithms are very fast, but generate lower-quality randomness,
    whereas other algorithms are slower, but generate better randomness, up to
    cryptographically secure randomness as provided by the <classname>Random\Engine\Secure</classname>
    engine.
   </para>

   <para>
    PHP provides several <classname>Random\Engine</classname>s out of the box to accomodate
    different use-cases. The <classname>Random\Engine\Secure</classname> engine that is
    backed by a <acronym>CSPRNG</acronym> is the recommended safe default choice, unless
    the application requires either reproducible sequences or very high performance.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="random-engine.synopsis">
   &reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="interface">
    <oointerface>
     <interfacename>Random\Engine</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.random-engine')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Random\\Engine'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

 </partintro>

 &reference.random.random.engine.generate;

</phpdoc:classref>
<!-- 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
-->
