From 339d9dbfdf6a800b12387ba2226a95d2172d6865 Mon Sep 17 00:00:00 2001
From: Regis Houssin <regis.houssin@capnetworks.com>
Date: Wed, 24 May 2017 18:44:03 +0200
Subject: [PATCH] New: add REST api "dictionaryevents" for to use with
"agendaevents"
---
.../api/class/api_dictionaryevents.class.php | 100 ++++++++++++++++++
1 file changed, 100 insertions(+)
create mode 100644 htdocs/api/class/api_dictionaryevents.class.php
diff --git a/htdocs/api/class/api_dictionaryevents.class.php b/htdocs/api/class/api_dictionaryevents.class.php
new file mode 100644
index 00000000000..23d7e8e5dba
--- /dev/null
+++ b/htdocs/api/class/api_dictionaryevents.class.php
@@ -0,0 +1,100 @@
+<?php
+/* Copyright (C) 2017 Regis Houssin <regis.houssin@capnetworks.com>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+use Luracast\Restler\RestException;
+
+require_once DOL_DOCUMENT_ROOT.'/main.inc.php';
+
+/**
+ * API class for events type (content of the actioncomm dictionary)
+ *
+ * @access protected
+ * @class DolibarrApiAccess {@requires user,external}
+ */
+class DictionaryEvents extends DolibarrApi
+{
+ /**
+ * Constructor
+ */
+ function __construct()
+ {
+ global $db;
+ $this->db = $db;
+ }
+
+ /**
+ * Get the list of events types.
+ *
+ * @param string $sortfield Sort field
+ * @param string $sortorder Sort order
+ * @param int $limit Number of items per page
+ * @param int $page Page number (starting from zero)
+ * @param string $type To filter on type of event
+ * @param string $module To filter on module events
+ * @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.code:like:'A%') and (t.active:>=:0)"
+ * @return List of events types
+ *
+ * @throws RestException
+ */
+ function index($sortfield = "code", $sortorder = 'ASC', $limit = 100, $page = 0, $type = '', $module = '', $sqlfilters = '')
+ {
+ $list = array();
+
+ $sql = "SELECT id, code, type, libelle as label, module";
+ $sql.= " FROM ".MAIN_DB_PREFIX."c_actioncomm as t";
+ $sql.= " WHERE t.active = 1";
+ if ($type) $sql.=" AND t.type LIKE '%" . $this->db->escape($type) . "%'";
+ if ($module) $sql.=" AND t.module LIKE '%" . $this->db->escape($module) . "%'";
+ // Add sql filters
+ if ($sqlfilters)
+ {
+ if (! DolibarrApi::_checkFilters($sqlfilters))
+ {
+ throw new RestException(503, 'Error when validating parameter sqlfilters '.$sqlfilters);
+ }
+ $regexstring='\(([^:\'\(\)]+:[^:\'\(\)]+:[^:\(\)]+)\)';
+ $sql.=" AND (".preg_replace_callback('/'.$regexstring.'/', 'DolibarrApi::_forge_criteria_callback', $sqlfilters).")";
+ }
+
+
+ $sql.= $this->db->order($sortfield, $sortorder);
+
+ if ($limit) {
+ if ($page < 0) {
+ $page = 0;
+ }
+ $offset = $limit * $page;
+
+ $sql .= $this->db->plimit($limit, $offset);
+ }
+
+ $result = $this->db->query($sql);
+
+ if ($result) {
+ $num = $this->db->num_rows($result);
+ $min = min($num, ($limit <= 0 ? $num : $limit));
+ for ($i = 0; $i < $min; $i++) {
+ $list[] = $this->db->fetch_object($result);
+ }
+ } else {
+ throw new RestException(503, 'Error when retrieving list of events types : '.$this->db->lasterror());
+ }
+
+ return $list;
+ }
+
+}
--
GitLab