Class Type

Type of display to be generated from the statistics.

This class is used by the Stats class.

Namespace: hrm\stats
Package: hrm
Located at stats/Type.php

Methods summary

`public`	# `__construct( string $name, string $variable, string $descriptiveName, string $type, boolean $adminOnly )` Type constructor: : sets the relevant information for the report. Type constructor: : sets the relevant information for the report. Parameters `$name` Name of the report. `$variable` Name of the column to target in the statistics table. `$descriptiveName` Descriptive name for the report. `$type` Type of report: one of 'text', 'piechart', 'linechart', 'dumptable'. `$adminOnly` Specifies whether the report is accessible only to the admin user.s
`public boolean`	# `isGraph( )` Returns true is the requested statistics generates a graph, or false if it returns a text/table. Returns true is the requested statistics generates a graph, or false if it returns a text/table. Returns boolean True for graphs, false for text/table.
`public string`	# `getStatisticsScript( hrm\DatabaseConnection $db, boolean $admin, string $fromDate, string $toDate, string $group, string $username )` Get the JS/PHP script to display the statistics. Get the JS/PHP script to display the statistics. Parameters `$db` DatabaseConnection object. `$admin` True if the user is the admin. `$fromDate` Start date for filtering in the form "YYYY-mm-dd" (or generally "YYYY-mm-dd hh:mm:ss"). `$toDate` End date for filtering in the form "YYYY-mm-dd" (or generally "YYYY-mm-dd hh:mm:ss"). `$group` Group name. `$username` User name. Returns string JS/PHP script to display the statistics.

Properties summary

`public string`	`$m_Name` Name of the report. Name of the report.	#
`public string`	`$m_Variable` Name of the column to target in the statistics table. Name of the column to target in the statistics table.	#
`public string`	`$m_DescriptiveName` Descriptive name for the report. Descriptive name for the report.	#
`public string`	`$m_Type` Type of report: one of 'text', 'piechart', 'linechart', 'dumptable'. Type of report: one of 'text', 'piechart', 'linechart', 'dumptable'.	#
`public boolean`	`$m_AdminOnly` Makes a particular report accessible only to the admin. Makes a particular report accessible only to the admin.	#