Bug 32292: Add column descriptions to subscriptions table / complete items table
[koha.git] / Koha / Database / Columns.pm
1 package Koha::Database::Columns;
2
3 # This file is part of Koha.
4 #
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.
9 #
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.
14 #
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>.
17
18 use Modern::Perl;
19 use Koha::I18N qw( __ );
20
21 =head1 NAME
22
23 Koha::Database::Columns
24
25 =head1 SYNOPSIS
26
27   use Koha::Database::Columns;
28   my $columns = Koha::Database::Columns->columns;
29
30 =head1 API
31
32 =head2 Methods
33
34 =head3 columns
35
36 Static method that returns a hashref with mappings from column names
37 to descriptions, for several tables. Currently
38
39 =over
40
41 =item biblio
42
43 =item biblioitems
44
45 =item borrowers
46
47 =item items
48
49 =item statistics
50
51 =item subscription
52
53 =item suggestion
54
55 =back
56
57 =cut
58
59 sub columns {
60     return {
61         borrowers => {
62             "borrowernumber"      => __("Borrower number"),
63             "title"               => __("Salutation"),
64             "surname"             => __("Surname"),
65             "firstname"           => __("First name"),
66             "middle_name"         => __("Middle name"),
67             "dateofbirth"         => __("Date of birth"),
68             "initials"            => __("Initials"),
69             "pronouns"            => __("Pronouns"),
70             "othernames"          => __("Other name"),
71             "sex"                 => __("Gender"),
72             "relationship"        => __("Relationship"),
73             "streetnumber"        => __("Street number"),
74             "streettype"          => __("Street type"),
75             "address"             => __("Address"),
76             "address2"            => __("Address 2"),
77             "city"                => __("City"),
78             "state"               => __("State"),
79             "zipcode"             => __("ZIP/Postal code"),
80             "country"             => __("Country"),
81             "phone"               => __("Primary phone"),
82             "phonepro"            => __("Secondary phone"),
83             "mobile"              => __("Other phone"),
84             "email"               => __("Primary email"),
85             "emailpro"            => __("Secondary email"),
86             "fax"                 => __("Fax"),
87             "B_streetnumber"      => __("Alternate address: Street number"),
88             "B_streettype"        => __("Alternate address: Street type"),
89             "B_address"           => __("Alternate address: Address"),
90             "B_address2"          => __("Alternate address: Address 2"),
91             "B_city"              => __("Alternate address: City"),
92             "B_state"             => __("Alternate address: State"),
93             "B_zipcode"           => __("Alternate address: ZIP/Postal code"),
94             "B_country"           => __("Alternate address: Country"),
95             "B_phone"             => __("Alternate address: Phone"),
96             "B_email"             => __("Alternate address: Email"),
97             "contactnote"         => __("Alternate contact: Note"),
98             "altcontactfirstname" => __("Alternate contact: First name"),
99             "altcontactsurname"   => __("Alternate contact: Surname"),
100             "altcontactaddress1"  => __("Alternate contact: Address"),
101             "altcontactaddress2"  => __("Alternate contact: Address 2"),
102             "altcontactaddress3"  => __("Alternate contact: City"),
103             "contactname"         => __("Alternate contact: Surname"),
104             "contactfirstname"    => __("Alternate contact: First name"),
105             "contacttitle"        => __("Alternate contact: Title"),
106             "altcontactstate"     => __("Alternate contact: State"),
107             "altcontactzipcode"   => __("Alternate contact: ZIP/Postal code"),
108             "altcontactcountry"   => __("Alternate contact: Country"),
109             "altcontactphone"     => __("Alternate contact: Phone"),
110             "cardnumber"          => __("Card number"),
111             "branchcode"          => __("Home library"),
112             "categorycode"        => __("Patron category"),
113             "sort1"               => __("Sort 1"),
114             "sort2"               => __("Sort 2"),
115             "dateenrolled"        => __("Registration date"),
116             "dateexpiry"          => __("Expiry date"),
117             "opacnote"            => __("OPAC note"),
118             "borrowernotes"       => __("Circulation note"),
119             "userid"              => __("Username"),
120             "password"            => __("Password"),
121             "flags"               => __("System permissions"),
122             "gonenoaddress"       => __("Gone no address flag"),
123             "lost"                => __("Lost card flag"),
124             "debarred"            => __("Restricted [until] flag"),
125             "debarredcomment"     => __("Comment"),
126             "smsalertnumber"      => __("Mobile phone number"),
127             "privacy"             => __("Privacy settings"),
128             "autorenew_checkouts" => __("Allow auto-renewals"),
129         },
130         items => {
131             "itemnumber"           => __("Item number (internal)"),
132             "biblionumber"         => __("Biblio number (internal)"),
133             "biblioitemnumber"     => __("Biblioitem number (internal)"),
134             "barcode"              => __("Barcode"),
135             "dateaccessioned"      => __("Date acquired"),
136             "booksellerid"         => __("Source of acquisition"),
137             "homebranch"           => __("Permanent library"),
138             "price"                => __("Price"),
139             "replacementprice"     => __("Replacement price"),
140             "replacementpricedate" => __("Price effective from"),
141             "datelastborrowed"     => __("Date last checked out"),
142             "datelastseen"         => __("Date last seen"),
143             "stack"                => __("Shelving control number"),
144             "onloan"               => __("Due date"),
145             "cn_source"    => __("Source of classification / shelving scheme"),
146             "cn_sort"      => __("Koha normalized classification for sorting"),
147             "notforloan"   => __("Not for loan"),
148             "itemlost"     => __("Lost status"),
149             "itemlost_on"  => __("Lost on"),
150             "withdrawn"    => __("Withdrawn status"),
151             "withdrawn_on" => __("Withdrawn on"),
152             "itemcallnumber"           => __("Call number"),
153             "coded_location_qualifier" => __("Coded location qualifier"),
154             "issues"                   => __("Total checkouts"),
155             "renewals"                 => __("Total renewals"),
156             "reserves"                 => __("Total holds"),
157             "restricted"               => __("Use restrictions"),
158             "itemnotes"                => __("Public note"),
159             "itemnotes_nonpublic"      => __("Internal note"),
160             "holdingbranch"            => __("Current library"),
161             "timestamp"                => __("Timestamp"),
162             "deleted_on"               => __("Date of deletion"),
163             "location"                 => __("Shelving location"),
164             "permanent_location"       => __("Permanent shelving location"),
165             "ccode"                    => __("Collection"),
166             "itype"                    => __("Koha item type"),
167             "stocknumber"              => __("Inventory number"),
168             "damaged"                  => __("Damaged status"),
169             "damaged_on"               => __("Damaged on"),
170             "materials"                => __("Materials specified"),
171             "uri"                      => __("Uniform resource identifier"),
172             "more_subfields_xml"       => __("Additional subfields (XML)"),
173             "enumchron"                => __("Serial enumeraton/chronology"),
174             "copynumber"               => __("Copy number"),
175             "new_status"               => __("New status"),
176             "exclude_from_local_holds_priority" => __("Exclude from local holds priority"),
177         },
178         statistics => {
179             "datetime"       => __("Statistics date and time"),
180             "branch"         => __("Library"),
181             "value"          => __("Value"),
182             "type"           => __("Type"),
183             "other"          => __(""),
184             "itemnumber"     => __("Item number"),
185             "itemtype"       => __("Itemtype"),
186             "borrowernumber" => __("Borrower number"),
187         },
188         biblio => {
189             "frameworkcode" => __("Framework code"),
190             "author"        => __("Author"),
191             "datecreated"   => __("Creation date"),
192             "timestamp"     => __("Modification date"),
193         },
194         biblioitems => {
195             "biblioitemnumber" => __("Biblioitem number"),
196             "biblionumber"     => __("Biblio number"),
197             "volume"           => __("Volume number"),
198             "number"           => __("Number"),
199             "classification"   => __("Classification"),
200             "itemtype"         => __("Biblio-level item type"),
201             "isbn"             => __("ISBN"),
202             "issn"             => __("ISSN"),
203             "dewey"            => __("Dewey/classification"),
204             "subclass"         => __("Sub classification"),
205             "publicationyear"  => __("Publication date"),
206             "publishercode"    => __("Publisher"),
207             "volumedate"       => __("Volume date"),
208             "volumedesc"       => __("Volume information"),
209             "timestamp"        => __("Timestamp"),
210             "illus"            => __("Illustrations"),
211             "pages"            => __("Number of pages"),
212             "notes"            => __("Notes"),
213             "size"             => __("Size"),
214             "place"            => __("Place of publication"),
215             "lccn"             => __("LCCN"),
216             "agerestriction"   => __("Age restriction"),
217             "url"              => __("URL"),
218             "title"            => __("Title"),
219         },
220         subscription => {
221             "startdate"   => __("Start date"),
222             "enddate"     => __("End date"),
223             "periodicity" => __("Periodicity"),
224             "callnumber"  => __("Call number"),
225             "location"    => __("Location"),
226             "branchcode"  => __("Library"),
227         },
228         suggestions => {
229             "author"          => __("Author"),
230             "copyrightdate"   => __("Copyright date"),
231             "isbn"            => __("ISBN"),
232             "publishercode"   => __("Publisher"),
233             "collectiontitle" => __("Collection title"),
234             "place"           => __("Place of publication"),
235             "quantity"        => __("Quantity"),
236             "itemtype"        => __("Item type"),
237             "branchcode"      => __("Library"),
238             "patronreason"    => __("Patron reason"),
239             "note"            => __("Note"),
240             "title"           => __("Title"),
241         }
242     };
243 }
244
245 1;