<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.random.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.random-int.php',
    1 => 'random_int',
    2 => '暗号学的にセキュアな方法で、等確率に出る整数を取得する',
  ),
  'up' => 
  array (
    0 => 'ref.random.php',
    1 => 'Random 関数',
  ),
  'prev' => 
  array (
    0 => 'function.random-bytes.php',
    1 => 'random_bytes',
  ),
  'next' => 
  array (
    0 => 'function.srand.php',
    1 => 'srand',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/random/functions/random-int.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.random-int" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">random_int</h1>
  <p class="verinfo">(PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">random_int</span> &mdash; <span class="dc-title">暗号学的にセキュアな方法で、等確率に出る整数を取得する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.random-int-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>random_int</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$min</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$max</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>

  <p class="para rdfs-comment">
   指定された最小値と最大値の区間から、
   等確率に選ばれるランダムな整数を生成します。
  </p>
  <p class="para">
   この関数が生成するランダムな値は、すべてのアプリケーションに対して適切です。
   たとえば暗号化キーのような、長期間使うシークレットが挙げられます。
  </p>

  
<p class="para">
 この関数が使う不規則性のソースは、優先度順に以下のとおりです:
</p>
<ul class="itemizedlist">
 <li class="listitem">
  <p class="para">
   Linux: <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   FreeBSD &gt;= 12 (PHP &gt;= 7.3): <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   Windows (PHP &gt;= 7.2): <a href="https://docs.microsoft.com/en-us/windows/desktop/SecCNG/cng-portal" class="link external">&raquo;&nbsp;CNG-API</a>
  </p>
  <p class="para">
   Windows: <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379942(v=vs.85).aspx" class="link external">&raquo;&nbsp;CryptGenRandom</a>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22 CCRandomGenerateBytes がコンパイル時に利用可能な場合): CCRandomGenerateBytes()
  </p>
  <p class="para">
   macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   DragonflyBSD (PHP &gt;= 8.1): <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   Solaris (PHP &gt;= 8.1): <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <span class="simpara">
   上記にあてはまらないオペレーティングシステムやPHP のバージョンの場合: <var class="filename">/dev/urandom</var>
  </span>
 </li>
 <li class="listitem">
  <span class="simpara">
   どの不規則性のソースも利用できなかったり、
   すべてのソースがランダムな値を生成できなかった場合、
   <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span> がスローされます。
  </span>
 </li>
</ul>

  
 <blockquote class="note"><p><strong class="note">注意</strong>: 
  <span class="simpara">
   この関数は PHP 7.0 で追加されたものですが、PHP 5.2 から 5.6 までのバージョンで使える
   <a href="https://github.com/paragonie/random_compat" class="link external">&raquo;&nbsp;ユーザーランドの実装</a>
   も公開されています。
  </span>
 </p></blockquote>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.random-int-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">min</code></dt>
    <dd>
     <p class="para">
      返される最小値。
     </p>
    </dd>
   
   
    <dt><code class="parameter">max</code></dt>
    <dd>
     <p class="para">
      返される最大値。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.random-int-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <code class="parameter">min</code> と <code class="parameter">max</code> の範囲で、
   暗号学的にセキュアな方法で、
   閉区間 [<code class="parameter">min</code>, <code class="parameter">max</code>]
   の中から等確率に出るよう選ばれた整数値を返します。
   <code class="parameter">min</code> と <code class="parameter">max</code>　
   も返される値に含みます。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.random-int-errors">
  <h3 class="title">エラー / 例外</h3>
  <ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   適切な不規則性のソースが見つからない場合は
   <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span> をスローします。
  </span>
 </li>

   <li class="listitem">
    <span class="simpara">
     <code class="parameter">max</code> が <code class="parameter">min</code> より小さい場合、
     <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> がスローされます。
    </span>
   </li>
  </ul>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.random-int-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.2.0</td>
      <td>
       <abbr title="Cryptographically Secure PseudoRandom Number Generator">CSPRNG</abbr> が失敗した場合に、
       <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span> をスローするようになりました。
       これより前のバージョンでは、<span class="classname"><a href="class.exception.php" class="classname">Exception</a></span> をスローしていました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.random-int-examples">
  <h3 class="title">例</h3>
  <div class="example" id="random-int.example.basic">
   <p><strong>例1 <span class="function"><strong>random_int()</strong></span> の例</strong></p>
   <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">random_int</span><span style="color: #007700">(</span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">999</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">random_int</span><span style="color: #007700">(-</span><span style="color: #0000BB">1000</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>上の例の出力は、
たとえば以下のようになります。</p></div>
   <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">int(248)
int(-898)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.random-int-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="random-randomizer.getint.php" class="methodname" rel="rdfs-seeAlso">Random\Randomizer::getInt()</a> - 等確率に選ばれる整数を取得する</span></li>
   <li><span class="function"><a href="function.random-bytes.php" class="function" rel="rdfs-seeAlso">random_bytes()</a> - 暗号学的にセキュアな、ランダムなバイト列を生成する</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>