Browse Source

Bug 26636: (QA follow-up) Add POD

Sponsored-by: Virginia Polytechnic Institute and State University

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Andrew Fuerste-Henry <andrew@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
21.05.x
Tomás Cohen Arazi 2 years ago
committed by Jonathan Druart
parent
commit
2294095574
  1. 30
      Koha/REST/Plugin/Objects.pm

30
Koha/REST/Plugin/Objects.pm

@ -29,21 +29,23 @@ Koha::REST::Plugin::Objects
=head2 Helper methods
=head3 objects.search
=cut
sub register {
my ( $self, $app ) = @_;
=head3 objects.find
my $patrons_rs = Koha::Patrons->new;
my $patrons = $c->objects->search( $patrons_rs );
my $patrons = $c->objects->find( $patrons_rs, $id );
Performs a database search using given Koha::Objects object and query parameters.
Performs a database search using given Koha::Objects object and the $id.
Returns an arrayref of the hashrefs representing the resulting objects
for API rendering.
Returns I<undef> if no object is found Returns the I<API representation> of
the requested object. It passes through any embeds if specified.
=cut
sub register {
my ( $self, $app ) = @_;
$app->helper(
'objects.find' => sub {
my ( $c, $result_set, $id ) = @_;
@ -66,6 +68,18 @@ sub register {
}
);
=head3 objects.search
my $patrons_rs = Koha::Patrons->new;
my $patrons = $c->objects->search( $patrons_rs );
Performs a database search using given Koha::Objects object and query parameters.
Returns an arrayref of the hashrefs representing the resulting objects
for API rendering.
=cut
$app->helper(
'objects.search' => sub {
my ( $c, $result_set ) = @_;

Loading…
Cancel
Save