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 aqorders
  42
  43 =item biblio
  44
  45 =item biblioitems
  46
  47 =item borrowers
  48
  49 =item items
  50
  51 =item statistics
  52
  53 =item subscription
  54
  55 =item suggestions
  56
  57 =back
  58
  59 =cut
  60
  61 sub columns {
  62     return {
  63         aqorders => {
  64             "ordernumber"             => __("Order number"),
  65             "biblionumber"            => __("Biblionumber (internal)"),
  66             "entrydate"               => __("Creation date"),
  67             "quantity"                => __("Quantity"),
  68             "currency"                => __("Currency"),
  69             "listprice"               => __("Vendor price"),
  70             "datereceived"            => __("Date received"),
  71             "invoiceid"               => __("Invoice ID (internal)"),
  72             "freight"                 => __("Not used (deprecated)"),
  73             "unitprice"               => __("Actual cost"),
  74             "unitprice_tax_excluded"  => __("Actual cost, tax excl."),
  75             "unitprice_tax_included"  => __("Actual cost, tax incl."),
  76             "quantityreceived"        => __("Quantity received"),
  77             "created_by"              => __("Borrower number of creator"),
  78             "datecancellationprinted" => __("Cancellation date"),
  79             "cancellationreason"      => __("Cancellation reason"),
  80             "order_internalnote"      => __("Internal note"),
  81             "order_vendornote"        => __("Vendor note"),
  82             "purchaseordernumber"     => __("Not used (deprecated)"),
  83             "basketno"                => __("Basket ID (inernal)"),
  84             "timestamp"               => __("Timestamp"),
  85             "rrp"                     => __("Retail price"),
  86             "replacementprice"        => __("Replacement price"),
  87             "rrp_tax_excluded"        => __("Retail price, tax excl."),
  88             "rrp_tax_included"        => __("Retail price, tax incl."),
  89             "ecost"                   => __("Budgeted cost"),
  90             "ecost_tax_excluded"      => __("Budgeted cost, tax excl."),
  91             "ecost_tax_included"      => __("Budgeted cost, tax incl."),
  92             "tax_rate_bak"            => __("Tax rate backup (deprecated)"),
  93             "tax_rate_on_ordering"    => __("Tax rate on order"),
  94             "tax_rate_on_receiving"   => __("Tax rate on receive"),
  95             "tax_value_bak"           => __("Tax value backup (deprecated)"),
  96             "tax_value_on_ordering"   => __("Tax amount on order"),
  97             "tax_value_on_receiving"  => __("Tax amount on receive"),
  98             "discount"                => __("Discount"),
  99             "budget_id"               => __("Fund ID (internal)"),
 100             "budgetdate"              => __("Not used (deprecated)"),
 101             "sort1"                   => __("Statistic 1"),
 102             "sort2"                   => __("Statistic 2"),
 103             "sort1_authcat"           => __("Not used"),
 104             "sort2_authcat"           => __("Not used"),
 105             "uncertainprice"          => __("Uncertain price"),
 106             "subscriptionid"          => __("Subscription ID (internal)"),
 107             "parent_ordernumber"      => __("Parent order number (internal)"),
 108             "orderstatus"             => __("Order status"),
 109             "line_item_id"            => __("Line item ID (EDIFACT)"),
 110             "suppliers_reference_number" => __("Vendor reference number (EDIFACT)"),
 111             "suppliers_reference_qualifier" => __("Vendor reference qualifier (EDIFACT)"),
 112             "suppliers_report"        => __("Vendor report (EDIFACT)"),
 113             "estimated_delivery_date" => __("Estimated delivery date"),
 114         },
 115         borrowers => {
 116             "borrowernumber"      => __("Borrower number"),
 117             "title"               => __("Salutation"),
 118             "surname"             => __("Surname"),
 119             "firstname"           => __("First name"),
 120             "middle_name"         => __("Middle name"),
 121             "dateofbirth"         => __("Date of birth"),
 122             "initials"            => __("Initials"),
 123             "pronouns"            => __("Pronouns"),
 124             "othernames"          => __("Other name"),
 125             "sex"                 => __("Gender"),
 126             "relationship"        => __("Relationship"),
 127             "streetnumber"        => __("Street number"),
 128             "streettype"          => __("Street type"),
 129             "address"             => __("Address"),
 130             "address2"            => __("Address 2"),
 131             "city"                => __("City"),
 132             "state"               => __("State"),
 133             "zipcode"             => __("ZIP/Postal code"),
 134             "country"             => __("Country"),
 135             "phone"               => __("Primary phone"),
 136             "phonepro"            => __("Secondary phone"),
 137             "mobile"              => __("Other phone"),
 138             "email"               => __("Primary email"),
 139             "emailpro"            => __("Secondary email"),
 140             "fax"                 => __("Fax"),
 141             "B_streetnumber"      => __("Alternate address: Street number"),
 142             "B_streettype"        => __("Alternate address: Street type"),
 143             "B_address"           => __("Alternate address: Address"),
 144             "B_address2"          => __("Alternate address: Address 2"),
 145             "B_city"              => __("Alternate address: City"),
 146             "B_state"             => __("Alternate address: State"),
 147             "B_zipcode"           => __("Alternate address: ZIP/Postal code"),
 148             "B_country"           => __("Alternate address: Country"),
 149             "B_phone"             => __("Alternate address: Phone"),
 150             "B_email"             => __("Alternate address: Email"),
 151             "contactnote"         => __("Alternate contact: Note"),
 152             "altcontactfirstname" => __("Alternate contact: First name"),
 153             "altcontactsurname"   => __("Alternate contact: Surname"),
 154             "altcontactaddress1"  => __("Alternate contact: Address"),
 155             "altcontactaddress2"  => __("Alternate contact: Address 2"),
 156             "altcontactaddress3"  => __("Alternate contact: City"),
 157             "contactname"         => __("Alternate contact: Surname"),
 158             "contactfirstname"    => __("Alternate contact: First name"),
 159             "contacttitle"        => __("Alternate contact: Title"),
 160             "altcontactstate"     => __("Alternate contact: State"),
 161             "altcontactzipcode"   => __("Alternate contact: ZIP/Postal code"),
 162             "altcontactcountry"   => __("Alternate contact: Country"),
 163             "altcontactphone"     => __("Alternate contact: Phone"),
 164             "cardnumber"          => __("Card number"),
 165             "branchcode"          => __("Home library"),
 166             "categorycode"        => __("Patron category"),
 167             "sort1"               => __("Sort 1"),
 168             "sort2"               => __("Sort 2"),
 169             "dateenrolled"        => __("Registration date"),
 170             "dateexpiry"          => __("Expiry date"),
 171             "password_expiration_date"    => __("Password expiration date"),
 172             "date_renewed"                => __("Account renewal date"),
 173             "opacnote"                    => __("OPAC note"),
 174             "borrowernotes"               => __("Circulation note"),
 175             "userid"                      => __("Username"),
 176             "password"                    => __("Password"),
 177             "secret"                      => __("Secret (2FA)"),
 178             "auth_method"                 => __("Authentication method"),
 179             "flags"                       => __("System permissions"),
 180             "gonenoaddress"               => __("Gone no address flag"),
 181             "lost"                        => __("Lost card flag"),
 182             "debarred"                    => __("Restricted [until] flag"),
 183             "debarredcomment"             => __("Comment"),
 184             "smsalertnumber"              => __("Mobile phone number"),
 185             "sms_provider_id"             => __("SMS provier ID (internal)"),
 186             "privacy"                     => __("Privacy settings"),
 187             "privacy_guarantor_fines"     => __("Show fines to guarantor"),
 188             "privacy_guarantor_checkouts" => __("Show checkouts to guarantor"),
 189             "checkprevcheckout"           => __("Check for previous checkouts"),
 190             "updated_on"                  => __("Last update date"),
 191             "lastseen"                    => __("Last activity date"),
 192             "lang"                   => __("Preferred language for notices"),
 193             "login_attempts"         => __("Number of failed login attempts"),
 194             "overdrive_auth_token"   => __("Overdrive auth token"),
 195             "anonymized"             => __("Data anonymization flag"),
 196             "autorenew_checkouts"    => __("Allow auto-renewals"),
 197             "primary_contact_method" => __("Primary contact method"),
 198           },
 199
 200         items => {
 201             "itemnumber"           => __("Item number (internal)"),
 202             "biblionumber"         => __("Biblio number (internal)"),
 203             "biblioitemnumber"     => __("Biblioitem number (internal)"),
 204             "barcode"              => __("Barcode"),
 205             "dateaccessioned"      => __("Date acquired"),
 206             "booksellerid"         => __("Source of acquisition"),
 207             "homebranch"           => __("Permanent library"),
 208             "price"                => __("Price"),
 209             "replacementprice"     => __("Replacement price"),
 210             "replacementpricedate" => __("Price effective from"),
 211             "datelastborrowed"     => __("Date last checked out"),
 212             "datelastseen"         => __("Date last seen"),
 213             "stack"                => __("Shelving control number"),
 214             "onloan"               => __("Due date"),
 215             "cn_source"    => __("Source of classification / shelving scheme"),
 216             "cn_sort"      => __("Koha normalized classification for sorting"),
 217             "notforloan"   => __("Not for loan"),
 218             "itemlost"     => __("Lost status"),
 219             "itemlost_on"  => __("Lost on"),
 220             "withdrawn"    => __("Withdrawn status"),
 221             "withdrawn_on" => __("Withdrawn on"),
 222             "itemcallnumber"           => __("Call number"),
 223             "coded_location_qualifier" => __("Coded location qualifier"),
 224             "issues"                   => __("Total checkouts"),
 225             "renewals"                 => __("Total renewals"),
 226             "reserves"                 => __("Total holds"),
 227             "restricted"               => __("Use restrictions"),
 228             "itemnotes"                => __("Public note"),
 229             "itemnotes_nonpublic"      => __("Internal note"),
 230             "holdingbranch"            => __("Current library"),
 231             "timestamp"                => __("Timestamp"),
 232             "deleted_on"               => __("Date of deletion"),
 233             "location"                 => __("Shelving location"),
 234             "permanent_location"       => __("Permanent shelving location"),
 235             "ccode"                    => __("Collection"),
 236             "itype"                    => __("Koha item type"),
 237             "stocknumber"              => __("Inventory number"),
 238             "damaged"                  => __("Damaged status"),
 239             "damaged_on"               => __("Damaged on"),
 240             "materials"                => __("Materials specified"),
 241             "uri"                      => __("Uniform resource identifier"),
 242             "more_subfields_xml"       => __("Additional subfields (XML)"),
 243             "enumchron"                => __("Serial enumeraton/chronology"),
 244             "copynumber"               => __("Copy number"),
 245             "new_status"               => __("New status"),
 246             "exclude_from_local_holds_priority" => __("Exclude from local holds priority"),
 247         },
 248         statistics => {
 249             "datetime"       => __("Statistics date and time"),
 250             "branch"         => __("Library"),
 251             "value"          => __("Value"),
 252             "type"           => __("Type"),
 253             "other"          => __(""),
 254             "itemnumber"     => __("Item number"),
 255             "itemtype"       => __("Itemtype"),
 256             "borrowernumber" => __("Borrower number"),
 257         },
 258         biblio => {
 259                         "biblionumber"  => __("Biblio number"),
 260             "frameworkcode" => __("Framework code"),
 261             "author"        => __("Author"),
 262             "title"         => __("Title"),
 263             "medium"        => __("Medium"),
 264             "subtitle"      => __("Remainder of title"),
 265             "part_number"   => __("Number of part/section of a work"),
 266             "part_name"     => __("Name of part/section of a work"),
 267             "unititle"      => __("Uniform title"),
 268             "notes"         => __("Notes"),
 269             "serial"        => __("Is a serial?"),
 270             "seriestitle"   => __("Series title"),
 271             "copyrightdate" => __("Copyright date"),
 272             "datecreated"   => __("Creation date"),
 273             "timestamp"     => __("Modification date"),
 274             "abstract"      => __("Abstract"),
 275         },
 276         biblioitems => {
 277             "biblioitemnumber" => __("Biblioitem number"),
 278             "biblionumber"     => __("Biblio number"),
 279             "volume"           => __("Volume number"),
 280             "number"           => __("Number"),
 281             "classification"   => __("Classification"),
 282             "itemtype"         => __("Biblio-level item type"),
 283             "isbn"             => __("ISBN"),
 284             "issn"             => __("ISSN"),
 285             "dewey"            => __("Dewey/classification"),
 286             "subclass"         => __("Sub classification"),
 287             "publicationyear"  => __("Publication date"),
 288             "publishercode"    => __("Publisher"),
 289             "volumedate"       => __("Volume date"),
 290             "volumedesc"       => __("Volume information"),
 291             "timestamp"        => __("Timestamp"),
 292             "illus"            => __("Illustrations"),
 293             "pages"            => __("Number of pages"),
 294             "notes"            => __("Notes"),
 295             "size"             => __("Size"),
 296             "place"            => __("Place of publication"),
 297             "lccn"             => __("LCCN"),
 298             "agerestriction"   => __("Age restriction"),
 299             "url"              => __("URL"),
 300             "title"            => __("Title"),
 301         },
 302         subscription => {
 303             "startdate"   => __("Start date"),
 304             "enddate"     => __("End date"),
 305             "periodicity" => __("Periodicity"),
 306             "callnumber"  => __("Call number"),
 307             "location"    => __("Location"),
 308             "branchcode"  => __("Library"),
 309         },
 310         suggestions => {
 311             "author"          => __("Author"),
 312             "copyrightdate"   => __("Copyright date"),
 313             "isbn"            => __("ISBN"),
 314             "publishercode"   => __("Publisher"),
 315             "collectiontitle" => __("Collection title"),
 316             "place"           => __("Place of publication"),
 317             "quantity"        => __("Quantity"),
 318             "itemtype"        => __("Item type"),
 319             "branchcode"      => __("Library"),
 320             "patronreason"    => __("Patron reason"),
 321             "note"            => __("Note"),
 322             "title"           => __("Title"),
 323         }
 324     };
 325 }
 326
 327 1;