/drupal7/sites/all/modules/feeds/includes/FeedsImporter.inc - Diff - Club Drupal - Forge Centrale Marseille

Révision ed9a13f1

Ajouté par Assos Assos il y a plus de 3 ans

ID ed9a13f1ed5cebae0b2b2b611e89e5772fa4cc4c
Parent d0ed0aa6
Enfant 80344a30

Weekly update of contrib modules

      */
     /**
      * Class for a Feeds importer.
+     *
      * A FeedsImporter object describes how an external source should be fetched,
      * parsed and processed. Feeds can manage an arbitrary amount of importers.
+     *
-...
      */
     class FeedsImporter extends FeedsConfigurable {
       // Every feed has a fetcher, a parser and a processor.
       // These variable names match the possible return values of
       // FeedsPlugin::typeOf().
       protected $fetcher, $parser, $processor;
       /**
        * Every feed has a fetcher, a parser and a processor.
+       *
        * These variable names match the possible return values of
        * FeedsPlugin::typeOf().
        */
       /**
        * The selected fetcher for this importer.
+       *
        * @var FeedsFetcher|null
        */
       protected $fetcher;
       /**
        * The selected parser for this importer.
+       *
        * @var FeedsParser|null
        */
       protected $parser;
       /**
        * The selected processor for this importer.
+       *
        * @var FeedsProcessor|null
        */
       protected $processor;
       // This array defines the variable names of the plugins above.
       /**
        * This array defines the variable names of the plugins above.
+       *
        * @var string[]
        */
       protected $plugin_types = array('fetcher', 'parser', 'processor');
       /**
        * Instantiate class variables, initialize and configure
        * plugins.
        * Instantiate class variables, initialize and configure plugins.
+       *
        * @param string $id
        *   The importer ID.
        */
       protected function __construct($id) {
         parent::__construct($id);
-...
+      }
       /**
        * Report how many items *should* be created on one page load by this
        * importer.
        * Reports how many items *should* be created on one request by this importer.
+       *
        * Note:
+       *
-...
        * number of items that can be created on one page load is actually without
        * limit.
+       *
        * @return
        * @return int
        *   A positive number defining the number of items that can be created on
        *   one page load. 0 if this number is unlimited.
        */
-...
       /**
        * Set plugin.
+       *
        * @param $plugin_key
        *   A fetcher, parser or processor plugin.
        * @param string $plugin_key
        *   The name of a fetcher, parser or processor plugin.
+       *
        * @todo Error handling, handle setting to the same plugin.
        */
       public function setPlugin($plugin_key) {
         // $plugin_type can be either 'fetcher', 'parser' or 'processor'
         // $plugin_type can be either 'fetcher', 'parser' or 'processor'.
         if ($plugin_type = FeedsPlugin::typeOf($plugin_key)) {
           if ($plugin = feeds_plugin($plugin_key, $this->id)) {
             // Unset existing plugin, switch to new plugin.
-...
        * @param FeedsConfigurable $configurable
        *   The feeds importer object to copy from.
        */
        public function copy(FeedsConfigurable $configurable) {
          parent::copy($configurable);
          if ($configurable instanceof FeedsImporter) {
            // Instantiate new fetcher, parser and processor and initialize their
            // configurations.
            foreach ($this->plugin_types as $plugin_type) {
              $this->setPlugin($configurable->config[$plugin_type]['plugin_key']);
              $this->$plugin_type->setConfig($configurable->config[$plugin_type]['config']);
+           }
+         }
+       }
       public function copy(FeedsConfigurable $configurable) {
         parent::copy($configurable);
         if ($configurable instanceof FeedsImporter) {
           // Instantiate new fetcher, parser and processor and initialize their
           // configurations.
           foreach ($this->plugin_types as $plugin_type) {
             $this->setPlugin($configurable->config[$plugin_type]['plugin_key']);
             $this->$plugin_type->setConfig($configurable->config[$plugin_type]['config']);
+          }
+        }
+      }
       /**
        * Get configuration of this feed.
-...
           ),
           'content_type' => '',
           'update' => 0,
           'import_period' => 1800, // Refresh every 30 minutes by default.
           'expire_period' => 3600, // Expire every hour by default, this is a hidden setting.
           'import_on_create' => TRUE, // Import on submission.
           // Refresh every 30 minutes by default.
           'import_period' => 1800,
           // Expire every hour by default, this is a hidden setting.
           'expire_period' => 3600,
           // Import on submission.
           'import_on_create' => TRUE,
           'process_in_background' => FALSE,
         ) + parent::configDefaults();
+      }
       /**
        * Override parent::configForm().
        * Overrides parent::configForm().
+       *
        * @param array $form_state
        *   The current state of the form.
+       *
        * @return array
        *   The form definition.
        */
       public function configForm(&$form_state) {
         $config = $this->getConfig();
-...
         $form['content_type'] = array(
           '#type' => 'select',
           '#title' => t('Attach to content type'),
           '#description' => t('If "Use standalone form" is selected a source is imported by using a form under !import_form.
                                If a content type is selected a source is imported by creating a node of that content type.',
                                array('!import_form' => l(url('import', array('absolute' => TRUE)), 'import', array('attributes' => array('target' => '_new'))))),
           '#description' => '<p>' . t('If "Use standalone form" is selected, a source is imported by using a form under !import_form. If a content type is selected, a source is imported by creating a node of that content type.', array(
             '!import_form' => l(url('import', array('absolute' => TRUE)), 'import', array('attributes' => array('target' => '_new'))),
           )) . '</p>',
           '#options' => array('' => t('Use standalone form')) + $node_types,
           '#default_value' => $config['content_type'],
         );
         $cron_required =  ' ' . l(t('Requires cron to be configured.'), 'http://drupal.org/cron', array('attributes' => array('target' => '_new')));
         $period = drupal_map_assoc(array(900, 1800, 3600, 10800, 21600, 43200, 86400, 259200, 604800, 2419200), 'format_interval');
         $cron_required = ' ' . l(t('Requires cron to be configured.'), 'http://drupal.org/cron', array('attributes' => array('target' => '_new')));
         $period = drupal_map_assoc(array(
 ,
 ,
 ,
 ,
 ,
 ,
 ,
 ,
 ,
           2419200,
         ), 'format_interval');
         foreach ($period as &$p) {
           $p = t('Every !p', array('!p' => $p));
+        }
-...
+      }
       /**
        * Overrides parent::configFormSubmit().
+       *
        * Reschedule if import period changes.
+       *
        * @param array $values
        *   An array that contains the values entered by the user through configForm.
        */
       public function configFormSubmit(&$values) {
         if ($this->config['import_period'] != $values['import_period']) {
-...
+        }
         return $dependencies;
+      }
+    }
     /**
      * Helper, see FeedsDataProcessor class.
      * Formats a time interval.
+     *
      * @param int $timestamp
      *   The length of the interval in seconds.
+     *
      * @return string
      *   A translated string representation of the interval.
      */
     function feeds_format_expire($timestamp) {
       if ($timestamp == FEEDS_EXPIRE_NEVER) {

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision ed9a13f1

Ajouté par Assos Assos il y a plus de 3 ans