You are here

Home » API reference » Date iCal 7.2 » date_ical.api.php

function hook_date_ical_feeds_object_alter in Date iCal 7.2

Alter the post-parse data for a single field from an iCal feed.

Parameters

$value: A string or object representing one parsed property of an iCal component.

$context: An associative array of context, with the following keys and values:

  • 'property_key': Inernal, parser-specific identifier for this property.
  • 'property': "RAW" value of this property.
  • 'item': The DateIcalComponentInterface object that holds the unparsed component.
  • 'parser_result': The parsed result of the whole Calendar.
  • 'feeds_source': Contains all the metadata about the configuration of this Feed.
5 invocations of hook_date_ical_feeds_object_alter()
DateIcalIcalcreatorParser::formatCategories in includes/DateIcalIcalcreatorParser.inc
Format Categories
DateIcalIcalcreatorParser::formatDateTime in includes/DateIcalIcalcreatorParser.inc
Format date fields.
DateIcalIcalcreatorParser::formatParamText in includes/DateIcalIcalcreatorParser.inc
Format Text Parameter
DateIcalIcalcreatorParser::formatRrule in includes/DateIcalIcalcreatorParser.inc
Format RRULEs, which specify when and how often the event is repeated.
DateIcalIcalcreatorParser::formatText in includes/DateIcalIcalcreatorParser.inc
Format text fields.

File

./date_ical.api.php, line 186

Code

function hook_date_ical_feeds_object_alter(&$value, $context) {

  // Example of what might be done with this alter hook
  if ($context['property_key'] == 'dtstart') {

    // Tweak the parsed FeedsDateTime object created from the start time.
    // ...
  }
}