class FeedsNodeProcessor in Feeds 8.2

Defines a node processor.

Creates Nodes from feed items.

Plugin annotation

@Plugin(
  id = "node",
  title = @Translation("Node processor"),
  description = @Translation("Creates nodes from feed items.")
)

Hierarchy

• class \Drupal\feeds\Plugin\FeedsConfigurable
  • class \Drupal\feeds\Plugin\FeedsPlugin implements FeedsSourceInterface
    • class \Drupal\feeds\Plugin\FeedsProcessor
      • class \Drupal\feeds\Plugin\feeds\processor\FeedsNodeProcessor

6 string references to 'FeedsNodeProcessor'

FeedsMapperDateMultipleTest::test in lib/Drupal/feeds/Tests/FeedsMapperDateMultipleTest.php

Testing import by loading a 4 item XML file.

FeedsUIUserInterfaceTestCase::testEditFeedConfiguration in feeds_ui/feeds_ui.test

UI functionality tests on feeds_ui_overview(), feeds_ui_create_form(), Change plugins on feeds_ui_edit_page().

feeds_import_feeds_importer_default in feeds_import/feeds_import.feeds_importer_default.inc

Implementation of hook_feeds_importer_default().

feeds_news_feeds_importer_default in feeds_news/feeds_news.feeds_importer_default.inc

Implementation of hook_feeds_importer_default().

feeds_update_7208 in ./feeds.install

Update to use generic bundle handling.

... See full list

File

lib/Drupal/feeds/Plugin/feeds/processor/FeedsNodeProcessor.php, line 29

Contains \Drupal\feeds\Plugin\feeds\fetcher\FeedsNodeProcessor.

Namespace

Drupal\feeds\Plugin\feeds\processor

class FeedsNodeProcessor extends FeedsProcessor {

  /**
   * Define entity type.
   */
  public function entityType() {
    return 'node';
  }

  /**
   * Implements parent::entityInfo().
   */
  protected function entityInfo() {
    $info = parent::entityInfo();
    $info['label plural'] = t('Nodes');
    return $info;
  }

  /**
   * Creates a new node in memory and returns it.
   */
  protected function newEntity(FeedsSource $source) {
    $defaults = variable_get('node_options_' . $this
      ->bundle(), array(
      'status',
      'promote',
    ));
    $node = entity_create('node', array(
      'type' => $this
        ->bundle(),
      'changed' => REQUEST_TIME,
      'created' => REQUEST_TIME,
      'is_new' => TRUE,
      'log' => 'Created by FeedsNodeProcessor',
      'uid' => $this->config['author'],
      'promote' => (int) in_array('promote', $defaults),
      'status' => (int) in_array('status', $defaults),
    ));
    return $node
      ->getBCEntity();
  }

  /**
   * Loads an existing node.
   *
   * If the update existing method is not FEEDS_UPDATE_EXISTING, only the node
   * table will be loaded, foregoing the node_load API for better performance.
   *
   * @todo Reevaluate the use of node_object_prepare().
   */
  protected function entityLoad(FeedsSource $source, $nid) {
    $node = parent::entityLoad($source, $nid);
    if ($this->config['update_existing'] != FEEDS_UPDATE_EXISTING) {
      $node->uid = $this->config['author'];
    }

    // node_object_prepare($node);
    // Workaround for issue #1247506. See #1245094 for backstory.
    if (!empty($node->menu)) {

      // If the node has a menu item(with a valid mlid) it must be flagged
      // 'enabled'.
      $node->menu['enabled'] = (int) (bool) $node->menu['mlid'];
    }

    // Populate properties that are set by node_object_prepare().
    if ($this->config['update_existing'] == FEEDS_UPDATE_EXISTING) {
      $node->log = 'Updated by FeedsNodeProcessor';
    }
    else {
      $node->log = 'Replaced by FeedsNodeProcessor';
    }
    return $node;
  }

  /**
   * Check that the user has permission to save a node.
   */
  protected function entitySaveAccess($entity) {

    // The check will be skipped for anonymous nodes.
    if ($this->config['authorize'] && !empty($entity->uid)) {
      $author = user_load($entity->uid);

      // If the uid was mapped directly, rather than by email or username, it
      // could be invalid.
      if (!$author) {
        $message = 'User %uid is not a valid user.';
        throw new FeedsAccessException(t($message, array(
          '%uid' => $entity->uid,
        )));
      }
      if (empty($entity->nid) || !empty($entity->is_new)) {
        $op = 'create';
        $access = node_access($op, $entity->type, $author);
      }
      else {
        $op = 'update';
        $access = node_access($op, $entity, $author);
      }
      if (!$access) {
        $message = 'User %name is not authorized to %op content type %content_type.';
        throw new FeedsAccessException(t($message, array(
          '%name' => $author->name,
          '%op' => $op,
          '%content_type' => $entity->type,
        )));
      }
    }
  }

  /**
   * Validates a node.
   */
  protected function entityValidate($entity) {
    if (!isset($entity->uid) || !is_numeric($entity->uid)) {
      $entity->uid = $this->config['author'];
    }
    if (drupal_strlen($entity->title) > 255) {
      $entity->title = drupal_substr($entity->title, 0, 255);
    }
  }

  /**
   * Save a node.
   */
  public function entitySave($entity) {
    node_save($entity);
  }

  /**
   * Delete a series of nodes.
   */
  protected function entityDeleteMultiple($nids) {
    node_delete_multiple($nids);
  }

  /**
   * Overrides parent::expiryQuery().
   */
  protected function expiryQuery(FeedsSource $source, $time) {
    $select = parent::expiryQuery($source, $time);
    $select
      ->condition('e.created', REQUEST_TIME - $time, '<');
    return $select;
  }

  /**
   * Return expiry time.
   */
  public function expiryTime() {
    return $this->config['expire'];
  }

  /**
   * Override parent::configDefaults().
   */
  public function configDefaults() {
    return array(
      'expire' => FEEDS_EXPIRE_NEVER,
      'author' => 0,
      'authorize' => TRUE,
    ) + parent::configDefaults();
  }

  /**
   * Override parent::configForm().
   */
  public function configForm(&$form_state) {
    $form = parent::configForm($form_state);
    $author = user_load($this->config['author']);
    $form['author'] = array(
      '#type' => 'textfield',
      '#title' => t('Author'),
      '#description' => t('Select the author of the nodes to be created - leave empty to assign "anonymous".'),
      '#autocomplete_path' => 'user/autocomplete',
      '#default_value' => empty($author->name) ? 'anonymous' : check_plain($author->name),
    );
    $form['authorize'] = array(
      '#type' => 'checkbox',
      '#title' => t('Authorize'),
      '#description' => t('Check that the author has permission to create the node.'),
      '#default_value' => $this->config['authorize'],
    );
    $period = drupal_map_assoc(array(
      FEEDS_EXPIRE_NEVER,
      3600,
      10800,
      21600,
      43200,
      86400,
      259200,
      604800,
      2592000,
      2592000 * 3,
      2592000 * 6,
      31536000,
    ), 'feeds_format_expire');
    $form['expire'] = array(
      '#type' => 'select',
      '#title' => t('Expire nodes'),
      '#options' => $period,
      '#description' => t('Select after how much time nodes should be deleted. The node\'s published date will be used for determining the node\'s age, see Mapping settings.'),
      '#default_value' => $this->config['expire'],
    );
    return $form;
  }

  /**
   * Override parent::configFormValidate().
   */
  public function configFormValidate(&$values) {
    if ($author = user_load_by_name($values['author'])) {
      $values['author'] = $author->uid;
    }
    else {
      $values['author'] = 0;
    }
  }

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

  /**
   * Override setTargetElement to operate on a target item that is a node.
   */
  public function setTargetElement(FeedsSource $source, $target_node, $target_element, $value) {
    switch ($target_element) {
      case 'created':
        $target_node->created = feeds_to_unixtime($value, REQUEST_TIME);
        break;
      case 'feeds_source':

        // Get the class of the feed node importer's fetcher and set the source
        // property. See feeds_node_update() how $node->feeds gets stored.
        if ($id = feeds_get_importer_id($this
          ->bundle())) {
          $class = get_class(feeds_importer($id)->fetcher);
          $target_node->feeds[$class]['source'] = $value;

          // This effectively suppresses 'import on submission' feature.
          // See feeds_node_insert().
          $target_node->feeds['suppress_import'] = TRUE;
        }
        break;
      case 'user_name':
        if ($user = user_load_by_name($value)) {
          $target_node->uid = $user->uid;
        }
        break;
      case 'user_mail':
        if ($user = user_load_by_mail($value)) {
          $target_node->uid = $user->uid;
        }
        break;
      default:
        parent::setTargetElement($source, $target_node, $target_element, $value);
        break;
    }
  }

  /**
   * Return available mapping targets.
   */
  public function getMappingTargets() {
    $type = node_type_load($this
      ->bundle());
    $targets = parent::getMappingTargets();
    if ($type && $type->has_title) {
      $targets['title'] = array(
        'name' => t('Title'),
        'description' => t('The title of the node.'),
        'optional_unique' => TRUE,
      );
    }
    $targets['nid'] = array(
      'name' => t('Node ID'),
      'description' => t('The nid of the node. NOTE: use this feature with care, node ids are usually assigned by Drupal.'),
      'optional_unique' => TRUE,
    );
    $targets['uid'] = array(
      'name' => t('User ID'),
      'description' => t('The Drupal user ID of the node author.'),
    );
    $targets['user_name'] = array(
      'name' => t('Username'),
      'description' => t('The Drupal username of the node author.'),
    );
    $targets['user_mail'] = array(
      'name' => t('User email'),
      'description' => t('The email address of the node author.'),
    );
    $targets['status'] = array(
      'name' => t('Published status'),
      'description' => t('Whether a node is published or not. 1 stands for published, 0 for not published.'),
    );
    $targets['created'] = array(
      'name' => t('Published date'),
      'description' => t('The UNIX time when a node has been published.'),
    );
    $targets['promote'] = array(
      'name' => t('Promoted to front page'),
      'description' => t('Boolean value, whether or not node is promoted to front page. (1 = promoted, 0 = not promoted)'),
    );
    $targets['sticky'] = array(
      'name' => t('Sticky'),
      'description' => t('Boolean value, whether or not node is sticky at top of lists. (1 = sticky, 0 = not sticky)'),
    );

    // Include language field if Locale module is enabled.
    if (module_exists('locale')) {
      $targets['language'] = array(
        'name' => t('Language'),
        'description' => t('The two-character language code of the node.'),
      );
    }

    // Include comment field if Comment module is enabled.
    if (module_exists('comment')) {
      $targets['comment'] = array(
        'name' => t('Comments'),
        'description' => t('Whether comments are allowed on this node: 0 = no, 1 = read only, 2 = read/write.'),
      );
    }

    // If the target content type is a Feed node, expose its source field.
    if ($id = feeds_get_importer_id($this
      ->bundle())) {
      $name = feeds_importer($id)->config['name'];
      $targets['feeds_source'] = array(
        'name' => t('Feed source'),
        'description' => t('The content type created by this processor is a Feed Node, it represents a source itself. Depending on the fetcher selected on the importer "@importer", this field is expected to be for example a URL or a path to a file.', array(
          '@importer' => $name,
        )),
        'optional_unique' => TRUE,
      );
    }

    // Let other modules expose mapping targets.
    self::loadMappers();
    $entity_type = $this
      ->entityType();
    $bundle = $this
      ->bundle();
    drupal_alter('feeds_processor_targets', $targets, $entity_type, $bundle);
    return $targets;
  }

  /**
   * Get nid of an existing feed item node if available.
   */
  protected function existingEntityId(FeedsSource $source, FeedsParserResult $result) {
    if ($nid = parent::existingEntityId($source, $result)) {
      return $nid;
    }

    // Iterate through all unique targets and test whether they do already
    // exist in the database.
    foreach ($this
      ->uniqueTargets($source, $result) as $target => $value) {
      switch ($target) {
        case 'nid':
          $nid = db_query("SELECT nid FROM {node} WHERE nid = :nid", array(
            ':nid' => $value,
          ))
            ->fetchField();
          break;
        case 'title':
          $nid = db_query("SELECT nid FROM {node} WHERE title = :title AND type = :type", array(
            ':title' => $value,
            ':type' => $this
              ->bundle(),
          ))
            ->fetchField();
          break;
        case 'feeds_source':
          if ($id = feeds_get_importer_id($this
            ->bundle())) {
            $nid = db_query("SELECT fs.feed_nid FROM {node} n JOIN {feeds_source} fs ON n.nid = fs.feed_nid WHERE fs.id = :id AND fs.source = :source", array(
              ':id' => $id,
              ':source' => $value,
            ))
              ->fetchField();
          }
          break;
      }
      if ($nid) {

        // Return with the first nid found.
        return $nid;
      }
    }
    return 0;
  }

}

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::copy	public	function	Copy a configuration.	1
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::getConfig	public	function	Implements getConfig().	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().
FeedsNodeProcessor::configDefaults	public	function	Override parent::configDefaults(). Overrides FeedsProcessor::configDefaults
FeedsNodeProcessor::configForm	public	function	Override parent::configForm(). Overrides FeedsProcessor::configForm
FeedsNodeProcessor::configFormSubmit	public	function	Reschedule if expiry time changes. Overrides FeedsConfigurable::configFormSubmit
FeedsNodeProcessor::configFormValidate	public	function	Override parent::configFormValidate(). Overrides FeedsConfigurable::configFormValidate
FeedsNodeProcessor::entityDeleteMultiple	protected	function	Delete a series of nodes. Overrides FeedsProcessor::entityDeleteMultiple
FeedsNodeProcessor::entityInfo	protected	function	Implements parent::entityInfo(). Overrides FeedsProcessor::entityInfo
FeedsNodeProcessor::entityLoad	protected	function	Loads an existing node. Overrides FeedsProcessor::entityLoad
FeedsNodeProcessor::entitySave	public	function	Save a node. Overrides FeedsProcessor::entitySave
FeedsNodeProcessor::entitySaveAccess	protected	function	Check that the user has permission to save a node. Overrides FeedsProcessor::entitySaveAccess
FeedsNodeProcessor::entityType	public	function	Define entity type. Overrides FeedsProcessor::entityType
FeedsNodeProcessor::entityValidate	protected	function	Validates a node. Overrides FeedsProcessor::entityValidate
FeedsNodeProcessor::existingEntityId	protected	function	Get nid of an existing feed item node if available. Overrides FeedsProcessor::existingEntityId
FeedsNodeProcessor::expiryQuery	protected	function	Overrides parent::expiryQuery(). Overrides FeedsProcessor::expiryQuery
FeedsNodeProcessor::expiryTime	public	function	Return expiry time. Overrides FeedsProcessor::expiryTime
FeedsNodeProcessor::getMappingTargets	public	function	Return available mapping targets. Overrides FeedsProcessor::getMappingTargets
FeedsNodeProcessor::newEntity	protected	function	Creates a new node in memory and returns it. Overrides FeedsProcessor::newEntity
FeedsNodeProcessor::setTargetElement	public	function	Override setTargetElement to operate on a target item that is a node. Overrides FeedsProcessor::setTargetElement
FeedsPlugin::all	public static	function	Get all available plugins.
FeedsPlugin::byType	public static	function	Gets all available plugins of a particular type.
FeedsPlugin::child	public static	function	Determines whether given plugin is derived from given base plugin.
FeedsPlugin::hasSourceConfig	public	function	Returns TRUE if $this->sourceForm() returns a form. Overrides FeedsSourceInterface::hasSourceConfig
FeedsPlugin::loadMappers	public static	function	Loads on-behalf implementations from mappers/ directory.
FeedsPlugin::save	public	function	Save changes to the configuration of this object. Delegate saving to parent (= Feed) which will collect information from this object by way of getConfig() and store it. Overrides FeedsConfigurable::save
FeedsPlugin::sourceDefaults	public	function	Implements FeedsSourceInterface::sourceDefaults(). Overrides FeedsSourceInterface::sourceDefaults	1
FeedsPlugin::sourceDelete	public	function	A source is being deleted. Overrides FeedsSourceInterface::sourceDelete	2
FeedsPlugin::sourceForm	public	function	Callback methods, exposes source form. Overrides FeedsSourceInterface::sourceForm	3
FeedsPlugin::sourceFormValidate	public	function	Validation handler for sourceForm. Overrides FeedsSourceInterface::sourceFormValidate	2
FeedsPlugin::sourceSave	public	function	A source is being saved. Overrides FeedsSourceInterface::sourceSave	2
FeedsPlugin::typeOf	public static	function	Determines the type of a plugin.
FeedsPlugin::__construct	protected	function	Constructor. Overrides FeedsConfigurable::__construct
FeedsProcessor::bundle	public	function	Bundle type this processor operates on.
FeedsProcessor::bundleOptions	public	function	Provides a list of bundle options for use in select lists.
FeedsProcessor::clear	public	function	Remove all stored results or stored results up to a certain time for a source.
FeedsProcessor::createLogMessage	protected	function	Creates a log message for when an exception occured during import.
FeedsProcessor::expire	public	function	Deletes feed items older than REQUEST_TIME - $time.
FeedsProcessor::getHash	protected	function	Retrieves the MD5 hash of $entity_id from the database.
FeedsProcessor::getLimit	public	function
FeedsProcessor::getMappings	public	function	Get mappings.
FeedsProcessor::hash	protected	function	Create MD5 hash of item and mappings array.
FeedsProcessor::itemCount	public	function	Counts the number of items imported by this processor.
FeedsProcessor::loadItemInfo	protected	function	Loads existing entity information and places it on $entity->feeds_item.
FeedsProcessor::map	protected	function	Execute mapping on an item.
FeedsProcessor::newItemInfo	protected	function	Adds Feeds specific information on $entity->feeds_item.
FeedsProcessor::pluginType	public	function	Implements FeedsPlugin::pluginType(). Overrides FeedsPlugin::pluginType
FeedsProcessor::process	public	function	Process the result of the parsing stage.
FeedsProcessor::uniqueTargets	protected	function	Utility function that iterates over a target array and retrieves all sources that are unique.