interface FetcherResultInterface in Feeds 8.3

Defines the interface for result objects returned by fetcher plugins.

Hierarchy

• interface \Drupal\feeds\Result\FetcherResultInterface

12 files declare their use of FetcherResultInterface

CsvParser.php in src/Feeds/Parser/CsvParser.php

FeedsBatchExecutable.php in src/FeedsBatchExecutable.php

FeedsExecutable.php in src/FeedsExecutable.php

FeedsExecutableTest.php in tests/src/Unit/FeedsExecutableTest.php

FetchEvent.php in src/Event/FetchEvent.php

... See full list

File

src/Result/FetcherResultInterface.php, line 8

Namespace

Drupal\feeds\Result

interface FetcherResultInterface {

  /**
   * Returns the file provided by the fetcher as a string.
   *
   * @return string
   *   The raw content from the source as a string.
   *
   * @throws \RuntimeException
   *   Thrown if an unexpected problem occurred usually regarding file handling.
   */
  public function getRaw();

  /**
   * Returns the path to the file containing the file provided by the fetcher.
   *
   * When it comes to preference and efficiency, this method should be used
   * whenever possible by parsers so that they do not have to load the entire
   * file into memory.
   *
   * @return string
   *   A path to a file containing the raw content of a feed.
   *
   * @throws \RuntimeException
   *   Thrown if an unexpected problem occurred usually regarding file handling.
   */
  public function getFilePath();

}

Members

Name	Modifiers	Type	Description	Overrides
FetcherResultInterface::getFilePath	public	function	Returns the path to the file containing the file provided by the fetcher.	1
FetcherResultInterface::getRaw	public	function	Returns the file provided by the fetcher as a string.	1