|
|
@@ -494,557 +494,413 @@ resources.useragent.bot.device.prefix = "Mobile_Device"
|
|
|
|
|
|
<sect2 id="zend.http.user-agent.methods">
|
|
|
<title>Available Methods</title>
|
|
|
- <refentry id="zend.http.user-agent.methods.constructor">
|
|
|
- <refnamediv>
|
|
|
- <refname>__construct</refname>
|
|
|
- <refpurpose>Instantiate and initialize</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>__construct</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$options = null</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>__construct()</title>
|
|
|
|
|
|
- <para>
|
|
|
- The constructor attempts to determine the current User-Agent based on the
|
|
|
- options provided, the current request information, and/or previously discovered
|
|
|
- information persisted in storage. Once instantiated, the detected device is
|
|
|
- immediately available.
|
|
|
- </para>
|
|
|
+ <variablelist>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.constructor">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>__construct</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$options = null</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Please see <link linkend="zend.http.user-agent.options">configuration
|
|
|
- options</link> section for details on the <varname>$options</varname> array.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ The constructor attempts to determine the current User-Agent based on the
|
|
|
+ options provided, the current request information, and/or previously discovered
|
|
|
+ information persisted in storage. Once instantiated, the detected device is
|
|
|
+ immediately available.
|
|
|
+ </para>
|
|
|
|
|
|
- <refentry id="zend.http.user-agent.methods.serialize">
|
|
|
- <refnamediv>
|
|
|
- <refname>serialize</refname>
|
|
|
- <refpurpose>Serialize the object for persistence</refpurpose>
|
|
|
- </refnamediv>
|
|
|
+ <para>
|
|
|
+ Please see <link linkend="zend.http.user-agent.options">configuration
|
|
|
+ options</link> section for details on the <varname>$options</varname> array.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>serialize</methodname>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.serialize">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>serialize</methodname>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <refsect1>
|
|
|
- <title>serialize()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Defined by the <interfacename>Serializable</interfacename> interface, this
|
|
|
+ method performs logic necessary to determine what within the object should be
|
|
|
+ serialized when the object is serialized by a storage adapter.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Defined by the <interfacename>Serializable</interfacename> interface, this
|
|
|
- method performs logic necessary to determine what within the object should be
|
|
|
- serialized when the object is serialized by a storage adapter.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.unserialize">
|
|
|
- <refnamediv>
|
|
|
- <refname>unserialize</refname>
|
|
|
- <refpurpose>Unserialize the object</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>unserialize</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$serialized</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>unserialize()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.unserialize">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>unserialize</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$serialized</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Defined by the <interfacename>Serializable</interfacename> interface, this
|
|
|
- method performs logic necessary to determine how to unserialize a previously
|
|
|
- serialized instance.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-options">
|
|
|
- <refnamediv>
|
|
|
- <refname>setOptions</refname>
|
|
|
- <refpurpose>Initialize object state</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setOptions</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$options</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setOptions()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Defined by the <interfacename>Serializable</interfacename> interface, this
|
|
|
+ method performs logic necessary to determine how to unserialize a previously
|
|
|
+ serialized instance.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Initializes object state. Please see the <link
|
|
|
- linkend="zend.http.user-agent.options">configuration options</link> section
|
|
|
- for information on the <varname>$options</varname> array.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.get-user-agent">
|
|
|
- <refnamediv>
|
|
|
- <refname>getUserAgent</refname>
|
|
|
- <refpurpose>Get the user agent string</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getUserAgent</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams></funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>getUserAgent()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-options">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setOptions</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$options</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieve the discovered User-Agent string. Unless set explicitly, this will be
|
|
|
- autodiscovered from the server array.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-user-agent">
|
|
|
- <refnamediv>
|
|
|
- <refname>setUserAgent</refname>
|
|
|
- <refpurpose>Set the user agent string</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setUserAgent</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$userAgent</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setUserAgent()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Initializes object state. Please see the <link
|
|
|
+ linkend="zend.http.user-agent.options">configuration options</link> section
|
|
|
+ for information on the <varname>$options</varname> array.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Set the User-Agent string explicitly. Once <methodname>getDevice()</methodname>
|
|
|
- has been called, this property is marked immutable, and calling this method will
|
|
|
- raise an exception.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.get-http-accept">
|
|
|
- <refnamediv>
|
|
|
- <refname>getHttpAccept</refname>
|
|
|
- <refpurpose>Get the HTTP Accept header value</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getHttpAccept</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$httpAccept = null</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>getHttpAccept()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-user-agent">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getUserAgent</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams></funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieve the HTTP Accept header value.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-http-accept">
|
|
|
- <refnamediv>
|
|
|
- <refname>setHttpAccept</refname>
|
|
|
- <refpurpose>Set the HTTP Accept header value</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setHttpAccept</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$httpAccept</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setHttpAccept()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieve the discovered User-Agent string. Unless set explicitly, this will be
|
|
|
+ autodiscovered from the server array.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Explicitly set the HTTP Accept header value. Once
|
|
|
- <methodname>getDevice()</methodname> has been called, this property is marked
|
|
|
- immutable, and calling this method will raise an exception.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.get-storage">
|
|
|
- <refnamediv>
|
|
|
- <refname>getStorage</refname>
|
|
|
- <refpurpose>Get the persistent storage object</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getStorage</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$browser = null</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>getStorage()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-user-agent">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setUserAgent</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$userAgent</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieves a persistent storage object for a given browser type.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-storage">
|
|
|
- <refnamediv>
|
|
|
- <refname>setStorage</refname>
|
|
|
- <refpurpose>Set the persistent storage object</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setStorage</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>Zend_Http_UserAgent_Storage $storage</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setStorage()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Set the User-Agent string explicitly. Once <methodname>getDevice()</methodname>
|
|
|
+ has been called, this property is marked immutable, and calling this method will
|
|
|
+ raise an exception.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Use this to explicitly set the peristent storage object. Once
|
|
|
- <methodname>getDevice()</methodname> has been called, the storage is marked
|
|
|
- immutable (as in: you may not inject a new storage object), and calling this
|
|
|
- method will raise an exception.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.clear-storage">
|
|
|
- <refnamediv>
|
|
|
- <refname>clearStorage</refname>
|
|
|
- <refpurpose>Clear the storage object</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>clearStorage</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$browser = null</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>clearStorage()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-http-accept">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getHttpAccept</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$httpAccept = null</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Clears any information in the persistent storage object.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieve the HTTP Accept header value.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refentry id="zend.http.user-agent.methods.get-config">
|
|
|
- <refnamediv>
|
|
|
- <refname>getConfig</refname>
|
|
|
- <refpurpose></refpurpose>
|
|
|
- </refnamediv>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-http-accept">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setHttpAccept</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$httpAccept</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getConfig</methodname>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Explicitly set the HTTP Accept header value. Once
|
|
|
+ <methodname>getDevice()</methodname> has been called, this property is marked
|
|
|
+ immutable, and calling this method will raise an exception.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refsect1>
|
|
|
- <title>getConfig()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-storage">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getStorage</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$browser = null</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieve configuration parameters.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieves a persistent storage object for a given browser type.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refentry id="zend.http.user-agent.methods.get-device">
|
|
|
- <refnamediv>
|
|
|
- <refname>getDevice</refname>
|
|
|
- <refpurpose>Get the device object</refpurpose>
|
|
|
- </refnamediv>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-storage">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setStorage</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>Zend_Http_UserAgent_Storage $storage</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getDevice</methodname>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Use this to explicitly set the peristent storage object. Once
|
|
|
+ <methodname>getDevice()</methodname> has been called, the storage is marked
|
|
|
+ immutable (as in: you may not inject a new storage object), and calling this
|
|
|
+ method will raise an exception.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refsect1>
|
|
|
- <title>getDevice()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.clear-storage">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>clearStorage</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$browser = null</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Use this method to get the User-Agent Device object; this is the object that
|
|
|
- will contain the various discovered device capabilities.
|
|
|
- </para>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Clears any information in the persistent storage object.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Discovery of the User-Agent device occurs in this method. Once the device has
|
|
|
- been retrieved, the server array, browser type, user agent, http accept, and
|
|
|
- storage properties are marked as immutable.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-config">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getConfig</methodname>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <refentry id="zend.http.user-agent.methods.get-browser-type">
|
|
|
- <refnamediv>
|
|
|
- <refname>getBrowserType</refname>
|
|
|
- <refpurpose></refpurpose>
|
|
|
- </refnamediv>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieve configuration parameters.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getBrowserType</methodname>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-device">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getDevice</methodname>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <refsect1>
|
|
|
- <title>getBrowserType()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Use this method to get the User-Agent Device object; this is the object that
|
|
|
+ will contain the various discovered device capabilities.
|
|
|
+ </para>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieve the discovered browser type; usually one of:
|
|
|
- </para>
|
|
|
+ <para>
|
|
|
+ Discovery of the User-Agent device occurs in this method. Once the device has
|
|
|
+ been retrieved, the server array, browser type, user agent, http accept, and
|
|
|
+ storage properties are marked as immutable.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <itemizedlist>
|
|
|
- <listitem><para>Bot</para></listitem>
|
|
|
- <listitem><para>Checker</para></listitem>
|
|
|
- <listitem><para>Console</para></listitem>
|
|
|
- <listitem><para>Desktop</para></listitem>
|
|
|
- <listitem><para>Email</para></listitem>
|
|
|
- <listitem><para>Feed</para></listitem>
|
|
|
- <listitem><para>Mobile</para></listitem>
|
|
|
- <listitem><para>Offline</para></listitem>
|
|
|
- <listitem><para>Probe</para></listitem>
|
|
|
- <listitem><para>Spam</para></listitem>
|
|
|
- <listitem><para>Text</para></listitem>
|
|
|
- <listitem><para>Validator</para></listitem>
|
|
|
- </itemizedlist>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-browser-type">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getBrowserType</methodname>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Unless explicitly set, the browser type is unknown until
|
|
|
- <methodname>getDevice()</methodname> has been called.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-browser-type">
|
|
|
- <refnamediv>
|
|
|
- <refname>setBrowserType</refname>
|
|
|
- <refpurpose>Set a browser type to prepend to the identification sequence</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setBrowserType</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$browserType</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setBrowserType()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieve the discovered browser type; usually one of:
|
|
|
+ </para>
|
|
|
|
|
|
- <para>
|
|
|
- Explicitly set the browser type to prepend to the identification sequence. Once
|
|
|
- <methodname>getDevice()</methodname> has been called, the browser type is marked
|
|
|
- immutable, and calling this method will raise an exception.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem><para>Bot</para></listitem>
|
|
|
+ <listitem><para>Checker</para></listitem>
|
|
|
+ <listitem><para>Console</para></listitem>
|
|
|
+ <listitem><para>Desktop</para></listitem>
|
|
|
+ <listitem><para>Email</para></listitem>
|
|
|
+ <listitem><para>Feed</para></listitem>
|
|
|
+ <listitem><para>Mobile</para></listitem>
|
|
|
+ <listitem><para>Offline</para></listitem>
|
|
|
+ <listitem><para>Probe</para></listitem>
|
|
|
+ <listitem><para>Spam</para></listitem>
|
|
|
+ <listitem><para>Text</para></listitem>
|
|
|
+ <listitem><para>Validator</para></listitem>
|
|
|
+ </itemizedlist>
|
|
|
|
|
|
- <refentry id="zend.http.user-agent.methods.get-server">
|
|
|
- <refnamediv>
|
|
|
- <refname>getServer</refname>
|
|
|
- <refpurpose>Retrieve the server array</refpurpose>
|
|
|
- </refnamediv>
|
|
|
+ <para>
|
|
|
+ Unless explicitly set, the browser type is unknown until
|
|
|
+ <methodname>getDevice()</methodname> has been called.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getServer</methodname>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-browser-type">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setBrowserType</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$browserType</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <refsect1>
|
|
|
- <title>getServer()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Explicitly set the browser type to prepend to the identification sequence. Once
|
|
|
+ <methodname>getDevice()</methodname> has been called, the browser type is marked
|
|
|
+ immutable, and calling this method will raise an exception.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieve the array of HTTP headers and environment variables used to perform
|
|
|
- device discovery. If the array has not yet been set, it is seeded with the
|
|
|
- <varname>$_SERVER</varname> superglobal.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-server">
|
|
|
- <refnamediv>
|
|
|
- <refname>setServer</refname>
|
|
|
- <refpurpose>Set the server array</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setServer</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$server</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setServer()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-server">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getServer</methodname>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Explicitly set the "server" array of HTTP headers and environment variables to
|
|
|
- use during device discovery. Once <methodname>getDevice()</methodname> has been
|
|
|
- called, the server array is marked immutable, and calling this method will raise
|
|
|
- an exception.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.get-server-value">
|
|
|
- <refnamediv>
|
|
|
- <refname>getServerValue</refname>
|
|
|
- <refpurpose></refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getServerValue</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$key</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>getServerValue()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieve the array of HTTP headers and environment variables used to perform
|
|
|
+ device discovery. If the array has not yet been set, it is seeded with the
|
|
|
+ <varname>$_SERVER</varname> superglobal.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieve a single value from the server array by key.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-server-value">
|
|
|
- <refnamediv>
|
|
|
- <refname>setServerValue</refname>
|
|
|
- <refpurpose></refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setServerValue</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$key, $value</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setServerValue()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-server">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setServer</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$server</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Overwrite or define a value in the internal server array. Once
|
|
|
- <methodname>getDevice()</methodname> has been called, the server array is marked
|
|
|
- immutable, and calling this method will raise an exception.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.set-plugin-loader">
|
|
|
- <refnamediv>
|
|
|
- <refname>setPluginLoader</refname>
|
|
|
- <refpurpose>Set a specific plugin loader instance</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>setPluginLoader</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$type, $loader</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>setPluginLoader()</title>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Explicitly set the "server" array of HTTP headers and environment variables to
|
|
|
+ use during device discovery. Once <methodname>getDevice()</methodname> has been
|
|
|
+ called, the server array is marked immutable, and calling this method will raise
|
|
|
+ an exception.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
|
|
|
- <para>
|
|
|
- <varname>$type</varname> may be one of "device" or "storage; the former is used
|
|
|
- when attempting to find device classes, the latter for finding storage classes.
|
|
|
- <varname>$loader</varname> may be a
|
|
|
- <classname>Zend_Loader_PluginLoader</classname> instance, or a string name
|
|
|
- containing the classname of a <classname>Zend_Loader_PluginLoader</classname>
|
|
|
- extension class.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
-
|
|
|
- <refentry id="zend.http.user-agent.methods.get-plugin-loader">
|
|
|
- <refnamediv>
|
|
|
- <refname>getPluginLoader</refname>
|
|
|
- <refpurpose>Retrieve a plugin loader</refpurpose>
|
|
|
- </refnamediv>
|
|
|
-
|
|
|
- <refsynopsisdiv>
|
|
|
- <methodsynopsis>
|
|
|
- <methodname>getPluginLoader</methodname>
|
|
|
- <methodparam>
|
|
|
- <funcparams>$type</funcparams>
|
|
|
- </methodparam>
|
|
|
- </methodsynopsis>
|
|
|
- </refsynopsisdiv>
|
|
|
-
|
|
|
- <refsect1>
|
|
|
- <title>getPluginLoader()</title>
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-server-value">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getServerValue</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$key</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
|
|
|
- <para>
|
|
|
- Retrieves either the "device" or "storage" plugin loader instance.
|
|
|
- </para>
|
|
|
- </refsect1>
|
|
|
- </refentry>
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieve a single value from the server array by key.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-server-value">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setServerValue</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$key, $value</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Overwrite or define a value in the internal server array. Once
|
|
|
+ <methodname>getDevice()</methodname> has been called, the server array is marked
|
|
|
+ immutable, and calling this method will raise an exception.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.set-plugin-loader">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>setPluginLoader</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$type, $loader</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ <varname>$type</varname> may be one of "device" or "storage; the former is used
|
|
|
+ when attempting to find device classes, the latter for finding storage classes.
|
|
|
+ <varname>$loader</varname> may be a
|
|
|
+ <classname>Zend_Loader_PluginLoader</classname> instance, or a string name
|
|
|
+ containing the classname of a <classname>Zend_Loader_PluginLoader</classname>
|
|
|
+ extension class.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry id="zend.http.user-agent.methods.get-plugin-loader">
|
|
|
+ <term>
|
|
|
+ <methodsynopsis>
|
|
|
+ <methodname>getPluginLoader</methodname>
|
|
|
+ <methodparam>
|
|
|
+ <funcparams>$type</funcparams>
|
|
|
+ </methodparam>
|
|
|
+ </methodsynopsis>
|
|
|
+ </term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>
|
|
|
+ Retrieves either the "device" or "storage" plugin loader instance.
|
|
|
+ </para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+ </variablelist>
|
|
|
</sect2>
|
|
|
|
|
|
<sect2 id="zend.http.user-agent.examples">
|
matthew