includes/rcfeed/RCFeedFormatter.php

   1 <?php
   2
   3 /**
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  * http://www.gnu.org/copyleft/gpl.html
  18  *
  19  * @file
  20  */
  21
  22 /**
  23  * Interface for RC feed formatters
  24  *
  25  * @since 1.22
  26  */
  27 interface RCFeedFormatter {
  28         /**
  29          * Formats the line to be sent by an engine
  30          *
  31          * @param array $feed The feed, as configured in an associative array.
  32          * @param RecentChange $rc The RecentChange object showing what sort
  33          *                         of event has taken place.
  34          * @param string|null $actionComment
  35          * @return string|null The text to send.  If the formatter returns null,
  36          *  the line will not be sent.
  37          */
  38         public function getLine( array $feed, RecentChange $rc, $actionComment );
  39 }