class ParserIcalFeedsParser in iCal feed parser 6.2

Class definition for iCal date module Parser.

Parses iCal feeds using the iCal parser included with the date module.

Hierarchy

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

2 string references to 'ParserIcalFeedsParser'

ParserIcalFeedsTestCase::createConfiguredFeed in tests/parser_ical_feeds.test

Basic test configured feed item, to import feed into.

parser_ical_feeds_plugins in ./parser_ical.module

Implementation of ctools plugin for feeds hook_feeds_plugins().

File

includes/ParserIcalFeedsParser.inc, line 107

class ParserIcalFeedsParser extends FeedsParser {

  /**
   * Parse content fetched by fetcher.
   */
  public function parse(FeedsImportBatch $batch, FeedsSource $source) {
    module_load_include('inc', 'parser_ical', 'parser_ical.dateapi');
    $result = _parser_ical_parse($batch
      ->getRaw());
    $batch
      ->setTitle($result['title']);
    $batch
      ->setItems($result['items']);

    // also available description, calscale, timezone
  }

  /**
   * Return mapping sources.
   *
   * At a future point, we could expose data type information here,
   * storage systems like Data module could use this information to store
   * parsed data automatically in fields with a correct field type.
   */
  public function getMappingSources() {
    return array(
      'title' => array(
        'name' => t('Title'),
        'description' => t('Title of the feed item.'),
      ),
      'description' => array(
        'name' => t('Description'),
        'description' => t('Description of the feed item.'),
      ),
      // 'author' => t('Author'), // not implemented
      'timestamp' => array(
        'name' => t('Published date'),
        'description' => t('Published date as UNIX time UTC of the feed item.'),
      ),
      'url' => array(
        'name' => t('Item URL (link)'),
        'description' => t('URL of the feed item.'),
      ),
      'guid' => array(
        'name' => t('Item GUID'),
        'description' => t('Global Unique Identifier of the feed item.'),
      ),
      'tags' => array(
        'name' => t('Categories'),
        'description' => t('An array of categories that have been assigned to the feed item.'),
      ),
      'ical_date' => array(
        'name' => t('iCal Date'),
        'description' => t('iCal date associated with item as an array.'),
      ),
      'ical_location' => array(
        'name' => t('iCal location string'),
        'description' => t('The location string associated with an item.'),
      ),
    ) + parent::getMappingSources();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsConfigurable::$config	protected	property
FeedsConfigurable::$disabled	protected	property	CTools export enabled status of this object.
FeedsConfigurable::$export_type	protected	property
FeedsConfigurable::$id	protected	property
FeedsConfigurable::addConfig	public	function	Similar to setConfig but adds to existing configuration.	1
FeedsConfigurable::configDefaults	public	function	Return default configuration.	6
FeedsConfigurable::configForm	public	function	Return configuration form for this object. The keys of the configuration form must match the keys of the array returned by configDefaults().	10
FeedsConfigurable::configFormSubmit	public	function	Submission handler for configForm().	3
FeedsConfigurable::configFormValidate	public	function	Validation handler for configForm().	3
FeedsConfigurable::copy	public	function	Copy a configuration.	1
FeedsConfigurable::existing	public	function	Determine whether this object is persistent and enabled. I. e. it is defined either in code or in the database and it is enabled.	1
FeedsConfigurable::getConfig	public	function	Implementation of getConfig().	1
FeedsConfigurable::instance	public static	function	Instantiate a FeedsConfigurable object.	1
FeedsConfigurable::setConfig	public	function	Set configuration.	1
FeedsConfigurable::__get	public	function	Override magic method __get(). Make sure that $this->config goes through getConfig()
FeedsConfigurable::__isset	public	function	Override magic method __isset(). This is needed due to overriding __get().
FeedsParser::clear	public	function	Clear all caches for results for given source.
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
FeedsPlugin::hasSourceConfig	public	function	Returns TRUE if $this->sourceForm() returns a form. Overrides FeedsSourceInterface::hasSourceConfig
FeedsPlugin::loadMappers	protected static	function	Loads on-behalf implementations from mappers/ directory.
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
FeedsPlugin::sourceDefaults	public	function	Implementation of FeedsSourceInterface::sourceDefaults(). Overrides FeedsSourceInterface::sourceDefaults	1
FeedsPlugin::sourceDelete	public	function	A source is being deleted. Overrides FeedsSourceInterface::sourceDelete	1
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	1
FeedsPlugin::__construct	protected	function	Constructor. Overrides FeedsConfigurable::__construct
ParserIcalFeedsParser::getMappingSources	public	function	Return mapping sources. Overrides FeedsParser::getMappingSources
ParserIcalFeedsParser::parse	public	function	Parse content fetched by fetcher. Overrides FeedsParser::parse