From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

SALVA / Sort-Key-DateTime-0.07 / lib / Sort / Key / DateTime.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

              
package Sort::Key::DateTime;
our $VERSION = '0.07';
use strict;
use warnings;
require Exporter;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw(dtkeysort
                    dtkeysort_inplace
                    rdtkeysort
                    rdtkeysort_inplac
                    dtsort
                    dtsort_inplace
                    rdtsort
                    rdtsort_inplace
                    mkkey_datetime
                    dtcmpstr);
use Sort::Key qw(keysort_inplace);
use DateTime;
use Carp;
sub dtcmpstr ($) {
    my $dt=shift;
    my $key = eval { sprintf("%010d%06d%010d", $dt->utc_rd_values) };
    $@ and croak "sorting key '$dt' generated for element '$_' is not a valid DateTime object ($@)";
    $key;
}
sub mkkey_datetime {
    my $dt = @_ ? shift : $_;
    sprintf("%010d%06d%010d", $dt->utc_rd_values);
}
use Sort::Key::Register dt => \&mkkey_datetime, 'string';
use Sort::Key::Register datetime => \&mkkey_datetime, 'string';
use Sort::Key::Maker dtkeysort => 'dt';
use Sort::Key::Maker rdtkeysort => '-dt';
use Sort::Key::Maker dtsort => \&mkkey_datetime, 'str';
use Sort::Key::Maker rdtsort => \&mkkey_datetime, '-str';
1;
__END__
=head1 NAME
Sort::Key::DateTime - Perl extension for sorting objects by some DateTime key
=head1 SYNOPSIS
  use Sort::Key::DateTime qw(dtkeysort);
  my @sorted = dtkeysort { $_->date } @meetings;
=head1 DESCRIPTION
Sort::Key::DateTime allows to sort objects by some (calculated) key of
type DateTime.
=head2 EXPORTS
=over 4
=item dtkeysort { CALC_DT_KEY } @array
returns the elements on C<@array> sorted by the DateTime key
calculated applying C<{ CALC_DT_KEY }> to them.
Inside C<{ CALC_DT_KEY }>, the object is available as C<$_>.
NOTE: sorting order is undefined when floating and non floating
DateTime keys are mixed.
=item rdtkeysort { CALC_DT_KEY } @array
sorted C<@array> in descending order
=item dtsort(@array)
=item rdtsort(@array)
sort an array of DateTime objects in ascending and descending order
respectively.
Example:
  my @sorted = dtsort @unsorted;
=item dtkeysort_inplace { CALC_DT_KEY } @array
=item rdtkeysort_inplace { CALC_DT_KEY } @array
=item dtsort @array
=item rdtsort @array
sort C<@array> in place.
=item mkkey_datetime($dt)
generates string sorting keys for DateTime objects
=back
=head1 SEE ALSO
L<Sort::Key>, L<Sort::Key::Maker>, perl L<sort> function docs.
L<DateTime> module documentation and FAQ available from the DateTime
project web site at L<http://datetime.perl.org/>
=head1 AUTHOR
Salvador FandiE<ntilde>o, E<lt>sfandino@yahoo.com<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2005, 2010 by Salvador FandiE<ntilde>o
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.4 or,
at your option, any later version of Perl 5 you may have available.
=cut