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