Skip to content
Snippets Groups Projects
Commit 451fc97f authored by Alex Barth's avatar Alex Barth
Browse files

Add comments.

parent 7b66cabe
No related branches found
No related tags found
No related merge requests found
......@@ -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;
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment