lib/iface.Message3.php

   1 <?php
   2 /**
   3  * Message filter module interface.
   4  *
   5  * @author Ant P. <xmpp:ant@specialops.ath.cx>
   6  * @version 3.0
   7  * @license http://specialops.ath.cx/repos/so2/trunk/COPYING
   8  */
   9 interface Message3 {
  10 //      /* Do normal XHTML checking and nl2br (default) */
  11         const HTML_FILTER = 0x0;
  12         /* Don't automatically add linebreaks */
  13         const HTML_RAW    = 0x1;
  14         // Plaintext or full-html stuff should be handled by the filter module
  15
  16         /**
  17          * Constructor
  18          *
  19          * @param string $input HTML string to check, usually a $_POST value
  20          * @param int $formatting Formatting flags to use
  21          */
  22         function __construct($input, $formatting = null);
  23
  24         /**
  25          * Check input syntax, if invalid throw an InvalidInputException saying why.
  26          */
  27         function validate();
  28
  29         /**
  30          * Get processed input back.
  31          *
  32          * @return null|string Null if an unrecoverable error occured
  33          */
  34         function getOutput();
  35 }
  36 ?>