<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.oci8.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.oci-set-client-identifier.php',
    1 => 'oci_set_client_identifier',
    2 => 'クライアント識別子を設定します',
  ),
  'up' => 
  array (
    0 => 'ref.oci8.php',
    1 => 'OCI8 関数',
  ),
  'prev' => 
  array (
    0 => 'function.oci-set-call-timout.php',
    1 => 'oci_set_call_timeout',
  ),
  'next' => 
  array (
    0 => 'function.oci-set-client-info.php',
    1 => 'oci_set_client_info',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/oci8/functions/oci-set-client-identifier.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.oci-set-client-identifier" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">oci_set_client_identifier</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.2, PHP 7, PHP 8, PECL OCI8 &gt;= 1.4.0)</p><p class="refpurpose"><span class="refname">oci_set_client_identifier</span> &mdash; <span class="dc-title">クライアント識別子を設定します</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.oci-set-client-identifier-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>oci_set_client_identifier</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$connection</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$client_id</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   同一のデータベース・ユーザーとして認証するライトウェイト・アプリケーションのユーザーを識別するために、
   様々なデータベースコンポーネントによって使用されるクライアント識別子を設定します。
  </p>
  <p class="para">
   PHP からデータベースへの次の「ラウンドトリップ」が起きると、
   クライアント識別子がデータベースに登録されます。これは一般的にSQLステートメントが実行されるときに起こります。
  </p>
  <p class="para">
   <code class="literal">SELECT SYS_CONTEXT(&#039;USERENV&#039;,&#039;CLIENT_IDENTIFIER&#039;)
   FROM DUAL</code> などとして、クライアント識別子を後に問い合わせることができます。
   <code class="literal">V$SESSION</code> のようなデータベース管理ビューにも同じ値が含まれています。
   それは <code class="literal">DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE</code>
   と一緒に追跡のために使われることができます。
   それは監査のために使われることができます。
  </p>
  <p class="para">
   この関数で設定した値は、同じ持続的接続を使っている複数のページリクエストにまたがって保持される可能性があります。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.oci-set-client-identifier-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection</code></dt>
     <dd>
      <p class="para">
<span class="function"><a href="function.oci-connect.php" class="function">oci_connect()</a></span>、<span class="function"><a href="function.oci-pconnect.php" class="function">oci_pconnect()</a></span>
あるいは <span class="function"><a href="function.oci-new-connect.php" class="function">oci_new_connect()</a></span> が返す Oracle 接続 ID。</p>
     </dd>
    
    
     <dt><code class="parameter">client_id</code></dt>
     <dd>
      <p class="para">
       ユーザーが選んだ、長さが最高64バイトの文字列。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.oci-set-client-identifier-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.oci-set-client-identifier-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 クライアント識別子をアプリケーションのユーザーに設定する</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// アプリケーションのユーザーログイン名を検索<br /></span><span style="color: #0000BB">session_start</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$un </span><span style="color: #007700">= </span><span style="color: #0000BB">my_validate_session</span><span style="color: #007700">(</span><span style="color: #0000BB">$_SESSION</span><span style="color: #007700">[</span><span style="color: #DD0000">'username'</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'myschema'</span><span style="color: #007700">, </span><span style="color: #DD0000">'welcome'</span><span style="color: #007700">, </span><span style="color: #DD0000">'localhost/XE'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// そのユーザーが誰であるか Oracle に通知<br /></span><span style="color: #0000BB">oci_set_client_identifier</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #0000BB">$un</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// データベースへの次の「ラウンドトリップ」がその識別子を背負うでしょう<br /></span><span style="color: #0000BB">$s </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #DD0000">'select mydata from mytable'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$s</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// ...<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.oci-set-client-identifier-notes">
  <h3 class="title">注意</h3>
  <div class="caution"><strong class="caution">警告</strong><h1 class="title">データベースとのやりとりに関するメモ</h1>
<p class="para">OCI8 関数の中には、データベースとのやりとりを伴わないものもあります。
たとえば、結果のキャッシングが有効になっている場合、
クエリを実行してもデータベースとのやりとりを行わない可能性があります。
</p></div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.oci-set-client-identifier-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.oci-set-module-name.php" class="function" rel="rdfs-seeAlso">oci_set_module_name()</a> - モジュール名を設定します</span></li>
    <li><span class="function"><a href="function.oci-set-action.php" class="function" rel="rdfs-seeAlso">oci_set_action()</a> - アクション名を設定します</span></li>
    <li><span class="function"><a href="function.oci-set-client-info.php" class="function" rel="rdfs-seeAlso">oci_set_client_info()</a> - クライアント情報を設定する</span></li>
    <li><span class="function"><a href="function.oci-set-db-operation.php" class="function" rel="rdfs-seeAlso">oci_set_db_operation()</a> - Sets the database operation</span></li>
   </ul>
  </p>
 </div>


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