Toby Inkster

NAME

HTML::Microformats::Format::hAlarm - an hCalendar alarm component

SYNOPSIS

 use Data::Dumper;
 use HTML::Microformats::DocumentContext;
 use HTML::Microformats::Format::hCalendar;

 my $context = HTML::Microformats::DocumentContext->new($dom, $uri);
 my @cals    = HTML::Microformats::Format::hCalendar->extract_all(
                   $dom->documentElement, $context);
 foreach my $cal (@cals)
 {
   foreach my $ev ($cal->get_vevent)
   {
     foreach my $alarm ($ev->get_valarm)
     {
       print $alarm->get_description . "\n";
           }
   }
 }

DESCRIPTION

HTML::Microformats::Format::hAlarm is a helper module for HTML::Microformats::Format::hCalendar. This class is used to represent alarm components within calendars. Generally speaking, you want to use HTML::Microformats::Format::hCalendar instead.

HTML::Microformats::Format::hAlarm inherits from HTML::Microformats::Format. See the base class definition for a description of property getter/setter methods, constructors, etc.

Additional Method

  • to_icalendar

    This method exports the data in iCalendar format. It requires RDF::iCalendar to work, and will throw an error at run-time if it's not available.

BUGS

Please report any bugs to http://rt.cpan.org/.

SEE ALSO

HTML::Microformats::Format::hCalendar, HTML::Microformats::Format, HTML::Microformats.

AUTHOR

Toby Inkster <tobyink@cpan.org>.

COPYRIGHT AND LICENCE

Copyright 2008-2012 Toby Inkster

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.