class FeedsOAIParser in Feeds OAI-PMH Fetcher and Parser 7

Class definition for OAI-PMH Dublin Core metadata parser.

Hierarchy

• class \FeedsOAIParser extends \FeedsParser

1 string reference to 'FeedsOAIParser'

feeds_oai_pmh_feeds_plugins in ./feeds_oai_pmh.module

Implementation of hook_feed_plugins().

File

./FeedsOAIParser.inc, line 12

Implementation of FeedsParser::parse().

class FeedsOAIParser extends FeedsParser {

  /**
   * Implementation of FeedsParser::parse().
   */
  public function parse(FeedsSource $source, FeedsFetcherResult $fetcher_result) {
    $result = new FeedsParserResult();
    require_once drupal_get_path('module', 'feeds_oai_pmh') . '/feeds_oai_pmh.inc';
    $feed = feeds_oai_pmh_parse($fetcher_result
      ->getRaw());
    if (!$feed) {

      // No items, return
      return $result;
    }

    // Check for items.
    if (is_array($feed['items'])) {

      // Add set name element to each of the items.
      $oai_endpoint_url = $source->config['FeedsOAIHTTPFetcher']['source'];
      $identify_response = feeds_oai_pmh_identify($oai_endpoint_url);
      if ($identify_response['repository']['sets']) {
        foreach ($feed['items'] as $index => $item) {
          foreach ($item['setspec_raw'] as $setspec) {
            $set_name = $identify_response['repository']['sets'][$setspec]['name'];
            $feed['items'][$index]['setspec_name'][] = $set_name;
          }

          // Return the items found in feed.
          $result->items[] = $item;
        }
      }
    }
    return $result;
  }

  /**
   * Implementation of FeedsParser::clear().
   *
   * Delete variables containing resumptionToken and from used in last fetch.
   */
  public function clear(FeedsSource $source) {

    // Only if FeedsOAIHTTPFetcher was used as the fetcher.
    if ($source->config['FeedsOAIHTTPFetcher']) {
      $oai_endpoint_url = $source->config['FeedsOAIHTTPFetcher']['source'];
      $set = $source->config['FeedsOAIHTTPFetcher']['set'];
      variable_del('feeds_oai:resumptionToken:' . $set . ':' . $oai_endpoint_url);
      variable_del('feeds_oai:from:' . $set . ':' . $oai_endpoint_url);
    }
    parent::clear($source);
  }

  /**
   * Return mapping sources.
   */
  public function getMappingSources() {
    self::loadMappers();
    $sources = array();
    drupal_alter('feeds_parser_sources', $sources, feeds_importer($this->id)->config['content_type']);
    $sources += array(
      'guid' => array(
        'name' => t('Repository Record identifier'),
        'description' => t('A unique string per each metadata record, defined by the repository.'),
      ),
      'timestamp' => array(
        'name' => t('Record publication date'),
        'description' => t("Date this metadata record was published on the repository. Different from the described item's publication date."),
      ),
      'metadata_record_url' => array(
        'name' => t('Raw metadata record URL'),
        'description' => t("The URL to a GetRecord OAI request for the source metadata record. Note: This URL will return raw XML data."),
      ),
      'url' => array(
        'name' => t('URL to resource'),
        'description' => t('All valid URLs detected in dc:identifier elements.'),
      ),
      'setspec_raw' => array(
        'name' => t('Set: setSpec (raw value)'),
        'description' => t("The set/setSpec from the record's header."),
      ),
      'setspec_name' => array(
        'name' => t('Set: name'),
        'description' => t("The set name for this record, taken from the repository's identify response."),
      ),
    );

    // Add dublin core field to mapping sources
    $elements = array(
      'title',
      'type',
      'subject',
      'contributor',
      'creator',
      'description',
      'publisher',
      'date',
      'format',
      'identifier',
      'source',
      'language',
      'relation',
      'coverage',
      'rights',
    );
    foreach ($elements as $element) {
      $sources[$element] = array(
        'name' => t('Metadata: dc:@element', array(
          '@element' => $element,
        )),
        'description' => t('From the metadata record.'),
      );
    }
    return $sources;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsOAIParser::clear	public	function	Implementation of FeedsParser::clear().
FeedsOAIParser::getMappingSources	public	function	Return mapping sources.
FeedsOAIParser::parse	public	function	Implementation of FeedsParser::parse().