Phpopentracker Reference Manual: Sat Feb 19 22:29:53 2005

phpOpenTracker Reference Manual
Generated by Doxygen 1.3.4
Sat Feb 19 22:29:53 2005

Contents
1 phpOpenTracker Project 1
1.1 Concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Core Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3 Admin&User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 phpOpenTracker Hierarchical Index 11

2.1 phpOpenTracker Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3 phpOpenTracker Class Index 13

3.1 phpOpenTracker Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4 phpOpenTracker File Index 15

4.1 phpOpenTracker File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5 phpOpenTracker Class Documentation 17

5.1 cDAO Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.2 cDAOpot_tables Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5.3 cDAOtblCategories Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.4 cDAOtblReports Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.5 cDAOtblReportsSearches Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 22
5.6 cDAOtblSearches Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
5.7 cDAOtblUserReports Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5.8 cDAOtblUsers Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
5.9 cLang Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.10 report Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6 phpOpenTracker File Documentation 31

6.1 reports.php File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.2 searches.php File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 1
phpOpenTracker Project
1.1 Concept
Project main concept is building of Traffic Tracking Engine
• Project based on OpenSource solution. OpenSource solution consist of only tracking engine, set of
APIs. originally there no GUI interfaces, this is very advanced engine with no GUIs
• My Project consist of creation GUI interfaces

2 phpOpenTracker Project
Figure 1.1: Custom User Report
1. User Interface
2. Tracking Code
3. Profile
4. Searches
5. Reports
6. Pre-Defined Reports
7. Admin Interface
1.2 Core Features
Project use XHTML design, advanced CSS using and no ’table’ tags. Design is very lightweight and page
size short. DAO based access to MySQL databases. MVC application hierarchy. Multi-language support.
FastTemplate engine based.
Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

1.3 Admin&User Interfaces 3
Figure 1.2: Example of Russian Language File
1.3 Admin&User Interfaces
Require Password authorization.
1.3.1 Users Managment
Figure 1.3: Admin look to users list

1.3.2 Create New User
Figure 1.4: Admin Create New User
1.3.3 Get a Web-Bug code,
Web-Bug code this is tracking code, which have to be included in all user-site pages. All html pages where
included web-bug code will be tracked by system. Code example:
<img src=’http://192.168.7.17/phpOpenTrackerFrontend/image.php?client_id=292403’/>
Figure 1.5: Web-Bug code
System can track not only entry pages, but exit pages too, web-bug code using for track entry pages, Exit
Links using for track exit targets.

Figure 1.6: Generate Exit Link
1.3.4 User Categories
User able to create category for group reports, System include lot of reports and user can compile several
reports in one custom report, so each user can have about 20-30 different reports and for easy managment
user can group reports by categories
Figure 1.7: User Categories
1.3.5 Searches
Searches - dataset of predefined traffic filters. User have ability to create reports with custom filters, for
example we can create report only for Mozilla browsers, or for IE browsers previous day or for Windows
systems current month

Figure 1.8: Searches List
Figure 1.9: Create New Searches
1.3.6 Reports
Ability for users to run system reports for pre-defined search.

Figure 1.10: User Select Report to Show
Base System Report List:
• Plot Access Statistics
• Plot Top Documents
• Plot Top Entry Documents
• Plot Top Exit Documents
• Plot Top Exit Targets
• Plot Top Hosts
• Plot Top Operating Systems
• Plot Top Referers
• Plot Top User Agents
• Top10 Details
• Top10 Documents
• Top10 Point Documents
• Visitors Online
• Visits and Impressions

Figure 1.11: User Browsers Report for total time-period
1.3.7 User-Defined Reports
Instead of run system reports user have ability to compile sveral system reports in one complex user-defined
reports, this is a set of single reports joined in one report
Figure 1.12: List of User-Defined Reports

Figure 1.13: Edit User-Defined Report

Figure 1.14: Show User-Defined Report

Chapter 2
phpOpenTracker Hierarchical Index
2.1 phpOpenTracker Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
cAuth
cDAO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
cDAOpot_tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
cDAOtblCategories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
cDAOtblReports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
cDAOtblReportsSearches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
cDAOtblSearches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
cDAOtblUserReports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
cDAOtblUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
cLang . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
12 phpOpenTracker Hierarchical Index

Chapter 3
phpOpenTracker Class Index
3.1 phpOpenTracker Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
cDAO (Global DAO class with base functions ) . . . . . . . . . . . . . . . . . . . . . . . . . . 17
cDAOpot_tables (PhpOpenTracker pot_∗ tables ) . . . . . . . . . . . . . . . . . . . . . . . . . 19
cDAOtblCategories (TblCategories table ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
cDAOtblReports (TblReports ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
cDAOtblReportsSearches (TblReportsSearches ) . . . . . . . . . . . . . . . . . . . . . . . . . . 22
cDAOtblSearches (TblSearches table ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
cDAOtblUserReports (User Defined Reports ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
cDAOtblUsers (Class for Table tblUsers ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
cLang (Multi-Language Support ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
report (Report Libraries ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
14 phpOpenTracker Class Index

Chapter 4
phpOpenTracker File Index
4.1 phpOpenTracker File List

Here is a list of all documented files with brief descriptions:
auth.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
categories.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
config.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
dao.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
db.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
exit.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
fnlib.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
image.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
etc/includes.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
lib/includes.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
index.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
modules/index.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
lang.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
login.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
logout.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
myReports.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
report-plot.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
report.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
reports.php (Reports Interfaces ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
searches.php (Manage Searches module ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
users.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??
16 phpOpenTracker File Index

Chapter 5
phpOpenTracker Class Documentation
5.1 cDAO Class Reference
Global DAO class with base functions.

Inheritance diagram for cDAO::
cDAO
cDAOpot_tables cDAOtblCategories cDAOtblReports cDAOtblReportsSearches cDAOtblSearches cDAOtblUserReports cDAOtblUsers
Public Member Functions
• get ($sql)
• lst ($sql)
• update ($rx, $id, $tbl, $key)
• insert ($rx, $tbl)
• recordsetToAssocArray ($recordSet)
Convert Recordset to associative array.
Public Attributes
• $db
Database class.
• $sql
Last SQL query.
18 phpOpenTracker Class Documentation
5.1.1 Detailed Description
Global DAO class with base functions.

Definition at line 4 of file dao.php.
5.1.2 Member Function Documentation
5.1.2.1 cDAO::lst ($ sql)
Make query return Recordset

References $sql.
The documentation for this class was generated from the following file:
• dao.php

5.2 cDAOpot_tables Class Reference 19
5.2 cDAOpot_tables Class Reference

phpOpenTracker pot_∗ tables
Inheritance diagram for cDAOpot_tables::
cDAO
cDAOpot_tables
phpOpenTracker pot_∗ tables

• dao.php

5.3 cDAOtblCategories Class Reference

tblCategories table
Inheritance diagram for cDAOtblCategories::
cDAO
cDAOtblCategories

• getById ($id)
• listCategories ()
• listIDCategory_CategoryByIDUser ($IDUser)
• listCategoriesByIDUser ($IDUser)
• update ($rx, $id)
• insert ($rx)
• lastId ()
• delete ($id)
Public Attributes
• $fields = array(IDCategory, IDUser, Category)
• $tableName = ’tblCategories’
• $keyName = ’IDCategory’
tblCategories table
• dao.php

5.4 cDAOtblReports Class Reference 21
5.4 cDAOtblReports Class Reference

tblReports
Inheritance diagram for cDAOtblReports::
cDAO
cDAOtblReports

• listReports ()
• getByID ($IDReport)
Public Attributes
• $fields = array(IDReport, ’Name’)
• $tableName = ’tblReports’
• $keyName = ’IDReport’
tblReports
• dao.php

5.5 cDAOtblReportsSearches Class Reference

tblReportsSearches
Inheritance diagram for cDAOtblReportsSearches::
cDAO
cDAOtblReportsSearches
• listReports ()
• listReportsByIDUserReport ($id)
• getByID ($id)
• update ($rowData, $id)
• insert ($rx)
• lastId ()
• delete ($id)
Public Attributes
• $fields
• $tableName = ’tblReportsSearches’
• $keyName = ’IDReportSearch’
tblReportsSearches
Complex User Report Set of simple reports
5.5.2 Member Data Documentation
5.5.2.1 cDAOtblReportsSearches::$fields
Initial value:

5.5 cDAOtblReportsSearches Class Reference 23
array(
IDReportSearch,
IDUserReport,
IDReport,
IDSearch,
Position
)

• dao.php

5.6 cDAOtblSearches Class Reference

tblSearches table
Inheritance diagram for cDAOtblSearches::
cDAO
cDAOtblSearches

• getById ($id)
• getSearchConstraints ($IDSearch)
• get_SearchName_CategoryName_clientid_ById ($IDSearch)
• listSearches ()
• listSearchesByIDUser ($IDUser)
• listSearches_IDSearch_Name_ByIDUser ($IDUser)
Get a [IDSearch], [CategoryName] / [Name].
• getClientId_byIDSearch ($IDSearch)
• insert ($rx)
• lastId ()
• delete ($id)
• deleteDirectSearches ()
• countDirectSearches ()
• directSearchId ()
Public Attributes
• $fields = array(IDSearch, IDUser, IDCategory, ’Name’, Search, typeId)
• $tableName = ’tblSearches’
• $keyName = ’IDSearch’
tblSearches table
• dao.php

5.7 cDAOtblUserReports Class Reference 25
5.7 cDAOtblUserReports Class Reference

User Defined Reports.
Inheritance diagram for cDAOtblUserReports::
cDAO
cDAOtblUserReports

• listReports ()
• listReportsByIDUSer ($IDUser)
• getByID ($IDReport)
• insert ($rx)
• lastId ()
• delete ($id)
Public Attributes
• $fields = array(IDUserReport, IDUser, ’Name’)
• $tableName = ’tblUserReports’
• $keyName = ’IDUserReport’
User Defined Reports.

Complex User Report Set of simple reports
• dao.php

5.8 cDAOtblUsers Class Reference

Class for Table tblUsers.
Inheritance diagram for cDAOtblUsers::
cDAO
cDAOtblUsers

• getByLoginPassword ($lg, $pwd)
• getById ($id)
• listUsers ()
• listAdmins ()
• update ($rx, $id)
• insert ($rx)
• lastId ()
• delete ($id)
Public Attributes
• $fields = array(IDUser’,’IDUserRole’,’Username’,’Passwd’,’client_id)
Class for Table tblUsers.

• dao.php

5.9 cLang Class Reference 27
5.9 cLang Class Reference
Multi-Language Support.
• cLang ($lang)
• uploadResources ()
Get Language Matrix from resource file.
• translationMatrix ()
Return Translation Matrix ENG -> CURRENT_LANG.
Public Attributes
• $langMatrix = array()
Translation Matrix.
• $currentLang = ’eng’
Current Language.
• $resFilename = ’etc/lang.csv’
Language Resources File.
• $langDimension = 2
Languages Amount in resource File.
• $langHeader
Multi-Language Support.
Definition at line 5 of file lang.php.
5.9.2 Member Data Documentation

5.9.2.1 cLang::$langHeader
Initial value:
array(
0 => ’eng’,
1 => ’rus’
)

Definition at line 16 of file lang.php.
• lang.php

5.10 report Class Reference 29
5.10 report Class Reference

Report Libraries.

• show (&$fastTemplate, &$formData)
Show one report.
Report Libraries.
Definition at line 3 of file report.php.
5.10.2 Member Function Documentation
5.10.2.1 report::show (&$ fastTemplate, &$ formData)
Show one report.

Init PDF report
Init RTF report
Get Average Clickpath Length
Get Average Time Between Visits
Get Average Visits
Get Nuber of Unique Visitors
Save PDF report to file
Switch reports Open report required report
Prepare General Data for Reports
Show report data
Plot access statistics
Visits and Impressions Report
Definition at line 6 of file report.php.
• report.php


Chapter 6
phpOpenTracker File Documentation
6.1 reports.php File Reference

Reports Interfaces.
Variables
• $daoSearches = new cDAOtblSearches()

• $daoReports = new cDAOtblReports()
• $moduleConfig = array()
• $formData = array()
• $formUserSelectReport = new formamanager()
• $formUserSelectReport id = $moduleConfig[’form’]
• $reportsOptionsRecordset = $daoReports → listReports()
• $reportsOptionsArray = $daoReports → recordsetToAssocArray($reportsOptionsRecordset)
• break
• case myreport
• default __pad0__
• $searchesOptionsArray
• $report = new report()
Reports Interfaces.
Definition in file reports.php.
6.1.2 Variable Documentation

32 phpOpenTracker File Documentation
6.1.2.1 $formData[’IDSearch’] = array()
Select Report Select Search Open report page

Definition at line 61 of file reports.php.
6.1.2.2 $moduleConfig[’IDUserReport’] = array()
Module config
6.1.2.3 $searchesOptionsArray
Initial value:
$daoSearches->recordsetToAssocArray($searchesOptionsRecordset)

6.2 searches.php File Reference 33
6.2 searches.php File Reference

Manage Searches module.
Variables
• $daoSearches = new cDAOtblSearches()
• $daoCategories = new cDAOtblCategories()
• $daoPot_Tables = new cDAOpot_tables()
• $rHours = array(’0’ => )
• $moduleConfig = array()
• $recordsetSearchDetails = $daoSearches → getById($moduleConfig[IDSearch])
• $formData = array()
• $formUserManageSearch = new formamanager()
• $formUserManageSearch id = $moduleConfig[’form’]
• break
• default __pad1__
• default
• $categoriesOptionsArray
• $searchTableData = unserialize(stripslashes($recordsetSearchDetails[Search]))
• $formPOTData = array()
• $formAdminManageUser = new formamanager()
Manage Searches module.

Definition in file searches.php.
6.2.2 Variable Documentation
6.2.2.1 $categoriesOptionsArray
Initial value:
$daoCategories->recordsetToAssocArray($categoriesOptionsRecordset)
Definition at line 115 of file searches.php.

Index
$categoriesOptionsArray
searches.php, 33
$fields
cDAOtblReportsSearches, 22
$formData
reports.php, 31
$langHeader
cLang, 27
$moduleConfig
reports.php, 32
$searchesOptionsArray
reports.php, 32
cDAO, 17
cDAO
lst, 18
cDAOpot_tables, 19
cDAOtblCategories, 20
cDAOtblReports, 21
cDAOtblReportsSearches, 22
cDAOtblReportsSearches
$fields, 22
cDAOtblSearches, 24
cDAOtblUserReports, 25
cDAOtblUsers, 26
cLang, 27
cLang
$langHeader, 27
lst
cDAO, 18
report, 29
show, 29
reports.php, 31
$formData, 31
$moduleConfig, 32
$searchesOptionsArray, 32
searches.php, 33
$categoriesOptionsArray, 33
show
report, 29

Phpopentracker Reference Manual: Sat Feb 19 22:29:53 2005

Uploaded by

Copyright:

Available Formats

You might also like

Phpopentracker Reference Manual: Sat Feb 19 22:29:53 2005

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Phpopentracker Reference Manual: Sat Feb 19 22:29:53 2005

Uploaded by

Copyright:

Available Formats

phpOpenTracker Reference Manual

Generated by Doxygen 1.3.4

Sat Feb 19 22:29:53 2005

2 phpOpenTracker Hierarchical Index 11

3 phpOpenTracker Class Index 13

4 phpOpenTracker File Index 15

5 phpOpenTracker Class Documentation 17

6 phpOpenTracker File Documentation 31

Project main concept is building of Traffic Tracking Engine

• My Project consist of creation GUI interfaces

Figure 1.1: Custom User Report

1.2 Core Features

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.2: Example of Russian Language File

1.3 Admin&User Interfaces

Require Password authorization.

1.3.1 Users Managment

Figure 1.3: Admin look to users list

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

1.3.2 Create New User

Figure 1.4: Admin Create New User

1.3.3 Get a Web-Bug code,

Figure 1.5: Web-Bug code

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.6: Generate Exit Link

1.3.4 User Categories

Figure 1.7: User Categories

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.8: Searches List

Figure 1.9: Create New Searches

Ability for users to run system reports for pre-defined search.

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.10: User Select Report to Show

Base System Report List:

• Plot Access Statistics

• Plot Top Documents

• Plot Top Entry Documents

• Plot Top Exit Documents

• Plot Top Exit Targets

• Plot Top Hosts

• Plot Top Operating Systems

• Plot Top Referers

• Plot Top User Agents

• Top10 Point Documents

• Visits and Impressions

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.11: User Browsers Report for total time-period

1.3.7 User-Defined Reports

Figure 1.12: List of User-Defined Reports

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.13: Edit User-Defined Report

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

Figure 1.14: Show User-Defined Report

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen

phpOpenTracker Hierarchical Index

2.1 phpOpenTracker Class Hierarchy

Generated on Sat Feb 19 22:29:54 2005 for phpOpenTracker by Doxygen