Docs For Class Module_admin

Class Module_admin_stats

Description

Module page class.

Located in /adminzone/pages/modules/admin_stats.php (line 25)

Method Summary

tempcode clear ()

tempcode get_between (tempcode $title, [boolean $stats_table = false], [?tempcode $extra_fields = NULL], [?tempcode $message = NULL])

?array get_entry_points ()

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode install_geolocation_data ()

tempcode keywords ()

tempcode load_times ()

tempcode misc ()

tempcode overview ()

tempcode page_stats ()

array page_x_share (PATH $page, string $type, string $graph_title, string $graph_description, string $list_title)

tempcode referrers ()

tempcode run ()

void save_graph (string $path, string $graph)

tempcode show_page ()

tempcode submission_rates ()

void uninstall ()

tempcode users_online ()

array views_per_x (PATH $page, string $type, string $graph_title, string $graph_description, [integer $hours = 1], [integer $total = 24])

tempcode _clear ()

Methods

clear (line 1225)

The UI to clear statistics.

return: The UI

tempcode clear ()

get_between (line 259)

An interface for choosing between dates.

return: The result of execution.

tempcode get_between (tempcode $title, [boolean $stats_table = false], [?tempcode $extra_fields = NULL], [?tempcode $message = NULL])

tempcode $title: The title to display.
boolean $stats_table: Whether display is dependent on what we kept in our stats table.
?tempcode $extra_fields: Extra fields to request (NULL: none).
?tempcode $message: The message to show for date selection (NULL: default).

get_entry_points (line 152)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

info (line 33)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

install (line 65)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

?integer $upgrade_from: What version we're upgrading from (NULL: new install)
?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)

install_geolocation_data (line 1289)

Install geolocation data.

return: The UI, showing the result of the installation

tempcode install_geolocation_data ()

keywords (line 663)

The UI to show top search keywords.

return: The UI

tempcode keywords ()

load_times (line 447)

The UI to show page load times.

return: The UI

tempcode load_times ()

misc (line 216)

The do-next manager for before content management.

return: The UI

tempcode misc ()

overview (line 904)

The UI to show page view statistics for the front page.

return: The UI

tempcode overview ()

page_stats (line 781)

The UI to show page view statistics.

return: The UI

tempcode page_stats ()

page_x_share (line 1429)

Create a pie chart of the ratios of the specified statistic for the specified page. The chart is saved as an SVG image in /data_custom/admin_stats/, and the tempcode for display of the graph and results table is returned

return: A linear array containing the graph and list tempcode objects, respectively

array page_x_share (PATH $page, string $type, string $graph_title, string $graph_description, string $list_title)

PATH $page: The page path
string $type: The statistic to use
string $graph_title: Language identifier for the graph title
string $graph_description: Language identifier for the graph description
string $list_title: Language identifier for the list title

referrers (line 549)

The UI to show referrers.

return: The UI

tempcode referrers ()

run (line 174)

Standard modular run function.

return: The result of execution.

tempcode run ()

save_graph (line 1508)

Save a graph to the server so it can be viewed client-side.

void save_graph (string $path, string $graph)

string $path: Name of the graph (no path or extension)
string $graph: SVG markup

show_page (line 970)

The UI to show page view statistics for a single page.

return: The UI

tempcode show_page ()

submission_rates (line 380)

The UI to show submission rates.

return: The UI

tempcode submission_rates ()

uninstall (line 49)

Standard modular uninstall function.

void uninstall ()

users_online (line 308)

The UI to show user online statistics.

return: The UI

tempcode users_online ()

views_per_x (line 1357)

Create a bar chart of the views the specified page has received in relation to the specified hours. The bar chart is stored in /data_custom/admin_stats/ as an SVG image, and the tempcode for display of the graph and results table is returned.

return: A linear array containing the graph and list tempcode objects, respectively

array views_per_x (PATH $page, string $type, string $graph_title, string $graph_description, [integer $hours = 1], [integer $total = 24])

PATH $page: The page path
string $type: The statistic type (for use in sort parameters and such)
string $graph_title: Language identifier for the graph title
string $graph_description: Language identifier for the graph description
integer $hours: The steps of hours to use
integer $total: The total hours to plot

_clear (line 1249)

The actualiser to clear statistics.

return: The UI

tempcode _clear ()

Documentation generated on Sun, 02 Jan 2011 23:08:03 +0000 by phpDocumentor 1.4.3