[Koha-cvs] koha/C4 Biblio.pm [dev_week]

[Joshua Ferraro]

CVSROOT:        /sources/koha
Module name:    koha
Branch:         dev_week
Changes by:     Joshua Ferraro <kados>  06/09/24 23:10:01

Modified files:
        C4             : Biblio.pm 

Log message:
        improving POD

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/koha/C4/Biblio.pm?cvsroot=koha&only_with_tag=dev_week&r1=1.115.2.51.2.26&r2=1.115.2.51.2.27

Patches:
Index: Biblio.pm
===================================================================
RCS file: /sources/koha/koha/C4/Biblio.pm,v
retrieving revision 1.115.2.51.2.26
retrieving revision 1.115.2.51.2.27
diff -u -b -r1.115.2.51.2.26 -r1.115.2.51.2.27
--- Biblio.pm   24 Sep 2006 21:48:15 -0000      1.115.2.51.2.26
+++ Biblio.pm   24 Sep 2006 23:10:01 -0000      1.115.2.51.2.27
@@ -83,9 +83,11 @@
 Biblio.pm contains functions for managing storage and editing of bibliographic 
data within Koha. Most of the functions in this module are used for cataloging 
records: adding, editing, or removing biblios, biblioitems, or items. Koha's 
stores bibliographic information in three places:
 
 =over 4 
+
 1. in the biblio,biblioitems,items, etc tables, which are limited to a 
one-to-one mapping to underlying MARC data
 2. as raw MARC in the Zebra index and storage engine
 3. as raw MARC the biblioitems.marc
+
 =back
 
 In the 2.4 version of Koha, the authoritative record-level information is in 
biblioitems.marc and the authoritative items information is in the items table.
@@ -120,7 +122,6 @@
 
 =back
 
-
 =head1 EXPORTED FUNCTIONS
 
 =head2 AddBiblio
@@ -129,7 +130,7 @@
 
 ($biblionumber,$oldbibnum,$oldbibitemnum) = 
AddBiblio($dbh,$record,$frameworkcode);
 
-Adds a new biblio to koha
+Exported function (core API) for adding a new biblio to koha.
 
 =back
 
@@ -252,21 +253,21 @@
 
 =over 4
 
-AddItem()
+AddItem( $dbh, $record, $biblionumber)
 
-Add a new item to Koha
+Exported function (core API) for adding a new item to Koha
 
 =back
 
 =cut
 
 sub AddItem {
-    my ( $dbh, $record, $bibid ) = @_;
+    my ( $dbh, $record, $biblionumber ) = @_;
     # add item in old-DB
-    my $frameworkcode=MARCfind_frameworkcode($dbh,$bibid);
+    my $frameworkcode=MARCfind_frameworkcode($dbh,$biblionumber);
     my $item = &MARCmarc2koha( $dbh, $record,$frameworkcode );
     # needs old biblionumber and biblioitemnumber
-    $item->{'biblionumber'} = $bibid;
+    $item->{'biblionumber'} = $biblionumber;
     my $sth =
       $dbh->prepare(
         "select biblioitemnumber,itemtype from biblioitems where 
biblionumber=?");
@@ -319,7 +320,7 @@
 
 ModBiblio($dbh,$record,$biblionumber,$frameworkcode);
 
-Exported function to modify a biblio
+Exported function (core API) to modify a biblio
 
 =back
 
@@ -379,16 +380,18 @@
 
 =over 4
 
+Exported function (core API) for modifying an item in Koha.
+
 =back
 
 =cut
 
 
 sub ModItem {
-    my ( $dbh, $record, $bibid, $itemnumber, $delete ) = @_;
+    my ( $dbh, $record, $biblionumber, $itemnumber, $delete ) = @_;
 
-    &MARCmoditem( $dbh, $record, $bibid, $itemnumber, $delete );
-    my $frameworkcode=MARCfind_frameworkcode($dbh,$bibid);
+    &MARCmoditem( $dbh, $record, $bilionumber, $itemnumber, $delete );
+    my $frameworkcode=MARCfind_frameworkcode($dbh,$biblionumber);
     my $olditem = MARCmarc2koha( $dbh, $record,$frameworkcode );
     _koha_modify_item( $dbh, $olditem );
 }
@@ -399,9 +402,14 @@
 
 my $error = &DelBiblio($dbh,$bibid);
 
-Delete biblio record from Zebra and Koha tables (biblio,biblioitems,items)
+Exported function (core API) for deleting a biblio in koha.
+
+Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
+
 Also backs it up to deleted* tables
 
+Checks to make sure there are not issues on any of the items
+
 return:
 C<$error> : undef unless an error occurs
 
@@ -472,18 +480,19 @@
 
 =over 4
 
-Deletes an item record
+DelItem( $dbh, $biblionumber, $itemnumber );
+
+Exported function (core API) for deleting an item record in Koha.
 
 =back
 
 =cut
 
 sub DelItem {
-    my ( $dbh, $bibid, $itemnumber ) = @_;
-    my $biblio = $bibid;
+    my ( $dbh, $biblionumber, $itemnumber ) = @_;
     &_koha_delete_item( $dbh, $itemnumber );
-    my $newrec=&MARCdelitem( $dbh, $bibid, $itemnumber );
-    &MARCaddbiblio($dbh,$newrec,$bibid,);
+    my $newrec=&MARCdelitem( $dbh, $biblionumber, $itemnumber );
+    &MARCaddbiblio($dbh,$newrec,$biblionumber,);
 }
 
 =head2 z3950_extended_services
@@ -3005,8 +3014,11 @@
 
 =cut
 
-# $Id: Biblio.pm,v 1.115.2.51.2.26 2006/09/24 21:48:15 kados Exp $
+# $Id: Biblio.pm,v 1.115.2.51.2.27 2006/09/24 23:10:01 kados Exp $
 # $Log: Biblio.pm,v $
+# Revision 1.115.2.51.2.27  2006/09/24 23:10:01  kados
+# improving POD
+#
 # Revision 1.115.2.51.2.26  2006/09/24 21:48:15  kados
 # Adding POD
 #