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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
#!perl
# PODNAME: RT::Client::REST::SearchResult
# ABSTRACT: search results object.
use strict;
use warnings;
package RT::Client::REST::SearchResult;
$RT::Client::REST::SearchResult::VERSION = '0.56';
sub new {
my $class = shift;
my %opts = @_;
my $self = bless {}, ref($class) || $class;
# FIXME: add validation.
$self->{_object} = $opts{object};
$self->{_ids} = $opts{ids} || [];
return $self;
}
sub count { scalar(@{shift->{_ids}}) }
sub _retrieve {
my ($self, $obj) = @_;
unless ($obj->autoget) {
$obj->retrieve;
}
return $obj;
}
sub get_iterator {
my $self = shift;
my @ids = @{$self->{_ids}};
my $object = $self->{_object};
return sub {
if (wantarray) {
my @tomap = @ids;
@ids = ();
return map { $self->_retrieve($object->($_)) } @tomap;
} elsif (@ids) {
return $self->_retrieve($object->(shift(@ids)));
} else {
return; # This signifies the end of the iterations
}
};
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
RT::Client::REST::SearchResult - search results object.
=head1 VERSION
version 0.56
=head1 SYNOPSIS
my $iterator = $search->get_iterator;
my $count = $iterator->count;
while (defined(my $obj = &$iterator)) {
# do something with the $obj
}
=head1 DESCRIPTION
This class is a representation of a search result. This is the type
of the object you get back when you call method C<search()> on
L<RT::Client::REST::Object>-derived objects. It makes it easy to
iterate over results and find out just how many there are.
=head1 METHODS
=over 4
=item B<count>
Returns the number of search results. This number will always be the
same unless you stick your fat dirty fingers into the object and abuse
it. This number is not affected by calls to C<get_iterator()>.
=item B<get_iterator>
Returns a reference to a subroutine which is used to iterate over the
results.
Evaluating it in scalar context, returns the next object
or C<undef> if all the results have already been iterated over. Note
that for each object to be instantiated with correct values,
B<retrieve()> method is called on the object before returning it
to the caller.
Evaluating the subroutine reference in list context returns a list
of all results fully instantiated. WARNING: this may be expensive,
as each object is issued B<retrieve()> method. Subsequent calls to
the iterator result in empty list.
You may safely mix calling the iterator in scalar and list context. For
example:
$iterator = $search->get_iterator;
$first = &$iterator;
$second = &$iterator;
@the_rest = &$iterator;
You can get as many iterators as you want -- they will not step on
each other's toes.
=item B<new>
You should not have to call it yourself, but just for the sake of
completeness, here are the arguments:
my $search = RT::Client::REST::SearchResult->new(
ids => [1 .. 10],
object => sub { # Yup, that's a closure.
RT::Client::REST::Ticket->new(
id => shift,
rt => $rt,
);
},
);
=back
=head1 SEE ALSO
L<RT::Client::REST::Object>, L<RT::Client::REST>.
=head1 AUTHORS
=over 4
=item *
Abhijit Menon-Sen <ams@wiw.org>
=item *
Dmitri Tikhonov <dtikhonov@yahoo.com>
=item *
Damien "dams" Krotkine <dams@cpan.org>
=item *
Dean Hamstead <dean@bytefoundry.com.au>
=item *
Miquel Ruiz <mruiz@cpan.org>
=item *
JLMARTIN
=item *
SRVSH
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Dmitri Tikhonov.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
