This module is used by the cdk interface to koha. Development on this has stopped, this module will be deprecated when a new curses or slang based interface is written. Used by C4::Circulation::Borrower C4::Circulation::Issues C4::Circulation::Renewals C4::Circulation::Returns C4::Groups C4::InterfaceCDK C4::Reserves telnet/doreturns.pl

The module that is used be the cgi scripts to deal with handling the monetary aspects of koha. Is used by C4::Circulation::Renewals2 C4::Interface::AccountsCDK mancredit.pl maninvoice.pl pay.pl tidyaccounts.pl updateitem.pl

The main function of this module is to provide authentification. However the get_template_and_user function has been provided so that a users login information is passed along automatically. This gets loaded into the template. Is used by admin-home.pl catalogue-home.pl charges.pl circ/branchtransfers.pl circ/circulation.pl deletemem.pl delitem.pl detail.pl mainpage.pl member-flags.pl member-password.pl members-home.pl moredetail.pl opac/opac-account.pl opac/opac-detail.pl opac/opac-main.pl opac/opac-membership.pl opac/opac-readingrecord.pl opac/opac-reserve.pl opac/opac-search.pl opac/opac-searchresults.pl opac/opac-user.pl opac/opac-userdetails.pl opac/opac-userupdate.pl reports-home.pl search.pl shelves.pl userpage.pl

Seeing all these opac scripts that are now templated reminds me we could use rewrite the opac using CGI::Application and get it down to just the one script.

The functions in this module deal with the authorities table in koha. It contains every functions to manage/find authorities. Used by admin/thesaurus.pl

Module to handle all the catalogue data. Is new in 1.3. Used by C4::Catalogue C4::Z3950 All the in acqui/ scripts and acqui.simple/ admin/koha2marclinks.pl currency.pl delbiblio.pl deletebiblioitem.pl delitem.pl marc/koha2marc marc/updatedb2marc.pl misc/bulkmarcimport.pl moditem.pl opac/opac-moredetail.pl request.pl showbudget.pl thesaurus_popup.pl updateitem.pl z3950/processz3950queue z3950/z3950import.pl

This module provides functions for manipulating virtual bookshelves, including creating and deleting bookshelves, and adding and removing items to and from bookshelves. Used by shelves.pl

The functions in this module deal with acquisitions, managing book orders, converting money to different currencies, and so forth. Used by MARCdetail.pl; All the scripts in acqui/ and acqui.simple/ addwebsite.pl currency.pl marc/koha2marc marc/updatedb2marc.pl misc/bulkmarcimport.pl moredetail.pl showbudget.pl updater/thesaurus_create.pl

This module is deprecated Not used by anything. If no one objects ill remove this from cvs

Another module used by the cdk scripts. Will be removed once we have a replacement for the cdk scripts. Used by C4::InterfaceCDK

Another module for use with the cdk scrips.Will be removed once we have a replacement for the cdk scripts Used by C4::Circulation::Issues C4::Circulation::Main C4::Circmain C4::Circulation C4::Reserves telnet/borrwraper.pl telnet/startint.pl

The functions in this module deal with circulation, issues, and returns, as well as general information about the library. Used by C4::Circulation::Renewals2 C4::Auth C4::BookShelves C4::Groups acqui.simple/addbookslccn.pl bookcount.pl circ/branchtransfers.pl circ/circulation.pl circ/returns.pl circ/selectbranchprinter.pl deletemem.pl groups.pl member-flags.pl member-password.pl misc/fines2.pl moremember.pl opac/opac-account.pl opac/opac-readingrecord.pl opac/opac-reserve.pl opac/opac-user.pl opac/opac-userdetails.pl opac/opac-userupdate.pl request.pl shelves.pl thesaurus_popup.pl tkperl/tkcirc updateitem.pl

This module contains several functions for dealing with fines for overdue items. It is primarily used by the 'misc/fines2.pl' script. Used by misc/fines2.pl

Another of the CDK modules, when we have a replacement it can disappear Used by C4::Circmain.pm C4::Circulation C4::Circulation::Borrower C4::Circulation::Issues C4::Circulation::Main C4::Circulation::Renewals C4::Circulation::Returns telnet/borrwraper.pl telnet/startint.pl

This module provides functions useful to the circulation desk, primarily for checking reserves and overdue items. Another CDK module Used by C4::Circulation::Borrower C4::Circulation::Issues C4::Circulation::Renewals C4::Circulation::Returns C4::Circmain C4::Reserves telnet/borrwraper.pl telnet/doreturns.pl telnet/startint.pl

Another CDK module, deals with checking if a book is able to be renewed Used by C4::Circulation::Borrower C4::Circulation::Main C4::Circulation::Renewals C4::Circmain C4::Circulation C4::InterfaceCDK.pm:use C4::Circulation::Renewals;

This module provides a few functions for handling loan renewals. Used by moremember.pl opac/opac-renew.pl opac/opac-user.pl renewscript.pl

Another of the CDK based modules Used by C4::Circulation::Main C4::Circmain C4::Circulation telnet/doreturns.pl

Also a CDK one Not used anywhere, this could be safely removed now

When a Koha script runs, it makes use of a certain number of things: configuration settings in /etc/koha.conf, a connection to the Koha database, and so forth. These things make up the context in which the script runs.

This module takes care of setting up the context for a script: figuring out which configuration file to load, and loading it, opening a connection to the right database, and so forth.

Most scripts will only use one context. They can simply have

 use C4::Context;

at the top.

Other scripts may need to use several contexts. For instance, if a library has two databases, one for a certain collection, and the other for everything else, it might be necessary for a script to use two different contexts to search both databases. Such scripts should use the &set_context and &restore_context functions, below.

By default, C4::Context reads the configuration from /etc/koha.conf. This may be overridden by setting the $KOHA_CONF environment variable to the pathname of a configuration file to use.

Used by Pretty much everything

Blank shell of a module .. this has been superseeded by C4::Context Is still used in a few places though. This needs to be fixed Used by C4::Biblio C4::Output C4::Z3950 admin/z3950servers.pl admin-home.pl catalogue-home.pl charges.pl groups.pl mainpage.pl member-flags.pl member-password.pl opac/opac-search.pl z3950/z3950import.pl

Functions for pretty-printing strings and numbers Used mainly by the modules used for the CDK interface, can be removed when the other cdk modules are Used by C4::Circulation::Borrower C4::Circulation::Issues. C4::Circulation::Renewal. C4::Accounts C4::InterfaceCDK C4::Reserves C4::Security C4::Interface::FlagsCDK C4::Interface::ReserveentCDK telnet/doreturns.pl

Only used by groups.pl Im not sure what groups.pl is .. steve looks like one of yours?

This module provides functions to see whether a given library card number or ISBN is valid. Used by C4/Circulation/Issues C4/Z3950 acqui.simple/marcimport.pl insertdata.pl insertidata.pl insertjdata.pl newimember.pl newjmember.pl newmember.pl z3950/z3950import.pl

Another CDK based module, used for building the dialogs for dealing with accounts. Can be removed when we have a replacement text/slang based interface Used by C4::Accounts

Another CDK based module, used for building the dialogs for dealing with borrowers. Not used, can be removed now

Yet another CDK based module Used by C4::Circulation::Borrower

Another one Not used.

And another Used by C4::Reserves

Yet another Used by C4::Circulation::Borrower C4::Circulation::Issues C4::Circulation::Main C4::Circulation::Renewals C4::Circulation::Returns C4::Accounts C4::Circmain C4::Reserves C4::Interface::AccountsCDK C4::Interface::BorrowerCDK C4::Interface::FlagsCDK C4::Interface::RenewalsCDK C4::Interface::ReserveentCDK telnet/borrwraper.pl telnet/doreturns.pl telnet/startint.pl

Perl Module containing convenience functions for Koha scripts Used by memberentry.pl modbibitem.pl moredetail.pl moremember.pl opac/opac-moredetail.pl opac/opac-readingrecord.pl opac/opac-reserve.pl opac/opac-user.pl opac/opac-userdetails.pl opac/opac-userupdate.pl request.pl

The functions in this module perform various catalog-maintenance functions, including deleting and undeleting books, fixing miscategorized items, etc. Used by maint/catmaintain.pl maint/shiftbib.pl

Functions for generating HTML for the Koha web interface. Is used by almost all of the scripts. gettemplate should be the only function being used.

The functions in this module handle sending text to a printer. Used by C4::Circulation/::Borrissues C4::Circulation::Issues.pm:use C4::Print; C4::Circulation::Returns.pm:use C4::Print; circ/circulation.pl circ/returns.pl circ/selectbranchprinter.pl groups.pl telnet/doreturns.pl

Module for use with the CDK interface based scripts Used by C4::Circulation::Main C4::Circmain C4::Circulation

The modules in this module handle everthing you want to do with reserves.

• C4::Circulation::Circ2
• C4::Search
• circ/branchtransfers.pl
• circ/returns.pl
• opac/opac-reserve.pl
• opac/opac-user.pl
• placerequest.pl
• request.pl
• modrequest.pl
• moremember.pl

Note added by Pierrick and Chris in may 2006: Finlay was working for Katipo until 2004 and he's not working on Koha anymore. We keep his comments in the wiki because it would be an interesting way to improve reserve module/API.

(Finlay speaking now) I am planning to totally reorganise both the api for this module and the database tables that it uses. I propose to replace it with an object oriented module.

Proposed API: Class methods:

my $reserves = Reserve::Find({
    itemnumber       => <itemnumber>,
    borrowernumber   => <borrowernumber>,
    biblionumber     => <biblionumber>,
    biblioitemnumber => <biblioitemnumber>
});

This method will replace FindReserves, CheckReserves and CheckWaiting. It will return a array ref to an array of Reserve objects.

my $res = Reserve::Create(.....)

Essentially the same as CreateReserve().

my $fee = Reserve::CalcFee(.....)

Essentially the same as CalcReserveFee()

my $res new Reserve(resnumber)

This recreates the reserve object from the unique resnumber (primary key). It can be used for passing reserve objects between cgi pages.

Object methods:

$res->cancel()

Should be obvious what this does.

$res->fill()

Only gets called when the reserved item is given to the borrower

$res->waiting($itemnumber)

Sets item with $itemnumber waiting for borrower

my $itemnumber = $res->is_waiting()

Returns itemnumber if reserve is waiting

The $res object will be a blessed hashref, as usual, and so it will have as attributes all the normal things like biblionumber, borrowernumber, various dates etc.

Empty module Is used by C4::Circulation::Borrower C4::Circulation::Issues C4::Circulation::Renewals C4::Circulation::Returns telnet/doreturns.pl

Though since its an empty module we can remove the use calls, then remove this module

This module provides the searching facilities for the Koha catalog and other databases. Used by C4::Circulation::Borrower C4::Circulation::Main C4::Circulation::Renewals C4::Circulation::Returns C4::Accounts C4::Accounts2 C4::Reserves C4::Reserves2 MARCdetail.pl acqui/acquire.pl acqui/finishreceive.pl acqui/newbasket2.pl acqui/newbiblio.pl acqui.simple/isbnsearch.pl acqui.simple/keywordsearch.pl admin/aqbookfund.pl admin/aqbudget.pl admin/authorised_values.pl admin/categorie.pl admin/categoryitem.pl admin/currency.pl admin/itemtypes.pl admin/koha2marclinks.pl admin/marc_subfields_structure.pl admin/marctagstructure.pl admin/printers.pl admin/stopwords.pl; admin/systempreferences.pl admin/thesaurus.pl admin/z3950servers.pl bookcount.pl boraccount.pl circ/circulation.pl circ/returns.pl delbiblio.pl deletemem.pl delitem.pl detail.pl imemberentry.pl insertdata.pl jmemberentry.pl mancredit.pl maninvoice.pl member-flags.pl member-password.pl member.pl: memberentry.pl misc/fines2.pl modbib.pl modbibitem.pl moditem.pl modrequest.pl modwebsites.pl moredetail.pl moremember.pl opac/opac-account.pl opac/opac-detail.pl opac/opac-moredetail.pl opac/opac-readingrecord.pl opac/opac-reserve.pl opac/opac-searchresults.pl opac/opac-user.pl opac/opac-userdetails.pl pay.pl placerequest.pl plugin_launcher.pl readingrec.pl request.pl search.pl shelves.pl subjectsearch.pl telnet/doreturns.pl thesaurus_popup.pl updatebibitem.pl userpage.pl value_builder/unimarc_field_100.pl value_builder/unimarc_field_700-4.pl

Used by the CDK based modules .. in use in hlt, but will be retired when a replacement is written Used by C4::Circulation::Main C4::Circmain C4::Circulation

Module for querying and stocking Virtual Bookshelves Needs copyright statement Currently not used, but will be

This module provides functions for parsing MARC records and files. Used by z3950/z3950import.pl

Function to interface with the statistics table. The &UpdateStats function adds an entry to the statistics table in the Koha database, which acts as an activity log. Every transaction like an issue,reserve,return,charge being paid etc, should call UpdateStats

Used by C4::Circulation::Borrower C4::Circulation::Circ2 C4::Circulation::Issues C4::Circulation::Renewals C4::Circulation::Renewals2 C4::Circulation::Returns C4::Accounts C4::Accounts2 C4::Groups C4::Reserves C4::Stats pay.pl reports.pl reservereport.pl reservereport.xls sec/writeoff.pl stats.pl stats2.pl telnet/doreturns.pl

Is used by reports.pl Neither the module or the reports.pl are used any more I suggest that both files are removed from cvs

This module contains functions for looking up Z39.50 servers, and for entering Z39.50 lookup requests. Used by z3950/z3950import.p