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

Improve importer documentation.

parent 41f3a8f9
No related branches found
No related tags found
No related merge requests found
...@@ -16,15 +16,16 @@ define('FEEDS_BATCH_COMPLETE', 1); ...@@ -16,15 +16,16 @@ define('FEEDS_BATCH_COMPLETE', 1);
define('FEEDS_BATCH_ACTIVE', 0); define('FEEDS_BATCH_ACTIVE', 0);
/** /**
* Class defining an importer object. This is the main hub for Feeds module's * A FeedsImporter object describes how an external source should be fetched,
* functionality. * parsed and processed. Feeds can manage an arbitrary amount of importers.
* *
* A FeedsImporter holds a pointer to a fetcher, a parser and a processor * A FeedsImporter holds a pointer to a FeedsFetcher, a FeedsParser and a
* plugin. It further contains the configuration for itself and each of the * FeedsProcessor plugin. It further contains the configuration for itself and
* three plugins. * each of the three plugins.
* *
* Its most important responsibilities are configuration management and expiring * Its most important responsibilities are configuration management, interfacing
* of all items produced by this importer. * with FeedsScheduler class and expiring of all items produced by this
* importer.
* *
* When a FeedsImporter is instantiated, it loads its configuration. Then it * When a FeedsImporter is instantiated, it loads its configuration. Then it
* instantiates one fetcher, one parser and one processor plugin depending on * instantiates one fetcher, one parser and one processor plugin depending on
......
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