Explorar el Código

Add categorisation of charts and ability to exclude categories from appearing in reports

Alan Lam hace 2 años
padre
commit
173bdb7b9e

+ 12 - 1
controllers/reports.php

@@ -40,6 +40,8 @@ if(!empty($location_ids)) {
 	$location_ids = array_filter($location_ids);
 }
 
+$exclude_categories = http::value("exclude_categories");
+
 $retests = http::value("retests", "int");
 
 $location_filters = [
@@ -92,6 +94,8 @@ $charts = [];
 $key_labels = [];
 $has_pass_fail = false;
 
+$template_config = new stdClass();
+
 $submit = http::value("submit");
 if($submit) {
 	try {
@@ -124,6 +128,13 @@ if($submit) {
 			throw $form_exception;
 		}
 
+		$template_config = $template->getConfiguration();
+
+		// Exclude categories
+		if(!$exclude_categories || !is_array($exclude_categories)) {
+			$exclude_categories = $template_config->reports->excludeCategories ?? [];
+		}
+
 		// Get all completed tests
 		$test_nvp = [
 			"project_id" => $project_ids,
@@ -507,7 +518,7 @@ if($submit) {
 }
 
 View::includeOnce("header", compact("page_title"));
-View::include("reports", compact("customer", "date_range", "date_start", "date_end", "date_resolution", "all_projects", "project_table_data", "exclude_project_ids", "location_ids", "retests", "charts", "data", "total_data", "locations_missing_region", "locations_missing_area_manager", "locations_missing_operations_manager", "locations_missing_brand", "region_data", "area_manager_data", "brand_data", "operations_manager_data", "key_labels", "has_pass_fail"));
+View::include("reports", compact("customer", "date_range", "date_start", "date_end", "date_resolution", "all_projects", "project_table_data", "exclude_project_ids", "location_ids", "retests", "charts", "data", "total_data", "locations_missing_region", "locations_missing_area_manager", "locations_missing_operations_manager", "locations_missing_brand", "region_data", "area_manager_data", "brand_data", "operations_manager_data", "key_labels", "has_pass_fail", "template_config", "exclude_categories"));
 View::includeOnce("footer");
 
 file_put_contents("periodic_data.bin", serialize($data));

+ 12 - 0
engine/chart.php

@@ -49,6 +49,8 @@ class Chart {
 	private $xAxes = [];
 	private $yAxes = [];
 
+	private $categories = [];
+
 	private $datalabelSuffixes = [];
 	private $datalabelFormatterCallback = false;
 
@@ -560,4 +562,14 @@ class Chart {
 		}
 	}
 
+	public function setCategories(array $categories): void {
+		$this->categories = $categories;
+	}
+
+	public function getCategories(): array {
+		return $this->categories;
+	}
+
+
+
 }

+ 24 - 20
engine/chart_generator.php

@@ -141,6 +141,10 @@ class ChartGenerator {
 		return $chart;
 	}
 
+	/**
+	 * @param array $venue_type_data
+	 * @return Chart[]
+	 */
 	public function getVenueTypeChallengeStagePieCharts(array $venue_type_data): array {
 		$field = $this->template->getChallengeStageField();
 		if(!$field) {
@@ -219,7 +223,7 @@ class ChartGenerator {
 
 	// Charts
 	public function getTestsByStageChart(array $labels, string $title = "Tests by Stage"): Chart {
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("doughnut");
 		$chart->setTitle("$title ({$this->dateRangeLabel})");
 		$chart->setLabels($labels);
@@ -248,7 +252,7 @@ class ChartGenerator {
 	}
 
 	public function getChallengerGenderChart(): Chart {
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("pie");
 		$chart->setTitle("Staff Gender ({$this->dateRangeLabel})");
 		$chart->setLabels(["Male", "Female", "Unspecified"]);
@@ -268,7 +272,7 @@ class ChartGenerator {
 	}
 
 	public function getTesterGenderChart(): Chart {
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("pie");
 		$chart->setTitle("Tester Gender ({$this->dateRangeLabel})");
 		$chart->setLabels(["Male", "Female"]);
@@ -298,7 +302,7 @@ class ChartGenerator {
 			$colours[] = self::COLOUR_GREY;
 		}
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("pie");
 		$chart->setTitle("{$title} ({$this->dateRangeLabel})");
 		$chart->setLabels($labels);
@@ -344,7 +348,7 @@ class ChartGenerator {
 
 	public function getPeriodicPassFailRateChart(string $title = "Pass / Fail"): Chart {
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addXAxis([
 			"type" => "category",
 			"stacked" => true,
@@ -522,7 +526,7 @@ class ChartGenerator {
 		$pass_counts = $this->getPeriodicPassCounts();
 		$fail_counts = $this->getPeriodicFailCounts();
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("bar");
 		$chart->setTitle("{$title} by {$this->resolutionName}");
 		$chart->setLabels($this->xDataLabels);
@@ -590,7 +594,7 @@ class ChartGenerator {
 
 			if($period_data->testCount === 0) continue;
 
-			$chart = new Chart;
+			$chart = new Chart();
 			$chart->setType("pie");
 			$chart->setTitle(sprintf($title_format, $key_label));
 			$chart->setLabels($labels);
@@ -623,7 +627,7 @@ class ChartGenerator {
 
 		$counts = array_merge($male_counts, $female_counts);
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addYAxis([
 			"id" => "y-axis-1",
 			"tick_config" => ["min" => 0, "max" => ceil(max($counts) / 10) * 10]
@@ -646,7 +650,7 @@ class ChartGenerator {
 		$pass_rates = $this->getPeriodicPassRates();
 		$pass_rate_max = ceil(max($pass_rates) / 10) * 10;
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addYAxis([
 			"id" => "y-axis-1",
 			"tick_config" => ["min" => 0, "max" => ceil(max($test_counts) / 10) * 10]
@@ -719,7 +723,7 @@ class ChartGenerator {
 		}
 
 		// Gender Comparison by Date Range
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addYAxis([
 			"id" => "y-axis-1",
 			"tick_config" => ["min" => 0, "max" => ceil(max($gender_test_counts) / 10) * 10]
@@ -741,7 +745,7 @@ class ChartGenerator {
 
 		$counts = array_merge($mcm_counts, $mcf_counts, $fcm_counts, $fcf_counts);
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addYAxis([
 			"id" => "y-axis-1",
 			"tick_config" => ["min" => 0, "max" => ceil(max($counts) / 10) * 10]
@@ -791,7 +795,7 @@ class ChartGenerator {
 			${$prefix . "_pass_rates"} = $pass_rates;
 		}
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addYAxis([
 			"id" => "y-axis-1",
 			"tick_config" => ["min" => 0, "max" => 100],
@@ -821,7 +825,7 @@ class ChartGenerator {
 
 				if($test_count === 0) continue;
 
-				$chart = new Chart;
+				$chart = new Chart();
 				$chart->setType("pie");
 				$chart->setTitle("$key_label $title Point of Challenge");
 				$chart->setLabels(["On Entry", "While Browsing", "During Play", "On Exit", "No Challenge"]);
@@ -860,7 +864,7 @@ class ChartGenerator {
 			$data_values[] = ($total_test_count === 0) ? 0 : round(($total_pass_count * 100) / $total_test_count);
 		}
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addXAxis([
 			"type" => "category",
 			"scale_label_config" => [
@@ -985,7 +989,7 @@ class ChartGenerator {
 
 	public function getCleanlinessChart(): Chart {
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("doughnut");
 		$chart->setTitle("Tests by Cleanliness ({$this->dateRangeLabel})");
 		$chart->setLabels(["Very dirty", "Dirty", "Adequate", "Clean", "Very Clean"]);
@@ -1026,7 +1030,7 @@ class ChartGenerator {
 
 			if($period_data->testCount === 0) continue;
 
-			$chart = new Chart;
+			$chart = new Chart();
 			$chart->setType("pie");
 			$chart->setTitle("$key_label Cleanliness");
 			$chart->setLabels(["Very dirty", "Dirty", "Adequate", "Clean", "Very Clean"]);
@@ -1059,7 +1063,7 @@ class ChartGenerator {
 		$no_counts = array_column($staff_badge_worn_counts, 1);
 		$yes_counts = array_column($staff_badge_worn_counts, 2);
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("bar");
 		$chart->setTitle("Staff Badge Worn by {$this->resolutionName}");
 		$chart->setLabels($this->xDataLabels);
@@ -1101,7 +1105,7 @@ class ChartGenerator {
 
 			if($period_data->testCount === 0) continue;
 
-			$chart = new Chart;
+			$chart = new Chart();
 			$chart->setType("pie");
 			$chart->setTitle("$key_label Staff Behaviour");
 			$chart->setLabels(["N/A", "Rude", "Slightly rude", "Neither rude or polite", "Polite", "Very polite"]);
@@ -1276,7 +1280,7 @@ class ChartGenerator {
 		$no_counts = array_column($values, 0);
 		$yes_counts = array_column($values, 1);
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->setType("bar");
 		$chart->setTitle("{$title} by {$this->resolutionName}");
 		$chart->setLabels($this->xDataLabels);
@@ -1292,7 +1296,7 @@ class ChartGenerator {
 
 	private function getPeriodicPassRateChart(string $title, array $yes_rates, array $no_rates, ?array $null_rates = null): Chart {
 
-		$chart = new Chart;
+		$chart = new Chart();
 		$chart->addYAxis([
 			"tick_config" => ["min" => 0, "max" => 100],
 		]);

+ 3 - 1
engine/http.php

@@ -132,11 +132,13 @@ class HTTP {
 				return is_array($value) ? array_map("htmlspecialchars", $value) : htmlspecialchars($value);
 			}
 
+			case "string":
 			case "trim": {
 				return is_array($value) ? array_map("trim", $value) : trim($value);
 			}
 
 			case "":
+			case "raw":
 			case "none": {
 				return $value;
 			}
@@ -146,7 +148,7 @@ class HTTP {
 			}
 
 			default: {
-				throw new Exception("Unknown validation type: $validation");
+				throw new RuntimeException("Unknown validation type: $validation");
 			}
 		}
 

+ 5 - 0
engine/template.php

@@ -93,6 +93,11 @@ class Template extends Model {
 		return $this->json;
 	}
 
+	public function getConfiguration(): object {
+		$json = $this->getJSON();
+		return json_decode($json) ?: new stdClass();
+	}
+
 	/**
 	 * @return Customer
 	 * @throws Exception

+ 12 - 0
json/age_verification_greene_king.json

@@ -1,4 +1,16 @@
 {
+	"reports": {
+		"categories": [
+			"Gaming",
+			"Alcohol",
+			"Gender",
+			"Eye Contact"
+		],
+		"excludeCategories": [
+			"Gender",
+			"Eye Contact"
+		]
+	},
 	"customerInvoiceFields": [
 		{"name": "play_spent", "label": "Money Spent by Testers"}
 	],

+ 108 - 31
template_processing/age_verification_greene_king/reports_build_charts.php

@@ -1,53 +1,130 @@
-<?php
+<?php /** @noinspection PhpUnhandledExceptionInspection */
 
 /**
  * @var ChartGenerator $generator
  * @var Template $template
+ * @var array $exclude_categories
  */
 
-$charts[] = $generator->getTestsByStageChart(["1 - On Entry", "2 - While Browsing", "3 - During Play", "4 - After Play", "5 - No Challenge"], __("Gaming Tests by Stage"));
-//$charts[] = $generator->getChallengerGenderChart();
-//$charts[] = $generator->getTesterGenderChart();
-$charts[] = $generator->getPassFailCountChart(__("Gaming Pass / Fail"));
-$charts[] = $generator->getPassFailCountChartByKey(__("Alcohol Age Verification"), "barAgeVerificationCounts");
-$charts[] = $generator->getPassFailCountChartByKey(__("Alcohol Pass / Fail"), "barCounts");
+$charts = [];
+
+$tests_by_stage_chart = $generator->getTestsByStageChart(["1 - On Entry", "2 - While Browsing", "3 - During Play", "4 - After Play", "5 - No Challenge"], __("Gaming Tests by Stage"));
+$tests_by_stage_chart->setCategories(["All", "Gaming"]);
+$charts[] = $tests_by_stage_chart;
+
+$challenge_gender_chart = $generator->getChallengerGenderChart();
+$challenge_gender_chart->setCategories(["All", "Gaming", "Gender"]);
+$charts[] = $challenge_gender_chart;
+
+$tester_gender_chart = $generator->getTesterGenderChart();
+$tester_gender_chart->setCategories(["All", "Gaming", "Gender"]);
+$charts[] = $tester_gender_chart;
+
+$gaming_pass_fail_chart = $generator->getPassFailCountChart(__("Gaming Pass / Fail"));
+$gaming_pass_fail_chart->setCategories(["All", "Gaming"]);
+$charts[] = $gaming_pass_fail_chart;
+
+$alcohol_age_verification_chart = $generator->getPassFailCountChartByKey(__("Alcohol Age Verification"), "barAgeVerificationCounts");
+$alcohol_age_verification_chart->setCategories(["All", "Alcohol"]);
+$charts[] = $alcohol_age_verification_chart;
+
+$alcohol_pass_fail_chart = $generator->getPassFailCountChartByKey(__("Alcohol Pass / Fail"), "barCounts");
+$alcohol_pass_fail_chart->setCategories(["All", "Alcohol"]);
+$charts[] = $alcohol_pass_fail_chart;
 
 if(!empty($venue_type_data)) {
-	$charts[] = ChartGenerator::getVenueTypePassFailChart($venue_type_data);
-	$charts = array_merge($charts, $generator->getVenueTypeChallengeStagePieCharts($venue_type_data));
+	$venue_type_pass_fail_chart = ChartGenerator::getVenueTypePassFailChart($venue_type_data);
+	$venue_type_pass_fail_chart->setCategories(["All", "Gaming", "Venue Type"]);
+	$charts[] = $venue_type_pass_fail_chart;
 
-	$chart = $generator->getVenueTypeChallengeStageStackedBarChart($venue_type_data);
-	if($chart) {
-		$charts[] = $chart;
+	foreach($generator->getVenueTypeChallengeStagePieCharts($venue_type_data) as $venue_type_challenge_stage_chart) {
+		$venue_type_challenge_stage_chart->setCategories(["All", "Gaming", "Venue Type"]);
+		$charts[] = $venue_type_challenge_stage_chart;
+	}
+
+	$venue_type_challenge_stage_stacked_chart = $generator->getVenueTypeChallengeStageStackedBarChart($venue_type_data);
+	if($venue_type_challenge_stage_stacked_chart) {
+		$venue_type_challenge_stage_stacked_chart->setCategories(["All", "Gaming", "Venue Type"]);
+		$charts[] = $venue_type_challenge_stage_stacked_chart;
 	}
 }
 
-$charts[] = $generator->getPeriodicPassFailRateChart(__("Gaming Pass / Fail"));
-//$charts[] = $generator->getPeriodicEyeContactChart();
-//$charts[] = $generator->getPeriodicEyeContactPassRateChart();
-$charts[] = $generator->getPeriodicLineOfSightPassRateChart([
+$periodic_pass_fail_chart = $generator->getPeriodicPassFailRateChart(__("Gaming Pass / Fail"));
+$periodic_pass_fail_chart->setCategories(["All", "Gaming"]);
+$charts[] = $periodic_pass_fail_chart;
+
+$periodic_eye_contact_chart = $generator->getPeriodicEyeContactChart();
+$periodic_eye_contact_chart->setCategories(["All", "Gaming", "Eye Contact"]);
+$charts[] = $periodic_eye_contact_chart;
+
+$periodic_eye_contact_pass_rate_chart = $generator->getPeriodicEyeContactPassRateChart();
+$periodic_eye_contact_pass_rate_chart->setCategories(["All", "Gaming", "Eye Contact"]);
+$charts[] = $periodic_eye_contact_pass_rate_chart;
+
+$periodic_line_of_sight_pass_rate_chart = $generator->getPeriodicLineOfSightPassRateChart([
 	"title" => __("Gaming Pass Rate by Line of Sight"),
 	"include_no_challenge" => false
 ]);
-$charts[] = $generator->getPeriodicPassRateChartByKey(__("Alcohol Age Verification Rate"), "barAgeVerificationCounts");
-$charts[] = $generator->getPeriodicPassRateChartByKey(__("Alcohol Pass Rate"), "barCounts");
-$charts[] = $generator->getPeriodicTotalsChart(__("Gaming Totals"));
-$charts = array_merge($charts, $generator->getPointOfChallengeCharts("Gaming %s Point of Challenge", ["On Entry", "While Browsing", "During Play", "After Play", "No Challenge"]));
-//$charts[] = $generator->getPeriodicTesterGenderChart();
-$charts[] = $generator->getPeriodicTestCountChart(__("Gaming Tests"));
-//$charts = array_merge($charts, $generator->getGenderComparisonCharts());
-
-if($generator->hasRegionData()) {
-//	$charts[] = $generator->getRegionPassRateChart();
-//	$charts[] = $generator->getPeriodicRegionPassRateChart();
+$periodic_line_of_sight_pass_rate_chart->setCategories(["All", "Gaming"]);
+$charts[] = $periodic_line_of_sight_pass_rate_chart;
+
+$periodic_alcohol_age_verification_rate_chart = $generator->getPeriodicPassRateChartByKey(__("Alcohol Age Verification Rate"), "barAgeVerificationCounts");
+$periodic_alcohol_age_verification_rate_chart->setCategories(["All", "Alcohol"]);
+$charts[] = $periodic_alcohol_age_verification_rate_chart;
+
+$periodic_alcohol_pass_rate_chart = $generator->getPeriodicPassRateChartByKey(__("Alcohol Pass Rate"), "barCounts");
+$periodic_alcohol_pass_rate_chart->setCategories(["All", "Alcohol"]);
+$charts[] = $periodic_alcohol_pass_rate_chart;
+
+$periodic_gaming_totals_chart = $generator->getPeriodicTotalsChart(__("Gaming Totals"));
+$periodic_gaming_totals_chart->setCategories(["All", "Gaming"]);
+$charts[] = $periodic_gaming_totals_chart;
+
+foreach($generator->getPointOfChallengeCharts("Gaming %s Point of Challenge", ["On Entry", "While Browsing", "During Play", "After Play", "No Challenge"]) as $gaming_point_of_challenge_chart) {
+	$gaming_point_of_challenge_chart->setCategories(["All", "Gaming"]);
+	$charts[] = $gaming_point_of_challenge_chart;
+}
+
+$periodic_test_count_chart = $generator->getPeriodicTestCountChart(__("Gaming Tests"));
+$periodic_test_count_chart->setCategories(["All", "Gaming"]);
+$charts[] = $periodic_test_count_chart;
+
+$periodic_tester_gender_chart = $generator->getPeriodicTesterGenderChart();
+$periodic_tester_gender_chart->setCategories(["All", "Gaming", "Gender"]);
+$charts[] = $periodic_tester_gender_chart;
+
+foreach($generator->getGenderComparisonCharts() as $gender_comparison_chart) {
+	$gender_comparison_chart->setCategories(["All", "Gaming", "Gender"]);
+	$charts[] = $gender_comparison_chart;
 }
 
 if($generator->hasAreaManagerData()) {
-	$charts[] = $generator->getAreaManagerPassRateChart();
-	$charts[] = $generator->getPeriodicAreaManagerPassRateChart();
+	$area_manager_pass_rate_chart = $generator->getAreaManagerPassRateChart();
+	$area_manager_pass_rate_chart->setCategories(["All", "Gaming", "Area Manager"]);
+	$charts[] = $area_manager_pass_rate_chart;
+
+	$periodic_area_manager_pass_rate_chart = $generator->getPeriodicAreaManagerPassRateChart();
+	$periodic_area_manager_pass_rate_chart->setCategories(["All", "Gaming", "Area Manager"]);
+	$charts[] = $periodic_area_manager_pass_rate_chart;
 }
 
 if($generator->hasBrandData()) {
-	$charts[] = $generator->getBrandPassRateChart();
-	$charts[] = $generator->getPeriodicBrandPassRateChart();
+	$brand_pass_rate_chart = $generator->getBrandPassRateChart();
+	$brand_pass_rate_chart->setCategories(["All", "Gaming", "Brand"]);
+	$charts[] = $brand_pass_rate_chart;
+
+	$periodic_brand_pass_rate_chart = $generator->getPeriodicBrandPassRateChart();
+	$periodic_brand_pass_rate_chart->setCategories(["All", "Gaming", "Brand"]);
+	$charts[] = $periodic_brand_pass_rate_chart;
 }
+
+$charts = array_filter($charts, static function(Chart $chart) use ($exclude_categories) {
+	foreach($exclude_categories as $exclude_category) {
+		$categories = $chart->getCategories();
+		if(in_array($exclude_category, $categories)) {
+			return false;
+		}
+	}
+
+	return true;
+});

+ 28 - 0
views/reports.php

@@ -6,6 +6,9 @@
  * @var string[] $key_labels
  * @var bool $has_pass_fail
  *
+ * @var array $exclude_categories
+ * @var object $template_config
+ *
  * @var string $date_range
  * @var string $date_resolution
  * @var string $date_start
@@ -145,6 +148,7 @@ let projectData = <?=json_encode($project_table_data)?>;
 					<input class="form-control" name="location_ids" type="text" id="location-ids" value="<?=htmlspecialchars(implode(" ", $location_ids))?>" placeholder="Enter location IDs" />
 					<small class="form-text text-muted">Separate each location ID with a space.<br />Leave blank to generate a report for all locations.</small>
 				</div>
+
 				<div class="form-group">
 					<label for="retests">Retests</label>
 					<select name="retests" id="retests" class="form-control">
@@ -160,6 +164,30 @@ let projectData = <?=json_encode($project_table_data)?>;
 					</select>
 				</div>
 
+				<?php
+				$categories = $template_config->reports->categories ?? [];
+				if($total_data && $categories) {
+					?>
+					<div class="form-group">
+						<label><?=htmlspecialchars(__("Exclude Categories"))?></label><br />
+						<?php
+						foreach($categories as $category) {
+							$id = sprintf("exclude-category-%s", strtolower($category));
+							$checked = in_array($category, $exclude_categories) ? "checked" : "";
+							?>
+							<div class="custom-control custom-switch">
+								<input class="custom-control-input" id="<?=$id?>" name="exclude_categories[]" type="checkbox" value="<?=htmlspecialchars($category)?>" <?=$checked?> />
+								<label class="custom-control-label" for="<?=$id?>"><?=htmlspecialchars($category)?></label>
+							</div>
+							<?php
+						}
+						?>
+					</div>
+					<?php
+				}
+				?>
+
+
 				<?php
 				/**
 				 * @param string $name