JDEGUEST / Module-Generic-v0.39.1 / lib / Module / Generic / DateTime / Interval.pod 

            

              
—
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

              
=encoding utf8
=head1 NAME
Module::Generic::DateTime::Interval - An Enhanced DateTime::Duration Object
=head1 SYNOPSIS
    use Module::Generic::DateTime::Interval;
    my $int = Module::Generic::DateTime::Interval->new( $duration );
    # Inspect by returning a formatted string showing year, month, etc
    print( $int->dump, "\n" );
    $int->days = 10;
    my $days = $int->days;
    $int->hours = 10;
    my $hours = $int->hours;
    $int->minutes = 10;
    my $minutes = $int->minutes;
    $int->months = 10;
    my $months = $int->months;
    $int->nanoseconds = 10;
    my $nano = $int->nanoseconds;
    $int->seconds = 10;
    my $seconds = $int->seconds;
    $int->weeks = 10;
    my $weeks = $int->weeks;
    $int->years = 10;
    my $years = $int->years;
    my $dt = DateTime->now;
    my $dt2 = DateTime->now->add( days => 10 );
    # Get an Module::Generic::DateTime::Interval object
    my $int = $dt2 - $dt;
    print $int->days, "\n"; # 10
=head1 DESCRIPTION
L<Module::Generic::DateTime::Interval> is a thin wrapper around L<DateTime::Duration> to provide enhance features. All other regular method calls of L<DateTime::Duration> are passed through to it via C<AUTOLOAD>.
This interval object is overloaded and allows the following operations: C<+>, C<->, C<*>, C<comparison>
=head1 METHODS
=head2 days
This is an lvalue method to set or get the number of days in this interval object.
Example:
    $int->days = 10;
    $int->days( 10 );
    my $days = $int->days;
=head2 hours
This is an lvalue method to set or get the number of hours in this interval object.
Example:
    $int->hours = 10;
    $int->hours( 10 );
    my $hours = $int->hours;
=head2 minutes
This is an lvalue method to set or get the number of minutes in this interval object.
Example:
    $int->minutes = 10;
    $int->minutes( 10 );
    my $minutes = $int->minutes;
=head2 months
This is an lvalue method to set or get the number of months in this interval object.
Example:
    $int->months = 10;
    $int->months( 10 );
    my $months = $int->months;
=head2 nanoseconds
This is an lvalue method to set or get the nanoseconds of days in this interval object.
Example:
    $int->nanoseconds = 10;
    $int->nanoseconds( 10 );
    my $nanoseconds = $int->nanoseconds;
=head2 seconds
This is an lvalue method to set or get the seconds of days in this interval object.
Example:
    $int->seconds = 10;
    $int->seconds( 10 );
    my $seconds = $int->seconds;
=head2 weeks
This is an lvalue method to set or get the weeks of days in this interval object.
Example:
    $int->weeks = 10;
    $int->weeks( 10 );
    my $weeks = $int->weeks;
=head2 years
This is an lvalue method to set or get the years of days in this interval object.
Example:
    $int->years = 10;
    $int->years( 10 );
    my $years = $int->years;
=head1 SERIALISATION
=for Pod::Coverage FREEZE
=for Pod::Coverage STORABLE_freeze
=for Pod::Coverage STORABLE_thaw
=for Pod::Coverage THAW
=for Pod::Coverage TO_JSON
Serialisation by L<CBOR|CBOR::XS>, L<Sereal> and L<Storable> is supported by this package. To that effect, the following subroutines are implemented: C<FREEZE>, C<THAW>, C<STORABLE_freeze> and C<STORABLE_thaw>
=head1 SEE ALSO
L<Module::Generic>, L<Module::Generic::DateTime>, L<DateTime>, L<DateTime::Format::Strptime>, L<DateTime::TimeZone>
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2000-2024 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.
=cut