<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.sessionhandlerinterface.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'sessionhandlerinterface.read.php',
    1 => 'SessionHandlerInterface::read',
    2 => 'セッションのデータを読み込む',
  ),
  'up' => 
  array (
    0 => 'class.sessionhandlerinterface.php',
    1 => 'SessionHandlerInterface',
  ),
  'prev' => 
  array (
    0 => 'sessionhandlerinterface.open.php',
    1 => 'SessionHandlerInterface::open',
  ),
  'next' => 
  array (
    0 => 'sessionhandlerinterface.write.php',
    1 => 'SessionHandlerInterface::write',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/session/sessionhandlerinterface/read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="sessionhandlerinterface.read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SessionHandlerInterface::read</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.4.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SessionHandlerInterface::read</span> &mdash; <span class="dc-title">セッションのデータを読み込む</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-sessionhandlerinterface.read-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SessionHandlerInterface::read</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$id</code></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   セッションのデータをセッションストレージから読み込み、その結果を返します。
   セッションを開始した直後、あるいは <span class="function"><a href="function.session-start.php" class="function">session_start()</a></span> を実行したときにコールされます。
   このメソッドがコールされる直前に <span class="function"><a href="sessionhandlerinterface.open.php" class="function">SessionHandlerInterface::open()</a></span>
   が実行されることに注意しましょう。
  </p>
  <p class="para">
   このメソッドは、セッションが開始するときに PHP 自身がコールします。
   このメソッドは、指定したセッション ID のセッションデータをストレージから取得しなければなりません。
   返す文字列の書式は、<span class="function"><a href="sessionhandlerinterface.write.php" class="function">SessionHandlerInterface::write()</a></span>
   に渡されたものと同様にシリアライズされたものでなければなりません。
   データが見つからない場合は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
  <p class="para">
   このメソッドが返すデータは、PHP が内部的にデコードします。デコードに使うメソッドは
   <a href="session.configuration.php#ini.session.serialize-handler" class="link">session.serialize_handler</a>
   で指定します。デコードした結果をスーパーグローバル <var class="varname"><a href="reserved.variables.session.php" class="classname">$_SESSION</a></var> に格納します。
  </p>
  <p class="para">
   シリアライズ方式は <span class="function"><a href="function.unserialize.php" class="function">unserialize()</a></span> とは異なっており、アクセスするためには
   <span class="function"><a href="function.session-decode.php" class="function">session_decode()</a></span> を使うことに注意しましょう。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-sessionhandlerinterface.read-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">id</code></dt>
    <dd>
     <p class="para">
      セッション id。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-sessionhandlerinterface.read-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   読み込んだデータをエンコードした文字列を返します。
   何も読まなかった場合は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返さなければなりません。
   この値は、PHP が内部的に使うためだけのものであることに注意しましょう。
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-sessionhandlerinterface.read-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li>
     <a href="session.configuration.php#ini.session.serialize-handler" class="link">session.serialize_handler</a>
    </li>
   </ul>
  </p>
 </div>


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