C4::Suggestions - Some useful functions for dealings with aqorders.
use C4::Suggestions;
The functions in this module deal with the aqorders in OPAC and in librarian interface
A suggestion is done in the OPAC. It has the status "ASKED"
When a librarian manages the suggestion, they can set the status to "REJECTED" or "ACCEPTED".
When the book is ordered, the suggestion status becomes "ORDERED"
When a book is ordered and arrived in the library, the status becomes "AVAILABLE"
All aqorders of a borrower can be seen by the borrower itself. Suggestions done by other borrowers can be seen when not "AVAILABLE"
(\@array) = &SearchSuggestion($suggestionhashref_to_search)
searches for a suggestion
return : \@array : the aqorders found.
Array of hash.
Note the status is stored twice : * in the status field * as parameter ( for example ASKED => 1,
or REJECTED => 1) .
This is for template & translation purposes.
\%sth = &GetSuggestion($suggestionid)
this function get the detail of the suggestion $suggestionid (input arg)
return : the result of the SQL query as a hash : $sth->fetchrow_hashref.
$ordernumber = &GetSuggestionFromBiblionumber($biblionumber)
Get a suggestion from it's biblionumber.
return : the id of the suggestion which is related to the biblionumber given on input args.
Get a suggestion and borrower's informations from it's biblionumber.
return : all informations (suggestion and borrower) of the suggestion which is related to the biblionumber given.
Get a suggestion and borrower's informations from it's suggestionid
return : all informations (suggestion and borrower) of the suggestion which is related to the suggestionid given.
$aqorders = &GetSuggestionByStatus($status,[$branchcode])
Get a suggestion from it's status
return : all the suggestion with $status
&CountSuggestion($status)
Count the number of aqorders with the status given on input argument. the arg status can be :
return : the number of suggestion with this status.
&NewSuggestion($suggestion);
Insert a new suggestion on database with value given on input arg.
&ModSuggestion($suggestion)
Modify the suggestion according to the hash passed by ref. The hash HAS to contain suggestionid Data not defined is not updated unless it is a note or sort1 Send a mail to notify the user that did the suggestion.
Note that there is no function to modify a suggestion.
&ConnectSuggestionAndBiblio($ordernumber,$biblionumber)
connect a suggestion to an existing biblio
&DelSuggestion($borrowernumber,$ordernumber)
Delete a suggestion. A borrower can delete a suggestion only if they are its owner.
Delete all suggestions older than TODAY-$days , that have be accepted or rejected.
We do now allow a negative number. If you want to delete all suggestions, just use Koha::Suggestions->delete or so.
Koha Development Team <http://koha-community.org/>