test.php 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  1. <?php
  2. class Test extends Model {
  3. protected static $table = "test";
  4. protected static $id_field = "id";
  5. protected static $fillable_fields = ["project_id", "location_id", "tester_id", "status", "test_fee", "test_time", "test_travel_cost", "shop_left", "shop_right", "attire", "challenge_stage", "challenge_description", "challenger_name", "challenger_description", "challenger_gender", "challenger_eye_contact", "additional_notes", "dts_due", "dts_start", "dts_end", "verifier_id", "verifier_notes", "pass", "dts_created", "dts_updated", "dts_assigned", "dts_verified"];
  6. const TEST_FIELDS = ["shop_left", "shop_right", "attire", "challenge_stage", "challenge_description", "challenger_name", "challenger_description", "challenger_gender", "challenger_eye_contact", "additional_notes"];
  7. // Constants
  8. const STATUS_CANCELLED = 0;
  9. const STATUS_UNASSIGNED = 1; // Location needs a tester
  10. const STATUS_ASSIGNED = 2; // Tester assigned
  11. const STATUS_CONFIRMED = 3; // Tester has said they can do it
  12. const STATUS_STARTED = 4;
  13. const STATUS_PENDING_VERIFICATION = 8;
  14. const STATUS_COMPLETED = 16;
  15. const STATUSES = [
  16. 0 => "Cancelled",
  17. 1 => "Unassigned",
  18. 2 => "Assigned",
  19. 3 => "Confirmed",
  20. 4 => "Started",
  21. 8 => "Pending Verification",
  22. 16 => "Completed",
  23. ];
  24. const STAGES = [
  25. 0 => "",
  26. 1 => "Challenge on entry",
  27. 2 => "Challenge while browsing",
  28. 3 => "Challenge during play",
  29. 4 => "Challenge on exit",
  30. 5 => "No challenge",
  31. ];
  32. const TEST_TIME_ANYTIME = 1;
  33. const TEST_TIME_DAY = 2;
  34. const TEST_TIME_NIGHT = 3;
  35. // Object methods
  36. public function sendAssignEmail($message) {
  37. $tester = $this->getTester();
  38. $location = $this->getLocation();
  39. // Content
  40. $name = htmlspecialchars($tester->first_name);
  41. $message = htmlspecialchars($message);
  42. $base_url = htmlspecialchars(PROTOCOL . "://" . DOMAIN . "/account/tests/" . $this->id);
  43. $address = htmlspecialchars($location->name . ", " . $location->getDisplayAddress(["address_1", "address_2", "city", "county", "postal_code"]));
  44. $date_due = date("j M Y", strtotime($this->dts_due));
  45. $admin_first_name = htmlspecialchars(Core::$user->first_name);
  46. $admin_phone = htmlspecialchars(Core::$user->phone);
  47. // Build
  48. $builder = new EmailBuilder;
  49. $builder->addParagraph("<b>Hi $name,</b>");
  50. $builder->addLeadParagraph("Congrats, you have been allocated a test!");
  51. if($message) {
  52. $builder->addParagraph($message);
  53. }
  54. $builder->addParagraph("We need you to confirm if you are able to do the test. Please check the details below and then confirm by pressing the <b>Accept</b> or <b>Decline</b> buttons and once you tap <b>Accept</b>, the test will be allocated to you.");
  55. $builder->addAcceptDeclineButtons($base_url);
  56. $builder->addParagraph("The site address is: <b>$address</b>");
  57. $builder->addParagraph("The date that need to complete and submit the results by is: <font color=\"red\"><b>$date_due</b></font>");
  58. $builder->addParagraph("For methodology and further notes please check the <b>Useful Documents</b> section on the <b>Account</b> page.");
  59. $builder->addParagraph("If you agree to conduct the test, log in and then go to <b>Tests</b> where you will be able to see the tests available to you. Please tap the <b>Begin</b> button and follow the instructions that is shown.");
  60. $builder->addParagraph("If you have any questions please send them to <a href=\"mailto:tests@check-policy.com\">tests@check-policy.com</a> or call <b>$admin_first_name</b> on <b>$admin_phone</b>.");
  61. $builder->addParagraph("If you are unable to submit the results via the web-based app please contact us and we can send you an offline form to complete. Please accept the test by tapping the <b>Accept</b> button and email us back saying you would like an offline form.");
  62. $content = $builder->build();
  63. // Send
  64. $mail = new Email;
  65. $mail->setHtmlContent($content);
  66. $mail->setFrom(EMAIL_CONTACT, EMAIL_FROM_NAME);
  67. $mail->addAddress($tester->email, $tester->getDisplayName());
  68. $mail->setSubject("You have been allocated a test");
  69. $mail->send();
  70. }
  71. public function sendDeclineEmail() {
  72. $tester = $this->getTester();
  73. $location = $this->getLocation();
  74. $project = $this->getProject();
  75. // Content
  76. $name = htmlspecialchars($tester->getDisplayName());
  77. $address = htmlspecialchars($location->name . ", " . $location->getDisplayAddress(["address_1", "address_2", "city", "county", "postal_code"]));
  78. $project_name = htmlspecialchars($project->name);
  79. $project_url = htmlspecialchars(PROTOCOL . "://" . DOMAIN . "/account/projects/" . $project->id);
  80. $internal_id = "N/A";
  81. if($location->internal_id) $internal_id = htmlspecialchars($location->internal_id);
  82. // Build
  83. $builder = new EmailBuilder;
  84. $builder->addParagraph("<b>Hi,</b>");
  85. $builder->addLeadParagraph("A tester has declined a test.");
  86. $builder->addParagraph("<b>Project:</b><br />$project_name");
  87. $builder->addParagraph("<b>Site:</b><br />$address<br />ID: $location->id | Internal ID: $internal_id");
  88. $builder->addParagraph("<b>Who:</b><br />$name<br />ID: $tester->id");
  89. $builder->addParagraph("<a href=\"$project_url\">Click here</a> to manage the project and reassign the test.");
  90. $content = $builder->build();
  91. // Send
  92. $mail = new Email;
  93. $mail->setHtmlContent($content);
  94. $mail->setFrom(EMAIL_NO_REPLY, EMAIL_FROM_NAME);
  95. $mail->addAddress(EMAIL_CONTACT, "Check Policy Contact");
  96. $mail->setSubject("Test declined: $project->name / $location->name");
  97. $mail->send();
  98. }
  99. public function sendResultEmail($to_address) {
  100. // Subject Format: {pass-text} - {stage-number} - Check Policy visit to: {internal-id} : {name} : {city} ({dd/mm/yyyy} {hh:mm})
  101. $location = $this->getLocation();
  102. // Content
  103. $pass_text = strtoupper($this->getPassText());
  104. $stage = $this->challenge_stage;
  105. $location_parts = [$location->internal_id, $location->name];
  106. $location_string = implode(" : ", array_filter($location_parts));
  107. $unix_start = strtotime($this->dts_start . " UTC");
  108. $date_time = date("d/m/Y H:i", $unix_start);
  109. // Attachments
  110. $pdf_path = $this->getDirectory() . "/pdf.pdf";
  111. $pdf_name = implode(" - ", array_filter([$location->internal_id, date("jS M Y")])) . ".pdf";
  112. // Build
  113. $builder = new EmailBuilder;
  114. $builder->addLeadParagraph("Congratulations!<br />A test has been completed at your location.");
  115. $builder->addParagraph("Please see attached PDF and do not hesitate to contact us if you have any questions.");
  116. $content = $builder->build();
  117. // Send
  118. $mail = new Email;
  119. $mail->setHtmlContent($content);
  120. $mail->setFrom(EMAIL_CONTACT, EMAIL_FROM_NAME);
  121. $mail->addAddress($to_address);
  122. $mail->addAttachment($pdf_path, $pdf_name);
  123. $mail->setSubject("$pass_text - $stage - Check Policy visit to: $location_string $date_time");
  124. $mail->send();
  125. }
  126. public function decline() {
  127. $this->sendDeclineEmail();
  128. $this->status = Test::STATUS_UNASSIGNED;
  129. $this->tester_id = null;
  130. $this->dts_due = null;
  131. $this->dts_assigned = null;
  132. $this->dts_updated = Util::getDateTime();
  133. return $this->commit();
  134. }
  135. public function getChallengeStageText() {
  136. if(is_null($this->challenge_stage)) return "";
  137. return Test::STAGES[$this->challenge_stage];
  138. }
  139. public function getStatusText() {
  140. return Test::STATUSES[$this->status];
  141. }
  142. public function getStatusClass() {
  143. switch($this->status) {
  144. case Test::STATUS_CANCELLED:
  145. return "secondary";
  146. case Test::STATUS_UNASSIGNED:
  147. return "danger";
  148. case Test::STATUS_ASSIGNED:
  149. case Test::STATUS_CONFIRMED:
  150. case Test::STATUS_STARTED:
  151. return "warning";
  152. case Test::STATUS_PENDING_VERIFICATION:
  153. return "primary";
  154. case Test::STATUS_COMPLETED:
  155. return "success";
  156. }
  157. }
  158. public function getProject() {
  159. return Project::get($this->project_id);
  160. }
  161. public function getLocation() {
  162. return Location::get($this->location_id);
  163. }
  164. public function getTester() {
  165. return User::get($this->tester_id);
  166. }
  167. public function getVerifier() {
  168. return User::get($this->verifier_id);
  169. }
  170. public function getValues($as_assoc_array = false) {
  171. $rows = TestValue::query(["test_id" => $this->id]);
  172. if($as_assoc_array) {
  173. $k = array_column($rows, "name");
  174. $v = array_column($rows, "value");
  175. $values = array_combine($k, $v);
  176. }
  177. else {
  178. $values = $rows;
  179. }
  180. return $values;
  181. }
  182. public function getDirectory() {
  183. $directory = ROOT_DIR . "/files/tests/" . $this->id;
  184. if($this->project_id == "PRACTICE") {
  185. $directory = ROOT_DIR . "/files/users/$this->tester_id/practice_tests/$this->template_id";
  186. }
  187. if(!file_exists($directory)) mkdir($directory, 0777, true);
  188. return $directory;
  189. }
  190. public function getDuration() {
  191. if(is_null($this->dts_end)) return false;
  192. $seconds = Util::getDurationFromDTS($this->dts_start, $this->dts_end);
  193. return $seconds;
  194. }
  195. public function getDisplayDuration() {
  196. $secs = $this->getDuration();
  197. $mins = floor($secs / 60);
  198. $secs = $secs % 60;
  199. return "$mins min. $secs sec.";
  200. }
  201. public function getPassClass() {
  202. if(is_null($this->pass)) return "secondary";
  203. return $this->pass ? "success" : "danger";
  204. }
  205. public function getPassIcon() {
  206. if(is_null($this->pass)) return "clock";
  207. return $this->pass ? "check-circle" : "times-circle";
  208. }
  209. public function getPassText() {
  210. if(is_null($this->pass)) return "Pending";
  211. return $this->pass ? "Pass" : "Fail";
  212. }
  213. public function getPDF() {
  214. $id = $this->id;
  215. $output = false;
  216. require ROOT_DIR . "/controllers/test_pdf.php";
  217. return $pdf;
  218. }
  219. public function assignTester($tester) {
  220. $this->tester_id = $tester->id;
  221. $this->dts_assigned = Util::getDateTime();
  222. $success = $this->commit();
  223. // TODO: Notify tester
  224. return $success;
  225. }
  226. }
  227. ?>