Bug 24883: Command line utility to load yaml files
[koha.git] / Koha / City.pm
blobd6466315b577f1cc9a59af586bc2b35a4d32d4fd
1 package Koha::City;
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::City - Koha City Object class
30 =head1 API
32 =head2 Class methods
34 =head3 to_api_mapping
36 This method returns the mapping for representing a Koha::City object
37 on the API.
39 =cut
41 sub to_api_mapping {
42 return {
43 cityid => 'city_id',
44 city_country => 'country',
45 city_name => 'name',
46 city_state => 'state',
47 city_zipcode => 'postal_code'
51 =head2 Internal methods
53 =head3 _type
55 =cut
57 sub _type {
58 return 'City';