modApi.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003   Rodolphe Quiedeville    <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2012  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2015   Jean-François Ferry   <jfefe@aternatik.fr>
 * Copyright (C) 2018   Regis Houssin     <regis.houssin@inodbox.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 <https://www.gnu.org/licenses/>.
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
 
 
class modApi extends DolibarrModules
{
  public function __construct($db)
  {
    global $langs, $conf;
 
    $this->db = $db;
 
    // Id for module (must be unique).
    // Use here a free id (See in Home -> System information -> Dolibarr for list of used modules id).
    $this->numero = 2610;
    // Key text used to identify module (for permissions, menus, etc...)
    $this->rights_class = 'api';
 
    // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
    // It is used to group modules in module setup page
    $this->family = "interface";
    $this->module_position = '24';
    // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
    $this->name = preg_replace('/^mod/i', '', get_class($this));
    // Module description, used if translation string 'ModuleXXXDesc' not found (where XXX is value of numeric property 'numero' of module)
    $this->description = "REST interface";
    // Possible values for version are: 'development', 'experimental', 'dolibarr' or 'dolibarr_deprecated' or version
    $this->version = 'dolibarr';
    // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
    $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
    // Can be enabled / disabled only in the main company with superadmin account
    $this->core_enabled = 1;
    // Name of image file used for this module.
    // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue'
    // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module'
    $this->picto = 'technic';
 
    $this->module_parts = array();
 
    // Data directories to create when module is enabled.
    // Example: this->dirs = array("/api/temp");
    $this->dirs = array('/api/temp');
 
    // Config pages. Put here list of php page, stored into api/admin directory, to use to setup module.
    $this->config_page_url = array("index.php@api");
 
    // Dependencies
    $this->hidden = false; // A condition to hide module
    $this->depends = array(); // List of modules id that must be enabled if this module is enabled
    $this->requiredby = array('modZapier'); // List of modules id to disable if this one is disabled
    $this->conflictwith = array(); // List of modules id this module is in conflict with
    $this->phpmin = array(7, 0); // Minimum version of PHP required by module
    $this->langfiles = array("other");
 
    // Constants
    // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
    // Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
    //                             1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0, 'current', 1)
    // );
    $this->const = array();
 
    // Array to add new pages in new tabs
    // Example: $this->tabs = array('objecttype:+tabname1:Title1:mylangfile@api:$user->hasRight('api','read'):/api/mynewtab1.php?id=__ID__',            // To add a new tab identified by code tabname1
    //                              'objecttype:+tabname2:SUBSTITUTION_Title2:mylangfile@api:$user->hasRight('othermodule','read'):/api/mynewtab2.php?id=__ID__',   // To add another new tab identified by code tabname2. Label will be result of calling all substitution functions on 'Title2' key.
    //                              'objecttype:-tabname:NU:conditiontoremove');                                                                        // To remove an existing tab identified by code tabname
    // where objecttype can be
    // 'categories_x'   to add a tab in category view (replace 'x' by type of category (0=product, 1=supplier, 2=customer, 3=member)
    // 'contact'          to add a tab in contact view
    // 'contract'         to add a tab in contract view
    // 'group'            to add a tab in group view
    // 'intervention'     to add a tab in intervention view
    // 'invoice'          to add a tab in customer invoice view
    // 'invoice_supplier' to add a tab in supplier invoice view
    // 'member'           to add a tab in foundation member view
    // 'opensurveypoll'   to add a tab in opensurvey poll view
    // 'order'            to add a tab in sales order view
    // 'order_supplier'   to add a tab in supplier order view
    // 'payment'      to add a tab in payment view
    // 'payment_supplier' to add a tab in supplier payment view
    // 'product'          to add a tab in product view
    // 'propal'           to add a tab in propal view
    // 'project'          to add a tab in project view
    // 'stock'            to add a tab in stock view
    // 'thirdparty'       to add a tab in third party view
    // 'user'             to add a tab in user view
    $this->tabs = array();
 
    // Dictionaries
    if (!isset($conf->api->enabled)) {
      $conf->api = new stdClass();
      $conf->api->enabled = 0;
    }
    $this->dictionaries = array();
 
    // Boxes
    // Add here list of php file(s) stored in core/boxes that contains class to show a box.
    $this->boxes = array(); // List of boxes
    // Example:
    //$this->boxes=array(array(0=>array('file'=>'myboxa.php','note'=>'','enabledbydefaulton'=>'Home'),1=>array('file'=>'myboxb.php','note'=>''),2=>array('file'=>'myboxc.php','note'=>'')););
 
    // Permissions
    $this->rights = array(); // Permission array used by this module
    $this->rights_admin_allowed = 1; // Admin is always granted of permission (even when module is disabled)
 
    $r = 0;
 
    // Add here list of permission defined by an id, a label, a boolean and two constant strings.
    // Example:
    $this->rights[$r][0] = $this->numero + $r;  // Permission id (must not be already used)
    $this->rights[$r][1] = 'Generate/modify users API key'; // Permission label
    $this->rights[$r][3] = 0;           // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'apikey';        // In php code, permission will be checked by test if ($user->hasRight('permkey','level1','level2'))
    $this->rights[$r][5] = 'generate';        // In php code, permission will be checked by test if ($user->hasRight('permkey','level1','level2'))
    $r++;
 
 
    // Main menu entries
    $this->menu = array(); // List of menus to add
    $r = 0;
 
    $this->menu[$r] = array('fk_menu'=>'fk_mainmenu=tools',
      'type'=>'left',
      'titre'=>'ApiExplorer',
      'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth"'),
      'mainmenu'=>'tools',
      'leftmenu'=>'devtools_api',
      'url'=>'/api/index.php/explorer',
      'langs'=>'modulebuilder',
      'position'=>100,
      'perms'=>'1',
      'enabled'=>'isModEnabled("api")',
      'target'=>'_apiexplorer',
      'user'=>0);
 
 
    // Exports
    $r = 1;
 
    // Example:
    // $this->export_code[$r]=$this->rights_class.'_'.$r;
    // $this->export_label[$r]='CustomersInvoicesAndInvoiceLines';  // Translation key (used only if key ExportDataset_xxx_z not found)
    // $this->export_enabled[$r]='1';                               // Condition to show export in list (ie: '$user->id==3'). Set to 1 to always show when module is enabled.
    // $this->export_permission[$r]=array(array("facture","facture","export"));
    // $this->export_fields_array[$r]=array(
    //  's.rowid'=>"IdCompany",'s.nom'=>'CompanyName','s.address'=>'Address','s.zip'=>'Zip','s.town'=>'Town','s.fk_pays'=>'Country','s.phone'=>'Phone',
    //  's.siren'=>'ProfId1','s.siret'=>'ProfId2','s.ape'=>'ProfId3','s.idprof4'=>'ProfId4','s.code_compta'=>'CustomerAccountancyCode',
    //  's.code_compta_fournisseur'=>'SupplierAccountancyCode','f.rowid'=>"InvoiceId",'f.ref'=>"InvoiceRef",'f.datec'=>"InvoiceDateCreation",
    //  'f.datef'=>"DateInvoice",'f.total_ht'=>"TotalHT",'f.total_ttc'=>"TotalTTC",'f.total_tva'=>"TotalVAT",'f.paye'=>"InvoicePaid",'f.fk_statut'=>'InvoiceStatus',
    //  'f.note'=>"InvoiceNote",'fd.rowid'=>'LineId','fd.description'=>"LineDescription",'fd.price'=>"LineUnitPrice",'fd.tva_tx'=>"LineVATRate",
    //  'fd.qty'=>"LineQty",'fd.total_ht'=>"LineTotalHT",'fd.total_tva'=>"LineTotalTVA",'fd.total_ttc'=>"LineTotalTTC",'fd.date_start'=>"DateStart",
    //  'fd.date_end'=>"DateEnd",'fd.fk_product'=>'ProductId','p.ref'=>'ProductRef'
    //);
    // $this->export_entities_array[$r]=array(
    //  's.rowid'=>"company",'s.nom'=>'company','s.address'=>'company','s.zip'=>'company','s.town'=>'company','s.fk_pays'=>'company','s.phone'=>'company',
    //  's.siren'=>'company','s.siret'=>'company','s.ape'=>'company','s.idprof4'=>'company','s.code_compta'=>'company','s.code_compta_fournisseur'=>'company',
    //  'f.rowid'=>"invoice",'f.ref'=>"invoice",'f.datec'=>"invoice",'f.datef'=>"invoice",'f.total_ht'=>"invoice",'f.total_ttc'=>"invoice",'f.total_tva'=>"invoice",
    //  'f.paye'=>"invoice",'f.fk_statut'=>'invoice','f.note'=>"invoice",'fd.rowid'=>'invoice_line','fd.description'=>"invoice_line",'fd.price'=>"invoice_line",
    //  'fd.total_ht'=>"invoice_line",'fd.total_tva'=>"invoice_line",'fd.total_ttc'=>"invoice_line",'fd.tva_tx'=>"invoice_line",'fd.qty'=>"invoice_line",
    //  'fd.date_start'=>"invoice_line",'fd.date_end'=>"invoice_line",'fd.fk_product'=>'product','p.ref'=>'product'
    //);
    // $this->export_sql_start[$r]='SELECT DISTINCT ';
    // $this->export_sql_end[$r]  =' FROM ('.MAIN_DB_PREFIX.'facture as f, '.MAIN_DB_PREFIX.'facturedet as fd, '.MAIN_DB_PREFIX.'societe as s)';
    // $this->export_sql_end[$r] .=' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on (fd.fk_product = p.rowid)';
    // $this->export_sql_end[$r] .=' WHERE f.fk_soc = s.rowid AND f.rowid = fd.fk_facture';
    // $this->export_sql_order[$r] .=' ORDER BY s.nom';
    // $r++;
  }
 
  public function init($options = '')
  {
    $sql = array();
 
    return $this->_init($sql, $options);
  }
 
  public function remove($options = '')
  {
    // Remove old constants with entity fields different of 0
    $sql = array(
      "DELETE FROM ".MAIN_DB_PREFIX."const WHERE name = ".$this->db->encrypt('MAIN_MODULE_API'),    // API can't be enabled per environment. Why ?
      "DELETE FROM ".MAIN_DB_PREFIX."const WHERE name = ".$this->db->encrypt('API_PRODUCTION_MODE') // Not in production mode by default at activation
    );
 
    return $this->_remove($sql, $options);
  }
}