aidan Sat Oct 2 23:49:17 2004 EDT
Modified files:
/phpdoc/en/reference/misc/functions get-browser.xml
Log:
Reorganised information and rewrote the example
http://cvs.php.net/diff.php/phpdoc/en/reference/misc/functions/get-browser.xml?r1=1.11&r2=1.12&ty=u
Index: phpdoc/en/reference/misc/functions/get-browser.xml
diff -u phpdoc/en/reference/misc/functions/get-browser.xml:1.11
phpdoc/en/reference/misc/functions/get-browser.xml:1.12
--- phpdoc/en/reference/misc/functions/get-browser.xml:1.11 Wed Aug 18 10:15:18
2004
+++ phpdoc/en/reference/misc/functions/get-browser.xml Sat Oct 2 23:49:16 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/misc.xml, last change in rev 1.2 -->
<refentry id="function.get-browser">
<refnamediv>
@@ -10,110 +10,110 @@
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>object</type><methodname>get_browser</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>user_agent</parameter></methodparam>
- <methodparam
choice="opt"><type>bool</type><parameter>return_array</parameter></methodparam>
- </methodsynopsis>
- <simpara>
+ <methodsynopsis>
+ <type>object</type><methodname>get_browser</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>user_agent</parameter></methodparam>
+ <methodparam
choice="opt"><type>bool</type><parameter>return_array</parameter></methodparam>
+ </methodsynopsis>
+ <para>
<function>get_browser</function> attempts to determine the
capabilities of the user's browser. This is done by looking up
the browser's information in the <filename>browscap.ini</filename>
- file. By default, the value of <varname>$_SERVER["HTTP_USER_AGENT"]</varname> is
+ file.
+ </para>
+ <para>
+ By default, the value of <varname>$_SERVER['HTTP_USER_AGENT']</varname> is
used; however, you can alter this (i.e., look up another browser's
- info) by passing the optional
- <parameter>user_agent</parameter> parameter to
- <function>get_browser</function>.
- </simpara>
+ info) by passing the optional <parameter>user_agent</parameter> parameter to
+ <function>get_browser</function>. You can bypass
<parameter>user_agent</parameter>
+ parameter with &null; value.
+ </para>
<simpara>
The information is returned in an <type>object</type>, which will contain
various data elements representing, for instance, the browser's
major and minor version numbers and ID string; &true;/&false; values
for features such as frames, JavaScript, and cookies; and so
forth.
- As of PHP 4.3.2, if the optional parameter
- <parameter>return_array</parameter> is &true;, this function will return
- <type>array</type> instead of <type>object</type>. You can bypass
- <parameter>user_agent</parameter> parameter with &null; value.
</simpara>
<simpara>
- While <filename>browscap.ini</filename> contains information on
- many browsers, it relies on user updates to keep the database
- current. The format of the file is fairly self-explanatory.
+ As of PHP 4.3.2, if the optional parameter
+ <parameter>return_array</parameter> is &true;, this function will return an
+ <type>array</type> instead of an <type>object</type>.
</simpara>
<para>
- The following example shows how one might list all available
- information retrieved about the user's browser.
<example>
- <title><function>get_browser</function> example</title>
+ <title>Listing all information about the users browser</title>
<programlisting role="php">
<![CDATA[
<?php
-echo $_SERVER['HTTP_USER_AGENT'] . "<hr />\n";
-
-$browser = get_browser();
-
-foreach ($browser as $name => $value) {
- echo "<b>$name</b> $value <br />\n";
-}
+echo $_SERVER['HTTP_USER_AGENT'] . "\n\n";
+$browser = get_browser(null, true);
+print_r($browser);
?>
]]>
</programlisting>
- <simpara>
- The output of the above script would look something like this:
- </simpara>
- <screen role="html">
+ &example.outputs.similar;
+ <screen>
<![CDATA[
-Mozilla/4.5 [en] (X11; U; Linux 2.2.9 i586)<hr />
-<b>browser_name_pattern:</b> Mozilla/4\.5.*<br />
-<b>parent:</b> Netscape 4.0<br />
-<b>platform:</b> Linux<br />
-<b>majorver:</b> 4<br />
-<b>minorver:</b> 5<br />
-<b>browser:</b> Netscape<br />
-<b>version:</b> 4<br />
-<b>frames:</b> 1<br />
-<b>tables:</b> 1<br />
-<b>cookies:</b> 1<br />
-<b>backgroundsounds:</b> <br />
-<b>vbscript:</b> <br />
-<b>javascript:</b> 1<br />
-<b>javaapplets:</b> 1<br />
-<b>activexcontrols:</b> <br />
-<b>beta:</b> <br />
-<b>crawler:</b> <br />
-<b>authenticodeupdate:</b> <br />
-<b>msn:</b> <br />
+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
+ [css] => 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>
- <simpara>
- In order for this to work, your <link
- linkend="ini.browscap">browscap</link> configuration setting in
- &php.ini; must point to the correct location of the
- <filename>browscap.ini</filename> file on your system.
- <filename>browscap.ini</filename> is not bundled with PHP but you
- may find an up-to-date <ulink url="&url.browscap.download;">
- browscap.ini file here</ulink>. By default, the
- <link linkend="ini.browscap">browscap</link> directive is commented out.
- </simpara>
- <simpara>
+ <para>
The <literal>cookies</literal> value simply means that the browser
itself is capable of accepting cookies and does not mean the user has
- enabled the browser to accept cookies or not. The only way to test if
+ enabled the browser to accept cookies or not. The only way to test if
cookies are accepted is to set one with <function>setcookie</function>,
reload, and check for the value.
- </simpara>
+ </para>
<note>
- <simpara>
- On versions older than PHP 4.0.6, you will have to pass the
- user agent in via the optional <parameter>user_agent</parameter>
- parameter if the PHP directive <link linkend="ini.register-globals">
- register_globals</link> is <literal>off</literal>. In this case,
- you will pass in <varname>$HTTP_SERVER_VARS['HTTP_USER_AGENT']</varname>.
- </simpara>
+ <para>
+ In order for this to work, your <link linkend="ini.browscap">browscap</link>
+ configuration setting in &php.ini; must point to the correct location of the
+ <filename>browscap.ini</filename> file on your system.
+ </para>
+ <para>
+ <filename>browscap.ini</filename> is not bundled with PHP, but you
+ may find an <ulink url="&url.browscap.download;">up-to-date
php_browscap.ini</ulink>
+ file here.
+ </para>
+ <para>
+ While <filename>browscap.ini</filename> contains information on
+ many browsers, it relies on user updates to keep the database
+ current. The format of the file is fairly self-explanatory.
+ </para>
</note>
</refsect1>
</refentry>
