class FeedsImporter in Feeds 8.2

A FeedsImporter object describes how an external source should be fetched, parsed and processed. Feeds can manage an arbitrary amount of importers.

A FeedsImporter holds a pointer to a FeedsFetcher, a FeedsParser and a FeedsProcessor plugin. It further contains the configuration for itself and each of the three plugins.

Its most important responsibilities are configuration management, interfacing with the job scheduler and expiring of all items produced by this importer.

When a FeedsImporter is instantiated, it loads its configuration. Then it instantiates one fetcher, one parser and one processor plugin depending on the configuration information. After instantiating them, it sets them to the configuration information it holds for them.

Hierarchy

class \Drupal\feeds\Plugin\FeedsConfigurable
- class \Drupal\feeds\FeedsImporter

Expanded class hierarchy of FeedsImporter

1 file declares its use of FeedsImporter

FeedsConfigurable.php in lib/Drupal/feeds/Plugin/FeedsConfigurable.php: FeedsConfigurable and helper functions.

File

lib/Drupal/feeds/FeedsImporter.php, line 30: FeedsImporter class and related.

Namespace

Drupal\feeds

View source

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;

  // This array defines the variable names of the plugins above.
  protected $plugin_types = array(
    'fetcher',
    'parser',
    'processor',
  );

  /**
   * Instantiate class variables, initialize and configure
   * plugins.
   */
  protected function __construct($id) {
    parent::__construct($id);

    // Try to load information from database.
    $this
      ->load();

    // Instantiate fetcher, parser and processor, set their configuration if
    // stored info is available.
    foreach ($this->plugin_types as $type) {
      $plugin = feeds_plugin($this->config[$type]['plugin_key'], $this->id);
      if (isset($this->config[$type]['config'])) {
        $plugin
          ->setConfig($this->config[$type]['config']);
      }
      $this->{$type} = $plugin;
    }
  }

  /**
   * Report how many items *should* be created on one page load by this
   * importer.
   *
   * Note:
   *
   * It depends on whether parser implements batching if this limit is actually
   * respected. Further, if no limit is reported it doesn't mean that the
   * number of items that can be created on one page load is actually without
   * limit.
   *
   * @return
   *   A positive number defining the number of items that can be created on
   *   one page load. 0 if this number is unlimited.
   */
  public function getLimit() {
    return $this->processor
      ->getLimit();
  }

  /**
   * Save configuration.
   */
  public function save() {
    $config = config('feeds.importer.' . $this->id);
    $config
      ->set('id', $this->id)
      ->set('config', $this
      ->getConfig())
      ->save();
  }

  /**
   * Load configuration and unpack.
   */
  public function load() {
    if (config('feeds.importer.' . $this->id)
      ->get('id')) {
      $config = config('feeds.importer.' . $this->id)
        ->get('config');
      $this->disabled = isset($config['disabled']) ? $config['disabled'] : FALSE;
      $this->config = $config;
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Deletes configuration.
   *
   * Removes configuration information from database, does not delete
   * configuration itself.
   */
  public function delete() {
    db_delete('feeds_importer')
      ->condition('id', $this->id)
      ->execute();
    feeds_reschedule($this->id);
  }

  /**
   * Set plugin.
   *
   * @param $plugin_key
   *   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'
    if ($plugin_type = FeedsPlugin::typeOf($plugin_key)) {
      if ($plugin = feeds_plugin($plugin_key, $this->id)) {

        // Unset existing plugin, switch to new plugin.
        unset($this->{$plugin_type});
        $this->{$plugin_type} = $plugin;

        // Set configuration information, blow away any previous information on
        // this spot.
        $this->config[$plugin_type] = array(
          'plugin_key' => $plugin_key,
        );
      }
    }
  }

  /**
   * Copy a FeedsImporter configuration into this importer.
   *
   * @param FeedsImporter $importer
   *   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']);
      }
    }
  }

  /**
   * Get configuration of this feed.
   */
  public function getConfig() {
    foreach (array(
      'fetcher',
      'parser',
      'processor',
    ) as $type) {
      $this->config[$type]['config'] = $this->{$type}
        ->getConfig();
    }
    return parent::getConfig();
  }

  /**
   * Return defaults for feed configuration.
   */
  public function configDefaults() {
    return array(
      'name' => '',
      'description' => '',
      'fetcher' => array(
        'plugin_key' => 'http',
      ),
      'parser' => array(
        'plugin_key' => 'syndication',
      ),
      'processor' => array(
        'plugin_key' => 'node',
      ),
      '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.
      'process_in_background' => FALSE,
    );
  }

  /**
   * Override parent::configForm().
   */
  public function configForm(&$form_state) {
    $config = $this
      ->getConfig();
    $form = array();
    $form['name'] = array(
      '#type' => 'textfield',
      '#title' => t('Name'),
      '#description' => t('A human readable name of this importer.'),
      '#default_value' => $config['name'],
      '#required' => TRUE,
    );
    $form['description'] = array(
      '#type' => 'textfield',
      '#title' => t('Description'),
      '#description' => t('A description of this importer.'),
      '#default_value' => $config['description'],
    );
    $node_types = node_type_get_names();
    array_walk($node_types, 'check_plain');
    $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',
          ),
        )),
      )),
      '#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');
    foreach ($period as &$p) {
      $p = t('Every !p', array(
        '!p' => $p,
      ));
    }
    $period = array(
      FEEDS_SCHEDULE_NEVER => t('Off'),
      0 => t('As often as possible'),
    ) + $period;
    $form['import_period'] = array(
      '#type' => 'select',
      '#title' => t('Periodic import'),
      '#options' => $period,
      '#description' => t('Choose how often a source should be imported periodically.') . $cron_required,
      '#default_value' => $config['import_period'],
    );
    $form['import_on_create'] = array(
      '#type' => 'checkbox',
      '#title' => t('Import on submission'),
      '#description' => t('Check if import should be started at the moment a standalone form or node form is submitted.'),
      '#default_value' => $config['import_on_create'],
    );
    $form['process_in_background'] = array(
      '#type' => 'checkbox',
      '#title' => t('Process in background'),
      '#description' => t('For very large imports. If checked, import and delete tasks started from the web UI will be handled by a cron task in the background rather than by the browser. This does not affect periodic imports, they are handled by a cron task in any case.') . $cron_required,
      '#default_value' => $config['process_in_background'],
    );
    return $form;
  }

  /**
   * Reschedule if import period changes.
   */
  public function configFormSubmit(&$values) {
    if ($this->config['import_period'] != $values['import_period']) {
      feeds_reschedule($this->id);
    }
    parent::configFormSubmit($values);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsConfigurable::$config	protected	property
FeedsConfigurable::$disabled	protected	property	CTools export enabled status of this object.
FeedsConfigurable::$export_type	protected	property
FeedsConfigurable::$id	protected	property
FeedsConfigurable::$instances	public static	property
FeedsConfigurable::addConfig	public	function	Similar to setConfig but adds to existing configuration.
FeedsConfigurable::configFormValidate	public	function	Validation handler for configForm().	3
FeedsConfigurable::existing	public	function	Determine whether this object is persistent and enabled. I. e. it is defined either in code or in the database and it is enabled.	1
FeedsConfigurable::instance	public static	function	Instantiate a FeedsConfigurable object.	1
FeedsConfigurable::setConfig	public	function	Set configuration.
FeedsConfigurable::__get	public	function	Override magic method __get(). Make sure that $this->config goes through getConfig().
FeedsConfigurable::__isset	public	function	Override magic method __isset(). This is needed due to overriding __get().
FeedsImporter::$fetcher	protected	property
FeedsImporter::$plugin_types	protected	property
FeedsImporter::configDefaults	public	function	Return defaults for feed configuration. Overrides FeedsConfigurable::configDefaults
FeedsImporter::configForm	public	function	Override parent::configForm(). Overrides FeedsConfigurable::configForm
FeedsImporter::configFormSubmit	public	function	Reschedule if import period changes. Overrides FeedsConfigurable::configFormSubmit
FeedsImporter::copy	public	function	Copy a FeedsImporter configuration into this importer. Overrides FeedsConfigurable::copy
FeedsImporter::delete	public	function	Deletes configuration.
FeedsImporter::getConfig	public	function	Get configuration of this feed. Overrides FeedsConfigurable::getConfig
FeedsImporter::getLimit	public	function	Report how many items should be created on one page load by this importer.
FeedsImporter::load	public	function	Load configuration and unpack.
FeedsImporter::save	public	function	Save configuration. Overrides FeedsConfigurable::save
FeedsImporter::setPlugin	public	function	Set plugin.
FeedsImporter::__construct	protected	function	Instantiate class variables, initialize and configure plugins. Overrides FeedsConfigurable::__construct

You are here

class FeedsImporter in Feeds 8.2

Hierarchy

File

Namespace

Members

API Navigation