lib/iface.Messagelist.php

   1 <?php
   2 /**
   3  * Messagelist structure interface
   4  *
   5  * @author Ant P <p@cpi.merseine.nu>
   6  * @license file://../COPYING
   7  * @version 2.15
   8  */
   9 interface Messagelist
  10 {
  11     const MODMSG = '<span class="deletedmsg">[Message below your minimum score setting (%d)]</span>';
  12
  13     /**
  14      * Get a topic ID, the message list layout, where to start and do something with it all.
  15      * @param int $topicid Topic ID to get
  16      * @param msglist $mv Messagelist object to use for output
  17      * @param int $tpp Number of messages per page, if possible
  18      * @param int $page Page number (zero index)
  19      */
  20     function __construct($topicid, Messagestyle $mo, $mpp, $page);
  21
  22     /**
  23      * Output the messagelist using the style module passed to the constructor.
  24      * @return null
  25      */
  26     public function display();
  27
  28     /**
  29      * Return (not echo) list of pages in a XHTML dd format (with no dl tags)
  30      *
  31      * If the class can't handle pages for whatever reason, this should return null.
  32      * @return string|null
  33      */
  34     public function pagelist();
  35 }
  36 ?>