gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Bug 23185: Realistic POD for Koha::Objects->search 

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
This commit is contained in:
Tomas Cohen Arazi 2020-05-07 18:20:57 -03:00
parent fdea245e99
commit b422e017ec
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Koha/Objects.pm
View File

@ -118,9 +118,21 @@ sub find_or_create {
return $object;
}
=head3 Koha::Objects->search();
=head3 search
my @objects = Koha::Objects->search($params);
# list context
my @objects = Koha::Objects->search([$params, $attributes]);
# scalar context
my $objects = Koha::Objects->search([$params, $attributes]);
while (my $object = $objects->next) {
do_stuff($object);
}
This B<instantiates> the I<Koha::Objects> class, and generates a resultset
based on the query I<$params> and I<$attributes> that are passed (like in DBIC).
In B<list context> it returns an array of I<Koha::Object> objects.
In B<scalar context> it returns an iterator.
=cut