api_mymodule.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2015   Jean-François Ferry   <jfefe@aternatik.fr>
 * Copyright (C) 2024-2025  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) ---Replace with your own copyright and developer email---
 *
 * 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 <https://www.gnu.org/licenses/>.
 */
 
use Luracast\Restler\RestException;
 
dol_include_once('/mymodule/class/myobject.class.php');
require_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
 
 
 
class MyModuleApi extends DolibarrApi
{
  public $myobject;
 
  public function __construct()
  {
    global $db;
    $this->db = $db;
    $this->myobject = new MyObject($this->db);
  }
 
 
  /* BEGIN MODULEBUILDER API MYOBJECT */
 
  public function get($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('mymodule', 'myobject', 'read')) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('myobject', $id, 'mymodule_myobject')) {
      throw new RestException(403, 'Access to instance id='.$id.' of object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->myobject->fetch($id);
    if (!$result) {
      throw new RestException(404, 'MyObject not found');
    }
 
    return $this->_cleanObjectDatas($this->myobject);
  }
 
 
  public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '')
  {
    global $hookmanager;
 
    $obj_ret = array();
    $tmpobject = new MyObject($this->db);
 
    if (!DolibarrApiAccess::$user->hasRight('mymodule', 'myobject', 'read')) {
      throw new RestException(403);
    }
 
    $socid = DolibarrApiAccess::$user->socid ?: 0;
 
    $restrictonsocid = 0; // Set to 1 if there is a field socid in table of object
 
    // If the internal user must only see his customers, force searching by him
    $search_sale = 0;
    if ($restrictonsocid && !DolibarrApiAccess::$user->hasRight('societe', 'client', 'voir') && !$socid) {
      $search_sale = DolibarrApiAccess::$user->id;
    }
    if (!isModEnabled('societe')) {
      $search_sale = 0; // If module thirdparty not enabled, sale representative is something that does not exists
    }
 
    $sql = "SELECT t.rowid";
    $sql .= " FROM ".$this->db->prefix().$tmpobject->table_element." AS t";
    if (!empty($tmpobject->isextrafieldmanaged) && (int) $tmpobject->isextrafieldmanaged == 1) {
      $sql .= " LEFT JOIN ".$this->db->prefix().$tmpobject->table_element."_extrafields AS ef ON (ef.fk_object = t.rowid)"; // Modification VMR Global Solutions to include extrafields as search parameters in the API GET call, so we will be able to filter on extrafields
    }
    if (!empty($tmpobject->ismultientitymanaged) && (int) $tmpobject->ismultientitymanaged == 1) {
      $sql .= " WHERE t.entity IN (".getEntity($tmpobject->element).")";
    } elseif (preg_match('/^\w+@\w+$/', (string) $tmpobject->ismultientitymanaged)) {
      $tmparray = explode('@', (string) $tmpobject->ismultientitymanaged);
      $sql .= " LEFT JOIN ".$this->db->prefix().$this->db->sanitize($tmparray[1])." as pt ON t.".$this->db->sanitize($tmparray[0])." = pt.rowid";
      $sql .= " WHERE pt.entity IN (".getEntity($tmpobject->element).")";
    } else {
      $sql .= " WHERE 1 = 1";
    }
    if ($restrictonsocid && $socid) {
      $sql .= " AND t.fk_soc = ".((int) $socid);
    }
    // Search on sale representative
    if ($search_sale && $search_sale != '-1') {
      if ($search_sale == -2) {
        $sql .= " AND ".getSalesRepresentativeSqlFilter('t.fk_soc', 0, 1);
      } elseif ($search_sale > 0) {
        $sql .= " AND ".getSalesRepresentativeSqlFilter('t.fk_soc', (int) $search_sale);
      }
    }
    // Add where from hooks and sqlfilters
    $parameters = array('sqlfilters' => $sqlfilters, 'apiroute' => 'myobject', 'apimethod' => __METHOD__);
    $action = 'list';
    $reshook = $hookmanager->executeHooks('printFieldListWhere', $parameters, $tmpobject, $action); // Note that $action and $object may have been modified by hook
    if ($reshook > 0) {
      $sql = $hookmanager->resPrint;
    } elseif ($reshook == 0) {
      $sql .= $hookmanager->resPrint;
    }
 
    if ($sqlfilters) {
      $errormessage = '';
      $sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
      if ($errormessage) {
        throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
      }
    }
 
    $sql .= $this->db->order($sortfield, $sortorder);
    if ($limit) {
      if ($page < 0) {
        $page = 0;
      }
      $offset = $limit * $page;
 
      $sql .= $this->db->plimit($limit + 1, $offset);
    }
 
    $result = $this->db->query($sql);
    $i = 0;
    if ($result) {
      $num = $this->db->num_rows($result);
      $min = min($num, ($limit <= 0 ? $num : $limit));
      while ($i < $min) {
        $obj = $this->db->fetch_object($result);
        $tmp_object = new MyObject($this->db);
        if ($tmp_object->fetch($obj->rowid)) {
          $obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($tmp_object), $properties);
        }
        $i++;
      }
    } else {
      throw new RestException(503, 'Error when retrieving myobject list: '.$this->db->lasterror());
    }
 
    return $obj_ret;
  }
 
  public function post($request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('mymodule', 'myobject', 'write')) {
      throw new RestException(403);
    }
 
    // Check mandatory fields
    $result = $this->_validateMyObject($request_data);
 
    foreach ($request_data as $field => $value) {
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller @phan-suppress-next-line PhanTypeInvalidDimOffset
        $this->myobject->context['caller'] = sanitizeVal((string) $request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        $this->myobject->fetch_optionals(); // To force the load of the extrafields definition by fetch_name_optionals_label()
 
        foreach ($value as $index => $val) {
          $this->myobject->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $this->myobject);
        }
        continue;
      }
 
      $this->myobject->$field = $this->_checkValForAPI((string) $field, $value, $this->myobject);
    }
 
    // Clean data
    // $this->myobject->abc = sanitizeVal($this->myobject->abc, 'alphanohtml');
 
    if ($this->myobject->create(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, "Error creating MyObject", array_merge(array($this->myobject->error), $this->myobject->errors));
    }
    return $this->myobject->id;
  }
 
  public function put($id, $request_data = null)
  {
    if (!DolibarrApiAccess::$user->hasRight('mymodule', 'myobject', 'write')) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('myobject', $id, 'mymodule_myobject')) {
      throw new RestException(403, 'Access to instance id='.$this->myobject->id.' of object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->myobject->fetch($id);
    if (!$result) {
      throw new RestException(404, 'MyObject not found');
    }
 
    foreach ($request_data as $field => $value) {
      if ($field == 'id') {
        continue;
      }
      if ($field === 'caller') {
        // Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
        $this->myobject->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
        continue;
      }
 
      if ($field == 'array_options' && is_array($value)) {
        foreach ($value as $index => $val) {
          $this->myobject->array_options[$index] = $this->_checkValExtrafieldsForAPI($index, $val, $this->myobject);
        }
        continue;
      }
 
      $this->myobject->$field = $this->_checkValForAPI((string) $field, $value, $this->myobject);
    }
 
    // Clean data
    // $this->myobject->abc = sanitizeVal($this->myobject->abc, 'alphanohtml');
 
    if ($this->myobject->update(DolibarrApiAccess::$user, 0) > 0) {
      return $this->get($id);
    } else {
      throw new RestException(500, $this->myobject->error);
    }
  }
 
  public function delete($id)
  {
    if (!DolibarrApiAccess::$user->hasRight('mymodule', 'myobject', 'delete')) {
      throw new RestException(403);
    }
    if (!DolibarrApi::_checkAccessToResource('myobject', $id, 'mymodule_myobject')) {
      throw new RestException(403, 'Access to instance id='.$this->myobject->id.' of object not allowed for login '.DolibarrApiAccess::$user->login);
    }
 
    $result = $this->myobject->fetch($id);
    if (!$result) {
      throw new RestException(404, 'MyObject not found');
    }
 
    if ($this->myobject->delete(DolibarrApiAccess::$user) == 0) {
      throw new RestException(409, 'Error when deleting MyObject : '.$this->myobject->error);
    } elseif ($this->myobject->delete(DolibarrApiAccess::$user) < 0) {
      throw new RestException(500, 'Error when deleting MyObject : '.$this->myobject->error);
    }
 
    return array(
      'success' => array(
        'code' => 200,
        'message' => 'MyObject deleted'
      )
    );
  }
 
 
  private function _validateMyObject($data)
  {
    if (!is_array($data)) {
      $data = array();
    }
    $myobject = array();
    foreach ($this->myobject->fields as $field => $propfield) {
      if (in_array($field, array('rowid', 'entity', 'date_creation', 'tms', 'fk_user_creat')) || $propfield['notnull'] != 1) {
        continue; // Not a mandatory field
      }
      if (!isset($data[$field])) {
        throw new RestException(400, "$field field missing");
      }
      $myobject[$field] = $data[$field];
    }
    return $myobject;
  }
 
  /* END MODULEBUILDER API MYOBJECT */
 
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
  protected function _cleanObjectDatas($object)
  {
    // phpcs:enable
    $object = parent::_cleanObjectDatas($object);
 
    unset($object->rowid);
    unset($object->canvas);
    //BEGIN MODULEBUILDER LINES
    // If object has lines, remove $db property
    if (isset($object->lines) && is_array($object->lines) && count($object->lines) > 0) {
      $nboflines = count($object->lines);
      for ($i = 0; $i < $nboflines; $i++) {
        $this->_cleanObjectDatas($object->lines[$i]);
 
        unset($object->lines[$i]->lines);
        unset($object->lines[$i]->note);
      }
    }
    //END MODULEBUILDER LINES
    return $object;
  }
}