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

   1 <?php
   2
   3 namespace wcf\data;
   4
   5 /**
   6  * Default interface for message action classes supporting quotes.
   7  *
   8  * @author  Alexander Ebert
   9  * @copyright   2001-2019 WoltLab GmbH
  10  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  11  * @package WoltLabSuite\Core\Data
  12  */
  13 interface IMessageQuoteAction
  14 {
  15     /**
  16      * Validates parameters to return a parsed template of all associated quotes.
  17      */
  18     public function validateGetRenderedQuotes();
  19
  20     /**
  21      * Returns the parsed template for all associated quotes.
  22      *
  23      * @return  array
  24      */
  25     public function getRenderedQuotes();
  26
  27     /**
  28      * Validates parameters to quote an entire message.
  29      */
  30     public function validateSaveFullQuote();
  31
  32     /**
  33      * Quotes an entire message.
  34      *
  35      * @return  array
  36      */
  37     public function saveFullQuote();
  38
  39     /**
  40      * Validates parameters to save a quote.
  41      */
  42     public function validateSaveQuote();
  43
  44     /**
  45      * Saves the quote message and returns the number of stored quotes.
  46      *
  47      * @return  array
  48      */
  49     public function saveQuote();
  50 }