| Both sides previous revisionPrevious revision | |
| documentation:rack:reference:misc [2022/04/03 14:00] – external edit 127.0.0.1 | documentation:rack:reference:misc [2023/08/31 21:16] (current) – Martijn Luinstra |
|---|
| ===== HttpException ===== | ===== HttpException ===== |
| |
| The class <php>HttpException</php> provides an interface to propagate errors that correspond to a HTTP status upstream into the view's pipeline. | The class ''HttpException'' 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. | The ''HttpException'' constructor has the signature ''%%__construct($status=500, $message=null, $html_message=null, $code=0)%%'', where ''%%$status%%'' is the HTTP status code, ''%%$message%%'' is the plain text error message and ''%%$html_message%%'' is a HTML representation of the error message. The ''%%$code%%'' parameter corresponds to the ''%%$code%%'' parameter of the default ''%%Exception%%'' implementation. |
| |
| Please note that the <php>$html_message</php> should/will be rendered unescaped, so use this carefully. | Please note that the ''%%$html_message%%'' should/will be rendered unescaped, so use this carefully. |
| |
| |
| ===== get_committee_email ===== | ===== get_committee_email ===== |
| |
| <php>get_committee_email($login)</php> is a simple function that turns a committee login into that committees email address. | ''%%get_committee_email($login)%%'' is a simple function that turns a committee login into that committees email address. |
| |
| ===== send_mail ===== | ===== send_mail ===== |
| |
| <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. | ''%%send_mail($from, $to, $body, $subject=null, array $headers=[])%%'' is a wrapper function for PHP's ''%%mail%%'' function. Its 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> | <code php> |
| $template = new Template('templates/email.phtml', $context); | $template = new Template('templates/email.phtml', $context); |
| |
| if (!$success) | if (!$success) |
| throw new HttpException(500, 'An error occurred when sending an email.'); | throw new HttpException(500, 'An error occurred when sending an email.'); |
| </PHP> | </code> |
| |
| |
| ===== Template ===== | ===== Template ===== |
| |
| The implementation of the <php>Template</php> class also resides in ''include/utils.php''. This has been extensively discussed [[documentation:rack:reference:templates|here]]. | The implementation of the ''Template'' class also resides in ''include/utils.php''. This has been extensively discussed [[documentation:rack:reference:templates|here]]. |