repo_zf1/documentation/manual/en/module_specs/Zend_Http_UserAgent-Features_Wurfl.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.http.user-agent-features-wurfl">
    <title>The WURFL UserAgent Features Adapter</title>

    <sect2 id="zend.http.user-agent-features-wurfl.intro">
        <title>Overview</title>

        <para>
            <ulink url="http://wurfl.sourceforge.net/">WURFL</ulink> (Wireless Universal Resource
            File) is a database of mobile device capabilities. This class provides a <link
                linkend="zend.http.user-agent-features">features adapter</link> that utilizes the
            <acronym>WURFL</acronym> PHP API in order to discover mobile device capabilities to
            inject into <classname>UserAgent</classname> device instances.
        </para>
    </sect2>

    <sect2 id="zend.http.user-agent-features-wurfl.quick-start">
        <title>Quick Start</title>

        <para>
            Please see the <link linkend="zend.http.user-agent.quick-start">Zend_Http_UserAgent
                quick start</link> for an example.
        </para>
    </sect2>

    <sect2 id="zend.http.user-agent-features-wurfl.options">
        <title>Configuration Options</title>

        <variablelist>
            <title>WURFL API Options</title>

            <varlistentry>
                <term>wurflapi.wurfl_api_version</term>

                <listitem>
                    <para>
                        If using the <acronym>WURFL</acronym> API, use this key to specify which
                        version you are using; typically, this will be either "1.0" or "1.1".
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>wurflapi.wurfl_lib_dir</term>

                <listitem>
                    <para>
                        If using the <acronym>WURFL</acronym> API, use this key to specify in which
                        directory the library exists.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>wurflapi.wurfl_config_file</term>

                <listitem>
                    <para>
                        If using the <acronym>WURFL</acronym> API, use this key to specify the
                        location of the configuration file you will use; typically, this will be
                        <filename>resources/wurfl-config.php</filename> within the
                        <varname>wurfl_lib_dir</varname>.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>wurflapi.wurfl_config_array.wurfl.main-file</term>

                <listitem>
                    <para>
                        If using version 1.1 of the <acronym>WURFL</acronym> API, you can omit using
                        a <varname>wurfl_config_file</varname>, and instead provide an associative
                        array of configuration values. This particular value indicates the location
                        of the <filename>wurfl.xml</filename> file containing the actual
                        <acronym>WURFL</acronym> database.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>wurflapi.wurfl_config_array.wurfl.patches[]</term>

                <listitem>
                    <para>
                        If using version 1.1 of the <acronym>WURFL</acronym> API, you can omit using
                        a <varname>wurfl_config_file</varname>, and instead provide an associative
                        array of configuration values. This particular value is an array of file
                        locations containing patchfiles for the <varname>wurfl.main-file</varname>
                        (which are used to ammend and extend the primary database file).
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>wurflapi.wurfl_config_array.persistence.provider</term>

                <listitem>
                    <para>
                        If using version 1.1 of the <acronym>WURFL</acronym> API, you can omit using
                        a <varname>wurfl_config_file</varname>, and instead provide an associative
                        array of configuration values. This particular value indicates the type of
                        persistence provider used when caching discovered capabilities. See the
                        <acronym>WURFL</acronym> documentation for potential values; "file" is a
                        known good value.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>wurflapi.wurfl_config_array.persistence.dir</term>

                <listitem>
                    <para>
                        If using version 1.1 of the <acronym>WURFL</acronym> API, you can omit using
                        a <varname>wurfl_config_file</varname>, and instead provide an associative
                        array of configuration values. This particular value indicates the location
                        where the persistence provider will cache discovered capabilities.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </sect2>

    <sect2 id="zend.http.user-agent-features-wurfl.methods">
        <title>Available Methods</title>

        <variablelist>
            <varlistentry id="zend.http.user-agent-features-wurfl.methods.get-from-request">
                <term>
                    <methodsynopsis>
                        <methodname>getFromRequest</methodname>
                        <methodparam>
                            <funcparams>array $request, array $config</funcparams>
                        </methodparam>
                    </methodsynopsis>
                </term>

                <listitem>
                    <para>
                        Decompose the request in order to return an array of device capabilities.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </sect2>
</sect1>