class FeedsImportBatch in Feeds 6

A FeedsImportBatch wraps the actual content retrieved from a FeedsSource. On import, it is created on the fetching stage and passed through the parsing and processing stage where it is normalized and consumed.

A Fetcher must return a FeedsImportBatch object on fetch(). To that end it can use one of the existing FeedsImportBatch classes (FeedsImportBatch, FeedsFileBatch or FeedsHTTPBatch) or provide its own as a direct or indirect extension of FeedsImportBatch.

A Parser must populate a FeedsImportBatch object upon parse(). For instance:

$batch->items = $parsed_rows;
$batch->title = 'My imported document';

Finally, a processor can work off the information produced on the parsing stage by consuming items with $batch->shiftItem().

while ($item = $batch
  ->shiftItem()) {
  $object = $this
    ->map($item);
  $object
    ->save();
}

If a processing task is very slow, it can be batched over multiple page loads. For batching the consumer loop can be left while the current progress is set on the batch object. If the current progress is not FEEDS_BATCH_COMPLETE the processor will be called again on a subsequent page load to continue where it has left off. For an example, see FeedsNodeProcessor::process().

$created = 0;
while ($item = $batch
  ->shiftItem()) {
  $object = $this
    ->map($item);
  $object
    ->save();
  $created++;

  // Created in this page load.
  $batch->created++;

  // Created total.
  if ($created > MAX_CREATED) {
    $batch
      ->setProgress(FEEDS_PROCESSING, $batch->created);
    return;
  }
}
$batch
  ->setProgress(FEEDS_PROCESSING, FEEDS_BATCH_COMPLETE);

Note: Knowledge of the internal structure of a single item in the $items array is managed by the mapping API specified in FeedsParser class and FeedsProcessor class.

Hierarchy

• class \FeedsBatch
  • class \FeedsImportBatch

See also

FeedsBatch

FeedsFileBatch

FeedsHTTPBatch

File

includes/FeedsBatch.inc, line 142

class FeedsImportBatch extends FeedsBatch {
  protected $current_item;
  protected $raw;
  public $title;
  public $description;
  public $link;
  public $items;
  public $feed_nid;
  public $created;
  public $updated;
  public function __construct($raw = '', $feed_nid = 0) {
    parent::__construct();
    $this->progress = array(
      FEEDS_FETCHING => FEEDS_BATCH_COMPLETE,
      FEEDS_PARSING => FEEDS_BATCH_COMPLETE,
      FEEDS_PROCESSING => FEEDS_BATCH_COMPLETE,
    );
    $this->total = array(
      FEEDS_FETCHING => 0,
      FEEDS_PARSING => 0,
      FEEDS_PROCESSING => 0,
    );
    $this->title = '';
    $this->description = '';
    $this->link = '';
    $this->items = array();
    $this->raw = $raw;
    $this->feed_nid = $feed_nid;
    $this->created = 0;
    $this->updated = 0;
  }

  /**
   * @return
   *   The raw content from the source as a string.
   *
   * @throws Exception
   *   Extending classes MAY throw an exception if a problem occurred.
   */
  public function getRaw() {
    return $this->raw;
  }

  /**
   * @return
   *   A path to a file containing the raw content as a source.
   *
   * @throws Exception
   *   If an unexpected problem occurred.
   */
  public function getFilePath() {
    if (!isset($this->file_path)) {
      $dir = file_directory_path() . '/feeds';
      if (!file_check_directory($dir, TRUE)) {
        throw new Exception(t('Feeds directory either cannot be created or is not writable.'));
      }
      $dest = file_destination($dir . '/' . get_class($this) . '_' . drupal_get_token($this->url) . '_' . time(), FILE_EXISTS_RENAME);
      $this->file_path = file_save_data($this
        ->getRaw(), $dest);
      if ($this->file_path === 0) {
        throw new Exception(t('Cannot write content to %dest', array(
          '%dest' => $dest,
        )));
      }
    }
    return $this->file_path;
  }

  /**
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $node = node_load($batch->feed_nid);
   *
   * Return the feed node related to this batch object.
   */
  public function feedNode() {
    if ($this->feed_nid) {
      return node_load($this->feed_nid);
    }
  }

  /**
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $title = $batch->title;
   *
   * @return
   *   A string that is the feed's title.
   */
  public function getTitle() {
    return $this->title;
  }

  /**
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $description = $batch->description;
   *
   * @return
   *   A string that is the feed's description.
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $link = $batch->link;
   *
   * @return
   *   A string that is the link to the feed's site (not the actual URL of the
   *   feed). Falls back to URL if not available.
   */
  public function getLink() {
    return $this->link;
  }

  /**
   * @todo Move to a nextItem() based approach, not consuming the item array.
   *   Can only be done once we don't cache the entire batch object between page
   *   loads for batching anymore.
   *
   * @return
   *   Next available item or NULL if there is none. Every returned item is
   *   removed from the internal array.
   */
  public function shiftItem() {
    $this->current_item = array_shift($this->items);
    return $this->current_item;
  }

  /**
   * @return
   *   Current feed item.
   */
  public function currentItem() {
    return empty($this->current_item) ? NULL : $this->current_item;
  }

  /**
   * Set title.
   *
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $batch->title = $title;
   */
  public function setTitle($title) {
    $this->title = $title;
  }

  /**
   * Set description.
   *
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $batch->description = $description;
   */
  public function setDescription($description) {
    $this->description = $description;
  }

  /**
   * Set link.
   *
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $batch->link = $link;
   */
  public function setLink($link) {
    $this->link = $link;
  }

  /**
   * Set items.
   *
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $batch->items = $items;
   *
   * @param $items
   *   An array of the items in the feed. Cannot be NULL.
   */
  public function setItems($items) {
    $this->items = $items;
  }

  /**
   * Add an item.
   *
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $batch->items[] = $item;
   */
  public function addItem($item) {
    $this->items[] = $item;
  }

  /**
   * Get number of items.
   *
   * @deprecated
   *   This method is deprecated. Access directly instead. For example:
   *   $count = count($batch->items);
   */
  public function getItemCount() {
    return count($this->items);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsBatch::$progress	protected	property
FeedsBatch::$total	protected	property
FeedsBatch::getProgress	public	function	Report progress.
FeedsBatch::getTotal	public	function	Get the total for a stage.
FeedsBatch::setProgress	public	function	Set progress for a stage.
FeedsBatch::setTotal	public	function	Set the total for a stage.
FeedsImportBatch::$created	public	property
FeedsImportBatch::$current_item	protected	property
FeedsImportBatch::$description	public	property
FeedsImportBatch::$feed_nid	public	property
FeedsImportBatch::$items	public	property
FeedsImportBatch::$link	public	property
FeedsImportBatch::$raw	protected	property
FeedsImportBatch::$title	public	property
FeedsImportBatch::$updated	public	property
FeedsImportBatch::addItem Deprecated	public	function	Add an item.
FeedsImportBatch::currentItem	public	function
FeedsImportBatch::feedNode Deprecated	public	function
FeedsImportBatch::getDescription Deprecated	public	function
FeedsImportBatch::getFilePath	public	function		1
FeedsImportBatch::getItemCount Deprecated	public	function	Get number of items.
FeedsImportBatch::getLink Deprecated	public	function
FeedsImportBatch::getRaw	public	function		2
FeedsImportBatch::getTitle Deprecated	public	function
FeedsImportBatch::setDescription Deprecated	public	function	Set description.
FeedsImportBatch::setItems Deprecated	public	function	Set items.
FeedsImportBatch::setLink Deprecated	public	function	Set link.
FeedsImportBatch::setTitle Deprecated	public	function	Set title.
FeedsImportBatch::shiftItem	public	function	@todo Move to a nextItem() based approach, not consuming the item array. Can only be done once we don't cache the entire batch object between page loads for batching anymore.
FeedsImportBatch::__construct	public	function	Overrides FeedsBatch::__construct	2