lib/iface.Messagelist.php

   1 <?php
   2 /**
   3  * Messagelist backend interface
   4  *
   5  * @author Anthony Parsons (xmpp:ant@specialops.ath.cx)
   6  * @license file://COPYING
   7  * @version $Id$
   8  */
   9 interface Messagelist
  10 {
  11         /**
  12          * Get a topic ID, the message list layout, where to start and do something with it all.
  13          * @param int $topicid Topic ID to get
  14          * @param msglist $mv Messagelist object to use for output
  15          * @param int $tpp Number of messages per page, if possible
  16          * @param int $page Page number (zero index)
  17          */
  18         function __construct($topicid, msglist $mv, $mpp, $page);
  19
  20         /**
  21          * Output the messagelist using $mv.
  22          * @return null
  23          */
  24         public function display();
  25
  26         /**
  27          * Return (not echo) list of pages in a XHTML dd format (with no dl tags)
  28          *
  29          * If the class can't handle pages for whatever reason, then return null instead.
  30          * @return string|null
  31          */
  32         public function pagelist();
  33 }
  34 ?>