oci-set-client-identifier.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: ed6de1ae20ce16c0c7be0b3fef282b6065bebfac Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: mikaelkael -->
<refentry xml:id="function.oci-set-client-identifier" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>oci_set_client_identifier</refname>
  <refpurpose>Définit l'identifiant du client</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>oci_set_client_identifier</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>client_id</parameter></methodparam>
  </methodsynopsis>
  <para>
   Définit l'identifiant du client, utilisé par de nombreux composants
   de la base de données pour identifier les utilisateurs de l'application
   qui s'authentifie avec le même nom d'utilisateur de base de données.
  </para>
  <para>
   L'identifiant du client est enregistré avec la base de données lors du prochain
   aller-retour 'round-trip' depuis PHP vers la base de données est effectué ;
   typiquement, l'exécution d'une requête SQL.
  </para>
  <para>
   L'identifiant peut par la suite être interrogé, par exemple,
   avec la requête <literal>SELECT SYS_CONTEXT('USERENV','CLIENT_IDENTIFIER')
   FROM DUAL</literal>. Une vue de l'administration de la base de données,
   comme la vue <literal>V$SESSION</literal> contient également la valeur.
   Il peut être utilisé avec <literal>DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE</literal>
   dans le cadrage d'un tracage. Il peut également être utilisé dans le cadre
   d'un audit.
  </para>
  <para>
   La valeur peut être conservée suivants les différentes requêtes des pages
   qui utilisent la même connexion persistante.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &oci.parameter.connection;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>client_id</parameter></term>
     <listitem>
      <para>
       Chaîne choisie par l'utilisateur jusqu'à 64 octets de long.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Définit l'identifiant du client comme l'utilisateur de l'application</title>
    <programlisting role="php">
<![CDATA[
<?php

// Retrouve le nom utilisé pour l'identification de l'utilisateur de l'application
session_start();
$un = my_validate_session($_SESSION['username']);
$c = oci_connect('myschema', 'welcome', 'localhost/XE');

// Informe Oracle sur cet utilisateur
oci_set_client_identifier($c, $un);

// Le prochain aller-retour (round-trip) vers la base de données validera cet identifiant
$s = oci_parse($c, 'select mydata from mytable');
oci_execute($s);

// ...

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &oci.roundtrip.caution;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>oci_set_module_name</function></member>
    <member><function>oci_set_action</function></member>
    <member><function>oci_set_client_info</function></member>
    <member><function>oci_set_db_operation</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- 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
-->