diff options
Diffstat (limited to 'modules/aggregator/aggregator.api.php')
| -rw-r--r-- | modules/aggregator/aggregator.api.php | 72 |
1 files changed, 34 insertions, 38 deletions
diff --git a/modules/aggregator/aggregator.api.php b/modules/aggregator/aggregator.api.php index ea1192760..0f708eb85 100644 --- a/modules/aggregator/aggregator.api.php +++ b/modules/aggregator/aggregator.api.php @@ -11,21 +11,21 @@ */ /** - * Implement this hook to create an alternative fetcher for aggregator module. + * Create an alternative fetcher for aggregator.module. * - * A fetcher downloads feed data to a Drupal site. The fetcher is called - * at the first of the three aggregation stages: data is downloaded by the - * active fetcher, it is converted to a common format by the active parser and - * finally, it is passed to all active processors which manipulate or store the - * data. + * A fetcher downloads feed data to a Drupal site. The fetcher is called at the + * first of the three aggregation stages: first, data is downloaded by the + * active fetcher; second, it is converted to a common format by the active + * parser; and finally, it is passed to all active processors, which manipulate + * or store the data. * * Modules that define this hook can be set as active fetcher on * admin/config/services/aggregator. Only one fetcher can be active at a time. * * @param $feed - * The $feed object that describes the resource to be downloaded. - * $feed->url contains the link to the feed. Download the data at the URL - * and expose it to other modules by attaching it to $feed->source_string. + * A feed object representing the resource to be downloaded. $feed->url + * contains the link to the feed. Download the data at the URL and expose it + * to other modules by attaching it to $feed->source_string. * * @return * TRUE if fetching was successful, FALSE otherwise. @@ -41,8 +41,7 @@ function hook_aggregator_fetch($feed) { } /** - * Implement this hook to expose the title and a short description of your - * fetcher. + * Specify the title and short description of your fetcher. * * The title and the description provided are shown on * admin/config/services/aggregator among other places. Use as title the human @@ -68,19 +67,19 @@ function hook_aggregator_fetch_info() { } /** - * Implement this hook to create an alternative parser for aggregator module. + * Create an alternative parser for aggregator module. * * A parser converts feed item data to a common format. The parser is called - * at the second of the three aggregation stages: data is downloaded by the - * active fetcher, it is converted to a common format by the active parser and - * finally, it is passed to all active processors which manipulate or store the - * data. + * at the second of the three aggregation stages: first, data is downloaded + * by the active fetcher; second, it is converted to a common format by the + * active parser; and finally, it is passed to all active processors which + * manipulate or store the data. * * Modules that define this hook can be set as the active parser on * admin/config/services/aggregator. Only one parser can be active at a time. * * @param $feed - * An object describing the resource to be parsed: $feed->source_string + * An object describing the resource to be parsed. $feed->source_string * contains the raw feed data. The hook implementation should parse this data * and add the following properties to the $feed object: * - description: The human-readable description of the feed. @@ -118,8 +117,7 @@ function hook_aggregator_parse($feed) { } /** - * Implement this hook to expose the title and a short description of your - * parser. + * Specify the title and short description of your parser. * * The title and the description provided are shown on * admin/config/services/aggregator among other places. Use as title the human @@ -145,23 +143,23 @@ function hook_aggregator_parse_info() { } /** - * Implement this hook to create a processor for aggregator module. + * Create a processor for aggregator.module. * * A processor acts on parsed feed data. Active processors are called at the - * third and last of the aggregation stages: data is downloaded by the active - * fetcher, it is converted to a common format by the active parser and - * finally, it is passed to all active processors which manipulate or store the - * data. + * third and last of the aggregation stages: first, data is downloaded by the + * active fetcher; second, it is converted to a common format by the active + * parser; and finally, it is passed to all active processors that manipulate or + * store the data. * * Modules that define this hook can be activated as processor on * admin/config/services/aggregator. * * @param $feed - * The $feed object that describes the resource to be processed. $feed->items - * contains an array of feed items downloaded and parsed at the parsing - * stage. See hook_aggregator_parse() for the basic format of a single item - * in the $feed->items array. For the exact format refer to the particular - * parser in use. + * A feed object representing the resource to be processed. $feed->items + * contains an array of feed items downloaded and parsed at the parsing stage. + * See hook_aggregator_parse() for the basic format of a single item in the + * $feed->items array. For the exact format refer to the particular parser in + * use. * * @see hook_aggregator_process_info() * @see hook_aggregator_fetch() @@ -176,17 +174,16 @@ function hook_aggregator_process($feed) { } /** - * Implement this hook to expose the title and a short description of your - * processor. + * Specify the title and short description of your processor. * * The title and the description provided are shown most importantly on * admin/config/services/aggregator. Use as title the natural name of the - * processor and as description a brief (40 to 80 characters) explanation of - * the functionality. + * processor and as description a brief (40 to 80 characters) explanation of the + * functionality. * - * This hook is only called if your module implements - * hook_aggregator_process(). If this hook is not implemented aggregator - * will use your module's file name as title and there will be no description. + * This hook is only called if your module implements hook_aggregator_process(). + * If this hook is not implemented aggregator will use your module's file name + * as title and there will be no description. * * @return * An associative array defining a title and a description string. @@ -203,8 +200,7 @@ function hook_aggregator_process_info($feed) { } /** - * Implement this hook to remove stored data if a feed is being deleted or a - * feed's items are being removed. + * Remove stored feed data. * * Aggregator calls this hook if either a feed is deleted or a user clicks on * "remove items". |