r39 - in manual: branches branches/phpOpenTracker-1 branches/phpOpenTracker-1/chapters/de branches/phpOpenTracker-1/chapters/en trunk trunk/chapters/de trunk/chapters/en trunk/listings
Sebastian Bergmann at BerliOS <[email protected]> Sat, 29 Jan 2005 10:31:23 +0100
| Newsgroups | gmane.comp.web.phpopentracker.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: s_bergmann
Date: 2005-01-29 10:31:22 +0100 (Sat, 29 Jan 2005)
New Revision: 39
Added:
manual/branches/phpOpenTracker-1/
manual/branches/phpOpenTracker-1/chapters/de/bookinfo.xml
manual/branches/phpOpenTracker-1/chapters/en/bookinfo.xml
manual/branches/phpOpenTracker-1/chapters/en/installation.xml
manual/trunk/chapters/de/bookinfo.xml
manual/trunk/chapters/en/bookinfo.xml
Removed:
manual/branches/phpOpenTracker-1/chapters/de/bookinfo.xml.in
manual/branches/phpOpenTracker-1/chapters/en/bookinfo.xml.in
manual/branches/phpOpenTracker-1/chapters/en/installation.xml
manual/trunk/chapters/de/api-reference.xml
manual/trunk/chapters/de/bookinfo.xml.in
manual/trunk/chapters/de/configuration.xml
manual/trunk/chapters/de/installation.xml
manual/trunk/chapters/de/internals.xml
manual/trunk/chapters/de/introduction.xml
manual/trunk/chapters/de/preface.xml
manual/trunk/chapters/de/tuning.xml
manual/trunk/chapters/en/api-reference.xml
manual/trunk/chapters/en/bookinfo.xml.in
manual/trunk/chapters/en/configuration.xml
manual/trunk/chapters/en/installation.xml
manual/trunk/chapters/en/internals.xml
manual/trunk/chapters/en/introduction.xml
manual/trunk/chapters/en/preface.xml
manual/trunk/chapters/en/tuning.xml
manual/trunk/listings/all_paths.php
manual/trunk/listings/api.php
manual/trunk/listings/api_plugin.php
manual/trunk/listings/average_clickpath_length.php
manual/trunk/listings/clickpaths.php
manual/trunk/listings/embedding_logging_engine.php
manual/trunk/listings/individual_clickpath.php
manual/trunk/listings/logging_engine_client_id.php
manual/trunk/listings/logging_engine_document.php
manual/trunk/listings/logging_engine_plugin.php
manual/trunk/listings/longest_paths.php
manual/trunk/listings/num_visitors_online.php
manual/trunk/listings/num_visitors_online_document.php
manual/trunk/listings/outgoing_links.php
manual/trunk/listings/p3p.php
manual/trunk/listings/page_impressions.php
manual/trunk/listings/page_impressions_document.php
manual/trunk/listings/plot_access_statistics.php
manual/trunk/listings/plot_access_statistics_german.php
manual/trunk/listings/plot_top.php
manual/trunk/listings/shortest_paths.php
manual/trunk/listings/timeranges.php
manual/trunk/listings/top.php
manual/trunk/listings/top_paths.php
manual/trunk/listings/visitors_online.php
manual/trunk/listings/visits.php
Modified:
manual/branches/phpOpenTracker-1/build
manual/trunk/build
manual/trunk/de.xml.in
manual/trunk/en.xml.in
Log:
Branch manual for phpOpenTracker 1.5. Start manual for phpOpenTracker 2 (trunk) from scratch.
Copied: manual/branches/phpOpenTracker-1 (from rev 37, manual/trunk)
Modified: manual/branches/phpOpenTracker-1/build
===================================================================
--- manual/trunk/build 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/branches/phpOpenTracker-1/build 2005-01-29 09:31:22 UTC (rev 39)
@@ -176,16 +176,6 @@
)
);
- prepareFile(
- 'chapters/' . $language . '/bookinfo.xml',
- array(
- '{svnversion}'
- ),
- array(
- shell_exec('svnversion .')
- )
- );
-
if ($format == 'html' || $format == 'html-chunked') {
exec('cp entities/online.ent entities.ent');
} else {
Added: manual/branches/phpOpenTracker-1/chapters/de/bookinfo.xml
===================================================================
--- manual/trunk/chapters/de/bookinfo.xml 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/branches/phpOpenTracker-1/chapters/de/bookinfo.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+
+<bookinfo>
+ <title>Handbuch für phpOpenTracker 1.5</title>
+
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Bergmann</surname>
+ </author>
+
+ <copyright>
+ <year>2000</year>
+ <year>2001</year>
+ <year>2002</year>
+ <year>2003</year>
+ <year>2004</year>
+ <year>2005</year>
+ <holder>Sebastian Bergmann</holder>
+ </copyright>
+
+ <pubdate>Aktualisiert am <?dbtimestamp format="d.m.Y"?>.</pubdate>
+</bookinfo>
+
+<dedication>
+ <para>
+ "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
+ </para>
+</dedication>
Deleted: manual/branches/phpOpenTracker-1/chapters/de/bookinfo.xml.in
===================================================================
--- manual/trunk/chapters/de/bookinfo.xml.in 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/branches/phpOpenTracker-1/chapters/de/bookinfo.xml.in 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,30 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<bookinfo>
- <title>Das phpOpenTracker Handbuch</title>
-
- <author>
- <firstname>Sebastian</firstname>
- <surname>Bergmann</surname>
- </author>
-
- <copyright>
- <year>2000</year>
- <year>2001</year>
- <year>2002</year>
- <year>2003</year>
- <year>2004</year>
- <year>2005</year>
- <holder>Sebastian Bergmann</holder>
- </copyright>
-
- <pubdate>
- Fassung {svnversion} vom <?dbtimestamp format="d.m.Y"?> um <?dbtimestamp format="H:M:S"?>.
- </pubdate>
-</bookinfo>
-
-<dedication>
- <para>
- "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
- </para>
-</dedication>
Added: manual/branches/phpOpenTracker-1/chapters/en/bookinfo.xml
===================================================================
--- manual/trunk/chapters/en/bookinfo.xml 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/branches/phpOpenTracker-1/chapters/en/bookinfo.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+
+<bookinfo>
+ <title>Manual for phpOpenTracker 1.5</title>
+
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Bergmann</surname>
+ </author>
+
+ <copyright>
+ <year>2000</year>
+ <year>2001</year>
+ <year>2002</year>
+ <year>2003</year>
+ <year>2005</year>
+ <holder>Sebastian Bergmann</holder>
+ </copyright>
+
+ <pubdate>Updated on <?dbtimestamp format="d.m.Y"?>.</pubdate>
+</bookinfo>
+
+<dedication>
+ <para>
+ "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
+ </para>
+</dedication>
Deleted: manual/branches/phpOpenTracker-1/chapters/en/bookinfo.xml.in
===================================================================
--- manual/trunk/chapters/en/bookinfo.xml.in 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/branches/phpOpenTracker-1/chapters/en/bookinfo.xml.in 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<bookinfo>
- <title>The phpOpenTracker Manual</title>
-
- <author>
- <firstname>Sebastian</firstname>
- <surname>Bergmann</surname>
- </author>
-
- <copyright>
- <year>2000</year>
- <year>2001</year>
- <year>2002</year>
- <year>2003</year>
- <year>2005</year>
- <holder>Sebastian Bergmann</holder>
- </copyright>
-
- <pubdate>
- Revision {svnversion} built on <?dbtimestamp format="d.m.Y"?> at <?dbtimestamp format="H:M:S"?>.
- </pubdate>
-</bookinfo>
-
-<dedication>
- <para>
- "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
- </para>
-</dedication>
Deleted: manual/branches/phpOpenTracker-1/chapters/en/installation.xml
===================================================================
--- manual/trunk/chapters/en/installation.xml 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/branches/phpOpenTracker-1/chapters/en/installation.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,368 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="installation">
- <title>Installation</title>
-
- <section id="installation.pear-installer">
- <title>Installing phpOpenTracker using the PEAR Installer</title>
-
- <para>
- If you have a PHP installation with a working &PEAR; environment,
- you may use the PEAR Installer to unpack the phpOpenTracker
- distribution and install it:
-
-<screen>
-pear install phpOpenTracker-X.X.X.tar.gz
-</screen>
-
- If you already installed a previous version of
- phpOpenTracker, you may want to upgrade it with
-
-<screen>
-pear upgrade phpOpenTracker-X.X.X.tar.gz
-</screen>
- </para>
- </section>
-
- <section id="installation.by-hand">
- <title>Installing phpOpenTracker by hand</title>
-
- <para>
- If you cannot use the PEAR Installer, you need to unpack the
- phpOpenTracker distribution and copy the
- <filename>phpOpenTracker/</filename> directory to a directory
- from which you can include it into your scripts.
- </para>
- </section>
-
- <section id="installation.setup">
- <title>Setting it up</title>
-
- <para>
- <orderedlist>
- <listitem>
- <para>
- Open the file
- <filename>conf/phpOpenTracker.php.dist</filename>
- in your favourite editor and save it to
- <filename>conf/phpOpenTracker.php</filename>
- after you made the following changes:
-
- <orderedlist numeration="lowerroman">
- <listitem>
- <para>
- Set <varname>db_type</varname> to match your RDBMS.
- Possible values are <varname>mssql</varname>,
- <varname>mysql</varname>, <varname>mysql_merge</varname>,
- <varname>oci8</varname> and <varname>pgsql</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Configure your database connection by setting the
- correct values for the <varname>db_*</varname>
- directives.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Set <varname>jpgraph_path</varname> to the path to
- your JPGraph installation.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- Create the phpOpenTracker tables in the database you specified
- in your <filename>conf/phpOpenTracker.php</filename> using
- the SQL dump appropriate for your database system from the
- <filename>docs/sql/</filename> directory.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <para>
- <emphasis role="bold">
- Database System Specific Notes
- </emphasis>
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- MySQL
- </para>
-
- <para>
- phpOpenTracker ships with several database table creation
- scripts for MySQL:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>innodb.sql</filename>
- </para>
-
- <para>
- Use the <filename>innodb.sql</filename> table creation
- script to create the tables using the &MYSQL_INNODB; storage
- backend.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>myisam.sql</filename>
- </para>
-
- <para>
- Use the <filename>myisam_merge.sql</filename> table creation
- script to create the tables using the &MYSQL_MYISAM; storage
- backend.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>myisam_merge.sql</filename>
- </para>
-
- <para>
- Use the <filename>myisam_merge.sql</filename> table creation
- script if you plan on using &MERGE_TABLES;.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- If you use phpOpenTracker together with a version of the MySQL Server
- prior to &MYSQL_4_1;, the MySQL user needs the privilige to
- create temporary tables. As of MySQL 4.0.2 this privilege is
- called <varname>CREATE TEMPORARY TABLES</varname>. Temporary
- tables are used to emulate &MYSQL_SUBQUERIES;, which are available as
- of MySQL 4.1.0.
- </para>
- </listitem>
-
- <listitem>
- <para>
- PostgreSQL
- </para>
-
- <para>
- The database that is to hold the phpOpenTracker tables needs to have the
- <varname>plpgsql</varname> language installed. This can be done
- using the following commands from the command-line:
- </para>
-
-<screen><![CDATA[
-createdb phpOpenTracker
-createlang plpgsql phpOpenTracker
-psql phpOpenTracker < postgresql.sql
-]]></screen>
- </listitem>
- </itemizedlist>
-
- <para>
- Add the following lines of code to your application and phpOpenTracker
- will start logging:
- </para>
-
- <example id="installation.setup.examples.embedding_logging_engine.php">
- <title>Embedding the Logging Engine</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/embedding_logging_engine.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- If you want to use phpOpenTracker together with an application that uses
- the same script or URL for all pages it serves, this is, for
- instance, often the case with Content Management Systems (CMS),
- it makes sense to pass the page's name or ID to phpOpenTracker's
- Logging Engine, so that it is used instead of the URL.
- </para>
-
- <example id="installation.setup.examples.logging_engine_document.php">
- <title>Passing a custom document title to phpOpenTracker's Logging Engine</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- If you want to track multiple websites with one installation of
- phpOpenTracker you need to pass an additional parameter <varname>client_id</varname>
- to the <function>phpOpenTracker::log</function> method with a
- unique integer ID for each website:
- </para>
-
- <example id="installation.setup.examples.logging_engine_client_id.php">
- <title>Using one phpOpenTracker installation for multiple websites</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_client_id.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="installation.webbug">
- <title>Using a web-bug to invoke phpOpenTracker</title>
-
- <para>
- With the <filename>image.php</filename> script you can
- invoke phpOpenTracker's logging mechanism through an image. The
- script will output a 1x1 pixel, transparent GIF image.
- </para>
-
- <para>
- The script accepts the following parameters, that can be passed
- using HTTP/GET:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- client_id
- </para>
-
- <para>
- If empty, the default client_id (1) will be used.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_url
- </para>
-
- <para>
- The document's URL, that calls the script. If empty, the
- HTTP_REFERER of the request to the script will be used as most
- common browsers store the URL of the document that embeds the image
- in this variable.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document
- </para>
-
- <para>
- The document's name.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer
- </para>
-
- <para>
- Referer of the document that embeds the image.
- </para>
- </listitem>
-
- <listitem>
- <para>
- add_data[]
- </para>
-
- <para>
- This field can be used to pass arbitrary data to the
- phpOpenTracker Logging Engine that will store it into the
- <filename>additional_data_table</filename> table.
- </para>
-
- <para>
- You can add multiple <add_data> parameters to the
- URL of the <filename>image.php</filename> script. Each one
- consists of a field / value pair, separated by
- <varname>::</varname>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- For a detailed example of this, have a look at the
- <filename>examples/webbug/</filename> directory.
- </para>
-
- <para>
- Please bear in mind, that visitors who have turned off image
- loading or use text-only browsers won't be tracked using this
- method.
- </para>
- </section>
-
- <section id="installation.logging-outgoing-links">
- <title>Logging outgoing links</title>
-
- <para>
- The <filename>docs/scripts/exit.php</filename> script can be used to log
- outgoing links.
- </para>
-
- <para>
- Have a look at the following example to learn how to send all outgoing
- links (ie. links that start with <filename>http://</filename>) through
- <filename>exit.php</filename> automatically using PHP's output-buffering
- mechanism:
- </para>
-
- <example id="installation.logging-outgoing-links.examples.outgoing_links.php">
- <title>Automatically send outgoing links through exit.php</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/outgoing_links.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="installation.p3p">
- <title>P3P Policy</title>
-
- <para>
- The MS Internet Explorer 6, and maybe other browsers, too, requires
- a &P3P; policy in order to accept cookies. This includes session
- cookies that are used by PHP's session management system, on which
- phpOpenTracker relies. phpOpenTracker cannot track visitors using the MS Internet
- Explorer 6 correctly if the tracked site does not send such a policy
- to the client.
- </para>
-
- <para>
- The code below shows a suitable P3P policy and how to send it using
- PHP. Note that it must be sent before the phpOpenTracker Logging Engine is
- invoked.
- </para>
-
- <example id="installation.p3p.examples.p3p.php">
- <title>Sending a compact P3P policy to the client</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/p3p.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-</chapter>
Copied: manual/branches/phpOpenTracker-1/chapters/en/installation.xml (from rev 38, manual/trunk/chapters/en/installation.xml)
Modified: manual/trunk/build
===================================================================
--- manual/trunk/build 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/build 2005-01-29 09:31:22 UTC (rev 39)
@@ -176,16 +176,6 @@
)
);
- prepareFile(
- 'chapters/' . $language . '/bookinfo.xml',
- array(
- '{svnversion}'
- ),
- array(
- shell_exec('svnversion .')
- )
- );
-
if ($format == 'html' || $format == 'html-chunked') {
exec('cp entities/online.ent entities.ent');
} else {
Deleted: manual/trunk/chapters/de/api-reference.xml
===================================================================
--- manual/trunk/chapters/de/api-reference.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/api-reference.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,2714 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="api-reference">
- <title>Die phpOpenTracker API</title>
- <titleabbrev id="api">phpOpenTracker API</titleabbrev>
-
- <section id="api-reference.introduction">
- <title>Einführung</title>
-
- <para>
- Momentan fällt mit phpOpenTracker noch keine grafische Benutzeroberfläche,
- mit der man sich Reports zusammenklicken kann, aus der Tüte, an
- einer solchen Lösung wird aber bereits gearbeitet. Stattdessen
- bietet phpOpenTracker eine mächtige Schnittstelle zu den gesammelten Daten
- und bietet entsprechende Auswertungen über die &POT_API; an.
- </para>
-
- <para>
- Über die Methode <function>phpOpenTracker::get</function> greift
- man auf die einzelnen API Funktionen zu. Diese Methode erwartet ein
- assoziatives Array als einzigen Parameter, über das der API Aufruf
- spezifiziert wird. Der Rückgabewert von
- <function>phpOpenTracker::get</function> ist standardmäßig eine
- PHP Variable, zum Beispiel ein Array oder ein Integerwert, kann aber
- für einige Anfragen als CSV oder XML gewünscht werden. Das
- folgende Beispiel zeigt die typische Verwendung der
- <function>phpOpenTracker::get</function> Methode:
-
- <example id="api-reference.introduction.examples.api.php">
- <title>Ein typischer phpOpenTracker::get() Aufruf</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/api.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </para>
-
- <para>
- Ebenso einfach wie der Zugriff auf statistische Werte, wie die
- Anzahl der Seitenzugriffe im letzten Beispiel, gestaltet sich die
- Analyse von Klickpfaden. Das folgende Codefragment liefert ein Array
- mit den 10 kürzesten Pfaden die in einem bestimmten Dokument der
- Website enden und während der aktuellen Stunde von Besuchern
- genommen wurden:
-
- <example id="api-reference.introduction.examples.clickpaths.php">
- <title>Auswertung von Klickpfaden</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/clickpaths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </para>
-
- <para>
- Mit wenigen Zeilen lassen sich optisch ansprechende Diagramme mit
- der &POT_API; erstellen. Das nachstehende Beispiel stellt die
- Besuche (Visits) der Anzahl an Zugriffen (Page Impressions)
- gegenüber:
-
- <example id="api-reference.introduction.examples.plot_access_statistics_german.php">
- <title>Erstellen eines Diagramms</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_access_statistics_german.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </para>
-
- <para>
- Ein etwas umfangreicheres Beispiel, der so genannte Simple Report,
- ist in der phpOpenTracker Distribution im Verzeichnis
- <filename>examples/</filename> enthalten. Der Simple Report bietet
- einen Überblick über die wichtigsten Statistiken einer Website.
- </para>
- </section>
-
- <section id="api-reference.constraints">
- <title>Spezifizierung von Suchkriterien</title>
- <titleabbrev id="constraints">Spezifizierung von Suchkriterien</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.1.0.</emphasis>
- </para>
-
- <para>
- Über den <varname>constraints</varname> Parameter kann ein Array
- mit Suchkriterien übergeben werden, für dessen Schlüssel die
- folgenden Werte möglich sind:
- </para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- entry_document
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_document
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_target
- </para>
- </listitem>
-
- <listitem>
- <para>
- host
- </para>
- </listitem>
-
- <listitem>
- <para>
- operating_system
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer
- </para>
- </listitem>
-
- <listitem>
- <para>
- user_agent
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Hinzugefügt in Version 1.1.0.</emphasis>
- </para>
-
- <para>
- weekday
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Hinzugefügt in Version 1.1.0.</emphasis>
- </para>
-
- <para>
- hour (0 bis 23)
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- Wird die &POT_API; in einem Skript verwendet, in dem bereits die
- phpOpenTracker Logging Engine aufgerufen wurde, so kann
- <varname>this</varname> als Wert verwendet werden. In diesem Fall
- wird der Wert des angegebenen Feldes des aktuellen Besuchers
- verwendet.
- </para>
-
- <example id="api-reference.constraints.examples.page_impressions_document.php">
- <title>Seitenzugriffe eines bestimmten Dokuments</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/page_impressions_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.timeranges">
- <title>Zeitintervalle spezifizieren</title>
- <titleabbrev id="timerange">Zeitintervall</titleabbrev>
-
- <para>
- Über das Array Element <varname>range</varname> des Parameter Arrays
- kann eine &POT_API; Funktion auf ein Zeitintervall beschränkt werden.
- Hierfür stehen die folgenden Bezeichner zur Verfügung:
- </para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- current_minute
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_minute
- </para>
- </listitem>
-
- <listitem>
- <para>
- current_hour
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_hour
- </para>
- </listitem>
-
- <listitem>
- <para>
- today
- </para>
- </listitem>
-
- <listitem>
- <para>
- yesterday
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- current_week
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- previous_week
- </para>
- </listitem>
-
- <listitem>
- <para>
- current_month
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_month
- </para>
- </listitem>
-
- <listitem>
- <para>
- current_year
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_year
- </para>
- </listitem>
-
- <listitem>
- <para>
- total
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- Sollte dies einmal nicht ausreichen, so kann alternativ über die beiden
- Array Elemente <varname>start</varname> und <varname>end</varname> ein
- Intervall mit UNIX Timestamps angegeben werden.
- </para>
-
- <example id="api-reference.timeranges.examples.timeranges.php">
- <title>Einschränken von Anfragen auf ein Zeitintervall</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/timeranges.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- Zusätzlich zu den oben aufgeführten Werten für den
- <varname>range</varname> Parameter gibt es noch die folgenden
- Intervallbezeichner:
- </para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- minute
- </para>
- </listitem>
-
- <listitem>
- <para>
- hour
- </para>
- </listitem>
-
- <listitem>
- <para>
- day
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- week
- </para>
- </listitem>
-
- <listitem>
- <para>
- month
- </para>
- </listitem>
-
- <listitem>
- <para>
- year
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- Diese generischen Intervallbezeichner benötigen zwei zusätzliche
- Parameter, <varname>range_start</varname> und
- <varname>range_length</varname>, und erlauben die Definition von
- Intervallen, die zum Zeitpunkt <varname>Aktuelle Zeit - (range_start *
- Länge(range))</varname> beginnen und eine Länge von
- <varname>range_length * Länge(range)</varname> haben.
- </para>
- </section>
-
- <section id="api-reference.result-formats">
- <title>Resultatformate</title>
- <titleabbrev id="result-formats">Resultatformate</titleabbrev>
-
- <para>
- Über das Array Element <varname>result_format</varname> des Parameter
- Arrays gibt man das gewünschte Resultatformat an.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- array
- </para>
-
- <para>
- Array Repräsentation.
- </para>
- </listitem>
-
- <listitem>
- <para>
- clickpath
- </para>
-
- <para>
- Clickpath Objekt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- csv
- </para>
-
- <para>
- Comma Separated Values (CSV). Dieses Format kann unter anderem
- von Microsoft Excel importiert werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- graphviz
- </para>
-
- <para>
- GraphViz Markup.
- </para>
-
- <para>
- GraphViz/dot ist ein von AT&T entwickeltes Werkzeug, mit
- dem man Graphen beliebiger Komplexität visualisieren kann. Es
- unterstützt GIF, PNG, JPEG, PostScript und SVG als
- Ausgabeformate für die erzeugte Grafik.
- </para>
- </listitem>
-
- <listitem>
- <para>
- graphviz_object
- </para>
-
- <para>
- GraphViz-Objekt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- SQL
- </para>
-
- <para>
- SQL Query.
- </para>
- </listitem>
-
- <listitem>
- <para>
- xml
- </para>
-
- <para>
- XML-Markup.
- </para>
- </listitem>
-
- <listitem>
- <para>
- xml_object
- </para>
-
- <para>
- &XML_TREE;-Objekt.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="api-reference.api-calls">
- <title>API Calls</title>
-
- <section id="api-reference.api-calls.all_paths">
- <title>all_paths</title>
- <titleabbrev id="all_paths">all_paths</titleabbrev>
-
- <para>
- Liefert GraphViz Markup für alle Klickpfade mit ihren jeweiligen
- Statistiken.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname>
- und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_color (optional, default: <varname>black</varname>)
- </para>
-
- <para>
- Farbe für Dokumente in GraphViz Graphen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &false;)
- </para>
-
- <para>
- Falls &true;, so werden Exit Targets berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_target_color (optional, default: <varname>red</varname>)
- </para>
-
- <para>
- Farbe für Exit Targets in GraphViz Graphen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &false;)
- </para>
-
- <para>
- Falls &true;, so werden Referer berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer_color (optional, default: <varname>green</varname>)
- </para>
-
- <para>
- Farbe für Referer in GraphViz Graphen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>graphviz</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>graphviz</varname> und <varname>graphviz_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.all_paths.php">
- <title>GraphViz Markup für alle Klickpfade erzeugen</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/all_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <figure id="api-reference.api-calls.figures.all_paths.png">
- <title>Klickpfade auf www.phpOpenTracker.de im November 2002</title>
-
- <graphic fileref="figures/all_paths.png" />
- </figure>
- </section>
-
- <section id="api-reference.api-calls.average_clickpath_length">
- <title>average_clickpath_length</title>
- <titleabbrev id="average_clickpath_length">average_clickpath_length</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die durchschnittliche Klickpfadlänge.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname>
- und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.all_paths.examples.average_clickpath_length.php">
- <title>Durchschnittliche Klickpfadlänge</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/average_clickpath_length.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.average_time_between_visits">
- <title>average_time_between_visits</title>
- <titleabbrev id="average_time_between_visits">average_time_between_visits</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die durchschnittliche Zeit zwischen Wiederholungsbesuchen.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname>
- und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.average_visits">
- <title>average_visits</title>
- <titleabbrev id="average_visits">average_visits</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die durchschnittliche Anzahl an Wiederholungsbesuchen.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname>
- und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.individual_clickpath">
- <title>individual_clickpath</title>
- <titleabbrev id="individual_clickpath">individual_clickpath</titleabbrev>
-
- <para>
- Liefert einen Klickpfad für eine gegebene accesslog_id.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- accesslog_id
- </para>
-
- <para>
- accesslog_id des Besuchers, dessen Klickpfad geliefert werden
- soll.
- </para>
- </listitem>
-
- <listitem>
- <para>
- resolve_ids (optional, voreingestellt: &true;)
- </para>
-
- <para>
- Ist dieser Parameter auf &true; gesetzt, so werden die
- internen IDs für Datenstrings entsprechend aufgelöst,
- andernfalls wird die ID anstelle des Strings zurückgegeben.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>clickpath</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>clickpath</varname>, <varname>graphviz</varname>,
- <varname>graphviz_object</varname>, <varname>xml</varname> und
- <varname>xml_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.individual_clickpath.php">
- <title>Klickpfad über die accesslog_id des Besuchers ermitteln</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/individual_clickpath.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <figure id="api-reference.api-calls.figures.clickpath.png">
- <title>Graph eines einzelnen Klickpfads</title>
-
- <graphic fileref="figures/clickpath.png" />
- </figure>
- </section>
-
- <section id="api-reference.api-calls.longest_paths">
- <title>longest_paths</title>
- <titleabbrev id="longest_paths">longest_paths</titleabbrev>
-
- <para>
- Liefert Informationen über längste Pfade.
- </para>
-
- <para>
- Die Anfrage kann auf einen Zeitabschnitt, ein Start- oder
- Enddokument oder eine maximale Länge des Pfades begrenzt werden.
- </para>
-
- <para>
- Für die Visualisierung von Klickpfaden, die von einer
- <varname>top_paths</varname> Anfrage zurück geliefert werden, mit
- GraphViz ist als Resultatformat <varname>array</varname> zu
- wählen. Das zurückgegebene Array enthält dann für jeden gefundenen
- Klickpfad ein Objekt der Klasse
- <classname>phpOpenTracker_Clickpath</classname>, dessen Methode
- <function>toGraph</function> das dem Klickpfad entsprechende
- GraphViz Markup liefert.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- from (optional)
- </para>
-
- <para>
- Berücksichtige nur Pfade, die in <varname>from</varname> beginnen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- to (optional)
- </para>
-
- <para>
- Berücksichtige nur Pfade, die in <varname>end</varname> enden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- subpaths (optional, voreingestellt: &false;)
- </para>
-
- <para>
- Hat dieser Parameter den Wert &true;, so werden bei der
- Analyse die kompletten Pfade der einzelnen Besucher in ihre
- jeweiligen Unterpfade aufgespalten. Hat er den Wert &false;,
- so werden nur die kompletten Pfade untersucht.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &true;)
- </para>
-
- <para>
- Falls &true;, so werden Exit Targets berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &true;)
- </para>
-
- <para>
- Falls &true;, so werden Referer berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- length (optional)
- </para>
-
- <para>
- Berücksichtige nur (Teil-)Pfade der Länge <varname>length</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Liefere nur <varname>limit</varname> viele Ergebnisse zurück.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>graphviz</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/>
- sind <varname>array</varname>, <varname>graphviz</varname> und
- <varname>graphviz_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.longest_paths.php">
- <title>Die 10 längsten Pfade, die in einem bestimmten Dokument enden</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/longest_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.num_one_time_visitors">
- <title>num_one_time_visitors</title>
- <titleabbrev id="num_one_time_visitors">num_one_time_visitors</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die Anzahl von Besuchern, die die Website nur einmal besucht haben.
- </para>
-
- <para>
- Anmerkung: Dieser API Aufruf liefert nur dann ein sinnvolles Ergebnis,
- wenn <varname>track_returning_visitors</varname> in der Konfigurationsdatei
- <filename>conf/phpOpenTracker.php</filename> aktiviert ist.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_return_visits">
- <title>num_return_visits</title>
- <titleabbrev id="num_return_visits">num_return_visits</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die Anzahl von Wiederholungsbesuchen.
- </para>
-
- <para>
- Anmerkung: Dieser API Aufruf liefert nur dann ein sinnvolles Ergebnis,
- wenn <varname>track_returning_visitors</varname> in der Konfigurationsdatei
- <filename>conf/phpOpenTracker.php</filename> aktiviert ist.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_returning_visitors">
- <title>num_returning_visitors</title>
- <titleabbrev id="num_returning_visitors">num_returning_visitors</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die Anzahl der Besucher, die die Website mehrfach
- besucht haben.
- </para>
-
- <para>
- Anmerkung: Dieser API Aufruf liefert nur dann ein sinnvolles Ergebnis,
- wenn <varname>track_returning_visitors</varname> in der Konfigurationsdatei
- <filename>conf/phpOpenTracker.php</filename> aktiviert ist.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_unique_visitors">
- <title>num_unique_visitors</title>
- <titleabbrev id="num_unique_visitors">num_unique_visitors</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.3.0.</emphasis>
- </para>
-
- <para>
- Liefert die Anzahl an Besuchern, die die Website besucht haben.
- </para>
-
- <para>
- Anmerkung: Dieser API Aufruf liefert nur dann ein sinnvolles Ergebnis,
- wenn <varname>track_returning_visitors</varname> in der Konfigurationsdatei
- <filename>conf/phpOpenTracker.php</filename> aktiviert ist.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_visitors_online">
- <title>num_visitors_online</title>
- <titleabbrev id="num_visitors_online">num_visitors_online</titleabbrev>
-
- <para>
- Liefert die Anzahl der Besucher, die gerade online sind.
- </para>
-
- <para>
- Die Anfrage kann auf ein Dokument eingeschränkt werden.
- </para>
-
- <para>
- Anmerkung: HTTP ist ein zustandloses Protokoll. Daher gibt es keine
- Möglichkeit, diese Frage korrekt zu beantworten. phpOpenTracker beantwortet
- sie aufgrund der Zugriffe der verschiedenen Besucher während der
- letzten 'session_lifetime' Minuten.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- session_lifetime (optional, voreingestellt: 3)
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.num_visitors_online.php">
- <title>Anzahl der Besucher, die momentan online sind</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/num_visitors_online.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <example id="api-reference.api-calls.examples.num_visitors_online_document.php">
- <title>Anzahl der Besucher, die momentan auf diesem Dokument sind</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/num_visitors_online_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.page_impressions">
- <title>page_impressions</title>
- <titleabbrev id="page_impressions">page_impressions</titleabbrev>
-
- <para>
- Liefert die Anzahl der Seitenzugriffe (Page Impressions) in einem
- gegebenen Zeitabschnitt.
- </para>
-
- <para>
- Das Ergebnis ist ein Wert, oder, wenn der 'interval' Parameter
- gegeben ist, eine Menge von Werten für die entsprechenden Intervalle
- innerhalb des zu untersuchenden Zeitabschnitts.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- interval (optional)
- </para>
-
- <para>
- Teilt den Zeitabschnitt in Intervalle zu je 'interval'
- Sekunden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>array</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>array</varname>, <varname>csv</varname>,
- <varname>xml</varname> und <varname>xml_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.page_impressions.php">
- <title>Seitenzugriffe gesamt, heute</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/page_impressions.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <example id="api-reference.api-calls.examples.page_impressions_document.php">
- <title>Seitenzugriffe eines bestimmten Dokuments</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/page_impressions_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.returning_visitors">
- <title>returning_visitors</title>
- <titleabbrev id="returning_visitors">returning_visitors</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.0.5.</emphasis>
- </para>
-
- <para>
- Liefert Informationen über die Anzahl von Wiederholungsbesuchen.
- </para>
-
- <para>
- Anmerkung: Dieser API Aufruf liefert nur dann ein sinnvolles Ergebnis,
- wenn <varname>track_returning_visitors</varname> in der Konfigurationsdatei
- <filename>conf/phpOpenTracker.php</filename> aktiviert ist.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>array</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>array</varname>, <varname>xml</varname> und
- <varname>xml_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.search_engines">
- <title>search_engines</title>
- <titleabbrev id="search_engines">search_engines</titleabbrev>
-
- <para>
- <emphasis>Nur verfügbar, wenn das Search-Engines-Plugin installiert ist.</emphasis>
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname>
- und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- what
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.shortest_paths">
- <title>shortest_paths</title>
- <titleabbrev id="shortest_paths">shortest_paths</titleabbrev>
-
- <para>
- Liefert Informationen über kürzeste Pfade.
- </para>
-
- <para>
- Die Anfrage kann auf einen Zeitabschnitt, ein Start- oder
- Enddokument oder eine maximale Länge des Pfades begrenzt werden.
- </para>
-
- <para>
- Für die Visualisierung von Klickpfaden, die von einer
- <varname>top_paths</varname> Anfrage zurück geliefert werden, mit
- GraphViz ist als Resultatformat <varname>array</varname> zu
- wählen. Das zurückgegebene Array enthält dann für jeden gefundenen
- Klickpfad ein Objekt der Klasse
- <classname>phpOpenTracker_Clickpath</classname>, dessen Methode
- <function>toGraph</function> das dem Klickpfad entsprechende
- GraphViz Markup liefert.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- from (optional)
- </para>
-
- <para>
- Berücksichtige nur Pfade, die in <varname>from</varname> beginnen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- to (optional)
- </para>
-
- <para>
- Berücksichtige nur Pfade, die in <varname>end</varname> enden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- subpaths (optional, voreingestellt: &false;)
- </para>
-
- <para>
- Hat dieser Parameter den Wert &true;, so werden bei der
- Analyse die kompletten Pfade der einzelnen Besucher in ihre
- jeweiligen Unterpfade aufgespalten. Hat er den Wert &false;,
- so werden nur die kompletten Pfade untersucht.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &true;)
- </para>
-
- <para>
- Falls &true;, so werden Exit Targets berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &true;)
- </para>
-
- <para>
- Falls &true;, so werden Referer berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- length (optional)
- </para>
-
- <para>
- Berücksichtige nur (Teil-)Pfade der Länge 'length'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Liefere nur 'limit' viele Ergebnisse
- zurück.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>graphviz</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/>
- sind <varname>array</varname>, <varname>graphviz</varname> und
- <varname>graphviz_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.shortest_paths.php">
- <title>Die 10 kürzesten Pfade, die in einem bestimmten Dokument enden</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/shortest_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.top">
- <title>top</title>
- <titleabbrev id="top">top</titleabbrev>
-
- <para>
- Liefert statistische Auswertungen.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- what
- </para>
-
- <para>
- Mögliche Felder für die Statistik sind <varname>document</varname>,
- <varname>entry_document</varname>, <varname>exit_document</varname>,
- <varname>exit_target</varname>, <varname>host</varname>,
- <varname>referer</varname>, <varname>operating_system</varname> und
- <varname>user_agent</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Liefere nur <varname>limit</varname> viele Ergebnisse zurück.
- </para>
- </listitem>
-
- <listitem>
- <para>
- order (optional, voreingestellt: <varname>DESC</varname>)
- </para>
-
- <para>
- Aufsteigend (<varname>ASC</varname>), oder absteigend (<varname>DESC</varname>).
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>array</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>array</varname>, <varname>csv</varname>, <varname>sql</varname>,
- <varname>xml</varname> und <varname>xml_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.top.php">
- <title>Die 10 Dokumente mit den meisten Seitenabrufen</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/top.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.top_paths">
- <title>top_paths</title>
- <titleabbrev id="top_paths">top_paths</titleabbrev>
-
- <para>
- Liefert Informationen über häufigste Pfade.
- </para>
-
- <para>
- Die Anfrage kann auf einen Zeitabschnitt, ein Start- oder
- Enddokument oder eine maximale Länge des Pfades begrenzt werden.
- </para>
-
- <para>
- Für die Visualisierung von Klickpfaden, die von einer
- <varname>top_paths</varname> Anfrage zurück geliefert werden, mit
- GraphViz ist als Resultatformat <varname>array</varname> zu
- wählen. Das zurückgegebene Array enthält dann für jeden gefundenen
- Klickpfad ein Objekt der Klasse
- <classname>phpOpenTracker_Clickpath</classname>, dessen Methode
- <function>toGraph</function> das dem Klickpfad entsprechende
- GraphViz Markup liefert.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- from (optional)
- </para>
-
- <para>
- Berücksichtige nur Pfade, die in <varname>from</varname> beginnen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- to (optional)
- </para>
-
- <para>
- Berücksichtige nur Pfade, die in <varname>end</varname> enden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- subpaths (optional, voreingestellt: &false;)
- </para>
-
- <para>
- Hat dieser Parameter den Wert &true;, so werden bei der
- Analyse die kompletten Pfade der einzelnen Besucher in ihre
- jeweiligen Unterpfade aufgespalten. Hat er den Wert &false;,
- so werden nur die kompletten Pfade untersucht.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &true;)
- </para>
-
- <para>
- Falls &true;, so werden Exit Targets berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &true;)
- </para>
-
- <para>
- Falls &true;, so werden Referer berücksichtigt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- length (optional)
- </para>
-
- <para>
- Berücksichtige nur (Teil-)Pfade der Länge <varname>length</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Liefere nur <varname>limit</varname> viele Ergebnisse zurück.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>graphviz</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/>
- sind <varname>array</varname>, <varname>graphviz</varname> und
- <varname>graphviz_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.top_paths.php">
- <title>Die 10 häufigsten Pfade der Länge 3, die in einem bestimmten Dokument enden</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/top_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.visits">
- <title>visits</title>
- <titleabbrev id="visits">visits</titleabbrev>
-
- <para>
- Liefert die Anzahl der Besuche in einem gegebenen Zeitabschnitt.
- </para>
-
- <para>
- Das Ergebnis ist ein Wert, oder, wenn der 'interval' Parameter
- gegeben ist, eine Menge von Werten für die entsprechenden Intervalle
- innerhalb des zu untersuchenden Zeitabschnitts.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- interval (optional)
- </para>
-
- <para>
- Teilt den Zeitabschnitt in Intervalle zu je <varname>interval</varname>
- Sekunden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>array</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>array</varname>, <varname>csv</varname>,
- <varname>xml</varname> und <varname>xml_object</varname>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.visits.php">
- <title>Besuche gesamt, heute</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/visits.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.visitors_online">
- <title>visitors_online</title>
- <titleabbrev id="visitors_online">visitors_online</titleabbrev>
-
- <para>
- Liefert Informationen über die Besucher, die momentan online sind.
- </para>
-
- <para>
- Die Anfrage kann auf ein Dokument eingeschränkt werden.
- </para>
-
- <para>
- Anmerkung: HTTP ist ein zustandloses Protokoll. Daher gibt es keine
- Möglichkeit, diese Frage korrekt zu beantworten. phpOpenTracker beantwortet
- sie aufgrund der Zugriffe der verschiedenen Besucher während der
- letzten 'session_lifetime' Minuten.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, voreingestellt: <varname>array</varname>)
- </para>
-
- <para>
- Mögliche <xref linkend="result-formats" endterm="result-formats"/> sind
- <varname>array</varname>, <varname>xml</varname> und
- <varname>xml_object</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- session_lifetime (optional, voreingestellt: 3)
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.visitors_online.php">
- <title>Informationen über die momentanen Besucher</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/visitors_online.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.plot_access_statistics">
- <title>plot: access_statistics</title>
- <titleabbrev id="plot_access_statistics">plot_access_statistics</titleabbrev>
-
- <para>
- Stellt in einem Diagramm die Anzahl der Besuche der Anzahl an
- Seitenzugriffen gegenüber.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- interval (optional)
- </para>
-
- <para>
- Teilt den Zeitabschnitt in Intervalle von <varname>hour</varname>,
- <varname>day</varname>, <varname>month</varname> oder
- <varname>year</varname> ein.
- </para>
- </listitem>
-
- <listitem>
- <para>
- width (optional, voreingestellt: 640)
- </para>
-
- <para>
- Breite des Bildes.
- </para>
- </listitem>
-
- <listitem>
- <para>
- height (optional, voreingestellt: 480)
- </para>
-
- <para>
- Höhe des Bildes.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color1 (optional, voreingestellt: <varname>red</varname>)
- </para>
-
- <para>
- Erste Farbe.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color2 (optional, voreingestellt: <varname>blue</varname>)
- </para>
-
- <para>
- Zweite Farbe.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font (optional, voreingestellt: <varname>FF_VERDANA</varname>)
- </para>
-
- <para>
- Schriftart des Diagramms. Mögliche Werte sind die Konstanten
- <varname>FF_COURIER</varname>, <varname>FF_VERDANA</varname>,
- <varname>FF_TIMES</varname>, <varname>FF_HANDWRT</varname>,
- <varname>FF_COMIC</varname>, <varname>FF_ARIAL</varname>
- und <varname>FF_BOOK</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_style (optional, voreingestellt: <varname>FS_NORMAL</varname>)
- </para>
-
- <para>
- Schriftstil des Diagramms. Mögliche Werte sind die Konstanten
- <varname>FS_NORMAL</varname>, <varname>FS_BOLD</varname>,
- <varname>FS_ITALIC</varname> und <varname>FS_BOLDIT</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_size (optional, voreingestellt: 10)
- </para>
-
- <para>
- Schriftgröße.
- </para>
- </listitem>
-
- <listitem>
- <para>
- month_names (optional, voreingestellt: englische Monatsnamen)
- </para>
-
- <para>
- Array mit lokalisierten Monatsnamen.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.plot_access_statistics.php">
- <title>Diagramm für die Zugriffsstatistik des aktuellen Tags</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_access_statistics.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <example id="api-reference.api-calls.examples.plot_access_statistics_german.php">
- <title>Digramm mit deutschen Monatsnames</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_access_statistics_german.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.plot_locations">
- <title>plot: locations</title>
- <titleabbrev id="plot_locations">plot_locations</titleabbrev>
-
- <para>
- <emphasis>Nur verfügbar, wenn Version 1.1.0 (oder neuer) des Localizer-Plugins installiert ist.</emphasis>
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname>
- und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_dnnet (optional, voreingestellt: <varname>blue</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_pppoly (optional, voreingestellt: <varname>green</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_ponet (optional, voreingestellt: <varname>black</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_rdline (optional, voreingestellt: <varname>grey</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- format (optional, voreingestellt: <varname>png</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- range (optional)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.plot_top">
- <title>plot: top</title>
- <titleabbrev id="plot_top">plot_top</titleabbrev>
-
- <para>
- Erzeugt ein Kuchendiagramm mit statistischen Daten.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, voreingestellt: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- what
- </para>
-
- <para>
- Mögliche Felder für die Statistik sind <varname>document</varname>,
- <varname>entry_document</varname>, <varname>exit_document</varname>,
- <varname>exit_target</varname>, <varname>host</varname>,
- <varname>referer</varname>, <varname>operating_system</varname> und
- <varname>user_agent</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Die Anfrage kann durch Angabe der folgenden Parameter auf ein
- <xref linkend="api-reference.timeranges" endterm="timerange"/> begrenzt werden:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> und / oder <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> und <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- Lesen Sie den Abschnitt über die <xref linkend="constraints"
- endterm="constraints" />.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Zeige nur <varname>limit</varname> viele Elemente im Diagramm.
- </para>
- </listitem>
-
- <listitem>
- <para>
- width (optional, voreingestellt: 640)
- </para>
-
- <para>
- Breite des Bildes.
- </para>
- </listitem>
-
- <listitem>
- <para>
- height (optional, voreingestellt: 480)
- </para>
-
- <para>
- Höhe des Bildes.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font (optional, voreingestellt: <varname>FF_VERDANA</varname>)
- </para>
-
- <para>
- Schriftart des Diagramms. Mögliche Werte sind die Konstanten
- <varname>FF_COURIER</varname>, <varname>FF_VERDANA</varname>,
- <varname>FF_TIMES</varname>, <varname>FF_HANDWRT</varname>,
- <varname>FF_COMIC</varname>, <varname>FF_ARIAL</varname>
- und <varname>FF_BOOK</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_style (optional, voreingestellt: <varname>FS_NORMAL</varname>)
- </para>
-
- <para>
- Schriftstil des Diagramms. Mögliche Werte sind die Konstanten
- <varname>FS_NORMAL</varname>, <varname>FS_BOLD</varname>,
- <varname>FS_ITALIC</varname> und <varname>FS_BOLDIT</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_size (optional, voreingestellt: 10)
- </para>
-
- <para>
- Schriftgröße.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.examples.plot_top.php">
- <title>Kuchendiagramm der 10 häufigsten Dokumente des aktuellen Monats</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_top.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <figure id="api-reference.api-calls.figures.plot_top.png">
- <title>Kuchendiagramm der 10 häufigsten Dokumente auf www.phpOpenTracker.de</title>
-
- <graphic fileref="figures/plot_top.png" />
- </figure>
- </section>
- </section>
-</chapter>
Copied: manual/trunk/chapters/de/bookinfo.xml (from rev 37, manual/trunk/chapters/de/bookinfo.xml.in)
===================================================================
--- manual/trunk/chapters/de/bookinfo.xml.in 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/trunk/chapters/de/bookinfo.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+
+<bookinfo>
+ <title>Handbuch für phpOpenTracker 2</title>
+
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Bergmann</surname>
+ </author>
+
+ <copyright>
+ <year>2000</year>
+ <year>2001</year>
+ <year>2002</year>
+ <year>2003</year>
+ <year>2004</year>
+ <year>2005</year>
+ <holder>Sebastian Bergmann</holder>
+ </copyright>
+
+ <pubdate>Aktualisiert am <?dbtimestamp format="d.m.Y"?>.</pubdate>
+</bookinfo>
+
+<dedication>
+ <para>
+ "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
+ </para>
+</dedication>
Deleted: manual/trunk/chapters/de/bookinfo.xml.in
===================================================================
--- manual/trunk/chapters/de/bookinfo.xml.in 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/bookinfo.xml.in 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,30 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<bookinfo>
- <title>Das phpOpenTracker Handbuch</title>
-
- <author>
- <firstname>Sebastian</firstname>
- <surname>Bergmann</surname>
- </author>
-
- <copyright>
- <year>2000</year>
- <year>2001</year>
- <year>2002</year>
- <year>2003</year>
- <year>2004</year>
- <year>2005</year>
- <holder>Sebastian Bergmann</holder>
- </copyright>
-
- <pubdate>
- Fassung {svnversion} vom <?dbtimestamp format="d.m.Y"?> um <?dbtimestamp format="H:M:S"?>.
- </pubdate>
-</bookinfo>
-
-<dedication>
- <para>
- "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
- </para>
-</dedication>
Deleted: manual/trunk/chapters/de/configuration.xml
===================================================================
--- manual/trunk/chapters/de/configuration.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/configuration.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,539 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="configuration">
- <title>Konfiguration</title>
-
- <section id="configuration.config-file">
- <title>Die Konfigurationsdatei</title>
-
- <para>
- Dieser Abschnitt beschreibt die Direktiven, die in der
- <filename>conf/phpOpenTracker.php</filename> gesetzt werden können.
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- db_type
- </para>
-
- <para>
- Mögliche Werte sind 'mysql', 'oci8' und 'pgsql'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_host
- </para>
-
- <para>
- Hostname des Datenbankservers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_port
- </para>
-
- <para>
- Port des Datenbankservers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_socket
- </para>
-
- <para>
- Socket des Datenbankservers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_user
- </para>
-
- <para>
- Username für die Verbindung zum Datenbankserver.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_password
- </para>
-
- <para>
- Passwort für die Verbindung zum Datenbankserver.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_database
- </para>
-
- <para>
- Name der verwendeten Datenbank.
- </para>
- </listitem>
-
- <listitem>
- <para>
- additional_data_table
- </para>
-
- <para>
- Name der Additional Data Table, voreingestellt ist
- 'pot_add_data'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- accesslog_table
- </para>
-
- <para>
- Name der Accesslog Table, voreingestellt ist
- 'pot_accesslog'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- documents_table
- </para>
-
- <para>
- Name der Documents Table, voreingestellt ist
- 'pot_documents'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets_table
- </para>
-
- <para>
- Name der Exit Targets Table,
- voreingestellt ist 'pot_exit_targets'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- hostnames_table
- </para>
-
- <para>
- Name der Hostnames Table, voreingestellt ist
- 'pot_hostnames'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers_table
- </para>
-
- <para>
- Name der Referers Table, voreingestellt ist
- 'pot_referers'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- operating_systems_table
- </para>
-
- <para>
- Name der Operating Systems Table, voreingestellt ist
- 'pot_operating_systems'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- user_agents_table
- </para>
-
- <para>
- Name der User Agents Table, voreingestellt ist
- 'pot_user_agents'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- visitors_table
- </para>
-
- <para>
- Name der Visitors Table, voreingestellt ist
- 'pot_visitors'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- merge_tables_mode
- </para>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.5.0.</emphasis>
- </para>
-
- <para>
- Mit dieser Einstellung wird das Verhalten des &MERGE_TABLES;-Handlers
- konfiguriert.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>day</filename> verwaltet eine Tabelle pro Tag.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>month</filename> (Standard) verwaltet eine Tabelle pro Monat.
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>
- jpgraph_path
- </para>
-
- <para>
- Setzen Sie <filename>jpgraph_path</filename> auf den
- Pfad zu Ihrer JPGraph Installation.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_env_var
- </para>
-
- <para>
- Zu verwendende Umgebungsvariable um die aktuelle URL zu
- ermitteln, zum Beispiel 'PATH_INFO'
- oder 'REQUEST_URI'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- clean_query_string & get_parameter_filter
- </para>
-
- <para>
- Wenn auf 'On' gesetzt, sorgt die Direktive
- 'clean_query_string' dafür, dass phpOpenTracker sämtliche HTTP GET
- Parameter aus der URL entfernt, bevor diese gespeichert wird.
- Die Session ID wird in jedem Fall entfernt.
- </para>
-
- <para>
- Während 'clean_query_string=On' dafür sorgt, dass sämtliche
- Parameter aus der URL entfernt werden, kann man mit
- 'get_parameter_filter' eine Menge von Parametern definieren,
- die entfernt werden sollen, die übrigen Parameter bleiben
- hierbei erhalten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- clean_referer_string
- </para>
-
- <para>
- Wenn auf 'On' gesetzt, sorgt diese Direktive
- 'clean_query_string' dafür, dass phpOpenTracker sämtliche HTTP GET
- Parameter aus der Referer URL entfernt, bevor diese
- gespeichert wird.
- </para>
- </listitem>
-
- <listitem>
- <para>
- debug_level
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- 0
- </para>
- <para>
- Keine Ausgabe von Fehler- und Warnmeldungen.
- </para>
- </listitem>
- <listitem>
- <para>
- 1 (default)
- </para>
- <para>
- Fehler- und Warnmeldungen werden ausgegeben.
- </para>
- </listitem>
- <listitem>
- <para>
- 2
- </para>
- <para>
- Zusätzliche Ausgabe von Debugging Informationen.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">
- Achtung: Wenn Sie phpOpenTracker "in Produktion", also nach einer
- anfänglichen Testphase einsetzen, so sollte diese Direktive
- auf '0' gesetzt werden. Für den Testbetrieb ist ein Wert
- von '1' ratsam, '2' sollte nur zur Fehlersuche verwendet
- werden.
- </emphasis>
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_on_fatal_errors
- </para>
-
- <para>
- Wenn auf 'On' gesetzt, sorgt diese Direktive dafür, dass phpOpenTracker
- die Skriptausführung anhält, wenn ein Fehler auftritt.
- </para>
-
- <para>
- <emphasis role="bold">
- Achtung: Wenn Sie phpOpenTracker "in Produktion", also nach einer
- anfänglichen Testphase einsetzen, so sollte diese Direktive
- auf '0' gesetzt werden.
- </emphasis>
- </para>
- </listitem>
-
- <listitem>
- <para>
- log_errors
- </para>
-
- <para>
- Wenn auf 'On' gesetzt, sorgt diese Direktive dafür, dass phpOpenTracker
- Fehler- und Warnmeldungen in die Datei, die unter <varname>logfile</varname>
- konfiguriert wurde, protokolliert. Sorgen Sie dafür, dass diese Datei existiert
- und der Webserver die nötigen Rechte besitzt:
-
-<screen>
-cd /path/to/phpOpenTracker
-touch error.log
-chmod 666 error.log
-</screen>
- </para>
-
- <para>
- <emphasis role="bold">
- Achtung: Wenn Sie phpOpenTracker "in Produktion", also nach einer
- anfänglichen Testphase einsetzen, so sollte diese Direktive
- auf '1' gesetzt werden.
- </emphasis>
- </para>
- </listitem>
-
- <listitem>
- <para>
- logfile
- </para>
-
- <para>
- Pfad der Protokolldatei.
- </para>
- </listitem>
-
- <listitem>
- <para>
- locking
- </para>
-
- <para>
- Mit dieser Direktive kann das Locking aktiviert bzw.
- deaktiviert werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- log_reload
- </para>
-
- <para>
- Das Logging von Reloads kann mit dieser Direktive deaktiviert
- werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- track_returning_visitors
- </para>
-
- <para>
- Das Erkennen von wiederkehrenden Besuchern kann mit dieser
- Direktive deaktiviert werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- returning_visitors_cookie
- </para>
-
- <para>
- Name des Cookies, über das wiederkehrende Besucher erkannt
- werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- returning_visitors_cookie_lifetime
- </para>
-
- <para>
- Das 'returning_visitors_cookie' Cookie ist für
- 'returning_visitors_cookie_lifetime' Tage gültig.
- </para>
- </listitem>
-
- <listitem>
- <para>
- resolve_hostname
- </para>
-
- <para>
- Das Auflösen von IP Adressen zu Hostnamen kann mit dieser
- Direktive deaktiviert werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- group_hostnames
- </para>
-
- <para>
- Das Zusammenfassen von Hostnamen kann mit dieser Direktive
- deaktiviert werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- group_user_agents
- </para>
-
- <para>
- Das Zusammenfassen von User Agent Informationen und Parsen
- derselben in Operating System und User Agent kann mit dieser
- Direktive deaktiviert werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- query_cache
- </para>
-
- <para>
- Diese Direktive aktiviert/deaktiviert den
- <xref linkend="tuning.query-cache" endterm="query-cache"/>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- query_cache_dir
- </para>
-
- <para>
- Das Verzeichnis, in dem der phpOpenTracker API Query Cache
- seine Daten ablegt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- query_cache_lifetime
- </para>
-
- <para>
- Lebenszeit eines phpOpenTracker API Query Cache Eintrags
- in Sekunden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- logging_engine_plugins
- </para>
-
- <para>
- Mit dieser Direktive werden die Namen, getrennt durch Kommata,
- der phpOpenTracker Logging Engine Plugins angegeben, die geladen werden
- sollen.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section id="configuration.locking-mechanism">
- <title>Der Locking Mechanismus</title>
-
- <para>
- Mit dem Locking Mechanismus ist es möglich, bestimmte Arten von
- Seitenzugriffen, beispielsweise von Suchmaschienen Crawlern, von der
- Protokollierung auszuschließen.
- </para>
-
- <para>
- Eine Zeile in der Datei <filename>conf/lock.ini</filename> repräsentiert
- hierbei eine Regel, die, so sie zutrifft, eine Ausschließung der Anfrage
- von der Protokollierung ausschließt.
- </para>
-
- <para>
- Eine solche Regel besteht aus zwei Teilen, die durch Whitespace von
- einander getrennt werden. Das erste Wort der Zeile gibt das Feld an,
- dessen Wert gegen den regulären Ausdruck gematched wird, der im
- zweiten Wort der Zeile gegeben ist.
- </para>
-
- <example>
- <title>Beispiel für Locking Regeln</title>
-
-<programlisting>
-# Zugriffe von Host 'localhost' nicht loggen
-host #localhost#
-
-# Zugriffe von 'googlebot' nicht loggen
-user_agent #googlebot#
-</programlisting>
- </example>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/de/installation.xml
===================================================================
--- manual/trunk/chapters/de/installation.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/installation.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,367 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="installation">
- <title>Installation</title>
-
- <section id="installation.pear-installer">
- <title>Installation der Dateien mit dem PEAR Installer</title>
-
- <para>
- Wenn Sie eine PHP Installation mit einer funktionierenden
- &PEAR; Umgebung verwenden, so können Sie den &PEAR; Installer
- verwenden, um das phpOpenTracker Distributionsarchiv zu entpacken, und
- die Dateien zu kopieren:
-
-<screen>
-pear install phpOpenTracker-X.X.X.tar.gz
-</screen>
-
- Falls eine vorherige Version von phpOpenTracker bereits auf diese Weise
- installiert wurde, so kann diese Installation wie folgt
- aktualisiert werden:
-
-<screen>
-pear upgrade phpOpenTracker-X.X.X.tar.gz
-</screen>
- </para>
- </section>
-
- <section id="installation.by-hand">
- <title>Installation der Dateien von Hand</title>
-
- <para>
- Sollten Sie den PEAR Installer nicht verwenden können, so
- entpacken Sie das phpOpenTracker Distributionsarchiv von Hand und
- kopieren Sie die Dateien in ein Verzeichnis, von dem aus Sie die
- <filename>phpOpenTracker.php</filename> Datei in Ihren Skripten
- inkludieren können.
- </para>
- </section>
-
- <section id="installation.setup">
- <title>Konfiguration</title>
-
- <para>
- <orderedlist>
- <listitem>
- <para>
- Benennen Sie die Datei
- <filename>conf/phpOpenTracker.php.dist</filename> in
- <filename>conf/phpOpenTracker.php</filename> um und
- öffnen Sie sie in einem Texteditor.
-
- <orderedlist numeration="lowerroman">
- <listitem>
- <para>
- Geben Sie mit der Direktive
- <varname>db_type</varname> den Typ Ihres
- Datenbanksystems an. Mögliche Werte sind
- <varname>mssql</varname>, <varname>mysql</varname>,
- <varname>mysql_merge</varname>, <varname>oci8</varname>
- und <varname>pgsql</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Konfigurieren Sie den Zugang zu Ihrem
- Datenbankserver über die restlichen
- <varname>db_*</varname> Direktiven.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Setzen Sie <varname>jpgraph_path</varname> auf den
- Pfad zu Ihrer JPGraph Installation.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- Erstellen Sie in der angegebenen Datenbankinstanz
- die nötigen Tabellen mit dem Schema für
- Ihr Datenbanksystem aus dem Verzeichnis
- <filename>docs/sql/</filename>.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <para>
- <emphasis role="bold">
- Datenbanksystemspezifische Anmerkungen
- </emphasis>
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- MySQL
- </para>
-
- <para>
- phpOpenTracker wird mit mehreren Skripten für die Erstellung der
- Tabellen für MySQL ausgeliefert:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>innodb.sql</filename>
- </para>
-
- <para>
- Verwenden Sie das <filename>innodb.sql</filename> Skript,
- wenn Sie das &MYSQL_INNODB;-Backend verwenden möchten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>myisam.sql</filename>
- </para>
-
- <para>
- Verwenden Sie das <filename>myisam.sql</filename> Skript,
- wenn Sie das &MYSQL_MYISAM;-Backend verwenden möchten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>myisam_merge.sql</filename>
- </para>
-
- <para>
- Verwenden Sie das <filename>myisam_merge.sql</filename> Skript,
- wenn Sie &MERGE_TABLES; verwenden möchten.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- Der verwendete MySQL Benutzeraccount muss über das Privileg
- zur Erzeugung von temporären Tabellen verfügen, falls eine
- ältere Version des MySQL Servers als &MYSQL_4_1; verwendet
- wird. phpOpenTracker verwendet temporäre Tabellen, um &MYSQL_SUBQUERIES;, die
- MySQL erst ab Version 4.1.0 unterstützt, mit älteren Versionen
- des MySQL Servers zu emulieren. Seit MySQL 4.0.2 heisst das
- notwendige Privileg <varname>CREATE TEMPORARY
- TABLES</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- PostgreSQL
- </para>
-
- <para>
- In der Datenbank, die die phpOpenTracker Tabellen aufnehmen soll,
- muss die <varname>plpgsql</varname> Sprache installiert sein.
- Dies kann mit den folgenden Befehlen von der Kommandozeile aus
- erfolgen:
- </para>
-
-<screen><![CDATA[
-createdb phpOpenTracker
-createlang plpgsql phpOpenTracker
-psql phpOpenTracker < postgresql.sql
-]]></screen>
- </listitem>
- </itemizedlist>
-
- <para>
- phpOpenTracker ist jetzt installiert und Sie können nun die
- Logging Engine aus Ihren Applikationen heraus aufrufen:
- </para>
-
- <example id="installation.setup.examples.embedding_logging_engine.php">
- <title>Aufruf der Logging Engine</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/embedding_logging_engine.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- Mit diesen beiden Zeilen legt phpOpenTracker nun die benötigten Daten
- über Besucher und Zugriff in der Datenbank ab. Die
- <function>log</function> Methode akzeptiert ein Parameter Array,
- über das Sie den Logging Vorgang anpassen können. Wenn Sie zum
- Beispiel ein Content Management System einsetzen und dieses
- Ihnen einen Titel oder Namen für das aktuelle Dokument zur
- Verfügung stellt, so können Sie phpOpenTracker diesen mitteilen und er
- wird anstelle der URL in der Datenbank gespeichert; dies
- erleichtert das Lesen der Auswertungen später. Sie übergeben den
- Namen oder Titel des aktuellen Dokumentes mit Hilfe des
- <varname>document</varname> Elements des Parameter Arrays, wie
- im nachstehenden Beispiel gezeigt:
- </para>
-
- <example id="installation.setup.examples.logging_engine_document.php">
- <title>Anpassen des Logging Vorgangs</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- Wenn Sie mit einer Installation von phpOpenTracker mehrere Websites verarbeiten
- möchten, dann übergeben Sie einfach an die <function>phpOpenTracker::log</function>
- Methode über den <varname>client_id</varname> Parameter eine für jede
- Website eindeutige, ganzzahlige ID:
- </para>
-
- <example id="installation.setup.examples.logging_engine_client_id.php">
- <title>Einsatz einer phpOpenTracker Installation für mehrere Websites</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_client_id.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="installation.webbug">
- <title>Verwenden eines Web Bugs</title>
-
- <para>
- Mit Hilfe des <filename>image.php</filename> Skriptes
- kann die phpOpenTracker Logging Engine über ein HTML Image Tag
- aufgerufen werden. Dieses Skript hat als Ausgabe ein 1x1 Pixel
- großes, transparentes GIF Bild.
- </para>
-
- <para>
- Das Skript akzeptiert die folgenden Parameter, die per HTTP/GET
- übergeben werden:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- client_id
- </para>
-
- <para>
- Zu verwendende <filename>client_id</filename>. Wenn nicht
- angegeben, wird <filename>1</filename> verwendet.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_url
- </para>
-
- <para>
- URL des aktuellen Dokuments.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document
- </para>
-
- <para>
- ID des aktuellen Dokuments.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer
- </para>
-
- <para>
- Referer.
- </para>
- </listitem>
-
- <listitem>
- <para>
- add_data[]
- </para>
-
- <para>
- Mit diesem Feld können beliebige Daten an die
- phpOpenTracker Logging Engine weitergereicht werden, die
- in der <filename>additional_data_table</filename> abgelegt
- werden.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- Ein ausführliches Beispiel finden Sie im
- <filename>examples/webbug/</filename> Verzeichnis.
- </para>
-
- <para>
- Bitte bedenken Sie, dass Besucher, die das automatische Laden
- von Bildern deaktiviert haben, mit dieser Methode nicht erfasst
- werden.
- </para>
- </section>
-
- <section id="installation.logging-outgoing-links">
- <title>Erfassen von externen Links</title>
-
- <para>
- Der folgende Code nutzt das PHP Output Buffering und reguläre Ausdrücke,
- um automatisch alle externen Links von
- <filename>docs/scripts/exit.php</filename> protokollieren zu lassen:
- </para>
-
- <example id="installation.logging-outgoing-links.examples.outgoing_links.php">
- <title>Erfassen von externen Links</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/outgoing_links.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="installation.p3p">
- <title>P3P Police</title>
-
- <para>
- Der MS Internet Explorer 6, und vielleicht auch andere Browser,
- erfordert eine &P3P; Police, bevor er Cookies akzeptiert. Dies
- betrifft auch die so genannten Session Cookies, die das von phpOpenTracker
- verwendete PHP Session Management nutzt. phpOpenTracker kann Besucher, die
- den MS Internet Explorer 6 als Browser einsetzen, nur dann korrekt
- verarbeiten, wenn eine entsprechende P3P Police an den Client
- gesendet wird.
- </para>
-
- <para>
- Der folgende Code sendet eine P3P Police. Dies muss vor dem Aufruf
- der phpOpenTracker Logging Engine erfolgen.
- </para>
-
- <example id="installation.p3p.examples.p3p.php">
- <title>Senden einer kompakten P3P Police an den Client</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/p3p.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/de/internals.xml
===================================================================
--- manual/trunk/chapters/de/internals.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/internals.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,321 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="internals">
- <title>phpOpenTracker Interna</title>
-
- <section id="internals.database">
- <title>Das phpOpenTracker Datenbankschema</title>
-
- <figure id="internals.database.database.png">
- <title>Das phpOpenTracker Datenbankschema</title>
-
- <graphic fileref="figures/database.png" />
- </figure>
- </section>
-
- <section id="internals.api-plugins">
- <title>Erweitern der phpOpenTracker API</title>
-
- <itemizedlist>
- <listitem>
- <para>
- Ein &POT_API; Plugin muss <filename>POT_INCLUDE_PATH . 'API/Plugin.php'</filename>
- importieren und sich von der <classname>phpOpenTracker_API_Plugin</classname>
- Klasse ableiten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Ein &POT_API; Plugin muss eine Klassenvariable
- <varname>$apiCalls</varname> definieren, die als Array eine
- Liste der Namen sämtlicher, von diesem Plugin zur Verfügung
- gestellen, API Aufrufe enthält.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Ein &POT_API; Plugin muss eine Klassenvariable
- <varname>$apiType</varname> definieren, deren Wert entweder
- <varname>get</varname> oder <varname>plot</varname> ist,
- jenachdem, ob die API Aufrufe über
- <function>phpOpenTracker::get</function> oder
- <function>phpOpenTracker::plot</function> erfolgen sollen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Ein &POT_API; Plugin muss den Konstruktor seiner Elternklasse
- aufrufen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Ein &POT_API; Plugin muss eine Methode
- <function>run</function> implementieren, die als
- einzigen Parameter das übliche &POT_API; API Aufruf Parameter
- Array akzeptiert.
- </para>
- </listitem>
- </itemizedlist>
-
- <example id="internals.api-plugins.examples.api_plugin.php">
- <title>Rumpf für ein phpOpenTracker API Plugin</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/api_plugin.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="internals.logging-engine-plugins">
- <title>Erweitern der phpOpenTracker Logging Engine</title>
-
- <itemizedlist>
- <listitem>
- <para>
- Ein phpOpenTracker Logging Engine Plugin muss <filename>POT_INCLUDE_PATH . 'LoggingEngine/Plugin.php'</filename>
- importieren und sich von der <classname>phpOpenTracker_LoggingEngine_Plugin</classname>
- Klasse ableiten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Ein phpOpenTracker Logging Engine Plugin kann eine
- <function>pre</function> Methode implementieren.
- </para>
-
- <para>
- Wird eine solche Methode implementiert, so muss sie einen
- booleschen Wert zurückliefern, wobei <varname>TRUE</varname>
- bedeutet, dass der aktuelle Zugriff gelogged werden soll,
- während <varname>FALSE</varname> angibt, dass der aktuelle
- Zugriff nicht gelogged werden soll.
- </para>
-
- <para>
- Die <function>pre</function> Methode wird vor den normalen
- Operationen der phpOpenTracker Logging Engine aufgerufen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Ein phpOpenTracker Logging Engine Plugin kann eine
- <function>post</function> Methode implementieren.
- </para>
-
- <para>
- Wird eine solche Methode implementiert, so muss sie ein
- assoziatives Array zurückliefern, deren Wertepaare in der
- Datenbank abgespeichert werden. Das Array kann leer sein.
- </para>
-
- <para>
- Die <function>post</function> Methode wird vor den normalen
- Operationen der phpOpenTracker Logging Engine aufgerufen.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- Das <varname>$this->container</varname> Attribut des Pluginobjektes
- enthält die Informationen über den aktuellen Request in einem
- assoziativen Array mit den folgenden Schlüsseln:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>
- accesslog_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- client_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- document
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- document_url
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- document_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- first_request
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- host
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- host_orig
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- host_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- ip_address
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- last_document
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- operating_system
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- operating_system_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- referer
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- referer_orig
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- referer_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- returning_visitor
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- timestamp
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- user_agent
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- user_agent_orig
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- user_agent_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- visitor_id
- </varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <example id="internals.logging-engine-plugins.examples.logging_engine_plugin.php">
- <title>Rumpf für ein phpOpenTracker Logging Engine Plugin</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_plugin.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/de/introduction.xml
===================================================================
--- manual/trunk/chapters/de/introduction.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/introduction.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,204 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="introduction">
- <title>Einführung</title>
-
- <section id="introduction.what">
- <title>Was phpOpenTracker ist</title>
-
- <para>
- phpOpenTracker ist ein umfangreiches Softwarepaket für die Messung des
- Traffics und der Analyse des Benutzerverhaltens von Web
- Applikationen und Internetseiten.
- </para>
-
- <para>
- Den Kern dieses Paketes stellt die so genannte phpOpenTracker
- Logging Engine dar, die die relevanten Daten über Besucher und
- Zugriffe der Site effizient in einer Datenbank ablegt. Hierbei
- kann eine Installation von phpOpenTracker den Datenverkehr beliebig
- vieler Websites protokollieren und auswerten.
- </para>
-
- <para>
- Mit Hilfe der &POT_API; kann einfach und flexibel auf die
- gesammelten Daten zugegriffen werden.
- </para>
- </section>
-
- <section id="introduction.why-need">
- <title>Warum man die Analysen braucht, die phpOpenTracker bietet</title>
-
- <para>
- Die Analyse von Klickpfaden, so wie sie von phpOpenTracker angeboten
- wird, ist für die Messung der Benutzbarkeit (englisch:
- 'Usability') unentbehrlich. Informationen über die am häufigsten
- von Besuchern genommenen Pfade auf der Website, sowie die
- kürzesten genommen Pfade zwischen bestimmten Dokumenten, geben
- Aufschluß darüber, wie die Website von ihren Besuchern
- aufgenommen wird. So lassen sich mit den aus der
- Klickpfadanalyse gewonnenen Erkenntnissen Aussagen darüber
- treffen, ob beispielsweise eine Werbekampagne ihren Zweck
- erfüllt oder ob die Navigation der Web Applikation wirklich so
- intuitiv ist, wie der Designer annimmt.
- </para>
- </section>
-
- <section id="introduction.features">
- <title>Leistungsmerkmale</title>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- Umfangreiche Framework Lösung für die Auswertung des
- Traffics von Web Applikationen und Internetseiten, sowie für
- die Analyse des Verhaltens von Besuchern des Online
- Angebots.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Hochperformante 'Logging Engine', die die benötigten Daten
- über jeden Zugriff effizient in einer Datenbank ablegt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Leistungsstarkes Interface für den Zugriff auf die
- gesammelten Daten und deren Analyse.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Sowohl dynamische, als auch statische Internetseiten können
- untersucht werden.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Kann aus jeder PHP Anwendung, zum Beispiel aus einem Content
- Management System (CMS), heraus aufgerufen werden. Darüber
- hinaus ist der Einsatz eines so genannten Web Bugs möglich.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Eine Installation von phpOpenTracker reicht aus, um sämtliche Web
- Sites / Virtual Hosts eines Servers zu verarbeiten.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="introduction.requirements">
- <title>Anforderungen</title>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- PHP 4.2.1 (oder neuer)
- </para>
- </listitem>
-
- <listitem>
- <para>
- Eines der folgenden Datenbanksysteme:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- &MSSQLSERVER;
- </para>
- </listitem>
-
- <listitem>
- <para>
- &MYSQL; 3.23.2 (oder neuer)
- </para>
-
- <para>
- Wenn Sie &MERGE_TABLES; verwenden möchten, so benötigen Sie
- MySQL 3.23.54 (oder neuer).
- </para>
-
- <para>
- Die Verwendung der jeweils aktuellen Version von MySQL
- 4 wird empfohlen. Der in MySQL 4.0.1 eingeführte
- &MYSQL_QUERY_CACHE; sowie die ab &MYSQL_4_1;
- unterstützten Unteranfragen beschleunigen die
- Ausführung von &POT_API; Anfragen.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &ORACLE; 8.1.6 (oder neuer)
- </para>
- </listitem>
-
- <listitem>
- <para>
- &POSTGRESQL;
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- &GRAPHVIZ;
- </para>
- <para>
- Sie benötigen dieses Paket, wenn Sie Klickpfade visualisieren
- möchten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &JPGRAPH; (getestet mit Version 1.9.1)
- </para>
- <para>
- Sie benötigen dieses Paket, wenn Sie statistische
- Auswertungen visualisieren möchten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &CACHE_LITE; 1.0.1 (oder neuer)
- </para>
- <para>
- Sie benötigen dieses Paket, wenn Sie den phpOpenTracker API
- Query Cache einsetzen möchten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &IMAGE_GRAPHVIZ; 1.0.1 (oder neuer)
- </para>
- <para>
- Sie benötigen dieses Paket, wenn Sie Klickpfade visualisieren
- möchten.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &XML_TREE; 1.1 (oder neuer)
- </para>
- <para>
- Sie benötigen dieses Paket, wenn Sie &XML; als Ergebnisformat
- verwenden möchten.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/de/preface.xml
===================================================================
--- manual/trunk/chapters/de/preface.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/preface.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,23 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<preface id="preface">
- <title>Vorwort</title>
-
- <section id="preface.copyright">
- <title>Copyright</title>
-
- <para>
- phpOpenTracker wird von &SB; entwickelt und ist unter der &LICENSE;
- als &OSS; veröffentlicht.
- </para>
-
- <para>
- phpOpenTracker ist kostenlos verfügbar. Dies heißt jedoch nicht, dass
- sich Sebastian nicht über Anerkennung für seine Arbeit freuen würde.
- Wenn Sie also phpOpenTracker nützlich finden und ihre Anerkennung zum
- Ausdruck bringen möchten, so werfen Sie doch einen Blick auf
- seinen &AMAZON_DE_WISHLIST;. Bitte geben Sie Ihre E-Mail Adresse an,
- damit sich Sebastian bei Ihnen für Ihr Geschenk bedanken kann.
- </para>
- </section>
-</preface>
Deleted: manual/trunk/chapters/de/tuning.xml
===================================================================
--- manual/trunk/chapters/de/tuning.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/de/tuning.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,138 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="tuning">
- <title>Performance Optimierung</title>
-
- <section id="tuning.introduction">
- <title>Einführung</title>
-
- <para>
- Bei der Entwicklung von phpOpenTracker werden der Prformanz der
- Logging Engine sowie der Flexibilität der &POT_API; besondere
- Bedeutung beigemessen. Dieses Kapitel stellt Möglichkeiten vor,
- die Performanz beider Komponenten zu verbessern.
- </para>
- </section>
-
- <section id="tuning.query-cache">
- <title>phpOpenTracker API Query Cache</title>
- <titleabbrev id="query-cache">phpOpenTracker API Query Cache</titleabbrev>
-
- <para>
- Das Ergebnis einer &POT_API; Abfrage, die auf ein vollständig in
- der Vergangenheit liegendes <xref linkend="api-reference.timeranges"
- endterm="timerange"/> beschränkt ist, kann im so genannten
- phpOpenTracker API Query Cache abgelegt werden. Spätere Anfragen
- nach demselben Ergebnis können aus dem Cache bedient werden, ohne
- dass die Datenbank bemüht bzw. das Ergebnis neu berechnet werden
- muss.
- </para>
-
- <para>
- Für die Verwendung des phpOpenTracker API Query Cache muss das
- PEAR Cache_Lite Paket installiert werden. Ferner sind die
- folgenden Einstellungen in der
- <filename>conf/phpOpenTracker.php</filename> vorzunehmen:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>query_cache</filename>
- </para>
-
- <para>
- Diese Direktive aktiviert/deaktiviert den
- phpOpenTracker API Query Cache.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>query_cache_dir</filename>
- </para>
-
- <para>
- Das Verzeichnis, in dem der phpOpenTracker API Query Cache
- seine Daten ablegt.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>query_cache_lifetime</filename>
- </para>
-
- <para>
- Lebenszeit eines phpOpenTracker API Query Cache Eintrags
- in Sekunden.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="tuning.mysql-merge-tables">
- <title>MySQL Merge Tables</title>
- <titleabbrev id="mysql-merge-tables">MySQL Merge Tables</titleabbrev>
-
- <para>
- <emphasis>Hinzugefügt in Version 1.2.0.</emphasis>
- </para>
-
- <para>
- Mit der Zeit wachsen die Tabellen <varname>pot_accesslog</varname> und
- <varname>pot_visitors</varname>, was zu einer Verschlechterung der
- Performanz von &POT_API; Anfragen führt.
- </para>
-
- <para>
- Bei der Verwendung von MySQL bieten sich die so genannten
- &MYSQL_MYISAM_MERGE; Tabellen an, mit deren Hilfe phpOpenTracker
- einen Satz von Log-Tabellen (eine Tabelle pro Monat) verwaltet.
- Somit können Datenbankabfragen auf relevante Teilbereiche der
- gesammelten Daten beschränkt werden, was die Ausführung von
- &POT_API; Anfragen beschleunigt.
- </para>
- </section>
-
- <section id="tuning.indexing">
- <title>Datenbankindizierung</title>
-
- <para>
- Die benötigte Zeit, um die Datenbankindizes in der von phpOpenTracker
- genutzen Datenbank zu verwalten, steigt im Verhältnis zur bereits
- vorhandenen Datenmenge an.
- </para>
-
- <para>
- ... TBD: DELAY_KEY_WRITE / PACK_KEYS ...
- </para>
-
- <para>
- Bei der Verwendung von anderen Datenbankumgebungen kann es
- allerdings durchaus angebracht sein, auf die Indizierung der
- Datenbank zu verzichten -- und damit Geschwindigkeit von Abfragen
- gegen Geschwindigkeit für den Logging Vorgang einzutauschen.
- </para>
- </section>
-
- <section id="tuning.dedicated-server">
- <title>Dedizierter Tracking Server</title>
-
- <para>
- In einer High Traffic Umgebung kann es angebracht sein, die
- phpOpenTracker Logging Engine auf einer anderen Maschine zu
- betreiben, als auf der, auf der der eigentliche Web Server
- installiert ist. Dies wird durch die Tatsache möglich, daß der
- Logging Vorgang durch einen so genannten Web Bug initiiert werden
- kann.
- </para>
-
- <para>
- Da dieser dedizierte Server nur den Logging Prozess auszuführen
- hat, wäre ein normaler Webserver, wie zum Beispiel Apache,
- überdimensioniert. Hier bietet sich der Einsatz von &LIGHTTPD;
- oder &THTTPD; an.
- </para>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/en/api-reference.xml
===================================================================
--- manual/trunk/chapters/en/api-reference.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/api-reference.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,2790 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="api-reference">
- <title>The phpOpenTracker API</title>
- <titleabbrev id="api">phpOpenTracker API</titleabbrev>
-
- <section id="api-reference.introduction">
- <title>Introduction</title>
-
- <para>
- The &POT_API; provides all the functionality needed to access
- the data gathered by the phpOpenTracker Logging Engine. It has
- methods to return the result of the performed query, as well as
- the possibility to plot it and output an image.
- </para>
-
- <para>
- The easiest way to use the &POT_API; is to include
- <filename>phpOpenTracker.php</filename> in your PHP application
- and then use its <function>phpOpenTracker::get</function>
- method. This method expects an array as its only parameter.
- </para>
-
- <example id="api-reference.introduction.examples.api.php">
- <title>Using the phpOpenTracker API from within a PHP application</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/api.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- For a more extensive example of how the &POT_API; works, have a
- look at the <filename>examples/simple_report</filename>
- application, that is part of the phpOpenTracker distribution.
- </para>
- </section>
-
- <section id="api-reference.constraints">
- <title>Specifying Search Constraints</title>
- <titleabbrev id="constraints">constraints</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.1.0.</emphasis>
- </para>
-
- <para>
- Most of the &POT_API;'s calls accept the
- <varname>constraints</varname> parameter, that holds a set of
- constraints in an array where the keys listed below are allowed:
- </para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- entry_document
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_document
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_target
- </para>
- </listitem>
-
- <listitem>
- <para>
- host
- </para>
- </listitem>
-
- <listitem>
- <para>
- operating_system
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer
- </para>
- </listitem>
-
- <listitem>
- <para>
- user_agent
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- weekday
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- hour (0 to 23)
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- If you use &POT_API; in a script that invoked the phpOpenTracker Logging
- Engine you may use <varname>this</varname> as a constrain value and
- the current visitor's value of the specified field will be used.
- </para>
-
- <example id="api-reference.constraints.examples.page_impressions_document.php">
- <title>Page Impressions on a given document</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/page_impressions_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.timeranges">
- <title>Specifying Timeranges</title>
- <titleabbrev id="timerange">timerange</titleabbrev>
-
- <para>
- Most of the &POT_API;'s calls accept a <varname>range</varname>
- parameter to limit the query to a specified timerange. Whenever
- this is the case, <varname>range</varname> may be one of the
- following:
- </para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- current_minute
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_minute
- </para>
- </listitem>
-
- <listitem>
- <para>
- current_hour
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_hour
- </para>
- </listitem>
-
- <listitem>
- <para>
- today
- </para>
- </listitem>
-
- <listitem>
- <para>
- yesterday
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- current_week
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- previous_week
- </para>
- </listitem>
-
- <listitem>
- <para>
- current_month
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_month
- </para>
- </listitem>
-
- <listitem>
- <para>
- current_year
- </para>
- </listitem>
-
- <listitem>
- <para>
- previous_year
- </para>
- </listitem>
-
- <listitem>
- <para>
- total
- </para>
- </listitem>
- </itemizedlist>
-
- <example id="api-reference.timeranges.examples.timeranges.php">
- <title>Specifying timeranges</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/timeranges.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- In addition to the above values for the <varname>range</varname>
- parameter you may use the following interval identifiers:
- </para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- minute
- </para>
- </listitem>
-
- <listitem>
- <para>
- hour
- </para>
- </listitem>
-
- <listitem>
- <para>
- day
- </para>
- </listitem>
-
- <listitem>
- <para>
- month
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- week
- </para>
- </listitem>
-
- <listitem>
- <para>
- year
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- These generic interval identifiers require two additional parameters,
- <varname>range_start</varname> and <varname>range_length</varname>,
- and allow to specifiy timeranges that start at <varname>current time -
- (range_start * length(range))</varname> have a length of
- <varname>range_length * length(range)</varname>.
- </para>
- </section>
-
- <section id="api-reference.result-formats">
- <title>Result Formats</title>
- <titleabbrev id="result-formats">result formats</titleabbrev>
-
- <itemizedlist>
- <listitem>
- <para>
- array
- </para>
-
- <para>
- Array representation.
- </para>
- </listitem>
-
- <listitem>
- <para>
- clickpath
- </para>
-
- <para>
- Clickpath object.
- </para>
- </listitem>
-
- <listitem>
- <para>
- csv
- </para>
-
- <para>
- Comma Separated Values (CSV). This format can be imported in
- spreadsheet applications like Microsoft Excel.
- </para>
- </listitem>
-
- <listitem>
- <para>
- graphviz
- </para>
-
- <para>
- GraphViz Markup.
- </para>
-
- <para>
- GraphViz/dot is a tool developed by AT&T to visualize
- graphs of arbitrary complexity. It supports GIF, PNG, JPEG,
- PostScript and SVG as output formats for the generated graphics.
- </para>
- </listitem>
-
- <listitem>
- <para>
- graphviz_object
- </para>
-
- <para>
- GraphViz object.
- </para>
- </listitem>
-
- <listitem>
- <para>
- SQL
- </para>
-
- <para>
- SQL Query.
- </para>
- </listitem>
-
- <listitem>
- <para>
- xml
- </para>
-
- <para>
- XML markup.
- </para>
- </listitem>
-
- <listitem>
- <para>
- xml_object
- </para>
-
- <para>
- &XML_TREE; object.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="api-reference.api-calls">
- <title>API Calls</title>
-
- <section id="api-reference.api-calls.all_paths">
- <title>all_paths</title>
- <titleabbrev id="all_paths">all_paths</titleabbrev>
-
- <para>
- Retrieve GraphViz markup for all clickpaths with their
- respective statistics.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_color (optional, default: <varname>black</varname>)
- </para>
-
- <para>
- Color of documents in GraphViz graphs.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include exit targets.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_target_color (optional, default: <varname>red</varname>)
- </para>
-
- <para>
- Color of exit targets in GraphViz graphs.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include referers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer_color (optional, default: <varname>green</varname>)
- </para>
-
- <para>
- Color of referers in GraphViz graphs.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>graphviz</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>graphviz</varname> and
- <varname>graphviz_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.all_paths.examples.all_paths.php">
- <title>Output GraphViz/dot markup for all clickpaths</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/all_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <figure id="api-reference.api-calls.all_paths.figures.all_paths.png">
- <title>Clickpaths on www.phpOpenTracker.de in November 2002</title>
-
- <graphic fileref="figures/all_paths.png" />
- </figure>
- </section>
-
- <section id="api-reference.api-calls.average_clickpath_length">
- <title>average_clickpath_length</title>
- <titleabbrev id="average_clickpath_length">average_clickpath_length</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the average clickpath length.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.all_paths.examples.average_clickpath_length.php">
- <title>Average Clickpath Length</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/average_clickpath_length.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.average_time_between_visits">
- <title>average_time_between_visits</title>
- <titleabbrev id="average_time_between_visits">average_time_between_visits</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the average time between the visits of returning visitors.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.average_visits">
- <title>average_visits</title>
- <titleabbrev id="average_visits">average_visits</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the average number of times returning visitors visited
- the website.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.individual_clickpath">
- <title>individual_clickpath</title>
- <titleabbrev id="individual_clickpath">individual_clickpath</titleabbrev>
-
- <para>
- Retrieve a clickpath by its accesslog_id.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- accesslog_id
- </para>
-
- <para>
- accesslog_id of the clickpath to be retrieved.
- </para>
- </listitem>
-
- <listitem>
- <para>
- resolve_ids (optional, default: &true;)
- </para>
-
- <para>
- Set to &true; to resolve data identifiers to their
- corresponding string, or to &false; to use the data
- identifier instead of the string.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>clickpath</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>clickpath</varname>,
- <varname>graphviz</varname>, <varname>graphviz_object</varname>,
- <varname>xml</varname> and <varname>xml_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.individual_clickpath.examples.individual_clickpath.php">
- <title>Retrieve a clickpath by its accesslog_id</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/individual_clickpath.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <figure id="api-reference.api-calls.individual_clickpath.figures.clickpath.png">
- <title>Graph of individual clickpath</title>
-
- <graphic fileref="figures/clickpath.png" />
- </figure>
- </section>
-
- <section id="api-reference.api-calls.longest_paths">
- <title>longest_paths</title>
- <titleabbrev id="longest_paths">longest_paths</titleabbrev>
-
- <para>
- Retrieve longest paths information.
- </para>
-
- <para>
- The query can be limited to a given timerange, to given start and/or
- end documents of the path and to a maximum number of documents in
- the path.
- </para>
-
- <para>
- To visualize the returned clickpaths with GraphViz select
- <varname>array</varname> as the result format. The returned array
- contains objects of the class <classname>phpOpenTracker_Clickpath</classname>
- that provides a method, <function>toGraph</function>, to generate
- GraphViz markup.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- from (optional)
- </para>
-
- <para>
- Consider only paths starting in <varname>from</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- to (optional)
- </para>
-
- <para>
- Consider only paths ending in <varname>end</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- subpaths (optional, default: &false;)
- </para>
-
- <para>
- Set to &false; to limit the query to complete,
- individually taken paths only. Otherwise each individually
- by a visitor taken clickpath will be split into its
- respective subpaths.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include exit targets.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include referers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- length (optional)
- </para>
-
- <para>
- Limit the query to (sub)paths of length <varname>length</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Return only this many result items.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>graphviz</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>graphviz</varname> and <varname>graphviz_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.longest_paths.examples.longest_paths.php">
- <title>Retrieve the 10 longest paths ending in a given document</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/longest_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.num_one_time_visitors">
- <title>num_one_time_visitors</title>
- <titleabbrev id="num_one_time_visitors">num_one_time_visitors</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the number of one-time visitors.
- </para>
-
- <para>
- Note: This API call can only return a meaningful result if
- <varname>track_returning_visitors</varname> is activated in the
- <filename>conf/phpOpenTracker.php</filename>
- configuration file.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_return_visits">
- <title>num_return_visits</title>
- <titleabbrev id="num_return_visits">num_return_visits</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the number of return visits.
- </para>
-
- <para>
- Note: This API call can only return a meaningful result if
- <varname>track_returning_visitors</varname> is activated in the
- <filename>conf/phpOpenTracker.php</filename>
- configuration file.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_returning_visitors">
- <title>num_returning_visitors</title>
- <titleabbrev id="num_returning_visitors">num_returning_visitors</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the number of returning visitors.
- </para>
-
- <para>
- Note: This API call can only return a meaningful result if
- <varname>track_returning_visitors</varname> is activated in the
- <filename>conf/phpOpenTracker.php</filename>
- configuration file.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_unique_visitors">
- <title>num_unique_visitors</title>
- <titleabbrev id="num_unique_visitors">num_unique_visitors</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.3.0.</emphasis>
- </para>
-
- <para>
- Returns the number of unique visitors.
- </para>
-
- <para>
- Note: This API call can only return a meaningful result if
- <varname>track_returning_visitors</varname> is activated in the
- <filename>conf/phpOpenTracker.php</filename>
- configuration file.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.num_visitors_online">
- <title>num_visitors_online</title>
- <titleabbrev id="num_visitors_online">num_visitors_online</titleabbrev>
-
- <para>
- Retrieve the number of visitors online.
- </para>
-
- <para>
- The query can be limited to a given document.
- </para>
-
- <para>
- Note: Since HTTP is a state-less protocol there is no way to excatly
- answer this question. phpOpenTracker determines this number by taking a look at the
- number of visitors during the last minutes. As a timerange the
- parameter <varname>session_lifetime</varname> is taken into
- consideration.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- session_lifetime (optional, default: 3)
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.num_visitors_online.examples.num_visitors_online.php">
- <title>Visitors online</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/num_visitors_online.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <example id="api-reference.api-calls.num_visitors_online.examples.num_visitors_online_document.php">
- <title>Visitors on current document</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/num_visitors_online_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.page_impressions">
- <title>page_impressions</title>
- <titleabbrev id="page_impressions">page_impressions</titleabbrev>
-
- <para>
- Retrieve the number of page impressions in a given timerange.
- </para>
-
- <para>
- The result can be either a single number, or, if the
- <varname>interval</varname> parameter is given, an array of
- sampled values at certain intervals throughout the timerange.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- interval (optional)
- </para>
-
- <para>
- Divides the given timerange into intervals of <varname>interval</varname> seconds.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>array</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>csv</varname>, <varname>xml</varname> and
- <varname>xml_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.page_impressions.examples.page_impressions.php">
- <title>Page Impressions</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/page_impressions.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <example id="api-reference.api-calls.page_impressions.examples.page_impressions_document.php">
- <title>Page Impressions of a given document</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/page_impressions_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.returning_visitors">
- <title>returning_visitors</title>
- <titleabbrev id="returning_visitors">returning_visitors</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.0.5.</emphasis>
- </para>
-
- <para>
- Returns information on returning visitors.
- </para>
-
- <para>
- Note: This API call can only return a meaningful result if
- <varname>track_returning_visitors</varname> is activated in the
- <filename>conf/phpOpenTracker.php</filename>
- configuration file.
- </para>
-
- <para>
- Parameter
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>array</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>xml</varname> and <varname>xml_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.search_engines">
- <title>search_engines</title>
- <titleabbrev id="search_engines">search_engines</titleabbrev>
-
- <para>
- <emphasis>Only available when the Search Engines plugin is installed.</emphasis>
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- what
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.shortest_paths">
- <title>shortest_paths</title>
- <titleabbrev id="shortest_paths">shortest_paths</titleabbrev>
-
- <para>
- Retrieve shortest paths information.
- </para>
-
- <para>
- The query can be limited to a given timerange, to given start and/or
- end documents of the path and to a maximum number of documents in
- the path.
- </para>
-
- <para>
- To visualize the returned clickpaths with GraphViz select
- <varname>array</varname> as the result format. The returned array
- contains objects of the class <classname>phpOpenTracker_Clickpath</classname>
- that provides a method, <function>toGraph</function>, to generate
- GraphViz markup.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- from (optional)
- </para>
-
- <para>
- Consider only paths starting in <varname>from</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- to (optional)
- </para>
-
- <para>
- Consider only paths ending in <varname>end</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- subpaths (optional, default: &false;)
- </para>
-
- <para>
- Set to &false; to limit the query to complete,
- individually taken paths only. Otherwise each individually
- by a visitor taken clickpath will be split into its
- respective subpaths.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include exit targets.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include referers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- length (optional)
- </para>
-
- <para>
- Limit the query to (sub)paths of length <varname>length</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Return only this many result items.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>graphviz</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>graphviz</varname> and <varname>graphviz_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.shortest_paths.examples.shortest_paths.php">
- <title>Retrieve the 10 shortest paths ending in a given document</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/shortest_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.top">
- <title>top</title>
- <titleabbrev id="top">top</titleabbrev>
-
- <para>
- Retrieve statistical information.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- what
- </para>
-
- <para>
- May be one of: <varname>document</varname>, <varname>entry_document</varname>,
- <varname>exit_document</varname>, <varname>exit_target</varname>,
- <varname>host</varname>, <varname>referer</varname>,
- <varname>operating_system</varname> and <varname>user_agent</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Return only this many result items.
- </para>
- </listitem>
-
- <listitem>
- <para>
- order (optional, default <varname>DESC</varname>)
- </para>
-
- <para>
- <varname>ASC</varname>ending or <varname>DESC</varname>ending.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>array</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>csv</varname>, <varname>sql</varname>,
- <varname>xml</varname> and <varname>xml_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.top.examples.top.php">
- <title>Retrieve the top 10 documents</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/top.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.top_paths">
- <title>top_paths</title>
- <titleabbrev id="top_paths">top_paths</titleabbrev>
-
- <para>
- Retrieve the most commonly used paths.
- </para>
-
- <para>
- The query can be limited to a given timerange, to given start and/or
- end documents of the path and to a maximum number of documents in
- the path.
- </para>
-
- <para>
- To visualize the returned clickpaths with GraphViz select
- <varname>array</varname> as the result format. The returned array
- contains objects of the class <classname>phpOpenTracker_Clickpath</classname>
- that provides a method, <function>toGraph</function>, to generate
- GraphViz markup.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- from (optional)
- </para>
-
- <para>
- Consider only paths starting in <varname>from</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- to (optional)
- </para>
-
- <para>
- Consider only paths ending in <varname>end</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- subpaths (optional, default: &false;)
- </para>
-
- <para>
- Set to &false; to limit the query to complete,
- individually taken paths only. Otherwise each individually
- by a visitor taken clickpath will be split into its
- respective subpaths.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include exit targets.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers (optional, default: &false;)
- </para>
-
- <para>
- Set to &true; to include referers.
- </para>
- </listitem>
-
- <listitem>
- <para>
- length (optional)
- </para>
-
- <para>
- Limit the query to (sub)paths of length <varname>length</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Return only this many result items.
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>graphviz</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>graphviz</varname> and <varname>graphviz_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.top_paths.examples.top_paths.php">
- <title>Retrieve the top 10 paths of length 3 ending in a given document</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/top_paths.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.visits">
- <title>visits</title>
- <titleabbrev id="visits">visits</titleabbrev>
-
- <para>
- Retrieve the number of visits in a given timerange.
- </para>
-
- <para>
- The result can be either a single number, or, if the
- <varname>interval</varname> parameter is given, an array of
- sampled values at certain intervals throughout the timerange.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- interval (optional)
- </para>
-
- <para>
- Divides the given epoch into subranges (Number of seconds).
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>array</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>csv</varname>, <varname>xml</varname> and
- <varname>xml_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.visitors.examples.visits.php">
- <title>Visits</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/visits.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.visitors_online">
- <title>visitors_online</title>
- <titleabbrev id="visitors_online">visitors_online</titleabbrev>
-
- <para>
- Retrieve information on the visitors currently online.
- </para>
-
- <para>
- The query can be limited to a given document.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- result_format (optional, default: <varname>array</varname>)
- </para>
-
- <para>
- Possible result formats are <varname>array</varname>,
- <varname>xml</varname> and <varname>xml_object</varname>.
- </para>
-
- <para>
- See the section on <xref linkend="result-formats"
- endterm="result-formats"/> for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- session_lifetime (optional, default: 3)
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.visitors_online.examples.visitors_online.php">
- <title>Retrieve information on the visitors currently on the site</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/visitors_online.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.plot_access_statistics">
- <title>plot: access_statistics</title>
- <titleabbrev id="plot_access_statistics">plot_access_statistics</titleabbrev>
-
- <para>
- Plot a graph of visits and page impressions for a given timerange.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- interval (optional)
- </para>
-
- <para>
- Divides the given timerange into intervals of <varname>hour</varname>,
- <varname>day</varname>, <varname>month</varname>, <varname>year</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- width (optional, default: 640)
- </para>
-
- <para>
- Width of the image.
- </para>
- </listitem>
-
- <listitem>
- <para>
- height (optional, default: 480)
- </para>
-
- <para>
- Height of the image.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color1 (optional, default: <varname>red</varname>)
- </para>
-
- <para>
- First color.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color2 (optional, default: <varname>blue</varname>)
- </para>
- <para>
- Second color.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font (optional, default: <varname>FF_VERDANA</varname>)
- </para>
-
- <para>
- Font to be used, possible values are <varname>FF_COURIER</varname>,
- <varname>FF_VERDANA</varname>, <varname>FF_TIMES</varname>,
- <varname>FF_HANDWRT</varname>, <varname>FF_COMIC</varname>,
- <varname>FF_ARIAL</varname> and <varname>FF_BOOK</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_style (optional, default: <varname>FS_NORMAL</varname>)
- </para>
-
- <para>
- Style of the font to be used, possible values are <varname>FS_NORMAL</varname>,
- <varname>FS_BOLD</varname>, <varname>FS_ITALIC</varname> and
- <varname>FS_BOLDIT</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_size (optional, default: 10)
- </para>
-
- <para>
- Size of the font to be used.
- </para>
- </listitem>
-
- <listitem>
- <para>
- month_names (optional, default: english month names)
- </para>
-
- <para>
- Array with localized month names.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.plot_access_statistics.examples.plot_access_statistics.php">
- <title>Plot access statistics for current day</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_access_statistics.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <example id="api-reference.api-calls.plot_access_statistics.examples.plot_access_statistics_german.php">
- <title>Plot access statistics for current year with German month names</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_access_statistics_german.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="api-reference.api-calls.plot_locations">
- <title>plot: locations</title>
- <titleabbrev id="plot_locations">plot_locations</titleabbrev>
-
- <para>
- <emphasis>Only available when version 1.1.0 (or later) of the Localizer plugin is installed.</emphasis>
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_dnnet (optional, default: <varname>blue</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_pppoly (optional, default: <varname>green</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_ponet (optional, default: <varname>black</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- color_rdline (optional, default: <varname>grey</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- format (optional, default: <varname>png</varname>)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
-
- <listitem>
- <para>
- range (optional)
- </para>
-
- <para>
- TO BE DOCUMENTED.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
-
- <section id="api-reference.api-calls.plot_top">
- <title>plot: top</title>
- <titleabbrev id="plot_top">plot_top</titleabbrev>
-
- <para>
- Plot a pie chart for top data for a given timerange.
- </para>
-
- <para>
- Parameters
-
- <orderedlist>
- <listitem>
- <para>
- client_id (optional, default: 1)
- </para>
- </listitem>
-
- <listitem>
- <para>
- constraints (optional)
- </para>
-
- <para>
- See the section on <xref linkend="constraints"
- endterm="constraints"/> for more details on
- constraining queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The query can be limited to a timerange defined by the
- following parameters:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>start</varname> and / or <varname>end</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>range</varname>, <varname>range_start</varname> and <varname>range_length</varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- See the section on <xref linkend="api-reference.timeranges" endterm="timerange"/>s
- for details.
- </para>
- </listitem>
-
- <listitem>
- <para>
- what
- </para>
-
- <para>
- May be one of: <varname>document</varname>, <varname>entry_document</varname>,
- <varname>exit_document</varname>, <varname>exit_target</varname>,
- <varname>host</varname>, <varname>referer</varname>,
- <varname>operating_system</varname> and <varname>user_agent</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- limit (optional)
- </para>
-
- <para>
- Plot only this many result items.
- </para>
- </listitem>
-
- <listitem>
- <para>
- width (optional, default: 640)
- </para>
-
- <para>
- Width of the image.
- </para>
- </listitem>
-
- <listitem>
- <para>
- height (optional, default: 480)
- </para>
-
- <para>
- Height of the image.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font (optional, default: <varname>FF_VERDANA</varname>)
- </para>
-
- <para>
- Font to be used, possible values are <varname>FF_COURIER</varname>,
- <varname>FF_VERDANA</varname>, <varname>FF_TIMES</varname>,
- <varname>FF_HANDWRT</varname>, <varname>FF_COMIC</varname>,
- <varname>FF_ARIAL</varname> and <varname>FF_BOOK</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_style (optional, default: <varname>FS_NORMAL</varname>)
- </para>
-
- <para>
- Style of the font to be used, possible values are <varname>FS_NORMAL</varname>,
- <varname>FS_BOLD</varname>, <varname>FS_ITALIC</varname> and
- <varname>FS_BOLDIT</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- font_size (optional, default: 10)
- </para>
-
- <para>
- Size of the font to be used.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <example id="api-reference.api-calls.plot_top.examples.plot_top.php">
- <title>Plot pie chart for top 10 pages during the current month</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/plot_top.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <figure id="api-reference.api-calls.top.figures.plot_top.png">
- <title>Pie chart for top 10 pages of www.phpOpenTracker.de</title>
-
- <graphic fileref="figures/plot_top.png" />
- </figure>
- </section>
- </section>
-</chapter>
Copied: manual/trunk/chapters/en/bookinfo.xml (from rev 37, manual/trunk/chapters/en/bookinfo.xml.in)
===================================================================
--- manual/trunk/chapters/en/bookinfo.xml.in 2004-12-31 09:15:33 UTC (rev 37)
+++ manual/trunk/chapters/en/bookinfo.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1" ?>
+
+<bookinfo>
+ <title>Manual for phpOpenTracker 2</title>
+
+ <author>
+ <firstname>Sebastian</firstname>
+ <surname>Bergmann</surname>
+ </author>
+
+ <copyright>
+ <year>2000</year>
+ <year>2001</year>
+ <year>2002</year>
+ <year>2003</year>
+ <year>2005</year>
+ <holder>Sebastian Bergmann</holder>
+ </copyright>
+
+ <pubdate>Updated on <?dbtimestamp format="d.m.Y"?>.</pubdate>
+</bookinfo>
+
+<dedication>
+ <para>
+ "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
+ </para>
+</dedication>
Deleted: manual/trunk/chapters/en/bookinfo.xml.in
===================================================================
--- manual/trunk/chapters/en/bookinfo.xml.in 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/bookinfo.xml.in 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<bookinfo>
- <title>The phpOpenTracker Manual</title>
-
- <author>
- <firstname>Sebastian</firstname>
- <surname>Bergmann</surname>
- </author>
-
- <copyright>
- <year>2000</year>
- <year>2001</year>
- <year>2002</year>
- <year>2003</year>
- <year>2005</year>
- <holder>Sebastian Bergmann</holder>
- </copyright>
-
- <pubdate>
- Revision {svnversion} built on <?dbtimestamp format="d.m.Y"?> at <?dbtimestamp format="H:M:S"?>.
- </pubdate>
-</bookinfo>
-
-<dedication>
- <para>
- "phpOpenTracker essenya, gul meletya; Sebastian carneron PHP."
- </para>
-</dedication>
Deleted: manual/trunk/chapters/en/configuration.xml
===================================================================
--- manual/trunk/chapters/en/configuration.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/configuration.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,541 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="configuration">
- <title>Configuration</title>
-
- <section id="configuration.config-file">
- <title>The Configuration File</title>
-
- <para>
- This section describes all directives of phpOpenTracker's configuration
- file, called <filename>conf/phpOpenTracker.php</filename>.
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- db_type
- </para>
-
- <para>
- Can be one of 'mysql', 'oci8' and 'pgsql'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_host
- </para>
-
- <para>
- The host of your database server.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_port
- </para>
-
- <para>
- The port your database server listens on.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_socket
- </para>
-
- <para>
- The socket your database server uses.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_user
- </para>
-
- <para>
- Username to connect with to your database server.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_password
- </para>
-
- <para>
- Password to connect with to your database server.
- </para>
- </listitem>
-
- <listitem>
- <para>
- db_database
- </para>
-
- <para>
- Name of the database to use.
- </para>
- </listitem>
-
- <listitem>
- <para>
- additional_data_table
- </para>
-
- <para>
- Name of the Additional Data Table, the default is
- 'pot_add_data'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- accesslog_table
- </para>
-
- <para>
- Name of the Accesslog Table, the default is
- 'pot_accesslog'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- documents_table
- </para>
-
- <para>
- Name of the Documents Table, the default is
- 'pot_documents'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_targets_table
- </para>
-
- <para>
- Name of the Exit Targets Table, the default is
- 'pot_exit_targets'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- hostnames_table
- </para>
-
- <para>
- Name of the Hostnames Table, the default is
- 'pot_hostnames'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referers_table
- </para>
-
- <para>
- Name of the Referers Table, the default is
- 'pot_referers'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- operating_systems_table
- </para>
-
- <para>
- Name of the Operating Systems Table, the default is
- 'pot_operating_systems'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- user_agents_table
- </para>
-
- <para>
- Name of the User Agents Table, the default is
- 'pot_user_agents'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- visitors_table
- </para>
-
- <para>
- Name of the Visitors Table, the default is
- 'pot_visitors'.
- </para>
- </listitem>
-
- <listitem>
- <para>
- merge_tables_mode
- </para>
-
- <para>
- <emphasis>Added in version 1.5.0.</emphasis>
- </para>
-
- <para>
- This configuration directive controls the resolution of the
- &MERGE_TABLES; backend.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>day</filename> maintains one table per day.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>month</filename> (default) maintains one table per month.
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para>
- jpgraph_path
- </para>
-
- <para>
- Set <filename>jpgraph_path</filename> to the path to
- your JPGraph installation.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_env_var
- </para>
-
- <para>
- Name of the environment variable to use for determination
- of current document. For instance,
- 'PATH_INFO' or
- 'REQUEST_URI' are possible here.
- </para>
- </listitem>
-
- <listitem>
- <para>
- clean_query_string & get_parameter_filter
- </para>
-
- <para>
- If set to 'On', this directive enables
- phpOpenTracker to strip away all HTTP GET parameters from the URL,
- before it gets stored in the DB. The Session ID will be
- stripped from the URL in either case.
- </para>
-
- <para>
- While setting clean_query_string to
- 'On' will clean the document's URL of
- any HTTP GET parameters, you can define with the
- get_parameter_filter array a list of HTTP GET parameters
- that you would like to be stripped from the URL.
- </para>
- </listitem>
-
- <listitem>
- <para>
- clean_referer_string
- </para>
-
- <para>
- If set to 'On', this directive enables
- phpOpenTracker to strip away all HTTP GET parameters from the
- referer's URL, before it gets stored in the DB.
- </para>
- </listitem>
-
- <listitem>
- <para>
- debug_level
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- 0
- </para>
-
- <para>
- Don't output error and warning messages.
- </para>
- </listitem>
-
- <listitem>
- <para>
- 1 (default)
- </para>
-
- <para>
- Output error and warning messages.
- </para>
- </listitem>
-
- <listitem>
- <para>
- 2
- </para>
-
- <para>
- Output additional debugging messages.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- <emphasis role="bold">
- Note: When using phpOpenTracker in production you most likely want to
- set this directive to '0' whereas in an initial testing
- phase a value of '1' is advisable. Use '2' only for debugging
- purposes.
- </emphasis>
- </para>
- </listitem>
-
- <listitem>
- <para>
- exit_on_fatal_errors
- </para>
-
- <para>
- If set to 'On', this directive makes phpOpenTracker to exit if a fatal
- error occurs.
- </para>
-
- <para>
- <emphasis role="bold">
- Note: When using phpOpenTracker in production (after an initial
- testing phase) you most likely want to set this directive
- to 'Off'.
- </emphasis>
- </para>
- </listitem>
-
- <listitem>
- <para>
- log_errors
- </para>
-
- <para>
- If set to 'On', this directive makes phpOpenTracker log error and
- warning messages to a logfile.
- </para>
-
- <para>
- Make sure that your webserver is allowed to write to the file:
-
-<screen>
-cd /path/to/phpOpenTracker
-touch error.log
-chmod 666 error.log
-</screen>
- </para>
-
- <para>
- <emphasis role="bold">
- Note: When using phpOpenTracker in production (after an initial
- testing phase) you most likely want to set this directive
- to 'On'.
- </emphasis>
- </para>
- </listitem>
-
- <listitem>
- <para>
- logfile
- </para>
-
- <para>
- Path of the logfile.
- </para>
- </listitem>
-
- <listitem>
- <para>
- locking
- </para>
-
- <para>
- With this directive you can turn on or off the locking of
- certain IPs and/or user agents.
- </para>
- </listitem>
-
- <listitem>
- <para>
- log_reload
- </para>
-
- <para>
- With this directive you can turn on or off the logging of
- reloaded documents.
- </para>
- </listitem>
-
- <listitem>
- <para>
- track_returning_visitors
- </para>
-
- <para>
- Detect and log returning visitors.
- </para>
- </listitem>
-
- <listitem>
- <para>
- returning_visitors_cookie
- </para>
-
- <para>
- Name of the cookie to use for returning visitors detection.
- </para>
- </listitem>
-
- <listitem>
- <para>
- returning_visitors_cookie_lifetime
- </para>
-
- <para>
- The 'returning_visitors_cookie' cookie expires after
- 'returning_visitors_cookie_lifetime' days.
- </para>
- </listitem>
-
- <listitem>
- <para>
- resolve_hostname
- </para>
-
- <para>
- Resolving of the hostname can be turned off.
- </para>
- </listitem>
-
- <listitem>
- <para>
- group_hostnames
- </para>
-
- <para>
- Grouping of hostnames can be turned off.
- </para>
- </listitem>
-
- <listitem>
- <para>
- group_user_agents
- </para>
-
- <para>
- Grouping and parsing of user agents can be turned off.
- </para>
- </listitem>
-
- <listitem>
- <para>
- query_cache
- </para>
-
- <para>
- This configuration directive turns on/off the
- <xref linkend="tuning.query-cache" endterm="query-cache"/>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- query_cache_dir
- </para>
-
- <para>
- The directory where the phpOpenTracker API Query Cache
- should store its files.
- </para>
- </listitem>
-
- <listitem>
- <para>
- query_cache_lifetime
- </para>
-
- <para>
- The lifetime of a phpOpenTracker API Query Cache entry in
- seconds.
- </para>
- </listitem>
-
- <listitem>
- <para>
- logging_engine_plugins
- </para>
-
- <para>
- With this directive you can define the names, separated by
- commas, of plugins for the phpOpenTracker Logging Engine, that should
- be loaded.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
-
- <section id="configuration.locking-mechanism">
- <title>The Locking Mechanism</title>
-
- <para>
- With phpOpenTracker's regular expression based locking mechanism
- you can easily exclude search engine crawlers and other robots
- from the logging process.
- </para>
-
- <para>
- Each line of the <filename>conf/lock.ini</filename> file represents a
- rule, that, if matched, causes the phpOpenTracker Logging Engine to ignore
- requests that come from certain hostnames, referers or are initiated by
- certain user agents.
- </para>
-
- <para>
- Each rule consists of two elements, divided by whitespace. The
- first one specifies the data field against which the rule should
- check, the latter may be an arbitrary regular expression that
- will be matched against the former value. Have a look at the
- following example:
- </para>
-
- <example>
- <title>Sample locking rules file</title>
-
-<programlisting>
-# Don't log requests from 'localhost'
-host #localhost#
-
-# Don't log requests when the user_agent contains 'googlebot'
-user_agent #googlebot#
-</programlisting>
- </example>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/en/installation.xml
===================================================================
--- manual/trunk/chapters/en/installation.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/installation.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,368 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="installation">
- <title>Installation</title>
-
- <section id="installation.pear-installer">
- <title>Installing phpOpenTracker using the PEAR Installer</title>
-
- <para>
- If you have a PHP installation with a working &PEAR; environment,
- you may use the PEAR Installer to unpack the phpOpenTracker
- distribution and install it:
-
-<screen>
-pear install phpOpenTracker-X.X.X.tar.gz
-</screen>
-
- If you already installed a previous version of
- phpOpenTracker, you may want to upgrade it with
-
-<screen>
-pear upgrade phpOpenTracker-X.X.X.tar.gz
-</screen>
- </para>
- </section>
-
- <section id="installation.by-hand">
- <title>Installing phpOpenTracker by hand</title>
-
- <para>
- If you cannot use the PEAR Installer, you need to unpack the
- phpOpenTracker distribution and copy the
- <filename>phpOpenTracker/</filename> directory to a directory
- from which you can include it into your scripts.
- </para>
- </section>
-
- <section id="installation.setup">
- <title>Setting it up</title>
-
- <para>
- <orderedlist>
- <listitem>
- <para>
- Open the file
- <filename>conf/phpOpenTracker.php.dist</filename>
- in your favourite editor and save it to
- <filename>conf/phpOpenTracker.php</filename>
- after you made the following changes:
-
- <orderedlist numeration="lowerroman">
- <listitem>
- <para>
- Set <varname>db_type</varname> to match your RDBMS.
- Possible values are <varname>mssql</varname>,
- <varname>mysql</varname>, <varname>mysql_merge</varname>,
- <varname>oci8</varname> and <varname>pgsql</varname>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Configure your database connection by setting the
- correct values for the <varname>db_*</varname>
- directives.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Set <varname>jpgraph_path</varname> to the path to
- your JPGraph installation.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- Create the phpOpenTracker tables in the database you specified
- in your <filename>conf/phpOpenTracker.php</filename> using
- the SQL dump appropriate for your database system from the
- <filename>docs/sql/</filename> directory.
- </para>
- </listitem>
- </orderedlist>
- </para>
-
- <para>
- <emphasis role="bold">
- Database System Specific Notes
- </emphasis>
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- MySQL
- </para>
-
- <para>
- phpOpenTracker ships with several database table creation
- scripts for MySQL:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>innodb.sql</filename>
- </para>
-
- <para>
- Use the <filename>innodb.sql</filename> table creation
- script to create the tables using the &MYSQL_INNODB; storage
- backend.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>myisam.sql</filename>
- </para>
-
- <para>
- Use the <filename>myisam.sql</filename> table creation
- script to create the tables using the &MYSQL_MYISAM; storage
- backend.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>myisam_merge.sql</filename>
- </para>
-
- <para>
- Use the <filename>myisam_merge.sql</filename> table creation
- script if you plan on using &MERGE_TABLES;.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- If you use phpOpenTracker together with a version of the MySQL Server
- prior to &MYSQL_4_1;, the MySQL user needs the privilige to
- create temporary tables. As of MySQL 4.0.2 this privilege is
- called <varname>CREATE TEMPORARY TABLES</varname>. Temporary
- tables are used to emulate &MYSQL_SUBQUERIES;, which are available as
- of MySQL 4.1.0.
- </para>
- </listitem>
-
- <listitem>
- <para>
- PostgreSQL
- </para>
-
- <para>
- The database that is to hold the phpOpenTracker tables needs to have the
- <varname>plpgsql</varname> language installed. This can be done
- using the following commands from the command-line:
- </para>
-
-<screen><![CDATA[
-createdb phpOpenTracker
-createlang plpgsql phpOpenTracker
-psql phpOpenTracker < postgresql.sql
-]]></screen>
- </listitem>
- </itemizedlist>
-
- <para>
- Add the following lines of code to your application and phpOpenTracker
- will start logging:
- </para>
-
- <example id="installation.setup.examples.embedding_logging_engine.php">
- <title>Embedding the Logging Engine</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/embedding_logging_engine.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- If you want to use phpOpenTracker together with an application that uses
- the same script or URL for all pages it serves, this is, for
- instance, often the case with Content Management Systems (CMS),
- it makes sense to pass the page's name or ID to phpOpenTracker's
- Logging Engine, so that it is used instead of the URL.
- </para>
-
- <example id="installation.setup.examples.logging_engine_document.php">
- <title>Passing a custom document title to phpOpenTracker's Logging Engine</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_document.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
-
- <para>
- If you want to track multiple websites with one installation of
- phpOpenTracker you need to pass an additional parameter <varname>client_id</varname>
- to the <function>phpOpenTracker::log</function> method with a
- unique integer ID for each website:
- </para>
-
- <example id="installation.setup.examples.logging_engine_client_id.php">
- <title>Using one phpOpenTracker installation for multiple websites</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_client_id.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="installation.webbug">
- <title>Using a web-bug to invoke phpOpenTracker</title>
-
- <para>
- With the <filename>image.php</filename> script you can
- invoke phpOpenTracker's logging mechanism through an image. The
- script will output a 1x1 pixel, transparent GIF image.
- </para>
-
- <para>
- The script accepts the following parameters, that can be passed
- using HTTP/GET:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- client_id
- </para>
-
- <para>
- If empty, the default client_id (1) will be used.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document_url
- </para>
-
- <para>
- The document's URL, that calls the script. If empty, the
- HTTP_REFERER of the request to the script will be used as most
- common browsers store the URL of the document that embeds the image
- in this variable.
- </para>
- </listitem>
-
- <listitem>
- <para>
- document
- </para>
-
- <para>
- The document's name.
- </para>
- </listitem>
-
- <listitem>
- <para>
- referer
- </para>
-
- <para>
- Referer of the document that embeds the image.
- </para>
- </listitem>
-
- <listitem>
- <para>
- add_data[]
- </para>
-
- <para>
- This field can be used to pass arbitrary data to the
- phpOpenTracker Logging Engine that will store it into the
- <filename>additional_data_table</filename> table.
- </para>
-
- <para>
- You can add multiple <add_data> parameters to the
- URL of the <filename>image.php</filename> script. Each one
- consists of a field / value pair, separated by
- <varname>::</varname>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- For a detailed example of this, have a look at the
- <filename>examples/webbug/</filename> directory.
- </para>
-
- <para>
- Please bear in mind, that visitors who have turned off image
- loading or use text-only browsers won't be tracked using this
- method.
- </para>
- </section>
-
- <section id="installation.logging-outgoing-links">
- <title>Logging outgoing links</title>
-
- <para>
- The <filename>docs/scripts/exit.php</filename> script can be used to log
- outgoing links.
- </para>
-
- <para>
- Have a look at the following example to learn how to send all outgoing
- links (ie. links that start with <filename>http://</filename>) through
- <filename>exit.php</filename> automatically using PHP's output-buffering
- mechanism:
- </para>
-
- <example id="installation.logging-outgoing-links.examples.outgoing_links.php">
- <title>Automatically send outgoing links through exit.php</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/outgoing_links.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="installation.p3p">
- <title>P3P Policy</title>
-
- <para>
- The MS Internet Explorer 6, and maybe other browsers, too, requires
- a &P3P; policy in order to accept cookies. This includes session
- cookies that are used by PHP's session management system, on which
- phpOpenTracker relies. phpOpenTracker cannot track visitors using the MS Internet
- Explorer 6 correctly if the tracked site does not send such a policy
- to the client.
- </para>
-
- <para>
- The code below shows a suitable P3P policy and how to send it using
- PHP. Note that it must be sent before the phpOpenTracker Logging Engine is
- invoked.
- </para>
-
- <example id="installation.p3p.examples.p3p.php">
- <title>Sending a compact P3P policy to the client</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/p3p.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/en/internals.xml
===================================================================
--- manual/trunk/chapters/en/internals.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/internals.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,317 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="internals">
- <title>phpOpenTracker Internals</title>
-
- <section id="internals.database">
- <title>The phpOpenTracker Database Schema</title>
-
- <figure id="internals.database.database.png">
- <title>The phpOpenTracker Database Schema</title>
-
- <graphic fileref="figures/database.png" />
- </figure>
- </section>
-
- <section id="internals.api-plugins">
- <title>Extending the phpOpenTracker API</title>
-
- <itemizedlist>
- <listitem>
- <para>
- A &POT_API; Plugin needs to import <filename>POT_INCLUDE_PATH . 'API/Plugin.php'</filename>
- and to extend the <classname>phpOpenTracker_API_Plugin</classname>
- class.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A &POT_API; Plugin needs to define a member variable
- <filename>$apiCalls</filename>, which is an array that contains
- the names of all API calls the plugin provides.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A &POT_API; Plugin needs to define a member variable
- <filename>$apiType</filename>, which is either
- <varname>get</varname> or <varname>plot</varname>, that
- specifies if the plugin is called through
- <function>phpOpenTracker::get</function> or
- <function>phpOpenTracker::plot</function>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A &POT_API; Plugin needs to call its parent's constructor.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A &POT_API; Plugin needs to provide a method
- <function>run</function>, which accept the typical
- &POT_API; call's parameter array.
- </para>
- </listitem>
- </itemizedlist>
-
- <example id="internals.api-plugins.examples.api_plugin.php">
- <title>Skeleton for a phpOpenTracker API Plugin</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/api_plugin.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-
- <section id="internals.logging-engine-plugins">
- <title>Extending the phpOpenTracker Logging Engine</title>
-
- <itemizedlist>
- <listitem>
- <para>
- A phpOpenTracker Logging Engine Plugin needs to import <filename>POT_INCLUDE_PATH . 'LoggingEngine/Plugin.php'</filename>
- and to extend the <classname>phpOpenTracker_LoggingEngine_Plugin</classname>
- class.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A phpOpenTracker Logging Engine Plugin may implement a method called
- <function>pre</function>.
- </para>
-
- <para>
- If it does, this method must return a boolean value where
- <varname>TRUE</varname> means that the current access is to be
- logged and <varname>FALSE</varname> means that the current
- access is not to be logged.
- </para>
-
- <para>
- The <function>pre</function> is called before the default
- operations of the phpOpenTracker Logging Engine are performed.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A phpOpenTracker Logging Engine Plugin may implement a method called
- <function>post</function>.
- </para>
-
- <para>
- If it does, this method must return an associative array that
- contains data to be stored into the additional data table. This
- array may be empty.
- </para>
-
- <para>
- The <function>post</function> is called after the default
- operations of the phpOpenTracker Logging Engine have been performed.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- The <varname>$this->container</varname> member of the plugin object
- contains all information for the current request stored in an
- associative array that has the following keys:
-
- <itemizedlist>
- <listitem>
- <para>
- <varname>
- accesslog_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- client_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- document
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- document_url
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- document_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- first_request
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- host
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- host_orig
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- host_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- ip_address
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- last_document
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- operating_system
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- operating_system_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- referer
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- referer_orig
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- referer_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- returning_visitor
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- timestamp
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- user_agent
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- user_agent_orig
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- user_agent_id
- </varname>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <varname>
- visitor_id
- </varname>
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <example id="internals.logging-engine-plugins.examples.logging_engine_plugin.php">
- <title>Skeleton for a phpOpenTracker Logging Engine Plugin</title>
-
-<programlisting xmlns:xi="http://www.w3.org/2003/XInclude">
-<xi:include href="listings/logging_engine_plugin.php"
- encoding="iso-8859-1"
- parse="text" />
-</programlisting>
- </example>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/en/introduction.xml
===================================================================
--- manual/trunk/chapters/en/introduction.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/introduction.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,240 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="introduction">
- <title>Introduction</title>
-
- <section id="introduction.what">
- <title>What is phpOpenTracker?</title>
-
- <para>
- phpOpenTracker is a framework solution for the analysis of website
- traffic and visitor behaviour.
- </para>
-
- <para>
- It features a logging engine that, either invoked as a web-bug
- by a HTML <img> tag or embedded with two lines of code
- into your PHP application, logs each request to a website into a
- database. One installation of phpOpenTracker can track an arbitrary
- number of web-sites.
- </para>
-
- <para>
- Through the &POT_API; module you can easily access the gathered
- data and perform complex operations on it, like for instance the
- analysis of your visitors' clickpaths.
- </para>
- </section>
-
- <section id="introduction.why-need">
- <title>Why do you need the information phpOpenTracker provides?</title>
-
- <para>
- The analysis of clickpaths is essential when you want to measure
- the usability of your website. phpOpenTracker's API functions
- '<xref linkend="shortest_paths" endterm="shortest_paths"/>' and
- '<xref linkend="top_paths" endterm="top_paths"/>' help to answer
- questions like: Is the navigation intuitive enough? Do visitors
- find the shortest, most direct way from A to B? How are ads
- perceived? On what document do they leave the website -- and
- where to? The answers to these questions help you to improve the
- user experience and the way your website is perceived by your
- customers.
- </para>
- <para>
-
- </para>
- </section>
-
- <section id="introduction.features">
- <title>Features</title>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- Complete framework for the analysis of website traffic and
- visitor analysis.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Highly optimized logging engine that stores the access
- information into a database.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Powerful Application Programming Interface (API) to access
- the gathered data and perform operations on it: from simple
- statistical queries to the complex analysis of the visitors'
- clickpaths.
- </para>
-
- <para>
- API calls can return their result in the following formats:
-
- <itemizedlist>
- <listitem>
- <para>
- PHP Object or Variable (default)
- </para>
- </listitem>
-
- <listitem>
- <para>
- CSV
- </para>
-
- <para>
- The Comma Separated Value (CSV) format can be used to
- import &POT_API; results into spreadsheet applications
- like Microsoft Excel.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &XML;
- </para>
-
- <para>
- The &POT_API; supports two means to return a result in
- XML. A result can either be returned as a XML tree
- object or in XML markup (text).
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- Can be used to track both dynamic and static pages.
- </para>
- </listitem>
-
- <listitem>
- <para>
- Can be invoked directly from within PHP applications, for instance by
- a Content Management System, or through a HTML image tag -- a so
- called Web Bug.
- </para>
- </listitem>
-
- <listitem>
- <para>
- One installation of phpOpenTracker may track an arbitrary number of
- different web sites.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="introduction.requirements">
- <title>Requirements</title>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- PHP 4.2.1 (or later)
- </para>
- </listitem>
-
- <listitem>
- <para>
- One of the following database servers supported by phpOpenTracker:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>
- &MSSQLSERVER;
- </para>
- </listitem>
-
- <listitem>
- <para>
- &MYSQL; 3.23.2 (or later)
- </para>
-
- <para>
- If you intend to use &MERGE_TABLES; you will need MySQL
- 3.23.54 (or later).
- </para>
-
- <para>
- The use of a current version of MySQL 4 is encouraged.
- The &MYSQL_QUERY_CACHE; (as of MySQL 4.0.1) and the
- support for Sub-Queries (as of &MYSQL_4_1;) improve
- the performance of &POT_API; queries.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &ORACLE; 8.1.6 (or later)
- </para>
- </listitem>
-
- <listitem>
- <para>
- &POSTGRESQL;
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- &GRAPHVIZ;
- </para>
- <para>
- You will need this package if you want to visualize
- clickpaths.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &JPGRAPH; (tested with version 1.9.1)
- </para>
- <para>
- You will need this package if you want to visualize
- statistical results.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &CACHE_LITE; 1.0.1 (or later)
- </para>
- <para>
- You will need this package if you want to use the
- phpOpenTracker API's Query Cache.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &IMAGE_GRAPHVIZ; 1.0.1 (or later)
- </para>
- <para>
- You will need this package if you want to visualize
- clickpaths.
- </para>
- </listitem>
-
- <listitem>
- <para>
- &XML_TREE; 1.1 (or later)
- </para>
- <para>
- You will need this package if you want to use &XML; as
- result format.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-</chapter>
Deleted: manual/trunk/chapters/en/preface.xml
===================================================================
--- manual/trunk/chapters/en/preface.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/preface.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<preface id="preface">
- <title>Preface</title>
-
- <section id="preface.copyright">
- <title>Copyright</title>
-
- <para>
- phpOpenTracker is developed by &SB; and published under the
- &LICENSE; as &OSS;.
- </para>
-
- <para>
- phpOpenTracker is available for free. This does not mean, that Sebastian
- doesn't like getting appreciation for his work. If you find
- phpOpenTracker useful and want to express your appreciation, have a look
- at his &AMAZON_EN_WISHLIST;. Please put your eMail address into the the
- message area, so that Sebastian can thank you for your present.
- </para>
- </section>
-</preface>
Deleted: manual/trunk/chapters/en/tuning.xml
===================================================================
--- manual/trunk/chapters/en/tuning.xml 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/chapters/en/tuning.xml 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,149 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1" ?>
-
-<chapter id="tuning">
- <title>Performance Tuning</title>
-
- <section id="tuning.introduction">
- <title>Introduction</title>
-
- <para>
- phpOpenTracker is developed with the performance of the Logging
- Engine and the flexibility of the &POT_API; in mind. This
- chapter explores techniques to increase the performance of both
- components.
- </para>
- </section>
-
- <section id="tuning.query-cache">
- <title>phpOpenTracker API Query Cache</title>
- <titleabbrev id="query-cache">phpOpenTracker API Query Cache</titleabbrev>
-
- <para>
- The result of a &POT_API; query which is limited to a <xref
- linkend="api-reference.timeranges" endterm="timerange"/> that lies completely
- in the past can be stored in a cache. Future requests to the same
- &POT_API; query will be satisfied from the cache without the need
- to actually query the database and calculate the result.
- </para>
-
- <para>
- To use the phpOpenTracker API Query Cache you have to install
- the PEAR Cache_Lite package and edit the following configuration
- directives in your <filename>conf/phpOpenTracker.php</filename>:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <filename>query_cache</filename>
- </para>
-
- <para>
- This configuration directive turns on/off the phpOpenTracker
- API Query Cache.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>query_cache_dir</filename>
- </para>
-
- <para>
- The directory where the phpOpenTracker API Query Cache
- should store its files.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <filename>query_cache_lifetime</filename>
- </para>
-
- <para>
- The lifetime of a phpOpenTracker API Query Cache entry in
- seconds.
- </para>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="tuning.mysql-merge-tables">
- <title>MySQL Merge Tables</title>
- <titleabbrev id="mysql-merge-tables">MySQL Merge Tables</titleabbrev>
-
- <para>
- <emphasis>Added in version 1.2.0.</emphasis>
- </para>
-
- <para>
- Over time the size of the <varname>pot_accesslog</varname> and
- <varname>pot_visitors</varname> tables increases. The former
- holds one row for every page impression, the latter one row for
- every visit. While these tables' size increases the performance
- of &POT_API; queries decreases since the database has to
- consider more data.
- </para>
-
- <para>
- With MySQL you can use the so called &MYSQL_MYISAM_MERGE; backend
- and let phpOpenTracker manage a set of log tables, one for each
- month. This can increase the performance of &POT_API; queries
- because database queries are now only executed on the relevant
- month tables rather than always on one single table that
- contains all the gathered data.
- </para>
- </section>
-
- <section id="tuning.indexing">
- <title>Database Indexing</title>
-
- <para>
- The amount of time needed to maintain the indexes in phpOpenTracker's
- database tables increases with the number of rows already
- stored.
- </para>
-
- <para>
- If you experience such an performance decrease, you might want
- to trade the speed of the &POT_API; for an increased performance
- of the phpOpenTracker Logging Engine by dropping the table's
- indexes.
- </para>
-
- <para>
- ... TBD: DELAY_KEY_WRITE / PACK_KEYS ...
- </para>
-
- <para>
- Creating a table with
- <varname>DELAY_KEY_WRITE=1</varname> will make the
- updating of indexes faster, as these are not logged to disk
- until the file is closed. The downside is that you should
- run <filename>myisamchk</filename> on these tables before
- you start <filename>mysqld</filename> to ensure that they
- are okay if something killed <filename>mysqld</filename> in
- the middle. As the key information can always be generated
- from the data, you should not lose anything by using
- <varname>DELAY_KEY_WRITE=1</varname>.
- </para>
- </section>
-
- <section id="tuning.dedicated-server">
- <title>Dedicated Server</title>
-
- <para>
- In a high traffic environment it is recommended to run the
- phpOpenTracker Logging Engine on a different machine than the
- main webserver. This is made possible by the fact that the
- logging process can be invoked through a so called web bug.
- </para>
-
- <para>
- Since the dedicated server only needs to perform the logging process
- and serve the web bug image, using a full featured webserver
- software like Apache is overhead. For this reason we recommend the
- use of &LIGHTTPD; or &THTTPD;.
- </para>
- </section>
-</chapter>
Modified: manual/trunk/de.xml.in
===================================================================
--- manual/trunk/de.xml.in 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/de.xml.in 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,14 +1,7 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE book SYSTEM "{DTD_PATH}" [
- <!ENTITY api-reference SYSTEM "chapters/de/api-reference.xml">
<!ENTITY bookinfo SYSTEM "chapters/de/bookinfo.xml">
- <!ENTITY configuration SYSTEM "chapters/de/configuration.xml">
- <!ENTITY installation SYSTEM "chapters/de/installation.xml">
- <!ENTITY internals SYSTEM "chapters/de/internals.xml">
- <!ENTITY introduction SYSTEM "chapters/de/introduction.xml">
- <!ENTITY preface SYSTEM "chapters/de/preface.xml">
- <!ENTITY tuning SYSTEM "chapters/de/tuning.xml">
<!ENTITY copyright SYSTEM "chapters/copyright.xml">
<!ENTITY % entities SYSTEM "entities.ent">
@@ -16,12 +9,5 @@
]>
<book>
&bookinfo;
- &preface;
- &introduction;
- &installation;
- &api-reference;
- &configuration;
- &tuning;
- &internals;
©right;
</book>
Modified: manual/trunk/en.xml.in
===================================================================
--- manual/trunk/en.xml.in 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/en.xml.in 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,14 +1,7 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE book SYSTEM "{DTD_PATH}" [
- <!ENTITY api-reference SYSTEM "chapters/en/api-reference.xml">
<!ENTITY bookinfo SYSTEM "chapters/en/bookinfo.xml">
- <!ENTITY configuration SYSTEM "chapters/en/configuration.xml">
- <!ENTITY installation SYSTEM "chapters/en/installation.xml">
- <!ENTITY internals SYSTEM "chapters/en/internals.xml">
- <!ENTITY introduction SYSTEM "chapters/en/introduction.xml">
- <!ENTITY preface SYSTEM "chapters/en/preface.xml">
- <!ENTITY tuning SYSTEM "chapters/en/tuning.xml">
<!ENTITY copyright SYSTEM "chapters/copyright.xml">
<!ENTITY % entities SYSTEM "entities.ent">
@@ -16,12 +9,5 @@
]>
<book>
&bookinfo;
- &preface;
- &introduction;
- &installation;
- &api-reference;
- &configuration;
- &tuning;
- &internals;
©right;
</book>
Deleted: manual/trunk/listings/all_paths.php
===================================================================
--- manual/trunk/listings/all_paths.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/all_paths.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,10 +0,0 @@
-<?php
-$graph = phpOpenTracker::get(
- array(
- 'api_call' => 'all_paths',
- 'result_format' => 'graphviz_object'
- )
-);
-
-$graph->image('png');
-?>
Deleted: manual/trunk/listings/api.php
===================================================================
--- manual/trunk/listings/api.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/api.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,8 +0,0 @@
-<?php
-print phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'current_month'
- )
-);
-?>
Deleted: manual/trunk/listings/api_plugin.php
===================================================================
--- manual/trunk/listings/api_plugin.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/api_plugin.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,28 +0,0 @@
-<?php
-class phpOpenTracker_API_example extends phpOpenTracker_API_Plugin {
- /**
- * API Calls
- *
- * @var array $apiCalls
- */
- var $apiCalls = array('example');
-
- /**
- * API Type
- *
- * @var string $apiType
- */
- var $apiType = 'get';
-
- /**
- * Runs the phpOpenTracker API call.
- *
- * @param array $parameters
- * @return mixed
- * @access public
- */
- function run($parameters) {
- // ...
- }
-}
-?>
Deleted: manual/trunk/listings/average_clickpath_length.php
===================================================================
--- manual/trunk/listings/average_clickpath_length.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/average_clickpath_length.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,7 +0,0 @@
-<?php
-print phpOpenTracker::get(
- array(
- 'api_call' => 'average_clickpath_length'
- )
-);
-?>
Deleted: manual/trunk/listings/clickpaths.php
===================================================================
--- manual/trunk/listings/clickpaths.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/clickpaths.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,10 +0,0 @@
-<?php
-$paths = phpOpenTracker::get(
- array(
- 'api_call' => 'shortest_paths',
- 'range' => 'current_hour',
- 'to' => '/shop/article.php?id=42',
- 'limit' => 10
- )
-);
-?>
Deleted: manual/trunk/listings/embedding_logging_engine.php
===================================================================
--- manual/trunk/listings/embedding_logging_engine.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/embedding_logging_engine.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,7 +0,0 @@
-<?php
-// prepend phpOpenTracker
-include 'phpOpenTracker.php';
-
-// log access
-phpOpenTracker::log();
-?>
Deleted: manual/trunk/listings/individual_clickpath.php
===================================================================
--- manual/trunk/listings/individual_clickpath.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/individual_clickpath.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,11 +0,0 @@
-<?php
-$clickpath = phpOpenTracker::get(
- array(
- 'api_call' => 'individual_clickpath',
- 'accesslog_id' => -987172453
- )
-);
-
-$graph = $clickpath->toGraph(true);
-$graph->image('png');
-?>
Deleted: manual/trunk/listings/logging_engine_client_id.php
===================================================================
--- manual/trunk/listings/logging_engine_client_id.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/logging_engine_client_id.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,11 +0,0 @@
-<?php
-// prepend phpOpenTracker
-include 'phpOpenTracker.php';
-
-// log access
-phpOpenTracker::log(
- array(
- 'client_id' => 42
- )
-);
-?>
Deleted: manual/trunk/listings/logging_engine_document.php
===================================================================
--- manual/trunk/listings/logging_engine_document.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/logging_engine_document.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,11 +0,0 @@
-<?php
-// prepend phpOpenTracker
-include 'phpOpenTracker.php';
-
-// log access
-phpOpenTracker::log(
- array(
- 'document' => 'page_name'
- )
-);
-?>
Deleted: manual/trunk/listings/logging_engine_plugin.php
===================================================================
--- manual/trunk/listings/logging_engine_plugin.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/logging_engine_plugin.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,19 +0,0 @@
-<?php
-class phpOpenTracker_LoggingEngine_Plugin_example extends phpOpenTracker_LoggingEngine_Plugin {
- /**
- * @return boolean
- * @access public
- */
- function pre() {
- return true;
- }
-
- /**
- * @return array
- * @access public
- */
- function post() {
- return array();
- }
-}
-?>
Deleted: manual/trunk/listings/longest_paths.php
===================================================================
--- manual/trunk/listings/longest_paths.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/longest_paths.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,12 +0,0 @@
-<?php
-$paths = phpOpenTracker::get(
- array(
- 'api_call' => 'longest_paths',
- 'range' => 'current_hour',
- 'to' => '/shop/article.php?id=42',
- 'limit' => 10
- )
-);
-
-print_r($paths);
-?>
Deleted: manual/trunk/listings/num_visitors_online.php
===================================================================
--- manual/trunk/listings/num_visitors_online.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/num_visitors_online.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,7 +0,0 @@
-<?php
-print phpOpenTracker::get(
- array(
- 'api_call' => 'num_visitors_online'
- )
-);
-?>
Deleted: manual/trunk/listings/num_visitors_online_document.php
===================================================================
--- manual/trunk/listings/num_visitors_online_document.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/num_visitors_online_document.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,10 +0,0 @@
-<?php
-print phpOpenTracker::get(
- array(
- 'api_call' => 'num_visitors_online',
- 'constraints' => array(
- 'document' => 'this'
- )
- )
-);
-?>
Deleted: manual/trunk/listings/outgoing_links.php
===================================================================
--- manual/trunk/listings/outgoing_links.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/outgoing_links.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,14 +0,0 @@
-<?php
-function encode_exit_urls($buffer) {
- return preg_replace(
- "#<a(.*)href=(\"|')http://([^\"']+)(\"|')#isUm",
- '"<a href=\"exit.php?url=".base64_encode(\'\\2\')."\""',
- $buffer
- );
-}
-
-// start output-buffering
-ob_start('encode_exit_urls');
-
-// main code of your script
-?>
Deleted: manual/trunk/listings/p3p.php
===================================================================
--- manual/trunk/listings/p3p.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/p3p.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,3 +0,0 @@
-<?php
-header('P3P: CP="NOI NID ADMa OUR IND UNI COM NAV"');
-?>
Deleted: manual/trunk/listings/page_impressions.php
===================================================================
--- manual/trunk/listings/page_impressions.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/page_impressions.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,19 +0,0 @@
-<?php
-printf(
- "%s page impressions (%s today)",
-
- phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'total'
- )
- ),
-
- phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'today'
- )
- )
-);
-?>
Deleted: manual/trunk/listings/page_impressions_document.php
===================================================================
--- manual/trunk/listings/page_impressions_document.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/page_impressions_document.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,25 +0,0 @@
-<?php
-printf(
- "%s page impressions on this document (%s today)",
-
- phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'total',
- 'constraints' => array(
- 'document' => 'this'
- )
- )
- ),
-
- phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'today',
- 'constraints' => array(
- 'document' => 'this'
- ),
- )
- )
-);
-?>
Deleted: manual/trunk/listings/plot_access_statistics.php
===================================================================
--- manual/trunk/listings/plot_access_statistics.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/plot_access_statistics.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,10 +0,0 @@
-<?php
-phpOpenTracker::plot(
- array(
- 'api_call' => 'access_statistics',
- 'range' => 'today'
- 'interval' => 'hour',
- 'mode' => 'line'
- )
-);
-?>
Deleted: manual/trunk/listings/plot_access_statistics_german.php
===================================================================
--- manual/trunk/listings/plot_access_statistics_german.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/plot_access_statistics_german.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,16 +0,0 @@
-<?php
-phpOpenTracker::plot(
- array(
- 'api_call' => 'access_statistics',
- 'range' => 'current_year'
- 'interval' => 'month',
- 'mode' => 'line',
- 'month_names' => array(
- 'Januar', 'Februar', 'März',
- 'April', 'Mai', 'Juni',
- 'Juli', 'August', 'September',
- 'Oktober', 'November', 'Dezember'
- )
- )
-);
-?>
Deleted: manual/trunk/listings/plot_top.php
===================================================================
--- manual/trunk/listings/plot_top.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/plot_top.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,10 +0,0 @@
-<?php
-phpOpenTracker::plot(
- array(
- 'api_call' => 'top',
- 'what' => 'document',
- 'limit' => 10,
- 'range' => 'current_month'
- )
-);
-?>
Deleted: manual/trunk/listings/shortest_paths.php
===================================================================
--- manual/trunk/listings/shortest_paths.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/shortest_paths.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,12 +0,0 @@
-<?php
-$paths = phpOpenTracker::get(
- array(
- 'api_call' => 'shortest_paths',
- 'range' => 'current_hour',
- 'to' => '/shop/article.php?id=42',
- 'limit' => 10
- )
-);
-
-print_r($paths);
-?>
Deleted: manual/trunk/listings/timeranges.php
===================================================================
--- manual/trunk/listings/timeranges.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/timeranges.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,22 +0,0 @@
-<?php
-print phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'total'
- )
-);
-
-print phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'today'
- )
-);
-
-print phpOpenTracker::get(
- array(
- 'api_call' => 'page_impressions',
- 'range' => 'yesterday'
- )
-);
-?>
Deleted: manual/trunk/listings/top.php
===================================================================
--- manual/trunk/listings/top.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/top.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,12 +0,0 @@
-<?php
-$documents = phpOpenTracker::get(
- array(
- 'api_call' => 'top',
- 'what' => 'document',
- 'range' => 'total',
- 'limit' => 10
- )
-);
-
-print_r($documents);
-?>
Deleted: manual/trunk/listings/top_paths.php
===================================================================
--- manual/trunk/listings/top_paths.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/top_paths.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,13 +0,0 @@
-<?php
-$paths = phpOpenTracker::get(
- array(
- 'api_call' => 'top_paths',
- 'range' => 'current_hour',
- 'to' => '/shop/article.php?id=42',
- 'length' => 3,
- 'limit' => 10
- )
-);
-
-print_r($paths);
-?>
Deleted: manual/trunk/listings/visitors_online.php
===================================================================
--- manual/trunk/listings/visitors_online.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/visitors_online.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,9 +0,0 @@
-<?php
-$visitors_online = phpOpenTracker::get(
- array(
- 'api_call' => 'visitors_online'
- )
-);
-
-print_r($visitors_online);
-?>
Deleted: manual/trunk/listings/visits.php
===================================================================
--- manual/trunk/listings/visits.php 2005-01-11 15:44:34 UTC (rev 38)
+++ manual/trunk/listings/visits.php 2005-01-29 09:31:22 UTC (rev 39)
@@ -1,19 +0,0 @@
-<?php
-printf(
- "%s visits (%s today)",
-
- phpOpenTracker::get(
- array(
- 'api_call' => 'visits',
- 'range' => 'total'
- )
- ),
-
- phpOpenTracker::get(
- array(
- 'api_call' => 'visits',
- 'range' => 'today'
- )
- )
-);
-?>