Attachment 116596 Details for Bug 26636 – Bug 26636: (QA follow-up) Add POD

[patch] Bug 26636: (QA follow-up) Add POD

Bug-26636-QA-follow-up-Add-POD.patch (text/plain), 2.00 KB, created by Agustín Moyano on 2021-02-09 15:35:19 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Agustín Moyano

Created: 2021-02-09 15:35:19 UTC

Size: 2.00 KB

patch

obsolete

>From 0b651f83524c397a8d496b9fb44331c5575c4271 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Tue, 2 Feb 2021 16:22:07 -0300
>Subject: [PATCH] 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>
>---
> Koha/REST/Plugin/Objects.pm | 30 ++++++++++++++++++++++--------
> 1 file changed, 22 insertions(+), 8 deletions(-)
>
>diff --git a/Koha/REST/Plugin/Objects.pm b/Koha/REST/Plugin/Objects.pm
>index 635f6d08c7..5fc6303020 100644
>--- a/Koha/REST/Plugin/Objects.pm
>+++ b/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 ) = @_;
>-- 
>2.25.0

Actions: View | Diff | Splinter Review

Attachments on bug 26636: 111418 | 111419 | 116222 | 116223 | 116224 | 116225 | 116226 | 116227 | 116228 | 116229 | 116230 | 116231 | 116594 | 116595 | 116596 | 116597 | 116598 | 117669 | 117670 | 117671 | 117672 | 117673 | 127528 | 127529 | 127530 | 127531 | 127532