"Cancelled",
1 => "Unassigned",
2 => "Assigned",
3 => "Confirmed",
4 => "Started",
8 => "Pending Verification",
16 => "Completed",
];
const STATUSES_TESTER_INVOICE = [
Test::STATUS_TESTER_INVOICE_NONE,
Test::STATUS_TESTER_INVOICE_PENDING,
Test::STATUS_TESTER_INVOICE_PAID
];
const STAGES = [
0 => "",
1 => "Challenge on entry",
2 => "Challenge while browsing",
3 => "Challenge during play",
4 => "Challenge on exit",
5 => "No challenge",
];
const TEST_TIME_ANYTIME = 1;
const TEST_TIME_DAY = 2;
const TEST_TIME_NIGHT = 3;
// Static methods
public static function getStatusTesterInvoiceText($status) {
switch($status) {
case Test::STATUS_TESTER_INVOICE_NONE:
return __("No Invoice Generated");
case Test::STATUS_TESTER_INVOICE_PENDING:
return __("Pending Payment");
case Test::STATUS_TESTER_INVOICE_PAID:
return __("Paid");
}
return __("Unknown");
}
public static function getStatusTesterInvoiceClass($status) {
switch($status) {
case Test::STATUS_TESTER_INVOICE_NONE:
return "secondary";
case Test::STATUS_TESTER_INVOICE_PENDING:
return "warning";
case Test::STATUS_TESTER_INVOICE_PAID:
return "success";
}
return "";
}
public static function exportCSV($processing_file, $tests = []) {
// Preload
Project::load(array_column($tests, "project_id"));
Location::load(array_column($tests, "location_id"));
User::load(array_column($tests, "tester_id"));
// Get processing file
$processing_file_path = ROOT_DIR . "/export_processing/{$processing_file}";
if(!file_exists($processing_file_path)) throw new Exception("Processing file not found.");
// Output
HTTP::setDownloadHeaders("export.csv");
$handle = fopen("php://output", "w");
require $processing_file_path;
fclose($handle);
}
// Object methods
public function sendAssignEmail($message) {
$tester = $this->getTester();
$location = $this->getLocation();
$project = $this->getProject();
// Content
$name = htmlspecialchars($tester->first_name);
$message = htmlspecialchars($message);
$base_url = htmlspecialchars(PROTOCOL . "://" . DOMAIN . "/account/tests/" . $this->id);
$address = htmlspecialchars($location->name . ", " . $location->getDisplayAddress(["address_1", "address_2", "city", "county", "postal_code"]));
$date_due = date("j M Y", strtotime($this->dts_due));
$admin_first_name = htmlspecialchars(Core::$user->first_name);
$admin_phone = htmlspecialchars(Core::$user->phone);
// Build
$builder = new EmailBuilder;
$builder->addParagraph("" . sprintf(__("Hi %s"), $name) . "");
$builder->addLeadParagraph(__("Congrats, you have been allocated a test!"));
if($project->isNighttime()) {
$builder->addParagraph("" . __("Evening Test to be done between 7PM and midnight.") . "");
}
if($message) {
$builder->addParagraph($message);
}
$builder->addParagraph(sprintf(__("We need you to confirm if you are able to do the test. Please check the details below and then confirm by pressing the %sAccept%s or %sDecline%s buttons and once you tap %sAccept%s, the test will be allocated to you."),
'', '',
'', '',
'', ''
));
$builder->addAcceptDeclineButtons($base_url);
$builder->addParagraph(sprintf(__("The site address is: %s"), "{$address}"));
$builder->addParagraph(sprintf(__("The date that need to complete and submit the results by is: %s"), "$date_due"));
$builder->addParagraph(sprintf(__("For methodology and further notes please check the %sUseful Documents%s section on the %sAccount%s page."),
'', '',
'', ''
));
$builder->addParagraph(sprintf(__("If you agree to conduct the test, log in and then go to %sTests%s where you will be able to see the tests available to you. Please tap the %sBegin%s button and follow the instructions that is shown."),
'', '',
'', ''
));
$builder->addParagraph(sprintf(__("If you have any questions please send them to %s or call %s on %s."),
"tests@check-policy.com",
"$admin_first_name",
"$admin_phone"
));
$builder->addParagraph(sprintf(__("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 %sAccept%s button and email us back saying you would like an offline form."),
'', ''
));
$content = $builder->build();
// Send
$mail = new Email;
$mail->setHtmlContent($content);
$mail->setFrom(EMAIL_CONTACT, EMAIL_FROM_NAME);
$mail->addAddress($tester->email, $tester->getDisplayName());
$mail->setSubject(__("You have been allocated a test"));
$mail->send();
}
public function sendClaimedEmail() {
$tester = $this->getTester();
$location = $this->getLocation();
$project = $this->getProject();
// Content
$name = htmlspecialchars($tester->first_name);
$address = htmlspecialchars($location->name . ", " . $location->getDisplayAddress(["address_1", "address_2", "city", "county", "postal_code"]));
$date_due = date("j M Y", strtotime($this->dts_due));
// Build
$builder = new EmailBuilder;
$builder->addParagraph("" . sprintf(__("Hi %s"), $name) . "");
$builder->addLeadParagraph(__("Congrats, you have claimed a test!"));
if($project->isNighttime()) {
$builder->addParagraph("" . __("Evening Test to be done between 7PM and midnight.") . "");
}
$builder->addParagraph(sprintf(__("The site address is: %s"), "$address"));
$builder->addParagraph(sprintf(__("The date that need to complete and submit the results by is: %s"), "$date_due"));
$builder->addParagraph(sprintf(__("For methodology and further notes please check the %sUseful Documents%s section on the %sAccount%s page."),
'', '',
'', ''
));
$builder->addParagraph(sprintf(__("Log in and then go to %sTests%s where you will be able to see the tests available to you. Please tap the %sBegin%s button and follow the instructions that is shown."),
'', '',
'', ''
));
$builder->addParagraph(sprintf(__("If you have any questions please send them to %s."),
"tests@check-policy.com"
));
$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."));
$content = $builder->build();
// Send
$mail = new Email;
$mail->setHtmlContent($content);
$mail->setFrom(EMAIL_CONTACT, EMAIL_FROM_NAME);
$mail->addAddress($tester->email, $tester->getDisplayName());
$mail->setSubject(__("You have claimed a test"));
$mail->send();
}
public function sendDeclineEmail() {
$tester = $this->getTester();
$location = $this->getLocation();
$project = $this->getProject();
// Content
$name = htmlspecialchars($tester->getDisplayName());
$address = htmlspecialchars($location->name . ", " . $location->getDisplayAddress(["address_1", "address_2", "city", "county", "postal_code"]));
$project_name = htmlspecialchars($project->name);
$project_url = htmlspecialchars(PROTOCOL . "://" . DOMAIN . "/account/projects/" . $project->id);
$internal_id = "N/A";
if($location->internal_id) $internal_id = htmlspecialchars($location->internal_id);
// Build
$builder = new EmailBuilder;
$builder->addParagraph("Hi,");
$builder->addLeadParagraph("A tester has declined a test.");
$builder->addParagraph("Project:
$project_name");
$builder->addParagraph("Site:
$address
ID: $location->id | Internal ID: $internal_id");
$builder->addParagraph("Who:
$name
ID: $tester->id");
$builder->addParagraph("Click here to manage the project and reassign the test.");
$content = $builder->build();
// Send
$mail = new Email;
$mail->setHtmlContent($content);
$mail->setFrom(EMAIL_NO_REPLY, EMAIL_FROM_NAME);
$mail->addAddress(EMAIL_CONTACT, APP_NAME . " Contact");
$mail->setSubject("Test declined: $project->name / $location->name");
$mail->send();
}
public function sendResultEmail($to_address) {
$location = $this->getLocation();
$project = $this->getProject();
$template = $project->getTemplate();
$subject_format_file_path = $template->getProcessingFilePath("result_email_subject_format.txt");
$subject_format = file_get_contents($subject_format_file_path);
// Content
$pass_text = strtoupper($this->getPassText());
$stage = $this->challenge_stage;
$location_parts = [$location->internal_id, $location->name];
$location_string = implode(" : ", array_filter($location_parts));
$unix_start = strtotime($this->dts_start . " UTC");
$date_time = date("d/m/Y H:i", $unix_start);
// Subject
$search_replace = [
"{pass}" => $pass_text,
"{stage}" => $stage,
"{location}" => $location_string,
"{date-time}" => $date_time,
];
$subject = str_replace(
array_keys($search_replace),
array_values($search_replace),
$subject_format
);
// Attachments
$pdf_path = $this->getDirectory() . "/pdf.pdf";
$pdf_name = implode(" - ", array_filter([$location->internal_id, date("jS M Y")])) . ".pdf";
// Lead paragraph
$lead_paragraph = "";
if($this->pass) {
$lead_paragraph .= "Congratulations!
";
}
$lead_paragraph .= "A test has been completed at your location.";
// Build
$builder = new EmailBuilder;
$builder->addLeadParagraph($lead_paragraph);
$builder->addParagraph("Please see attached PDF and do not hesitate to contact us if you have any questions.");
$content = $builder->build();
// Send
$mail = new Email;
$mail->setHtmlContent($content);
$mail->setFrom(EMAIL_CONTACT, EMAIL_FROM_NAME);
$mail->addAddress($to_address);
$mail->addAttachment($pdf_path, $pdf_name);
$mail->setSubject($subject);
$mail->send();
}
public function decline() {
$this->sendDeclineEmail();
$this->status = Test::STATUS_UNASSIGNED;
$this->tester_id = null;
$this->dts_due = null;
$this->dts_assigned = null;
$this->dts_updated = Util::getDateTime();
return $this->commit();
}
public function getChallengeStageText() {
if(is_null($this->challenge_stage)) return "";
return Test::STAGES[$this->challenge_stage];
}
public function getStatusText() {
return Test::STATUSES[$this->status];
}
public function getStatusClass() {
switch($this->status) {
case Test::STATUS_CANCELLED:
return "secondary";
case Test::STATUS_UNASSIGNED:
return "danger";
case Test::STATUS_ASSIGNED:
case Test::STATUS_CONFIRMED:
case Test::STATUS_STARTED:
return "warning";
case Test::STATUS_PENDING_VERIFICATION:
return "primary";
case Test::STATUS_COMPLETED:
return "success";
}
}
public function getProject() {
return Project::get($this->project_id);
}
/**
* @return Location
*/
public function getLocation() {
return Location::get($this->location_id);
}
/**
* @return User
*/
public function getTester() {
return User::get($this->tester_id);
}
/**
* @return User
*/
public function getVerifier() {
return User::get($this->verifier_id);
}
public function getValues($as_assoc_array = false) {
$rows = TestValue::query(["test_id" => $this->id]);
if($as_assoc_array) {
$k = array_column($rows, "name");
$v = array_column($rows, "value");
$values = array_combine($k, $v);
}
else {
$values = $rows;
}
return $values;
}
public function getDirectory() {
$directory = ROOT_DIR . "/files/tests/" . $this->id;
if($this->project_id == "PRACTICE") {
$directory = ROOT_DIR . "/files/users/$this->tester_id/practice_tests/$this->template_id";
}
if(!file_exists($directory)) mkdir($directory, 0777, true);
return $directory;
}
public function getDuration() {
if(is_null($this->dts_end)) return false;
$seconds = Util::getDurationFromDTS($this->dts_start, $this->dts_end);
return $seconds;
}
public function getDisplayDuration() {
$secs = $this->getDuration();
$mins = floor($secs / 60);
$secs = $secs % 60;
return "$mins min. $secs sec.";
}
/**
* @return string Bootstrap class name
*/
public function getPassClass() {
if(is_null($this->pass)) return "secondary";
return $this->pass ? "success" : "danger";
}
/**
* @return string FA icon name without prefix
*/
public function getPassIcon() {
if(is_null($this->pass)) return "clock";
return $this->pass ? "check-circle" : "times-circle";
}
/**
* @return string Pending, Pass or Fail
*/
public function getPassText() {
if(is_null($this->pass)) return __("Pending");
return $this->pass ? __("Pass") : __("Fail");
}
public function getMPDF() {
/** @var Mpdf $mpdf */
$id = $this->id;
$output = false;
require ROOT_DIR . "/controllers/test_pdf.php";
return $mpdf;
}
/**
* @param User $tester
* @return bool
* @throws Exception
*/
public function assignTester(User $tester) {
$this->tester_id = $tester->id;
$this->dts_assigned = Util::getDateTime();
$success = $this->commit();
// TODO: Notify tester
return $success;
}
/**
* @return Test|null
* @throws Exception
*/
public function getPreviousTest(): ?Test {
$nvp = [
"dts_start" => (new Constraint("LESS_THAN"))->setValues($this->dts_start),
"location_id" => $this->location_id,
"status" => Test::STATUS_COMPLETED,
];
$tests = Test::query($nvp, [
"sort" => "dts_start",
"order" => "desc",
]);
return $tests ? $tests[0] : null;
}
/**
* @return bool
* @throws Exception
*/
public function unassignTester(): bool {
$this->status = Test::STATUS_UNASSIGNED;
$this->tester_id = null;
$this->dts_due = null;
$this->dts_assigned = null;
return $this->commit();
}
/**
* @return bool
*/
public function isPass(): bool {
if(is_null($this->pass)) return false;
return !empty($this->pass);
}
/**
* @return bool
*/
public function isPending(): bool {
return is_null($this->pass);
}
/**
* @return bool
*/
public function isFail(): bool {
if(is_null($this->pass)) return false;
return empty($this->pass);
}
/**
* @return bool
*/
public function isCompleted() {
return $this->status == Test::STATUS_COMPLETED;
}
/**
* @return bool
*/
public function isPendingVerification() {
return $this->status == Test::STATUS_PENDING_VERIFICATION;
}
/**
* @return bool
*/
public function hasPDF(): bool {
$directory = $this->getDirectory();
return file_exists($directory . "/pdf.pdf");
}
/**
* @return string
*/
public function getPDFUrl(): string {
return "/account/tests/{$this->id}/files/pdf";
}
/**
* @return bool
*/
public function hasTesterInvoicePDF(): bool {
$directory = $this->getDirectory();
return file_exists($directory . "/tester_invoice.pdf");
}
/**
* @return bool
* @throws Exception
*/
public function markTesterInvoicePaid(): bool {
if($this->status_tester_invoice == Test::STATUS_TESTER_INVOICE_PENDING) {
$this->status_tester_invoice = Test::STATUS_TESTER_INVOICE_PAID;
$this->dts_tester_invoice_paid = Util::getDateTime();
return $this->commit();
}
return false;
}
/**
* @return bool
* @throws Exception
*/
public function rejectTesterInvoice(): bool {
if($this->status_tester_invoice == Test::STATUS_TESTER_INVOICE_PENDING) {
$this->status_tester_invoice = Test::STATUS_TESTER_INVOICE_NONE;
$this->dts_tester_invoice_generated = null;
$pdf_filepath = $this->getDirectory() . "/tester_invoice.pdf";
unlink($pdf_filepath);
return $this->commit();
}
return false;
}
/**
* @return string
*/
public function getTesterInvoiceReference(): string {
$location = $this->getLocation();
$tester = $this->getTester();
return
"T" . str_pad($this->id, 3, "0", STR_PAD_LEFT) .
"/L" . str_pad($location->id, 3, "0", STR_PAD_LEFT) .
"/U" . str_pad($tester->id, 3, "0", STR_PAD_LEFT);
}
}