JmesPathLinesParser.php in Feeds extensible parsers 8

Namespace

Drupal\feeds_ex\Feeds\Parser

File

src/Feeds/Parser/JmesPathLinesParser.php

<?php

namespace Drupal\feeds_ex\Feeds\Parser;

use RuntimeException;
use Drupal\feeds\Exception\EmptyFeedException;
use Drupal\feeds\FeedInterface;
use Drupal\feeds\Result\FetcherResultInterface;
use Drupal\feeds\Result\ParserResultInterface;
use Drupal\feeds\StateInterface;
use Drupal\feeds_ex\File\LineIterator;

/**
 * Defines a JSON Lines parser using JMESPath.
 *
 * @FeedsParser(
 *   id = "jmespathlines",
 *   title = @Translation("JSON Lines JMESPath"),
 *   description = @Translation("Parse JSON Lines with JMESPath.")
 * )
 */
class JmesPathLinesParser extends JmesPathParser {

  /**
   * The file iterator.
   *
   * @var \Drupal\feeds_ex\File\LineIterator
   */
  protected $iterator;

  /**
   * {@inheritdoc}
   */
  protected function hasConfigurableContext() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp(FeedInterface $feed, FetcherResultInterface $fetcher_result, StateInterface $state) {
    parent::setUp($feed, $fetcher_result, $state);
    $this->iterator = new LineIterator($fetcher_result
      ->getFilePath());
    if (!$this->iterator
      ->getSize()) {
      throw new EmptyFeedException();
    }
    $this->iterator
      ->setLineLimit($this->configuration['line_limit']);
    if (!$state->total) {
      $state->total = $this->iterator
        ->getSize();
    }
    $this->iterator
      ->setStartPosition((int) $state->pointer);
  }

  /**
   * {@inheritdoc}
   */
  protected function parseItems(FeedInterface $feed, FetcherResultInterface $fetcher_result, ParserResultInterface $result, StateInterface $state) {
    $expressions = $this
      ->prepareExpressions();
    $variable_map = $this
      ->prepareVariables($expressions);
    foreach ($this->iterator as $row) {
      $row = $this
        ->getEncoder()
        ->convertEncoding($row);
      try {
        $row = $this->utility
          ->decodeJsonArray($row);
      } catch (RuntimeException $e) {

        // An array wasn't returned. Skip this item.
        continue;
      }
      if ($item = $this
        ->executeSources($row, $expressions, $variable_map)) {
        $result
          ->addItem($item);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function cleanUp(FeedInterface $feed, ParserResultInterface $result, StateInterface $state) {
    $state->pointer = $this->iterator
      ->ftell();
    unset($this->iterator);
    parent::cleanUp($feed, $result, $state);
  }

}

Classes

Name	Description
JmesPathLinesParser	Defines a JSON Lines parser using JMESPath.