/drupal7/sites/all/modules/feeds/feeds.api.php - Club Drupal - Forge Centrale Marseille

root / drupal7 / sites / all / modules / feeds / feeds.api.php @ 41cc1b08

       <?php
       /**
        * @file
        * Documentation of Feeds hooks.
        */
       /**
        * Feeds offers a CTools based plugin API. Fetchers, parsers and processors are
        * declared to Feeds as plugins.
+       *
        * @see feeds_feeds_plugins()
        * @see FeedsFetcher
        * @see FeedsParser
        * @see FeedsProcessor
+       *
        * @defgroup pluginapi Plugin API
        * @{
        */
       /**
        * Example of a CTools plugin hook that needs to be implemented to make
        * hook_feeds_plugins() discoverable by CTools and Feeds. The hook specifies
        * that the hook_feeds_plugins() returns Feeds Plugin API version 1 style
        * plugins.
        */
       function hook_ctools_plugin_api($owner, $api) {
         if ($owner == 'feeds' && $api == 'plugins') {
           return array('version' => 1);
+        }
+      }
       /**
        * A hook_feeds_plugins() declares available Fetcher, Parser or Processor
        * plugins to Feeds. For an example look at feeds_feeds_plugin(). For exposing
        * this hook hook_ctools_plugin_api() MUST be implemented, too.
+       *
        * @see feeds_feeds_plugin()
        */
       function hook_feeds_plugins() {
         $info = array();
         $info['MyFetcher'] = array(
           'name' => 'My Fetcher',
           'description' => 'Fetches my stuff.',
           'help' => 'More verbose description here. Will be displayed on fetcher selection menu.',
           'handler' => array(
             'parent' => 'FeedsFetcher',
             'class' => 'MyFetcher',
             'file' => 'MyFetcher.inc',
             'path' => drupal_get_path('module', 'my_module'), // Feeds will look for MyFetcher.inc in the my_module directory.
           ),
         );
         $info['MyParser'] = array(
           'name' => 'ODK parser',
           'description' => 'Parse my stuff.',
           'help' => 'More verbose description here. Will be displayed on parser selection menu.',
           'handler' => array(
             'parent' => 'FeedsParser', // Being directly or indirectly an extension of FeedsParser makes a plugin a parser plugin.
             'class' => 'MyParser',
             'file' => 'MyParser.inc',
             'path' => drupal_get_path('module', 'my_module'),
           ),
         );
         $info['MyProcessor'] = array(
           'name' => 'ODK parser',
           'description' => 'Process my stuff.',
           'help' => 'More verbose description here. Will be displayed on processor selection menu.',
           'handler' => array(
             'parent' => 'FeedsProcessor',
             'class' => 'MyProcessor',
             'file' => 'MyProcessor.inc',
             'path' => drupal_get_path('module', 'my_module'),
           ),
         );
         return $info;
+      }
       /**
        * @}
        */
       /**
        * @defgroup import Import and clear hooks
        * @{
        */
       /**
        * Invoked after a feed source has been parsed, before it will be processed.
+       *
        * @param FeedsSource $source
        *  FeedsSource object that describes the source that has been imported.
        * @param FeedsParserResult $result
        *   FeedsParserResult object that has been parsed from the source.
        */
       function hook_feeds_after_parse(FeedsSource $source, FeedsParserResult $result) {
         // For example, set title of imported content:
         $result->title = 'Import number ' . my_module_import_id();
+      }
       /**
        * Invoked before a feed source import starts.
+       *
        * @param FeedsSource $source
        *  FeedsSource object that describes the source that is going to be imported.
        */
       function hook_feeds_before_import(FeedsSource $source) {
         // See feeds_rules module's implementation for an example.
+      }
       /**
        * Invoked before a feed item is updated/created/replaced.
+       *
        * This is called every time a feed item is processed no matter if the item gets
        * updated or not.
+       *
        * @param FeedsSource $source
        *  The source for the current feed.
        * @param array $item
        *  All the current item from the feed.
        * @param int|null $entity_id
        *  The id of the current item which is going to be updated. If this is a new
        *  item, then NULL is passed.
        */
       function hook_feeds_before_update(FeedsSource $source, $item, $entity_id) {
         if ($entity_id) {
           $processor = $source->importer->processor;
           db_update('foo_bar')
             ->fields(array('entity_type' => $processor->entityType(), 'entity_id' => $entity_id, 'last_seen' => REQUEST_TIME))
             ->condition('entity_type', $processor->entityType())
             ->condition('entity_id', $entity_id)
             ->execute();
+        }
+      }
       /**
        * Invoked before a feed item is saved.
+       *
        * @param FeedsSource $source
        *   FeedsSource object that describes the source that is being imported.
        * @param $entity
        *   The entity object.
        * @param array $item
        *   The parser result for this entity.
        * @param int|null $entity_id
        *   The id of the current item which is going to be updated. If this is a new
        *   item, then NULL is passed.
        */
       function hook_feeds_presave(FeedsSource $source, $entity, $item, $entity_id) {
         if ($entity->feeds_item->entity_type == 'node') {
           // Skip saving this entity.
           $entity->feeds_item->skip = TRUE;
+        }
+      }
       /**
        * Invoked after a feed item has been saved.
+       *
        * @param FeedsSource $source
        *  FeedsSource object that describes the source that is being imported.
        * @param $entity
        *   The entity object that has just been saved.
        * @param array $item
        *   The parser result for this entity.
        * @param int|null $entity_id
        *  The id of the current item which is going to be updated. If this is a new
        *  item, then NULL is passed.
        */
       function hook_feeds_after_save(FeedsSource $source, $entity, $item, $entity_id) {
         // Use $entity->nid of the saved node.
         // Although the $entity object is passed by reference, any changes made in
         // this function will be ignored by the FeedsProcessor.
         $config = $source->importer->getConfig();
         if ($config['processor']['config']['purge_unseen_items'] && isset($entity->feeds_item)) {
           $feeds_item = $entity->feeds_item;
           $feeds_item->batch_id = feeds_delete_get_current_batch($feeds_item->feed_nid);
           drupal_write_record('feeds_delete_item', $feeds_item);
+        }
+      }
       /**
        * Invoked after a feed source has been imported.
+       *
        * @param FeedsSource $source
        *  FeedsSource object that describes the source that has been imported.
        */
       function hook_feeds_after_import(FeedsSource $source) {
         // See geotaxonomy module's implementation for an example.
         // We can also check for an exception in this hook. The exception should not
         // be thrown here, Feeds will handle it.
         if (isset($source->exception)) {
           watchdog('mymodule', 'An exception occurred during importing!', array(), WATCHDOG_ERROR);
           mymodule_panic_reaction($source);
+        }
+      }
       /**
        * Invoked after a feed source has been cleared of its items.
+       *
        * @param FeedsSource $source
        *  FeedsSource object that describes the source that has been cleared.
        */
       function hook_feeds_after_clear(FeedsSource $source) {
+      }
       /**
        * @}
        */
       /**
        * @defgroup mappingapi Mapping API
        * @{
        */
       /**
        * Alter mapping sources.
+       *
        * Use this hook to add additional mapping sources for any parser. Allows for
        * registering a callback to be invoked at mapping time.
+       *
        * @see my_source_get_source().
        * @see locale_feeds_parser_sources_alter().
        */
       function hook_feeds_parser_sources_alter(&$sources, $content_type) {
         $sources['my_source'] = array(
           'name' => t('Images in description element'),
           'description' => t('Images occuring in the description element of a feed item.'),
           'callback' => 'my_source_get_source',
         );
+      }
       /**
        * Example callback specified in hook_feeds_parser_sources_alter().
+       *
        * To be invoked on mapping time.
+       *
        * @param $source
        *   The FeedsSource object being imported.
        * @param $result
        *   The FeedsParserResult object being mapped from.
        * @param $key
        *   The key specified in the $sources array in
        *   hook_feeds_parser_sources_alter().
+       *
        * @return
        *   The value to be extracted from the source.
+       *
        * @see hook_feeds_parser_sources_alter()
        * @see locale_feeds_get_source()
        */
       function my_source_get_source(FeedsSource $source, FeedsParserResult $result, $key) {
         $item = $result->currentItem();
         return my_source_parse_images($item['description']);
+      }
       /**
        * Adds mapping targets for processors.
+       *
        * This hook allows additional target options to be added to the processors
        * mapping form.
+       *
        * If the key in $targets[] does not correspond to the actual key on the node
        * object ($node->key), real_target MUST be specified. See mappers/link.inc
+       *
        * For an example implementation, see mappers/text.inc
+       *
        * @param string $entity_type
        *   The entity type of the target, for instance a 'node' entity.
        * @param string $bundle
        *   The entity bundle to return targets for.
+       *
        * @return array
        *   Array containing the targets to be offered to the user. This function must
        *   return an array, even an empty one.
        */
       function hook_feeds_processor_targets($entity_type, $bundle) {
         $targets = array();
         if ($entity_type == 'node') {
           $targets['my_node_field'] = array(
             'name' => t('My custom node field'),
             'description' => t('Description of what my custom node field does.'),
             'callback' => 'my_module_set_target',
             // Specify both summary_callback and form_callback to add a per mapping
             // configuration form.
             'summary_callbacks' => array('my_module_summary_callback'),
             'form_callbacks' => array('my_module_form_callback'),
           );
           $targets['my_node_field2'] = array(
             'name' => t('My Second custom node field'),
             'description' => t('Description of what my second custom node field does.'),
             'callback' => 'my_module_set_target2',
             'real_target' => 'my_node_field_two', // Specify real target field on node.
           );
           $targets['my_node_field3'] = array(
             'name' => t('My third custom node field'),
             'description' => t('Description of what my third custom node field does.'),
             'callback' => 'my_module_set_target3',
             // Set optional_unique to TRUE and specify unique_callbacks to allow the
             // target to be unique. Existing entities can be updated based on unique
             // targets.
             'optional_unique' => TRUE,
             'unique_callbacks' => array('my_module_mapper_unique'),
             // Preprocess callbacks are called before the actual callback allowing you
             // to prepare values on the entity or mapping array.
             'preprocess_callbacks' => array('my_module_preprocess_callback'),
           );
+        }
         return $targets;
+      }
       /**
        * Alters the target array.
+       *
        * This hook allows modifying the target array.
+       *
        * @param array &$targets
        *   Array containing the targets to be offered to the user. Add to this array
        *   to expose additional options.
        * @param string $entity_type
        *   The entity type of the target, for instance a 'node' entity.
        * @param string $bundle
        *   The entity bundle to return targets for.
+       *
        * @see hook_feeds_processor_targets()
        */
       function hook_feeds_processor_targets_alter(array &$targets, $entity_type, $bundle) {
         if ($entity_type == 'node' && $bundle == 'article') {
           if (isset($targets['nid'])) {
             $targets['nid']['unique_callbacks'][] = 'my_module_mapper_unique';
             $targets['nid']['optional_unique'] = TRUE;
+          }
+        }
+      }
       /**
        * Example callback specified in hook_feeds_processor_targets().
+       *
        * @param FeedsSource $source
        *   Field mapper source settings.
        * @param object $entity
        *   An entity object, for instance a node object.
        * @param string $target
        *   A string identifying the target on the node.
        * @param array $values
        *   The value to populate the target with.
        * @param array $mapping
        *  Associative array of the mapping settings from the per mapping
        *  configuration form.
        */
       function my_module_set_target(FeedsSource $source, $entity, $target, array $values, array $mapping) {
         $entity->{$target}[$entity->language][0]['value'] = reset($values);
         if (isset($source->importer->processor->config['input_format'])) {
           $entity->{$target}[$entity->language][0]['format'] = $source->importer->processor->config['input_format'];
+        }
+      }
       /**
        * Example of the summary_callback specified in hook_feeds_processor_targets().
+       *
        * @param array $mapping
        *   Associative array of the mapping settings.
        * @param string $target
        *   Array of target settings, as defined by the processor or
        *   hook_feeds_processor_targets_alter().
        * @param array $form
        *   The whole mapping form.
        * @param array $form_state
        *   The form state of the mapping form.
+       *
        * @return string
        *   Returns, as a string that may contain HTML, the summary to display while
        *   the full form isn't visible.
        *   If the return value is empty, no summary and no option to view the form
        *   will be displayed.
        */
       function my_module_summary_callback(array $mapping, $target, array $form, array $form_state) {
         if (empty($mapping['my_setting'])) {
           return t('My setting <strong>not</strong> active');
+        }
         else {
           return t('My setting <strong>active</strong>');
+        }
+      }
       /**
        * Example of the form_callback specified in hook_feeds_processor_targets().
+       *
        * The arguments are the same that my_module_summary_callback() gets.
+       *
        * @return array
        *   The per mapping configuration form. Once the form is saved, $mapping will
        *   be populated with the form values.
+       *
        * @see my_module_summary_callback()
        */
       function my_module_form_callback(array $mapping, $target, array $form, array $form_state) {
         return array(
           'my_setting' => array(
             '#type' => 'checkbox',
             '#title' => t('My setting checkbox'),
             '#default_value' => !empty($mapping['my_setting']),
           ),
         );
+      }
       /**
        * Example of the unique_callbacks specified in hook_feeds_processor_targets().
+       *
        * @param FeedsSource $source
        *   The Feed source.
        * @param string $entity_type
        *   Entity type for the entity to be processed.
        * @param string $bundle
        *   Bundle name for the entity to be processed.
        * @param string $target
        *   A string identifying the unique target on the entity.
        * @param array $values
        *   The unique values to be checked.
+       *
        * @return int|null
        *   The existing entity id, or NULL if no existing entity is found.
+       *
        * @see hook_feeds_processor_targets()
        * @see FeedsProcessor::existingEntityId()
        */
       function my_module_mapper_unique(FeedsSource $source, $entity_type, $bundle, $target, array $values) {
         list($field_name, $column) = explode(':', $target . ':value');
         // Example for if the target is a field.
         $query = new EntityFieldQuery();
         $result = $query
           ->entityCondition('entity_type', $entity_type)
           ->entityCondition('bundle', $bundle)
           ->fieldCondition($field_name, $column, $values)
           ->execute();
         if (!empty($result[$entity_type])) {
           return key($result[$entity_type]);
+        }
+      }
       /**
        * Example of the preprocess_callbacks specified in hook_feeds_processor_targets().
+       *
        * @param FeedsSource $source
        *   The Feed source.
        * @param object $entity
        *   The entity being processed.
        * @param array $target
        *   The full target definition.
        * @param array &$mapping
        *   The mapping configuration.
+       *
        * @see hook_feeds_processor_targets()
        */
       function my_module_preprocess_callback(FeedsSource $source, $entity, array $target, array &$mapping) {
         // Add in default values.
         $mapping += array('setting_value' => TRUE);
+      }
       /**
        * @}
        */

Projet

Général

Profil

Club Drupal

root / drupal7 / sites / all / modules / feeds / feeds.api.php @ 41cc1b08