Miscelaneous

The file include/utils.php provides a some additional functionality to the rest of the system.

The class <php>HttpException</php> provides an interface to propagate errors that correspond to a HTTP status upstream into the view's pipeline.

The <php>HttpException</php> constructor has the signature <php>__construct($status=500, $message=null, $html_message=null, $code=0)</php>, where <php>$status</php> is the HTTP status code, <php>$message</php> is the plain text error message and <php>$html_message</php> is a HTML representation of the error message. The <php>$code</php> parameter corresponds to the <php>$code</php> parameter of the default <php>Exception</php> implementation.

Please note that the <php>$html_message</php> should/will be rendered unescaped, so use this carefully.

<php>get_committee_email($login)</php> is a simple function that turns a committee login into that committees email address.

<php>send_mail($from, $to, $body, $subject=null, array $headers=[])</php> is a wrapper function for PHP's <php>mail</php> function. It's main goal is to remove some overhead of setting the right content-type headers. If no subject is provided, it also searches the body for a HTML <title> element and takes that as the subject. The following snippet shows how to use this function to send an email with a rendered template as body.

<PHP> $template = new Template('templates/email.phtml', $context);

$success = send_mail(

  ADMIN_EMAIL, // Sender is the admin emailaddress
  filter_var($context['email'], FILTER_SANITIZE_EMAIL), // Receiver is grabbed from $context
  $template->render(),
  null, // Subject is set in the <title> attribute in the template
  ['Bcc: ' . ADMIN_EMAIL] // Add Bcc header to send a copy to the admins

);

Determine wether email has ben send succesfully if (!$success) throw new HttpException(500, 'An error occurred when sending an email.'); </PHP> ===== Template ===== The implementation of the <php>Template</php> class also resides in include/utils.php. This has been extensively discussed here.