wcfsetup/install/files/lib/data/IMessageQuickReplyAction.class.php

   1 <?php
   2 namespace wcf\data;
   3
   4 /**
   5  * Default interface for actions implementing quick reply.
   6  *
   7  * @author      Alexander Ebert
   8  * @copyright   2001-2014 WoltLab GmbH
   9  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  10  * @package     com.woltlab.wcf
  11  * @subpackage  data
  12  * @category    Community Framework
  13  */
  14 interface IMessageQuickReplyAction {
  15         /**
  16          * Creates a new message object.
  17          *
  18          * @return      \wcf\data\DatabaseObject
  19          */
  20         public function create();
  21
  22         /**
  23          * Returns a message list object.
  24          *
  25          * @param       \wcf\data\DatabaseObject                $container
  26          * @param       integer                         $lastMessageTime
  27          * @return      \wcf\data\DatabaseObjectList
  28          */
  29         public function getMessageList(DatabaseObject $container, $lastMessageTime);
  30
  31         /**
  32          * Returns page no for given container object.
  33          *
  34          * @param       \wcf\data\DatabaseObject                $container
  35          * @return      array
  36          */
  37         public function getPageNo(DatabaseObject $container);
  38
  39         /**
  40          * Returns the redirect url.
  41          *
  42          * @param       \wcf\data\DatabaseObject                $container
  43          * @param       \wcf\data\DatabaseObject                $message
  44          * @return      string
  45          */
  46         public function getRedirectUrl(DatabaseObject $container, DatabaseObject $message);
  47
  48         /**
  49          * Validates the message.
  50          *
  51          * @param       \wcf\data\DatabaseObject                $container
  52          * @param       string                          $message
  53          */
  54         public function validateMessage(DatabaseObject $container, $message);
  55
  56         /**
  57          * Creates a new message and returns it.
  58          *
  59          * @return      array
  60          */
  61         public function quickReply();
  62
  63         /**
  64          * Validates the container object for quick reply.
  65          *
  66          * @param       \wcf\data\DatabaseObject                $container
  67          */
  68         public function validateContainer(DatabaseObject $container);
  69
  70         /**
  71          * Validates parameters for quick reply.
  72          */
  73         public function validateQuickReply();
  74 }