class FeedsOPMLParser in Feeds 7.2

Feeds parser plugin that parses OPML feeds.

Hierarchy

• class \FeedsConfigurable
  • class \FeedsPlugin implements FeedsSourceInterface
    • class \FeedsParser
      • class \FeedsOPMLParser

2 string references to 'FeedsOPMLParser'

feeds_news_feeds_importer_default in feeds_news/feeds_news.feeds_importer_default.inc

Implements hook_feeds_importer_default().

_feeds_feeds_plugins in ./feeds.plugins.inc

Break out for feeds_feed_plugins().

File

plugins/FeedsOPMLParser.inc, line 11

OPML Parser plugin.

class FeedsOPMLParser extends FeedsParser {

  /**
   * Implements FeedsParser::parse().
   */
  public function parse(FeedsSource $source, FeedsFetcherResult $fetcher_result) {
    feeds_include_library('opml_parser.inc', 'opml_parser');
    $opml = opml_parser_parse($fetcher_result
      ->getRaw());
    $result = new FeedsParserResult($opml['items']);
    $result->title = $opml['title'];
    return $result;
  }

  /**
   * Return mapping sources.
   */
  public function getMappingSources() {
    return array(
      'title' => array(
        'name' => t('Feed title'),
        'description' => t('Title of the feed.'),
      ),
      'xmlurl' => array(
        'name' => t('Feed URL'),
        'description' => t('URL of the feed.'),
      ),
    ) + parent::getMappingSources();
  }

  /**
   * Overrides FeedsParser::providesSourceTitle().
   *
   * This parser supports retrieving a title from the source.
   */
  public function providesSourceTitle() {
    return TRUE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsConfigurable::$config	protected	property	Holds the actual configuration information.
FeedsConfigurable::$disabled	protected	property	CTools export enabled status of this object.
FeedsConfigurable::$export_type	protected	property	CTools export type of this object.
FeedsConfigurable::$id	protected	property	An unique identifier for the configuration.
FeedsConfigurable::addConfig	public	function	Similar to setConfig but adds to existing configuration.
FeedsConfigurable::configForm	public	function	Returns configuration form for this object.	6
FeedsConfigurable::configFormSubmit	public	function	Submission handler for configForm().	2
FeedsConfigurable::configFormValidate	public	function	Validation handler for configForm().	3
FeedsConfigurable::copy	public	function	Copy a configuration.	1
FeedsConfigurable::doesExist	public	function	Determine whether this object is persistent.	1
FeedsConfigurable::existing	public	function	Determines whether this object is persistent and enabled.	1
FeedsConfigurable::getConfig	public	function	Implements getConfig().	1
FeedsConfigurable::hasConfigForm	public	function	Returns whether or not the configurable has a config form.
FeedsConfigurable::isEnabled	public	function	Determine whether this object is enabled.
FeedsConfigurable::setConfig	public	function	Set configuration.
FeedsConfigurable::validateConfig	public	function	Validates the configuration.	2
FeedsConfigurable::__get	public	function	Overrides magic method __get().
FeedsConfigurable::__isset	public	function	Override magic method __isset(). This is needed due to overriding __get().
FeedsOPMLParser::getMappingSources	public	function	Return mapping sources. Overrides FeedsParser::getMappingSources
FeedsOPMLParser::parse	public	function	Implements FeedsParser::parse(). Overrides FeedsParser::parse
FeedsOPMLParser::providesSourceTitle	public	function	Overrides FeedsParser::providesSourceTitle(). Overrides FeedsParser::providesSourceTitle
FeedsParser::clear	public	function	Clear all caches for results for given source.
FeedsParser::getMappingSourceList	public	function	Get list of mapped sources.	1
FeedsParser::getSourceElement	public	function	Get an element identified by $element_key of the given item. The element key corresponds to the values in the array returned by FeedsParser::getMappingSources().	1
FeedsParser::pluginType	public	function	Implements FeedsPlugin::pluginType(). Overrides FeedsPlugin::pluginType
FeedsPlugin::$pluginDefinition	protected	property	The plugin definition.
FeedsPlugin::all	public static	function	Get all available plugins.
FeedsPlugin::byType	public static	function	Gets all available plugins of a particular type.
FeedsPlugin::child	public static	function	Determines whether given plugin is derived from given base plugin.
FeedsPlugin::configDefaults	public	function	Overrides FeedsConfigurable::configDefaults(). Overrides FeedsConfigurable::configDefaults	4
FeedsPlugin::dependencies	public	function	Implements FeedsConfigurable::dependencies(). Overrides FeedsConfigurable::dependencies	1
FeedsPlugin::hasSourceConfig	public	function	Returns TRUE if $this->sourceForm() returns a form. Overrides FeedsSourceInterface::hasSourceConfig
FeedsPlugin::instance	public static	function	Instantiates a FeedsPlugin object. Overrides FeedsConfigurable::instance
FeedsPlugin::loadMappers	public static	function	Loads on-behalf implementations from mappers/ directory.
FeedsPlugin::pluginDefinition	public	function	Returns the plugin definition.
FeedsPlugin::save	public	function	Save changes to the configuration of this object. Delegate saving to parent (= Feed) which will collect information from this object by way of getConfig() and store it. Overrides FeedsConfigurable::save	1
FeedsPlugin::setPluginDefinition	protected	function	Sets the plugin definition.
FeedsPlugin::sourceDefaults	public	function	Implements FeedsSourceInterface::sourceDefaults(). Overrides FeedsSourceInterface::sourceDefaults	1
FeedsPlugin::sourceDelete	public	function	A source is being deleted. Overrides FeedsSourceInterface::sourceDelete	2
FeedsPlugin::sourceForm	public	function	Callback methods, exposes source form. Overrides FeedsSourceInterface::sourceForm	3
FeedsPlugin::sourceFormValidate	public	function	Validation handler for sourceForm. Overrides FeedsSourceInterface::sourceFormValidate	2
FeedsPlugin::sourceSave	public	function	A source is being saved. Overrides FeedsSourceInterface::sourceSave	2
FeedsPlugin::typeOf	public static	function	Determines the type of a plugin.
FeedsPlugin::__construct	protected	function	Constructs a FeedsPlugin object. Overrides FeedsConfigurable::__construct