From 0083fc4f25d099a383324f14dc3d99f0aafcf9d3 Mon Sep 17 00:00:00 2001 From: Jonathan Druart Date: Tue, 22 Apr 2025 11:36:14 +0200 Subject: [PATCH] Bug 39367: Replace tabs with spaces in POD --- C4/SIP/ILS.pm | 16 ++-- C4/SIP/ILS/Item.pm | 90 +++++++++++----------- C4/SIP/ILS/Patron.pm | 176 +++++++++++++++++++++---------------------- C4/Scrubber.pm | 2 +- 4 files changed, 142 insertions(+), 142 deletions(-) diff --git a/C4/SIP/ILS.pm b/C4/SIP/ILS.pm index 85219584cf3..63fe6fae9b8 100644 --- a/C4/SIP/ILS.pm +++ b/C4/SIP/ILS.pm @@ -556,11 +556,11 @@ sub renew { # This is gross, but in a real ILS it would be better # if (defined($title_id)) { - # foreach my $i (@{$patron->{items}}) { - # $item = new ILS::Item $i; - # last if ($title_id eq $item->title_id); - # $item = undef; - # } + # foreach my $i (@{$patron->{items}}) { + # $item = new ILS::Item $i; + # last if ($title_id eq $item->title_id); + # $item = undef; + # } # } else { my $j = 0; my $count = scalar @{ $patron->{items} }; @@ -665,8 +665,8 @@ ILS - Portability layer to interface between Open-SIP and ILS $currency); $status = $ils->add_hold($patron_id, $patron_pwd, $item_id, - $title_id, $expiry_date, - $pickup_locn, $hold_type, $fee_ack); + $title_id, $expiry_date, + $pickup_locn, $hold_type, $fee_ack); $status = $ils->cancel_hold($patron_id, $patron_pwd, $item_id, $title_id); @@ -1019,7 +1019,7 @@ take. =item C<$fee_ack> -Boolean. If true, the patron has acknowleged that she is willing +Boolean. If true, the patron has acknowledged that she is willing to pay the fee associated with placing a hold on this item. If C<$fee_ack> is false, then the ILS should refuse to place the hold. diff --git a/C4/SIP/ILS/Item.pm b/C4/SIP/ILS/Item.pm index fed47a09faa..6392e3c6b82 100644 --- a/C4/SIP/ILS/Item.pm +++ b/C4/SIP/ILS/Item.pm @@ -593,13 +593,13 @@ ILS::Item - Portable Item status object class for SIP =head1 SYNOPSIS - use ILS; - use ILS::Item; + use ILS; + use ILS::Item; - # Look up item based on item_id - my $item = new ILS::Item $item_id; + # Look up item based on item_id + my $item = new ILS::Item $item_id; - # Basic object access methods + # Basic object access methods $item_id = $item->id; $title = $item->title_id; $media_type = $item->sip_media_type; @@ -637,11 +637,11 @@ For the most part, Cs are not operated on directly, but are passed to C methods as part of a transaction. That is, rather than having an item check itself in: - $item->checkin; + $item->checkin; the code tells the ILS that the item has returned: - $ils->checkin($item_id); + $ils->checkin($item_id); Similarly, patron's don't check things out (a la, C<$patron-Echeckout($item)>), but the ILS checks items out to @@ -665,17 +665,17 @@ the item. Return the SIP-defined media type of the item. The specification provides the following definitions: - 000 Other - 001 Book - 002 Magazine - 003 Bound journal - 004 Audio tape - 005 Video tape - 006 CD/CDROM - 007 Diskette - 008 Book with diskette - 009 Book with CD - 010 Book with audio tape + 000 Other + 001 Book + 002 Magazine + 003 Bound journal + 004 Audio tape + 005 Video tape + 006 CD/CDROM + 007 Diskette + 008 Book with diskette + 009 Book with CD + 010 Book with audio tape The SIP server does not use the media type code to alter its behavior at all; it merely passes it through to the self-service @@ -730,19 +730,19 @@ institution or library that owns the item." Returns a two-character string describing the circulation status of the item, as defined in the specification: - 01 Other - 02 On order - 03 Available - 04 Charged - 05 Charged; not to be recalled until earliest recall date - 06 In process - 07 Recalled - 08 Waiting on hold shelf - 09 Waiting to be re-shelved - 10 In transit between library locations - 11 Claimed returned - 12 Lost - 13 Missing + 01 Other + 02 On order + 03 Available + 04 Charged + 05 Charged; not to be recalled until earliest recall date + 06 In process + 07 Recalled + 08 Waiting on hold shelf + 09 Waiting to be re-shelved + 10 In transit between library locations + 11 Claimed returned + 12 Lost + 13 Missing =item C<$bool = $item-Eavailable> @@ -767,7 +767,7 @@ hold on the item. These functions all return the corresponding date as a standard SIP-format timestamp: - YYYYMMDDZZZZHHMMSS + YYYYMMDDZZZZHHMMSS Where the C<'Z'> characters indicate spaces. @@ -793,24 +793,24 @@ than one currency, however. The type of fee being charged, as defined by the SIP protocol specification: - 01 Other/unknown - 02 Administrative - 03 Damage - 04 Overdue - 05 Processing - 06 Rental - 07 Replacement - 08 Computer access charge - 09 Hold fee + 01 Other/unknown + 02 Administrative + 03 Damage + 04 Overdue + 05 Processing + 06 Rental + 07 Replacement + 08 Computer access charge + 09 Hold fee =item C<$mark = $item-Esip_security_marker> The type of security system with which the item is tagged: - 00 Other - 01 None - 02 3M Tattle-tape - 03 3M Whisper tape + 00 Other + 01 None + 02 3M Tattle-tape + 03 3M Whisper tape =item C<$msg = $item-Escreen_msg> diff --git a/C4/SIP/ILS/Patron.pm b/C4/SIP/ILS/Patron.pm index 6cdc16f3b48..e08b845d4fe 100644 --- a/C4/SIP/ILS/Patron.pm +++ b/C4/SIP/ILS/Patron.pm @@ -937,62 +937,62 @@ and to display information about the patron's borrowing activity. =head1 SYNOPSIS - use ILS; - use ILS::Patron; - - # Look up patron based on patron_id - my $patron = new ILS::Patron $patron_id - - # Basic object access methods - $patron_id = $patron->id; - $str = $patron->name; - $str = $patron->address; - $str = $patron->email_addr; - $str = $patron->home_phone; - $str = $patron->sip_birthdate; - $str = $patron->ptype; - $str = $patron->language; - $str = $patron->password; - $str = $patron->check_password($password); - $str = $patron->currency; - $str = $patron->screen_msg; - $str = $patron->print_line; - - # Check patron permissions - $bool = $patron->charge_ok; - $bool = $patron->renew_ok; - $bool = $patron->recall_ok; - $bool = $patron->hold_ok; - $bool = $patron->card_lost; - $bool = $patron->too_many_charged; - $bool = $patron->too_many_overdue; - $bool = $patron->too_many_renewal; - $bool = $patron->too_many_claim_return; - $bool = $patron->too_many_lost( $server ); - $bool = $patron->excessive_fines; - $bool = $patron->excessive_fees; - $bool = $patron->too_many_billed; - - # Patron borrowing activity - $num = $patron->recall_overdue; - $num = $patron->fee_amount; - $bool = $patron->drop_hold($item_id); - @holds = $patron->hold_items($start, $end); - @items = $patron->overdue_items($start, $end); - @items = $patron->charged_items($start, $end); - @items = $patron->fine_items($start, $end); - @items = $patron->recall_items($start, $end); - @items = $patron->unavail_holds($start, $end); - - # Changing a patron's status - $patron->block($card_retained, $blocked_msg); - $patron->enable; + use ILS; + use ILS::Patron; + + # Look up patron based on patron_id + my $patron = new ILS::Patron $patron_id + + # Basic object access methods + $patron_id = $patron->id; + $str = $patron->name; + $str = $patron->address; + $str = $patron->email_addr; + $str = $patron->home_phone; + $str = $patron->sip_birthdate; + $str = $patron->ptype; + $str = $patron->language; + $str = $patron->password; + $str = $patron->check_password($password); + $str = $patron->currency; + $str = $patron->screen_msg; + $str = $patron->print_line; + + # Check patron permissions + $bool = $patron->charge_ok; + $bool = $patron->renew_ok; + $bool = $patron->recall_ok; + $bool = $patron->hold_ok; + $bool = $patron->card_lost; + $bool = $patron->too_many_charged; + $bool = $patron->too_many_overdue; + $bool = $patron->too_many_renewal; + $bool = $patron->too_many_claim_return; + $bool = $patron->too_many_lost( $server ); + $bool = $patron->excessive_fines; + $bool = $patron->excessive_fees; + $bool = $patron->too_many_billed; + + # Patron borrowing activity + $num = $patron->recall_overdue; + $num = $patron->fee_amount; + $bool = $patron->drop_hold($item_id); + @holds = $patron->hold_items($start, $end); + @items = $patron->overdue_items($start, $end); + @items = $patron->charged_items($start, $end); + @items = $patron->fine_items($start, $end); + @items = $patron->recall_items($start, $end); + @items = $patron->unavail_holds($start, $end); + + # Changing a patron's status + $patron->block($card_retained, $blocked_msg); + $patron->enable; =head1 INITIALIZATION A patron object is created by calling - $patron = new ILS::Patron $patron_id; + $patron = new ILS::Patron $patron_id; where C<$patron_id> is the patron's barcode as received from the self service terminal. If the patron barcode is not registered, @@ -1004,14 +1004,14 @@ The following functions return the corresponding information about the given patron, or C if the information is unavailable. - $patron_id = $patron-Eid; - $str = $patron-Ename; - $str = $patron-Eaddress; - $str = $patron-Eemail_addr; - $str = $patron-Ehome_phone; + $patron_id = $patron-Eid; + $str = $patron-Ename; + $str = $patron-Eaddress; + $str = $patron-Eemail_addr; + $str = $patron-Ehome_phone; - $str = $patron-Escreen_msg; - $str = $patron-Eprint_line; + $str = $patron-Escreen_msg; + $str = $patron-Eprint_line; If there are outstanding display messages associated with the patron, then these return the screen message and print line, @@ -1025,7 +1025,7 @@ explication however. Returns the patron's birthday formatted according to the SIP specification: - YYYYMMDD HHMMSS + YYYYMMDD HHMMSS =head2 C<$str = $patron-Eptype;> @@ -1043,14 +1043,14 @@ A three-digit string encoding the patron's preferred language. The full list is defined in the SIP specification, but some of the important values are: - 000 Unknown (default) - 001 English - 002 French - 008 Spanish - 011 Canadian French - 016 Arabic - 019 Chinese - 021 North American Spanish + 000 Unknown (default) + 001 English + 002 French + 008 Spanish + 011 Canadian French + 016 Arabic + 019 Chinese + 021 North American Spanish =head2 C<$bool = $patron-Echeck_password($password);> @@ -1066,20 +1066,20 @@ patron's preferred currency. Most of the methods associated with Patrons are related to checking if they're authorized to perform various actions: - $bool = $patron-Echarge_ok; - $bool = $patron-Erenew_ok; - $bool = $patron-Erecall_ok; - $bool = $patron-Ehold_ok; - $bool = $patron-Ecard_lost; - $bool = $patron-Erecall_overdue; - $bool = $patron-Etoo_many_charged; - $bool = $patron-Etoo_many_overdue; - $bool = $patron-Etoo_many_renewal; - $bool = $patron-Etoo_many_claim_return; - $bool = $patron-Etoo_many_lost( $server ); - $bool = $patron-Eexcessive_fines; - $bool = $patron-Eexcessive_fees; - $bool = $patron-Etoo_many_billed; + $bool = $patron-Echarge_ok; + $bool = $patron-Erenew_ok; + $bool = $patron-Erecall_ok; + $bool = $patron-Ehold_ok; + $bool = $patron-Ecard_lost; + $bool = $patron-Erecall_overdue; + $bool = $patron-Etoo_many_charged; + $bool = $patron-Etoo_many_overdue; + $bool = $patron-Etoo_many_renewal; + $bool = $patron-Etoo_many_claim_return; + $bool = $patron-Etoo_many_lost( $server ); + $bool = $patron-Eexcessive_fines; + $bool = $patron-Eexcessive_fees; + $bool = $patron-Etoo_many_billed; =head1 LISTS OF ITEMS ASSOCIATED WITH THE USER @@ -1090,17 +1090,17 @@ and C<$end>, which define a subset of the list of items to be returned (C<1> is the first item in the list). The following methods all return a reference to a list of C<$item_id>s: - $items = $patron-Ehold_items($start, $end); - $items = $patron-Eoverdue_items($start, $end); - $items = $patron-Echarged_items($start, $end); - $items = $patron-Erecall_items($start, $end); - $items = $patron-Eunavail_holds($start, $end); + $items = $patron-Ehold_items($start, $end); + $items = $patron-Eoverdue_items($start, $end); + $items = $patron-Echarged_items($start, $end); + $items = $patron-Erecall_items($start, $end); + $items = $patron-Eunavail_holds($start, $end); It is also possible to retrieve an itemized list of the fines outstanding. This method returns a reference to an itemized list of fines: - $fines = $patron-Efine_items($start, $end); + $fines = $patron-Efine_items($start, $end); =head1 PATRON BORROWING ACTIVITY @@ -1132,6 +1132,6 @@ blocked, or C if the patron ID is not valid. =head2 C<$patron-Eenable;> -Reenable the patron after she's been blocked. This is a test +Re-enable the patron after she's been blocked. This is a test function and will not normally be called by self-service terminals in production. diff --git a/C4/Scrubber.pm b/C4/Scrubber.pm index f09fb998e49..855524e2b6d 100644 --- a/C4/Scrubber.pm +++ b/C4/Scrubber.pm @@ -38,7 +38,7 @@ my %scrubbertypes = ( ); sub new { - shift; # ignore our class we are wrapper + shift; # ignore our class we are wrapper my $type = (@_) ? shift : 'default'; if ( !exists $scrubbertypes{$type} ) { croak "New called with unrecognized type '$type'"; -- 2.34.1