Bug 24455: (follow-up) Document function
[koha.git] / Koha / Biblioitem.pm
blob8f63a7cc983b265e55728002d5cdcdd510f37cb7
1 package Koha::Biblioitem;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
18 use Modern::Perl;
20 use Carp;
22 use Koha::Database;
24 use base qw(Koha::Object);
26 =head1 NAME
28 Koha::Biblioitem - Koha Biblioitem Object class
30 =head1 API
32 =head2 Class methods
34 =head3 to_api_mapping
36 This method returns the mapping for representing a Koha::Biblioitem object
37 on the API.
39 =cut
41 sub to_api_mapping {
42 return {
43 agerestriction => 'age_restriction',
44 biblionumber => 'biblio_id',
45 biblioitemnumber => undef, # meaningless
46 collectionissn => 'collection_issn',
47 collectiontitle => 'collection_title',
48 collectionvolume => 'collection_volume',
49 editionresponsibility => undef, # obsolete, not mapped
50 editionstatement => 'edition_statement',
51 illus => 'illustrations',
52 itemtype => 'item_type',
53 lccn => 'lc_control_number',
54 place => 'publication_place',
55 publicationyear => 'publication_year',
56 publishercode => 'publisher',
57 size => 'material_size',
58 totalissues => 'serial_total_issues',
59 volumedate => 'volume_date',
60 volumedesc => 'volume_description',
65 =head2 Internal methods
67 =head3 _type
69 =cut
71 sub _type {
72 return 'Biblioitem';