class FeedsFileFetcherResult in Feeds 7.2

Definition of the import batch object created on the fetching stage by FeedsFileFetcher.

Hierarchy

• class \FeedsResult
  • class \FeedsFetcherResult
    • class \FeedsFileFetcherResult

File

plugins/FeedsFileFetcher.inc, line 12

Home of the FeedsFileFetcher and related classes.

class FeedsFileFetcherResult extends FeedsFetcherResult {

  /**
   * Constructor.
   */
  public function __construct($file_path) {
    parent::__construct('');
    $this->file_path = $file_path;
  }

  /**
   * Overrides parent::getRaw().
   */
  public function getRaw() {
    return $this
      ->sanitizeRaw(file_get_contents($this->file_path));
  }

  /**
   * Overrides parent::getFilePath().
   */
  public function getFilePath() {
    $this
      ->checkFile();
    return $this
      ->sanitizeFile($this->file_path);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsFetcherResult::$file_path	protected	property	The path to a file where the raw data is stored.
FeedsFetcherResult::$raw	protected	property	The raw fetched data.
FeedsFetcherResult::checkFile	protected	function	Checks that a file exists and is readable.
FeedsFetcherResult::constructFilePath	public	function	Constructs file name for saving the raw data.
FeedsFetcherResult::fileExists	public	function	Returns if the file to parse exists.
FeedsFetcherResult::getFeedsInProgressDir	public	function	Returns directory for storing files that are in progress of import.
FeedsFetcherResult::getFileContents	public	function	Returns the contents of a file, if it exists.
FeedsFetcherResult::rawExists	public	function	Returns if raw data exists.
FeedsFetcherResult::sanitizeFile	public	function	Sanitize the file in place.
FeedsFetcherResult::sanitizeRaw	public	function	Sanitize the raw content string.
FeedsFetcherResult::sanitizeRawOptimized	public	function	Sanitize the raw content string.
FeedsFetcherResult::saveRawToFile	public	function	Saves the raw fetcher result to a file.
FeedsFetcherResult::__sleep	public	function	Prevent saving the raw result when serializing object.
FeedsFileFetcherResult::getFilePath	public	function	Overrides parent::getFilePath(). Overrides FeedsFetcherResult::getFilePath
FeedsFileFetcherResult::getRaw	public	function	Overrides parent::getRaw(). Overrides FeedsFetcherResult::getRaw
FeedsFileFetcherResult::__construct	public	function	Constructor. Overrides FeedsFetcherResult::__construct