get-browser.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3c699fad2dd94ee926ba04bdaf79e6f14b5b728b Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.get-browser" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>get_browser</refname>
  <refpurpose>Indique les capacités du navigateur client</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>object</type><type>array</type><type>false</type></type><methodname>get_browser</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>user_agent</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>return_array</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>get_browser</function> essaie de déterminer les capacités
   du navigateur client. Cela se fait en lisant les informations 
   dans le fichier <filename>browscap.ini</filename>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>user_agent</parameter></term>
     <listitem>
      <para>
       L'entête user agent à analyser. Par défaut, la valeur de
       l'en-tête <literal>User-Agent</literal> est utilisé; cependant, 
       vous pouvez l'altérer (i.e. cherche d'autres informations sur 
       le navigateur) en passant ce paramètre.
      </para>
      <para>
       Vous pouvez annuler ce paramètre en y passant la valeur &null;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>return_array</parameter></term>
     <listitem>
      <para>
       Si définit à &true;, cette fonction retournera un &array;
       au lieu d'un &object;.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Les informations sont retournées sous forme d'un objet,
   dont les différents membres contiendront des informations,
   telles que les versions majeures et mineures et des chaînes
   d'identification ; des booléens pour des caractéristiques
   telles que frames, JavaScript, et cookies ; et ainsi de suite.
  </para>
  <para>
   La valeur <literal>cookies</literal> indique simplement que le
   navigateur est capable d'accepter les cookies, et n'indique pas
   si l'utilisateur les a activé sur son navigateur. Le seul moyen
   de tester l'activation des cookies est d'en poser un avec
   la fonction <function>setcookie</function>, de recharger la page
   et de vérifier que le cookie existe toujours.
  </para>
  <para>
   Retourne &false; si aucune information ne peut être récupéré, tel que
   quand l'option de configuration <link linkend="ini.browscap">browscap</link>
   dans &php.ini; n'a pas été définie.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>
     Exemple avec <function>get_browser</function> : 
     liste des capacités du navigateur du client web
    </title>
    <programlisting role="php">
<![CDATA[
<?php
echo $_SERVER['HTTP_USER_AGENT'] . "\n\n";

$browser = get_browser(null, true);
print_r($browser);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7) Gecko/20040803 Firefox/0.9.3

Array
(
    [browser_name_regex] => ^mozilla/5\.0 (windows; .; windows nt 5\.1; .*rv:.*) gecko/.* firefox/0\.9.*$
    [browser_name_pattern] => Mozilla/5.0 (Windows; ?; Windows NT 5.1; *rv:*) Gecko/* Firefox/0.9*
    [parent] => Firefox 0.9
    [platform] => WinXP
    [browser] => Firefox
    [version] => 0.9
    [majorver] => 0
    [minorver] => 9
    [cssversion] => 2
    [frames] => 1
    [iframes] => 1
    [tables] => 1
    [cookies] => 1
    [backgroundsounds] =>
    [vbscript] =>
    [javascript] => 1
    [javaapplets] => 1
    [activexcontrols] =>
    [cdf] =>
    [aol] =>
    [beta] => 1
    [win16] =>
    [crawler] =>
    [stripper] =>
    [wap] =>
    [netclr] =>
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Afin de pouvoir fonctionner, la directive de configuration 
    <link linkend="ini.browscap">browscap</link> dans le fichier &php.ini; 
    doit pointer vers le fichier <filename>browscap.ini</filename> de votre
    système.
   </para>
   <para>
    <filename>browscap.ini</filename> n'est pas distribué avec PHP, mais vous
    pouvez le télécharger sur 
    <link xlink:href="&url.browscap.download;">php_browscap.ini</link>.
   </para>
   <para>
    Bien que <filename>browscap.ini</filename> contienne des informations
    sur de très nombreux navigateur, il incombe à l'utilisateur de
    conserver sa base de données à jour. Le format du fichier
    est très simple à comprendre.
   </para>
  </note>
 </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
-->