summaryrefslogtreecommitdiff
path: root/includes/rcfeed/RCFeedEngine.php
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@sbcglobal.net>2016-05-01 15:12:12 -0400
committerLuke Shumaker <lukeshu@sbcglobal.net>2016-05-01 15:12:12 -0400
commitc9aa36da061816dee256a979c2ff8d2ee41824d9 (patch)
tree29f7002b80ee984b488bd047dbbd80b36bf892e9 /includes/rcfeed/RCFeedEngine.php
parentb4274e0e33eafb5e9ead9d949ebf031a9fb8363b (diff)
parentd1ba966140d7a60cd5ae4e8667ceb27c1a138592 (diff)
Merge branch 'archwiki'
# Conflicts: # skins/ArchLinux.php # skins/ArchLinux/archlogo.gif
Diffstat (limited to 'includes/rcfeed/RCFeedEngine.php')
-rw-r--r--includes/rcfeed/RCFeedEngine.php33
1 files changed, 29 insertions, 4 deletions
diff --git a/includes/rcfeed/RCFeedEngine.php b/includes/rcfeed/RCFeedEngine.php
index f733bcb7..0b0cd869 100644
--- a/includes/rcfeed/RCFeedEngine.php
+++ b/includes/rcfeed/RCFeedEngine.php
@@ -1,12 +1,37 @@
<?php
+
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Interface for RC feed engines, which send formatted notifications
+ *
+ * @since 1.22
+ */
interface RCFeedEngine {
/**
* Sends some text to the specified live feed.
*
- * @see RecentChange::cleanupForIRC
- * @param array $feed The feed, as configured in an associative array.
- * @param string $line The text to send.
- * @return boolean success
+ * @see IRCColourfulRCFeedFormatter::cleanupForIRC
+ * @param array $feed The feed, as configured in an associative array
+ * @param string $line The text to send
+ * @return bool Success
*/
public function send( array $feed, $line );
}