From 7e366c303ed0e9e214ac42fdcdd63077df83046d Mon Sep 17 00:00:00 2001 From: Xebax Date: Sun, 7 Aug 2016 20:58:28 +0200 Subject: [PATCH] Add Towns to the REST API. --- htdocs/api/class/api_towns.class.php | 75 ++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 htdocs/api/class/api_towns.class.php diff --git a/htdocs/api/class/api_towns.class.php b/htdocs/api/class/api_towns.class.php new file mode 100644 index 00000000000..aa99e9e93bd --- /dev/null +++ b/htdocs/api/class/api_towns.class.php @@ -0,0 +1,75 @@ + + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +use Luracast\Restler\RestException; + +require_once DOL_DOCUMENT_ROOT.'/main.inc.php'; +require_once DOL_DOCUMENT_ROOT.'/core/class/ccountry.class.php'; + +/** + * API class for towns (content of the ziptown dictionary) + * + * @access protected + * @class DolibarrApiAccess {@requires user,external} + */ +class Towns +{ + /** + * Constructor + */ + function __construct() + { + global $db; + $this->db = $db; + } + + /** + * Get the list of towns. + * + * @param string $zipcode To filter the towns by zipcode + * @param string $town To filter the towns by name + * @return List of towns + * + * @throws RestException + */ + function index($zipcode = '', $town = '') + { + $list = array(); + + $sql = "SELECT rowid AS id, zip, town, fk_county, fk_pays AS fk_country"; + $sql.= " FROM ".MAIN_DB_PREFIX."c_ziptown"; + $sql.= " WHERE active = 1"; + if ($zipcode) $sql.=" AND zip LIKE '" . $this->db->escape($zipcode) . "%'"; + if ($town) $sql.=" AND town LIKE '%" . $this->db->escape($town) . "%'"; + $sql.= " ORDER BY zip, town"; + + $result = $this->db->query($sql); + + if ($result) { + $num = $this->db->num_rows($result); + for ($i = 0; $i < $num; $i++) { + $list[] = $this->db->fetch_object($result); + } + } else { + throw new RestException(503, 'Error when retrieving list of towns : '.$this->db->lasterror()); + } + + return $list; + } + +}