You are here

Home » API reference » Feed Import 7.3

README.txt in Feed Import 7.3

Same filename in this branch
  1. 7.3 README.txt
  2. 7.3 feed_import_base/README.txt
  3. 7.3 feed_import_base/filters/README.txt
Same filename and directory in other branches
  1. 8 feed_import_base/README.txt
FEED IMPORT BASE

Project page: https://drupal.org/project/feed_import
Developers info: https://drupal.org/node/2190383

------------------------------
About Feed Import Base
------------------------------

This module provides basic import functionality and abstractization supporting
all entity types.

The reader (source)
----------
Reader's job is to fetch content from a resource and map it to values by paths.
By default there are 6 provided readers:
  -XML files - XPATH mapped
  -XML Chunked for huge xml files - XPATH mapped
  -DomDocument XML/HTML - XPATH mapped
  -CSV fiels - Column name or index mapped
  -JSON files - Path to value mapped
  -SQL databases - Column name mapped


The Hash Manager
----------------
Used to monitor imported items for update/delete.
This module provides only an SQL based Hash Manager.


The filter
----------
Used to filter values. This module provides a powerful filter class.


The processor
-------------
The processor takes care of all import process.
This module provides just one processor compatibile with all readers.


Hooks
-------------
There are two hooks you could implement:

hook_feed_import_error($error_type, $feed, $report)

$error_type - an integer indicationg error type.
Can be one of the following constant from FeedImport class:
FEED_OVERLAP_ERR - overlap error
FEED_ITEMS_ERR   - few items error
FEED_SOURCE_ERR  - source error
FEED_CONFIG_ERR  - configuration error

$feed - feed configuration
$report - report info

hook_feed_import_success($feed, $report)
$feed - feed configuration
$report - report info

These hooks will not be called if variable feed_import_invoke_hooks
is set to false.

File

feed_import_base/README.txt
View source 
  1. FEED IMPORT BASE

  2. 

  3. Project page: https://drupal.org/project/feed_import

  4. Developers info: https://drupal.org/node/2190383

  5. 

  6. ------------------------------

  7. About Feed Import Base

  8. ------------------------------

  9. 

  10. This module provides basic import functionality and abstractization supporting

  11. all entity types.

  12. 

  13. The reader (source)

  14. ----------

  15. Reader's job is to fetch content from a resource and map it to values by paths.

  16. By default there are 6 provided readers:

  17.   -XML files - XPATH mapped

  18.   -XML Chunked for huge xml files - XPATH mapped

  19.   -DomDocument XML/HTML - XPATH mapped

  20.   -CSV fiels - Column name or index mapped

  21.   -JSON files - Path to value mapped

  22.   -SQL databases - Column name mapped

  23. 

  24. 

  25. The Hash Manager

  26. ----------------

  27. Used to monitor imported items for update/delete.

  28. This module provides only an SQL based Hash Manager.

  29. 

  30. 

  31. The filter

  32. ----------

  33. Used to filter values. This module provides a powerful filter class.

  34. 

  35. 

  36. The processor

  37. -------------

  38. The processor takes care of all import process.

  39. This module provides just one processor compatibile with all readers.

  40. 

  41. 

  42. Hooks

  43. -------------

  44. There are two hooks you could implement:

  45. 

  46. hook_feed_import_error($error_type, $feed, $report)

  47. 

  48. $error_type - an integer indicationg error type.

  49. Can be one of the following constant from FeedImport class:

  50. FEED_OVERLAP_ERR - overlap error

  51. FEED_ITEMS_ERR   - few items error

  52. FEED_SOURCE_ERR  - source error

  53. FEED_CONFIG_ERR  - configuration error

  54. 

  55. $feed - feed configuration

  56. $report - report info

  57. 

  58. hook_feed_import_success($feed, $report)

  59. $feed - feed configuration

  60. $report - report info

  61. 

  62. These hooks will not be called if variable feed_import_invoke_hooks

  63. is set to false.