Perl 5.42 is released: See what's new Learn more

TOBYINK / HTML-Microformats-0.100 / lib / HTML / Microformats / Format / hAlarm.pm 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
—
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

              
=head1 NAME
HTML::Microformats::Format::hAlarm - an hCalendar alarm component
=head1 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";
           }
   }
 }
=head1 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.
=cut
package HTML::Microformats::Format::hAlarm;
use base qw(HTML::Microformats::Format HTML::Microformats::Mixin::Parser);
use common::sense;
use 5.008;
our $VERSION = '0.100';
sub new
{
        my ($class, $element, $context) = @_;
        my $cache = $context->cache;
         
        return $cache->get($context, $element, $class)
                if defined $cache && $cache->get($context, $element, $class);
         
        my $self = {
                'element'    => $element ,
                'context'    => $context ,
                'cache'      => $cache ,
                'id'         => $context->make_bnode($element) ,
                };
         
        bless $self, $class;
         
        my $clone = $element->cloneNode(1);  
        $self->_expand_patterns($clone);
        $self->_simple_parse($clone);
        $cache->set($context, $element, $class, $self)
                if defined $cache;
        return $self;
}
sub format_signature
{
        my $ical  = 'http://www.w3.org/2002/12/cal/icaltzd#';
        my $icalx = 'http://buzzword.org.uk/rdf/icaltzdx#';
        return {
                'root' => 'valarm',
                'classes' => [
                        ['action',       '?',  {'value-title'=>'allow'}],
                        ['attach',       'U?'],
                        ['attendee',     'M*', {'embedded'=>'hCard', 'is-in-cal'=>1}],
                        ['description',  '?'],
                        ['duration',     'D?'],
                        ['repeat',       'n?', {'value-title'=>'allow'}],
                        ['trigger',      'D?'] # TODO: should really allow 'related' subproperty and allow datetime values too. post-0.001
                ],
                'options' => {
                        'rel-enclosure'  => 'attach',
                },
                'rdf:type' => ["${ical}Valarm"] ,
                'rdf:property' => {
                        'action'           => { 'literal'  => ["${ical}action"] } ,
                        'attach'           => { 'resource' => ["${ical}attach"] } ,
                        'attendee'         => { 'resource' => ["${ical}attendee"], 'literal'  => ["${icalx}attendee"] } ,
                        'description'      => { 'literal'  => ["${ical}description"] } ,
                        'duration'         => { 'literal'  => ["${ical}duration"] } ,
                        'repeat'           => { 'literal'  => ["${ical}repeat"] , 'literal_datatype'=>'integer' } ,
                        'trigger'          => { 'literal'  => ["${ical}trigger"] } ,
                },
        };
}
sub profiles
{
        return HTML::Microformats::Format::hCalendar::profiles(@_);
}
1;
=head1 BUGS
Please report any bugs to L<http://rt.cpan.org/>.
=head1 SEE ALSO
L<HTML::Microformats::Format::hCalendar>,
L<HTML::Microformats::Format>,
L<HTML::Microformats>.
=head1 AUTHOR
Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
=head1 COPYRIGHT
Copyright 2008-2010 Toby Inkster
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut