<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.random-randomizer.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'random-randomizer.shufflearray.php',
    1 => 'Random\\Randomizer::shuffleArray',
    2 => '配列の順列を取得する',
  ),
  'up' => 
  array (
    0 => 'class.random-randomizer.php',
    1 => 'Random\\Randomizer',
  ),
  'prev' => 
  array (
    0 => 'random-randomizer.serialize.php',
    1 => 'Random\\Randomizer::__serialize',
  ),
  'next' => 
  array (
    0 => 'random-randomizer.shufflebytes.php',
    1 => 'Random\\Randomizer::shuffleBytes',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/random/random/randomizer/shufflearray.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="random-randomizer.shufflearray" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Random\Randomizer::shuffleArray</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.2.0)</p><p class="refpurpose"><span class="refname">Random\Randomizer::shuffleArray</span> &mdash; <span class="dc-title">配列の順列を取得する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-random-randomizer.shufflearray-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Random\Randomizer::shuffleArray</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$array</code></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   指定された <code class="parameter">array</code> のあり得る順列から、
   等確率に選ばれた順列を返します。
  </p>
  <p class="para">
   指定された <code class="parameter">array</code> のあり得る順列それぞれが、返される確率は等しくなります。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-random-randomizer.shufflearray-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">array</code></dt>
    <dd>
     <p class="para">
      値をシャッフルする配列
     </p>
     <p class="para">
      指定された配列は変更されません。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-random-randomizer.shufflearray-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <code class="parameter">array</code> の値の順列を返します。
  </p>
  <p class="para">
   指定された <code class="parameter">array</code> のキーは保存されません。
   つまり、返される配列はリスト (<span class="function"><a href="function.array-is-list.php" class="function">array_is_list()</a></span>) になります。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-random-randomizer.shufflearray-errors">
  <h3 class="title">エラー / 例外</h3>
  <ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
    <a href="class.random-randomizer.php#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a> に存在する
    <span class="methodname"><a href="random-engine.generate.php" class="methodname">Random\Engine::generate()</a></span> メソッド
    がスローした、あらゆる <span class="classname"><a href="class.throwable.php" class="classname">Throwable</a></span> がスローされます。
  </span>
 </li>

  </ul>
 </div>


 <div class="refsect1 examples" id="refsect1-random-randomizer.shufflearray-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>Random\Randomizer::shuffleArray()</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 />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">\Random\Randomizer</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$fruits </span><span style="color: #007700">= [ </span><span style="color: #DD0000">'red' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'🍎'</span><span style="color: #007700">, </span><span style="color: #DD0000">'green' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'🥝'</span><span style="color: #007700">, </span><span style="color: #DD0000">'yellow' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'🍌'</span><span style="color: #007700">, </span><span style="color: #DD0000">'pink' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'🍑'</span><span style="color: #007700">, </span><span style="color: #DD0000">'purple' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'🍇' </span><span style="color: #007700">];<br /><br /></span><span style="color: #FF8000">// 配列をシャッフルします<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Salad: "</span><span style="color: #007700">, </span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">', '</span><span style="color: #007700">, </span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">shuffleArray</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">)), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// 再度シャッフルします<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Another Salad: "</span><span style="color: #007700">, </span><span style="color: #0000BB">implode</span><span style="color: #007700">(</span><span style="color: #DD0000">', '</span><span style="color: #007700">, </span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">shuffleArray</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">)), </span><span style="color: #DD0000">"\n"</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">Salad: 🍎, 🥝, 🍇, 🍌, 🍑
Another Salad: 🍑, 🍇, 🥝, 🍎, 🍌</pre>
</div>
   </div>
  </div>
 </div>



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