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

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

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

        <para>
            <ulink url="">TeraWurfl</ulink> parses the WURFL database into a MySQL
            database, and provides an API for querying that database for mobile device capabilies.
            The API also performs rigorous caching, leading to excellent performance.
        </para>
    </sect2>

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

        <para>
            You will need to <ulink
                url="http://www.tera-wurfl.com/wiki/index.php/Downloads">download</ulink> and <ulink
                url="http://www.tera-wurfl.com/wiki/index.php/Installation">install</ulink>
            TeraWurfl. Make a note of where you install the library
            (<filename>TeraWurfl.php</filename>); we recommend installing it in your application's
            <filename>library</filename> directory.
        </para>

        <para>
            Once installed, the easiest way to use TeraWurfl is to configure it via the application
            resource.
        </para>

        <programlisting language="ini"><![CDATA[
resources.useragent.terawurfl.terawurfl_lib_dir = APPLICATION_PATH "/../library/"
]]></programlisting>

        <para>
            If the file is autoloadable, you can also specify an empty configuration in order to
            utilize the adapter.
        </para>

        <programlisting language="ini"><![CDATA[
resources.useragent.terawurfl[] =
]]></programlisting>
    </sect2>

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

        <variablelist>
            <title>TeraWurfl API Options</title>

            <varlistentry>
                <term>terawurfl.terawurfl_lib_dir</term>

                <listitem>
                    <para>
                        If using the TeraWurfl API, use this key to specify in which
                        directory the <filename>TeraWurfl.php</filename> file exists.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </sect2>

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

        <variablelist>
            <varlistentry id="zend.http.user-agent-features-tera-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>