reports.php 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. <?php /** @noinspection PhpIncludeInspection */
  2. /** @noinspection PhpUnhandledExceptionInspection */
  3. Core::addScript("public/js/app-reports.js");
  4. Core::addBreadcrumb("/account", "Account");
  5. Core::addBreadcrumb("/account/reports", "Reports");
  6. $customer = Customer::getForAdmin();
  7. if(!$customer) throw new Exception("You do not have permission to access this page.");
  8. $customer_slug = Util::slug($customer->name);
  9. $customer_slug = str_replace("-", "_", $customer_slug);
  10. $logo_file_path = ROOT_DIR . "/public/img/customer_logos/{$customer_slug}_logo.png";
  11. $has_logo = file_exists($logo_file_path);
  12. $page_title = "$customer->name Reports";
  13. Core::addBreadcrumb("/account/reports?customer_id=$customer->id", $page_title);
  14. $date_range = http::value("date_range");
  15. if(!$date_range) $date_range = "ytd";
  16. $date_resolution = http::value("date_resolution");
  17. $date_start = http::value("date_start");
  18. $date_end = http::value("date_end");
  19. $exclude_project_ids = http::value("exclude_project_ids", "int");
  20. if(!is_array($exclude_project_ids)) $exclude_project_ids = [];
  21. $location_ids = http::value("location_ids");
  22. if(!empty($location_ids)) {
  23. $location_ids = explode(" ", $location_ids);
  24. $location_ids = array_map("intval", $location_ids);
  25. $location_ids = array_filter($location_ids);
  26. }
  27. $retests = http::value("retests", "int");
  28. if(!is_array($location_ids)) {
  29. $location_ids = [];
  30. }
  31. $all_projects = Project::query([
  32. "customer_id" => $customer->id
  33. ]);
  34. if(Core::$user->isCustomer()) {
  35. // Filter to only projects that have past the deadline
  36. $all_projects = array_filter($all_projects, static function(Project $project) {
  37. return $project->isFinished();
  38. });
  39. }
  40. $project_table_data = [];
  41. foreach($all_projects as $p) {
  42. $project_table_data[] = $p->getDataTableRow();
  43. }
  44. $all_project_ids = array_column($all_projects, "id");
  45. $data = [];
  46. $region_data = [];
  47. $area_manager_data = [];
  48. $total_data = new stdClass;
  49. $locations_missing_region = [];
  50. $locations_missing_area_manager = [];
  51. $charts = [];
  52. $key_labels = [];
  53. $has_pass_fail = false;
  54. $submit = http::value("submit");
  55. if($submit) {
  56. try {
  57. Core::validateCSRFToken($submit);
  58. $form_exception = new FormException;
  59. // Get all projects
  60. $projects = Project::query([
  61. "customer_id" => $customer->id,
  62. "id" => (new Constraint("NOT_IN"))->setValues(...$exclude_project_ids)
  63. ]);
  64. $project_ids = array_intersect($all_project_ids, array_column($projects, "id"));
  65. // Enforce unique template ID in selection
  66. $template_ids = array_unique(array_column($projects, "template_id"));
  67. if(count($template_ids) > 1) $form_exception->addError("Projects with different templates have been selected.");
  68. // Check template exists
  69. $template_id = array_shift($template_ids);
  70. $template = Template::get($template_id);
  71. if(!$template) $form_exception->addError("Template cannot be found.");
  72. if($form_exception->hasErrors()) throw $form_exception;
  73. // Get all completed tests
  74. $test_nvp = [
  75. "project_id" => $project_ids,
  76. "status" => Test::STATUS_COMPLETED
  77. ];
  78. if($location_ids) {
  79. $test_nvp["location_id"] = $location_ids;
  80. }
  81. if($retests !== null) {
  82. $test_nvp["retest"] = $retests;
  83. }
  84. $tests = Test::query($test_nvp);
  85. $test_result_set = new TestResultSet($tests);
  86. // Calculate date ranges
  87. $min_year = date("Y");
  88. $max_year = date("Y");
  89. switch($date_range) {
  90. case "ytd":
  91. default:
  92. // Nothing to do
  93. $date_range_label = "YTD";
  94. $min_dts = "$min_year-01-01";
  95. $max_dts = "$max_year-12-31 23:59:59";
  96. break;
  97. case "unbound":
  98. // Work out year range
  99. foreach($tests as $test) {
  100. $dt = new DateTime($test->dts_start . " UTC");
  101. $dt->setTimezone(new DateTimeZone(TIMEZONE));
  102. $year = $dt->format("Y");
  103. if($year < $min_year) $min_year = $year;
  104. if($year > $max_year) $max_year = $year;
  105. }
  106. $date_range_label = "$min_year - $max_year";
  107. $min_dts = "$min_year-01-01";
  108. $max_dts = "$max_year-12-31 23:59:59";
  109. break;
  110. case "custom":
  111. $check = strcmp($date_start, $date_end);
  112. if($check > 0) {
  113. $temp = $date_start;
  114. $date_start = $date_end;
  115. $date_end = $temp;
  116. }
  117. [$min_year, $min_month, $min_day] = explode("-", $date_start);
  118. [$max_year, $max_month, $max_day] = explode("-", $date_end);
  119. $min_dts = "$date_start 00:00:00";
  120. $max_dts = "$date_end 23:59:59";
  121. $min_time = strtotime($min_dts);
  122. $max_time = strtotime($max_dts);
  123. $date_range_label = sprintf("%s - %s", date("j M y", $min_time), date("j M y", $max_time));
  124. if(preg_match("/01-01$/", $date_start) && preg_match("/12-31$/", $date_end)) {
  125. $date_range_label = $min_year === $max_year ? $min_year : "$min_year - $max_year";
  126. }
  127. break;
  128. }
  129. $tests = $test_result_set->filterByDateRange($min_dts, $max_dts);
  130. // Get test values
  131. $test_ids = array_column($tests, "id");
  132. $test_values = TestValue::query([
  133. "test_id" => $test_ids,
  134. ]);
  135. $test_values_map = [];
  136. foreach($test_values as $test_value) {
  137. $test_id = $test_value->test_id;
  138. $name = $test_value->name;
  139. if(!isset($test_values_map[$test_id])) {
  140. $test_values_map[$test_id] = new stdClass;
  141. }
  142. $test_values_map[$test_id]->{$name} = $test_value->value;
  143. }
  144. // Load users
  145. User::load(array_column($tests, "tester_id"));
  146. // Load locations
  147. $locations = Location::load(array_column($tests, "location_id"));
  148. // Get region and area manager IDs
  149. $regions = array_filter(array_column($locations, "region"));
  150. $area_managers = array_filter(array_column($locations, "area_manager"));
  151. uksort($regions, "strnatcasecmp");
  152. uksort($area_managers, "strnatcasecmp");
  153. foreach($regions as $region) {
  154. $region_data[$region] = [];
  155. }
  156. foreach($area_managers as $area_manager) {
  157. $area_manager_data[$area_manager] = [];
  158. }
  159. $has_regions = !empty($region_data);
  160. $has_area_managers = !empty($area_manager_data);
  161. foreach($locations as $location) {
  162. if($has_regions && !$location->region) $locations_missing_region[] = $location;
  163. if($has_area_managers && !$location->area_manager) $locations_missing_area_manager[] = $location;
  164. }
  165. // Check if date range is same year
  166. $same_year = ($min_year === $max_year);
  167. // Empty data objects hook
  168. require $template->getProcessingFilePath("reports_create_empty_objects.php");
  169. $has_pass_fail = isset($empty_data->passCount);
  170. // Initialise date-array based on date range and resolution
  171. $keys = [];
  172. $key_labels = [];
  173. $resolution_name = "Quarter";
  174. for($year = $min_year; $year <= $max_year; $year++) {
  175. switch($date_resolution) {
  176. case "monthly":
  177. $resolution_name = "Month";
  178. foreach(range(1, 12) as $month) {
  179. if(!$same_year) $label = date("M Y", mktime(0, 0, 0, $month, 1, date("Y")));
  180. else $label = date("M", mktime(0, 0, 0, $month, 1, date("Y")));
  181. $month = str_pad($month, 2, "0", STR_PAD_LEFT);
  182. $keys[] = "$year-$month";
  183. $key_labels[] = $label;
  184. }
  185. break;
  186. case "quarterly":
  187. default:
  188. $resolution_name = "Quarter";
  189. foreach(range(1, 4) as $quarter) {
  190. if(!$same_year) $label = "Q$quarter $year";
  191. else $label = "Q$quarter";
  192. $keys[] = "$year-$quarter";
  193. $key_labels[] = $label;
  194. }
  195. break;
  196. }
  197. }
  198. foreach($keys as $index => $key) {
  199. $label = $key_labels[$index];
  200. /** @var object $empty_data */
  201. $data[$key] = clone $empty_data;
  202. $data[$key]->label = $label;
  203. foreach($region_data as &$r) {
  204. $r[$key] = clone $empty_data;
  205. $r[$key]->label = $label;
  206. }
  207. unset($r);
  208. foreach($area_manager_data as &$a) {
  209. $a[$key] = clone $empty_data;
  210. $a[$key]->label = $label;
  211. }
  212. unset($a);
  213. }
  214. $max_unix = 0;
  215. // Process test results
  216. foreach($tests as $test) {
  217. $tester = $test->getTester();
  218. $location = $test->getLocation();
  219. $project = $test->getProject();
  220. $test_values = $test_values_map[$test->id] ?? new stdClass;
  221. $region = $location->region;
  222. $area_manager = $location->area_manager;
  223. $dts = $project->dts_report ?: $test->dts_start;
  224. $dt = new DateTime($dts . " UTC");
  225. $dt->setTimezone(new DateTimeZone(TIMEZONE));
  226. $unix = $dt->format("U");
  227. $year = $dt->format("Y");
  228. $month = $dt->format("m");
  229. $quarter = ceil($month / 3);
  230. if($unix > $max_unix) {
  231. $max_unix = $unix;
  232. }
  233. switch($date_resolution) {
  234. case "monthly":
  235. $key = "$year-$month";
  236. break;
  237. case "quarterly":
  238. default:
  239. $key = "$year-$quarter";
  240. break;
  241. }
  242. // Skip processing if test is void
  243. if($test->isVoid()) {
  244. $data[$key]->voidCount++;
  245. $total_data->voidCount++;
  246. }
  247. else {
  248. $total_data->testCount++;
  249. $data[$key]->testCount++;
  250. if($region) $region_data[$region][$key]->testCount++;
  251. if($area_manager) $area_manager_data[$area_manager][$key]->testCount++;
  252. if($tester->gender === "M") {
  253. $data[$key]->maleTesterCount++;
  254. $total_data->maleTesterCount++;
  255. }
  256. if($tester->gender === "F") {
  257. $data[$key]->femaleTesterCount++;
  258. $total_data->femaleTesterCount++;
  259. }
  260. // Process test hook
  261. require $template->getProcessingFilePath("reports_process_test.php");
  262. }
  263. }
  264. $current_month = date("m", $max_unix);
  265. $current_quarter = ceil(date("n", $max_unix) / 3);
  266. // Initialise generator
  267. $generator = new ChartGenerator($total_data, $data);
  268. $generator->setDateRangeLabel($date_range_label);
  269. $generator->setResolutionName($resolution_name);
  270. $generator->setPeriodKeysAndLabels($keys, $key_labels);
  271. $generator->setRegionData($region_data);
  272. $generator->setAreaManagerData($area_manager_data);
  273. // Build charts hook
  274. require $template->getProcessingFilePath("reports_build_charts.php");
  275. }
  276. catch(FormException $e) {
  277. $e->generateAlerts();
  278. }
  279. catch(Exception $e) {
  280. Core::addAlert("danger", $e->getMessage());
  281. }
  282. // Export hook
  283. if(!empty($action)) {
  284. switch($action) {
  285. case "export-pptx":
  286. case "export-odp":
  287. require "reports_presentation.php";
  288. break;
  289. default:
  290. break;
  291. }
  292. }
  293. }
  294. View::includeOnce("header", compact("page_title"));
  295. 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", "region_data", "area_manager_data", "key_labels", "has_pass_fail"));
  296. View::includeOnce("footer");