From 25fc359c69f05f1e0c46192fd1021ff0f931bb11 Mon Sep 17 00:00:00 2001 From: Lucas Gass Date: Thu, 21 Nov 2024 17:59:54 +0000 Subject: [PATCH] Bug 37334: Add POD Signed-off-by: Emmi Takkinen --- Koha/Items.pm | 49 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 47 insertions(+), 2 deletions(-) diff --git a/Koha/Items.pm b/Koha/Items.pm index c7288e24141..43dfebb6787 100644 --- a/Koha/Items.pm +++ b/Koha/Items.pm @@ -222,6 +222,14 @@ sub filter_by_bookable { ); } +=head3 filter_by_checked_out + + my $checked_out_items = $items->filter_by_checked_out; + +Returns a new resultset, containing only those items that are currently checked out. + +=cut + sub filter_by_checked_out { my ( $self, $params ) = @_; @@ -237,6 +245,14 @@ sub filter_by_checked_out { return $self->search( { 'me.itemnumber' => { '-in' => $checkouts } } ); } +=head3 filter_by_in_transit + + my $in_tranist_items = $items->filter_by_in_transit; + +Returns a new resultset, containing only those items that are currently in transit. + +=cut + sub filter_by_in_transit { my ( $self, $params ) = @_; @@ -252,9 +268,13 @@ sub filter_by_in_transit { return $self->search( { 'me.itemnumber' => { '-in' => $transfers } } ); } -sub filter_by_for_loan { +=head3 filter_by_has_holds -} + my $has_hold_items = $items->filter_by_has_holds; + +Returns a new resultset, containing only those items that currently have holds. + +=cut sub filter_by_has_holds { my ( $self, $params ) = @_; @@ -271,6 +291,14 @@ sub filter_by_has_holds { return $self->search( { 'me.itemnumber' => { '-in' => $holds } } ); } +=head3 filter_by_has_recalls + + my $has_recalls_items = $items->filter_by_has_recalls; + +Returns a new resultset, containing only those items that currently have recalls. + +=cut + sub filter_by_has_recalls { my ( $self, $params ) = @_; @@ -286,6 +314,14 @@ sub filter_by_has_recalls { return $self->search( { 'me.itemnumber' => { '-in' => $recalls } } ); } +=head3 filter_by_available + + my $available_items = $items->filter_by_available; + +Returns a new resultset, containing only those items that are currently available. + +=cut + sub filter_by_available { my ($self) = @_; @@ -575,6 +611,15 @@ sub apply_regex { return $value; } + +=head3 search + + my $search_result = $object->search( $params, $attributes ); + +Filters items based on the specified status. + +=cut + sub search { my ( $self, $params, $attributes ) = @_; my $status = ( $params && ref($params) eq 'HASH' ) ? delete $params->{_status} : undef; -- 2.39.5