From 451fc97ff1c07fd24f0d1c4e0ae539e5f6c31f72 Mon Sep 17 00:00:00 2001
From: Alex Barth <alex_b@53995.no-reply.drupal.org>
Date: Wed, 16 Sep 2009 23:32:31 +0000
Subject: [PATCH] Add comments.
---
includes/feed.inc | 38 +++++++++++++++++++++++++++++++++++++-
1 file changed, 37 insertions(+), 1 deletion(-)
diff --git a/includes/feed.inc b/includes/feed.inc
index 5aec3ff5..fd4953d0 100644
--- a/includes/feed.inc
+++ b/includes/feed.inc
@@ -339,6 +339,8 @@ class FeedsFetcher extends FeedsConfigurable {
*
* @param $source
* Source value as entered by user through sourceForm().
+ *
+ * @todo: Define format of return value?
*/
public function fetch($source) {
return NULL;
@@ -349,9 +351,28 @@ class FeedsFetcher extends FeedsConfigurable {
* Abstract class, defines interface for parsers.
*/
class FeedsParser extends FeedsConfigurable {
+
+ /**
+ * Parse content fetched by fetcher.
+ *
+ * Stub method. Extending classes must implement this method.
+ *
+ * @param $raw
+ * Content returned by fetcher.
+ * @return
+ * A parsed array.
+ * @todo: define this array (object?).
+ */
public function parse($raw) {
return NULL;
}
+
+ /**
+ * Declare the possible mapping sources that this parser produces.
+ *
+ * @return
+ * An array of mapping sources.
+ */
public function getMappingSources() {
return NULL;
}
@@ -361,9 +382,24 @@ class FeedsParser extends FeedsConfigurable {
* Abstract class, defines interface for processors.
*/
class FeedsProcessor extends FeedsConfigurable {
+
+ /**
+ * Process the result of the parser or previous processors.
+ *
+ * Stub method. Extending classes must implement this method.
+ *
+ * @param $feed
+ * Result returned by parser.
+ */
public function process($feed) {
- return NULL;
}
+
+ /**
+ * Declare possible mapping targets.
+ *
+ * @return
+ * An array of mapping targets.
+ */
public function getMappingTargets() {
return NULL;
}
--
GitLab