dolibarr  18.0.0-alpha
api_members.class.php
1 <?php
2 /* Copyright (C) 2016 Xebax Christy <xebax@wanadoo.fr>
3  * Copyright (C) 2017 Regis Houssin <regis.houssin@inodbox.com>
4  * Copyright (C) 2020 Thibault FOUCART<support@ptibogxiv.net>
5  * Copyright (C) 2020 Frédéric France <frederic.france@netlogic.fr>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <https://www.gnu.org/licenses/>.
19  */
20 
21 use Luracast\Restler\RestException;
22 
23 require_once DOL_DOCUMENT_ROOT.'/societe/class/societe.class.php';
24 require_once DOL_DOCUMENT_ROOT.'/adherents/class/adherent.class.php';
25 require_once DOL_DOCUMENT_ROOT.'/adherents/class/subscription.class.php';
26 require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
27 
34 class Members extends DolibarrApi
35 {
39  public static $FIELDS = array(
40  'morphy',
41  'typeid'
42  );
43 
47  public function __construct()
48  {
49  global $db, $conf;
50  $this->db = $db;
51  }
52 
63  public function get($id)
64  {
65  if (!DolibarrApiAccess::$user->hasRight('adherent', 'lire')) {
66  throw new RestException(401);
67  }
68 
69  $member = new Adherent($this->db);
70  if ($id == 0) {
71  $result = $member->initAsSpecimen();
72  } else {
73  $result = $member->fetch($id);
74  }
75  if (!$result) {
76  throw new RestException(404, 'member not found');
77  }
78 
79  if (!DolibarrApi::_checkAccessToResource('adherent', $member->id) && $id > 0) {
80  throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
81  }
82 
83  return $this->_cleanObjectDatas($member);
84  }
85 
100  public function getByThirdparty($thirdparty)
101  {
102  if (!DolibarrApiAccess::$user->hasRight('adherent', 'lire')) {
103  throw new RestException(401);
104  }
105 
106  $member = new Adherent($this->db);
107  $result = $member->fetch('', '', $thirdparty);
108  if (!$result) {
109  throw new RestException(404, 'member not found');
110  }
111 
112  if (!DolibarrApi::_checkAccessToResource('adherent', $member->id)) {
113  throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
114  }
115 
116  return $this->_cleanObjectDatas($member);
117  }
118 
133  public function getByThirdpartyEmail($email)
134  {
135  if (!DolibarrApiAccess::$user->hasRight('adherent', 'lire')) {
136  throw new RestException(401);
137  }
138 
139  $thirdparty = new Societe($this->db);
140  $result = $thirdparty->fetch('', '', '', '', '', '', '', '', '', '', $email);
141  if (!$result) {
142  throw new RestException(404, 'thirdparty not found');
143  }
144 
145  $member = new Adherent($this->db);
146  $result = $member->fetch('', '', $thirdparty->id);
147  if (!$result) {
148  throw new RestException(404, 'member not found');
149  }
150 
151  if (!DolibarrApi::_checkAccessToResource('adherent', $member->id)) {
152  throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
153  }
154 
155  return $this->_cleanObjectDatas($member);
156  }
157 
172  public function getByThirdpartyBarcode($barcode)
173  {
174  if (!DolibarrApiAccess::$user->hasRight('adherent', 'lire')) {
175  throw new RestException(401);
176  }
177 
178  $thirdparty = new Societe($this->db);
179  $result = $thirdparty->fetch('', '', '', $barcode);
180  if (!$result) {
181  throw new RestException(404, 'thirdparty not found');
182  }
183 
184  $member = new Adherent($this->db);
185  $result = $member->fetch('', '', $thirdparty->id);
186  if (!$result) {
187  throw new RestException(404, 'member not found');
188  }
189 
190  if (!DolibarrApi::_checkAccessToResource('adherent', $member->id)) {
191  throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
192  }
193 
194  return $this->_cleanObjectDatas($member);
195  }
196 
214  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $typeid = '', $category = 0, $sqlfilters = '')
215  {
216  global $db, $conf;
217 
218  $obj_ret = array();
219 
220  if (!DolibarrApiAccess::$user->hasRight('adherent', 'lire')) {
221  throw new RestException(401);
222  }
223 
224  $sql = "SELECT t.rowid";
225  $sql .= " FROM ".MAIN_DB_PREFIX."adherent as t";
226  if ($category > 0) {
227  $sql .= ", ".MAIN_DB_PREFIX."categorie_member as c";
228  }
229  $sql .= ' WHERE t.entity IN ('.getEntity('adherent').')';
230  if (!empty($typeid)) {
231  $sql .= ' AND t.fk_adherent_type='.((int) $typeid);
232  }
233  // Select members of given category
234  if ($category > 0) {
235  $sql .= " AND c.fk_categorie = ".((int) $category);
236  $sql .= " AND c.fk_member = t.rowid";
237  }
238  // Add sql filters
239  if ($sqlfilters) {
240  $errormessage = '';
241  $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
242  if ($errormessage) {
243  throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
244  }
245  }
246 
247  $sql .= $this->db->order($sortfield, $sortorder);
248  if ($limit) {
249  if ($page < 0) {
250  $page = 0;
251  }
252  $offset = $limit * $page;
253 
254  $sql .= $this->db->plimit($limit + 1, $offset);
255  }
256 
257  $result = $this->db->query($sql);
258  if ($result) {
259  $i = 0;
260  $num = $this->db->num_rows($result);
261  $min = min($num, ($limit <= 0 ? $num : $limit));
262  while ($i < $min) {
263  $obj = $this->db->fetch_object($result);
264  $member = new Adherent($this->db);
265  if ($member->fetch($obj->rowid)) {
266  $obj_ret[] = $this->_cleanObjectDatas($member);
267  }
268  $i++;
269  }
270  } else {
271  throw new RestException(503, 'Error when retrieve member list : '.$this->db->lasterror());
272  }
273  if (!count($obj_ret)) {
274  throw new RestException(404, 'No member found');
275  }
276 
277  return $obj_ret;
278  }
279 
286  public function post($request_data = null)
287  {
288  if (!DolibarrApiAccess::$user->hasRight('adherent', 'creer')) {
289  throw new RestException(401);
290  }
291  // Check mandatory fields
292  $result = $this->_validate($request_data);
293 
294  $member = new Adherent($this->db);
295  foreach ($request_data as $field => $value) {
296  $member->$field = $value;
297  }
298  if ($member->create(DolibarrApiAccess::$user) < 0) {
299  throw new RestException(500, 'Error creating member', array_merge(array($member->error), $member->errors));
300  }
301  return $member->id;
302  }
303 
311  public function put($id, $request_data = null)
312  {
313  if (!DolibarrApiAccess::$user->hasRight('adherent', 'creer')) {
314  throw new RestException(401);
315  }
316 
317  $member = new Adherent($this->db);
318  $result = $member->fetch($id);
319  if (!$result) {
320  throw new RestException(404, 'member not found');
321  }
322 
323  if (!DolibarrApi::_checkAccessToResource('member', $member->id)) {
324  throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
325  }
326 
327  foreach ($request_data as $field => $value) {
328  if ($field == 'id') {
329  continue;
330  }
331  // Process the status separately because it must be updated using
332  // the validate(), resiliate() and exclude() methods of the class Adherent.
333  if ($field == 'statut') {
334  if ($value == '0') {
335  $result = $member->resiliate(DolibarrApiAccess::$user);
336  if ($result < 0) {
337  throw new RestException(500, 'Error when resiliating member: '.$member->error);
338  }
339  } elseif ($value == '1') {
340  $result = $member->validate(DolibarrApiAccess::$user);
341  if ($result < 0) {
342  throw new RestException(500, 'Error when validating member: '.$member->error);
343  }
344  } elseif ($value == '-2') {
345  $result = $member->exclude(DolibarrApiAccess::$user);
346  if ($result < 0) {
347  throw new RestException(500, 'Error when excluding member: '.$member->error);
348  }
349  }
350  } else {
351  $member->$field = $value;
352  }
353  }
354 
355  // If there is no error, update() returns the number of affected rows
356  // so if the update is a no op, the return value is zero.
357  if ($member->update(DolibarrApiAccess::$user) >= 0) {
358  return $this->get($id);
359  } else {
360  throw new RestException(500, 'Error when updating member: '.$member->error);
361  }
362  }
363 
370  public function delete($id)
371  {
372  if (!DolibarrApiAccess::$user->hasRight('adherent', 'supprimer')) {
373  throw new RestException(401);
374  }
375  $member = new Adherent($this->db);
376  $result = $member->fetch($id);
377  if (!$result) {
378  throw new RestException(404, 'member not found');
379  }
380 
381  if (!DolibarrApi::_checkAccessToResource('member', $member->id)) {
382  throw new RestException(401, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
383  }
384 
385 
386  $res = $member->delete($member->id, DolibarrApiAccess::$user);
387  if ($res < 0) {
388  throw new RestException(500, "Can't delete, error occurs");
389  } elseif ($res == 0) {
390  throw new RestException(409, "Can't delete, that product is probably used");
391  }
392 
393  return array(
394  'success' => array(
395  'code' => 200,
396  'message' => 'Member deleted'
397  )
398  );
399  }
400 
409  private function _validate($data)
410  {
411  $member = array();
412  foreach (Members::$FIELDS as $field) {
413  if (!isset($data[$field])) {
414  throw new RestException(400, "$field field missing");
415  }
416  $member[$field] = $data[$field];
417  }
418  return $member;
419  }
420 
421  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
428  protected function _cleanObjectDatas($object)
429  {
430  // phpcs:enable
431  $object = parent::_cleanObjectDatas($object);
432 
433  // Remove the subscriptions because they are handled as a subresource.
434  unset($object->subscriptions);
435  unset($object->fk_incoterms);
436  unset($object->label_incoterms);
437  unset($object->location_incoterms);
438  unset($object->fk_delivery_address);
439  unset($object->shipping_method_id);
440 
441  unset($object->total_ht);
442  unset($object->total_ttc);
443  unset($object->total_tva);
444  unset($object->total_localtax1);
445  unset($object->total_localtax2);
446 
447  return $object;
448  }
449 
462  public function getSubscriptions($id)
463  {
464  $obj_ret = array();
465 
466  if (!DolibarrApiAccess::$user->hasRight('adherent', 'cotisation', 'lire')) {
467  throw new RestException(401);
468  }
469 
470  $member = new Adherent($this->db);
471  $result = $member->fetch($id);
472  if (!$result) {
473  throw new RestException(404, 'member not found');
474  }
475 
476  $obj_ret = array();
477  foreach ($member->subscriptions as $subscription) {
478  $obj_ret[] = $this->_cleanObjectDatas($subscription);
479  }
480  return $obj_ret;
481  }
482 
495  public function createSubscription($id, $start_date, $end_date, $amount, $label = '')
496  {
497  if (!DolibarrApiAccess::$user->hasRight('adherent', 'cotisation', 'creer')) {
498  throw new RestException(401);
499  }
500 
501  $member = new Adherent($this->db);
502  $result = $member->fetch($id);
503  if (!$result) {
504  throw new RestException(404, 'member not found');
505  }
506 
507  return $member->subscription($start_date, $amount, 0, '', $label, '', '', '', $end_date);
508  }
509 
523  public function getCategories($id, $sortfield = "s.rowid", $sortorder = 'ASC', $limit = 0, $page = 0)
524  {
525  if (!DolibarrApiAccess::$user->rights->categorie->lire) {
526  throw new RestException(401);
527  }
528 
529  $categories = new Categorie($this->db);
530 
531  $result = $categories->getListForItem($id, 'member', $sortfield, $sortorder, $limit, $page);
532 
533  if (empty($result)) {
534  throw new RestException(404, 'No category found');
535  }
536 
537  if ($result < 0) {
538  throw new RestException(503, 'Error when retrieve category list : '.$categories->error);
539  }
540 
541  return $result;
542  }
543 }
Members\getCategories
getCategories($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
Get categories for a member.
Definition: api_members.class.php:523
Members\put
put($id, $request_data=null)
Update member.
Definition: api_members.class.php:311
Societe
Class to manage third parties objects (customers, suppliers, prospects...)
Definition: societe.class.php:50
db
$conf db
API class for accounts.
Definition: inc.php:41
$sql
if(isModEnabled('facture') &&!empty($user->rights->facture->lire)) if((isModEnabled('fournisseur') &&empty($conf->global->MAIN_USE_NEW_SUPPLIERMOD) && $user->hasRight("fournisseur", "facture", "lire"))||(isModEnabled('supplier_invoice') && $user->hasRight("supplier_invoice", "lire"))) if(isModEnabled('don') &&!empty($user->rights->don->lire)) if(isModEnabled('tax') &&!empty($user->rights->tax->charges->lire)) if(isModEnabled('facture') &&isModEnabled('commande') && $user->hasRight("commande", "lire") &&empty($conf->global->WORKFLOW_DISABLE_CREATE_INVOICE_FROM_ORDER)) $sql
Social contributions to pay.
Definition: index.php:745
Members
Definition: api_members.class.php:34
Members\createSubscription
createSubscription($id, $start_date, $end_date, $amount, $label='')
Add a subscription for a member.
Definition: api_members.class.php:495
DolibarrApi\_checkAccessToResource
static _checkAccessToResource($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
Check access by user to a given resource.
Definition: api.class.php:283
Categorie
Class to manage categories.
Definition: categorie.class.php:47
Members\_validate
_validate($data)
Validate fields before creating an object.
Definition: api_members.class.php:409
DolibarrApi
Class for API REST v1.
Definition: api.class.php:30
Members\getByThirdparty
getByThirdparty($thirdparty)
Get properties of a member object by linked thirdparty.
Definition: api_members.class.php:100
Members\getByThirdpartyBarcode
getByThirdpartyBarcode($barcode)
Get properties of a member object by linked thirdparty barcode.
Definition: api_members.class.php:172
Members\index
index($sortfield="t.rowid", $sortorder='ASC', $limit=100, $page=0, $typeid='', $category=0, $sqlfilters='')
List members.
Definition: api_members.class.php:214
forgeSQLFromUniversalSearchCriteria
forgeSQLFromUniversalSearchCriteria($filter, &$error='')
forgeSQLFromUniversalSearchCriteria
Definition: functions.lib.php:11711
Adherent
Class to manage members of a foundation.
Definition: adherent.class.php:46
Members\getSubscriptions
getSubscriptions($id)
List subscriptions of a member.
Definition: api_members.class.php:462
Members\getByThirdpartyEmail
getByThirdpartyEmail($email)
Get properties of a member object by linked thirdparty email.
Definition: api_members.class.php:133
Members\_cleanObjectDatas
_cleanObjectDatas($object)
Clean sensible object datas.
Definition: api_members.class.php:428
Members\__construct
__construct()
Constructor.
Definition: api_members.class.php:47
Members\post
post($request_data=null)
Create member object.
Definition: api_members.class.php:286