NEW Add API for partnership module

Debug module builder
This commit is contained in:
Laurent Destailleur 2022-07-15 13:41:02 +02:00
parent add38d0d04
commit b000ee7c50
5 changed files with 420 additions and 22 deletions

View File

@ -257,6 +257,8 @@ if (!empty($reg[1]) && $reg[1] == 'explorer' && ($reg[2] == '/swagger.json' || $
continue;
}
//dol_syslog("We scan to search api file with into ".$dir_part.$file_searched);
$regapi = array();
if (is_readable($dir_part.$file_searched) && preg_match("/^api_(.*)\.class\.php$/i", $file_searched, $regapi)) {
$classname = ucwords($regapi[1]);

View File

@ -3887,15 +3887,18 @@ function img_picto($titlealt, $picto, $moreatt = '', $pictoisfullpath = false, $
if (strpos($pictowithouttext, 'fontawesome_') !== false || preg_match('/^fa-/', $pictowithouttext)) {
// This is a font awesome image 'fonwtawesome_xxx' or 'fa-xxx'
$pictowithouttext = str_replace('fontawesome_', '', $pictowithouttext);
$pictowithouttext = str_replace('fa-', '', $pictowithouttext);
$pictowithouttextarray = explode('_', $pictowithouttext);
$marginleftonlyshort = 0;
if (!empty($pictowithouttextarray[1])) {
$fakey = 'fa-'.$pictowithouttextarray[1];
$fa = empty($pictowithouttextarray[2]) ? 'fa' : $pictowithouttextarray[2];
$facolor = empty($pictowithouttextarray[3]) ? '' : $pictowithouttextarray[3];
$fasize = empty($pictowithouttextarray[4]) ? '' : $pictowithouttextarray[4];
// Syntax is 'fontawesome_fakey_faprefix_facolor_fasize' or 'fa-fakey_faprefix_facolor_fasize'
$fakey = 'fa-'.$pictowithouttextarray[0];
$fa = empty($pictowithouttextarray[1]) ? 'fa' : $pictowithouttextarray[1];
$facolor = empty($pictowithouttextarray[2]) ? '' : $pictowithouttextarray[2];
$fasize = empty($pictowithouttextarray[3]) ? '' : $pictowithouttextarray[3];
} else {
$fakey = 'fa-'.$pictowithouttext;
$fa = 'fa';

View File

@ -111,7 +111,7 @@ print '<br>';
print '<table class="noborder centpercent">';
print '<tr class="liste_titre">';
print '<td style="width: 30%">'.$langs->trans("Key").'</td>';
print '<td>'.$langs->trans("Parameter").'</td>';
print '<td>'.$langs->trans("Value").'</td>';
print "</tr>\n";
@ -134,35 +134,35 @@ if ($conf->global->MAIN_FEATURES_LEVEL >= 2) {
print '</td></tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("UseSpecificEditorName").'</td>';
print '<td>'.$langs->trans("UseSpecificEditorName").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_SPECIFIC_EDITOR_NAME" value="'.$conf->global->MODULEBUILDER_SPECIFIC_EDITOR_NAME.'">';
print '</td>';
print '</tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("UseSpecificEditorURL").'</td>';
print '<td>'.$langs->trans("UseSpecificEditorURL").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_SPECIFIC_EDITOR_URL" value="'.$conf->global->MODULEBUILDER_SPECIFIC_EDITOR_URL.'">';
print '</td>';
print '</tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("UseSpecificFamily").'</td>';
print '<td>'.$langs->trans("UseSpecificFamily").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_SPECIFIC_FAMILY" value="'.$conf->global->MODULEBUILDER_SPECIFIC_FAMILY.'">';
print '</td>';
print '</tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("UseSpecificAuthor").'</td>';
print '<td>'.$langs->trans("UseSpecificAuthor").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_SPECIFIC_AUTHOR" value="'.$conf->global->MODULEBUILDER_SPECIFIC_AUTHOR.'">';
print '</td>';
print '</tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("UseSpecificVersion").'</td>';
print '<td>'.$langs->trans("UseSpecificVersion").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_SPECIFIC_VERSION" value="'.$conf->global->MODULEBUILDER_SPECIFIC_VERSION.'">';
print '</td>';
@ -170,14 +170,14 @@ if ($conf->global->MAIN_FEATURES_LEVEL >= 2) {
}
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("UseSpecificReadme").'</td>';
print '<td>'.$langs->trans("UseSpecificReadme").'</td>';
print '<td>';
print '<textarea class="centpercent" rows="20" name="MODULEBUILDER_SPECIFIC_README">'.$conf->global->MODULEBUILDER_SPECIFIC_README.'</textarea>';
print '</td>';
print '</tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("AsciiToHtmlConverter").'</td>';
print '<td>'.$langs->trans("AsciiToHtmlConverter").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_ASCIIDOCTOR" value="'.$conf->global->MODULEBUILDER_ASCIIDOCTOR.'">';
print ' '.$langs->trans("Example").': asciidoc, asciidoctor';
@ -185,7 +185,7 @@ print '</td>';
print '</tr>';
print '<tr class="oddeven">';
print '<td class="tdtop">'.$langs->trans("AsciiToPdfConverter").'</td>';
print '<td>'.$langs->trans("AsciiToPdfConverter").'</td>';
print '<td>';
print '<input type="text" name="MODULEBUILDER_ASCIIDOCTORPDF" value="'.$conf->global->MODULEBUILDER_ASCIIDOCTORPDF.'">';
print ' '.$langs->trans("Example").': asciidoctor-pdf';

View File

@ -343,10 +343,10 @@ if ($dirins && $action == 'initmodule' && $modulename) {
'---Put here your own copyright and developer email---'=>dol_print_date($now, '%Y').' '.$user->getFullName($langs).($user->email ? ' <'.$user->email.'>' : ''),
'Editor name'=>$editorname,
'https://www.example.com'=>$editorurl,
'1.0'=>$version,
'idpicto'=>(empty($picto)) ? 'generic' : $picto,
'$this->version = \'1.0\''=>'$this->version = \''.$version.'\'',
'$this->picto = \'generic\';'=>(empty($picto)) ? '$this->picto = \'generic\'' : '$this->picto = \''.$picto.'\';',
"modulefamily" =>$family,
500000=>$idmodule
'500000'=>$idmodule
);
if (!empty($conf->global->MODULEBUILDER_SPECIFIC_EDITOR_NAME)) {
@ -382,7 +382,6 @@ if ($dirins && $action == 'initmodule' && $modulename) {
if (!$error) {
setEventMessages('ModuleInitialized', null);
$module = $modulename;
$modulename = '';
clearstatcache(true);
if (function_exists('opcache_invalidate')) {
@ -2115,8 +2114,8 @@ if ($module == 'initmodule') {
print '<option value="other" selected="">'.$langs->trans("ModuleFamilyOther").'</option>';
print '</select><br>';
print ajax_combobox("family");
print '<span class="opacitymedium">'.$langs->trans("Picto").'</span> <input type="text" name="idpicto" value="generic" placeholder="'.dol_escape_htmltag($langs->trans("Picto")).'">';
print $form->textwithpicto('', $langs->trans("Example").': generic, globe, ... any font awesome code');
print '<span class="opacitymedium">'.$langs->trans("Picto").'</span> <input type="text" name="idpicto" value="fa-generic" placeholder="'.dol_escape_htmltag($langs->trans("Picto")).'">';
print $form->textwithpicto('', $langs->trans("Example").': fa-generic, fa-globe, ... any font awesome code.<br>Advanced syntax is fa-fakey[_faprefix[_facolor[_fasize]]]');
print '<br>';
print '<span class="opacitymedium">'.$langs->trans("Description").'</span> <input type="text" name="description" value="" class="minwidth500"><br>';
@ -2269,7 +2268,7 @@ if ($module == 'initmodule') {
print '</table>';
print '<br>';
print load_fiche_titre($langs->trans("DescriptorFile"), '', '');
print load_fiche_titre($form->textwithpicto($langs->trans("DescriptorFile"), $pathtofile), '', '');
if (!empty($moduleobj)) {
print '<div class="underbanner clearboth"></div>';
@ -2347,7 +2346,7 @@ if ($module == 'initmodule') {
print '<br><br>';
// Readme file
print load_fiche_titre($langs->trans("ReadmeFile"), '', '');
print load_fiche_titre($form->textwithpicto($langs->trans("ReadmeFile"), $pathtofilereadme), '', '');
print '<!-- readme file -->';
if (dol_is_file($dirread.'/'.$pathtofilereadme)) {
@ -2359,7 +2358,7 @@ if ($module == 'initmodule') {
print '<br><br>';
// ChangeLog
print load_fiche_titre($langs->trans("ChangeLog"), '', '');
print load_fiche_titre($form->textwithpicto($langs->trans("ChangeLog"), $pathtochangelog), '', '');
print '<!-- changelog file -->';
if (dol_is_file($dirread.'/'.$pathtochangelog)) {

View File

@ -0,0 +1,394 @@
<?php
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
* Copyright (C) 2022 Alice Adminson <aadminson@example.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/>.
*/
use Luracast\Restler\RestException;
dol_include_once('/partnership/class/partnership.class.php');
/**
* \file partnership/class/api_partnership.class.php
* \ingroup partnership
* \brief File for API management of partnership.
*/
/**
* API class for partnership partnership
*
* @access protected
* @class DolibarrApiAccess {@requires user,external}
*/
class PartnershipApi extends DolibarrApi
{
/**
* @var Partnership $partnership {@type Partnership}
*/
public $partnership;
/**
* Constructor
*
* @url GET /
*
*/
public function __construct()
{
global $db;
$this->db = $db;
$this->partnership = new Partnership($this->db);
}
/**
* Get properties of a partnership object
*
* Return an array with partnership informations
*
* @param int $id ID of partnership
* @return array|mixed data without useless information
*
* @url GET partnerships/{id}
*
* @throws RestException 401 Not allowed
* @throws RestException 404 Not found
*/
public function get($id)
{
if (!DolibarrApiAccess::$user->rights->partnership->read) {
throw new RestException(401);
}
$result = $this->partnership->fetch($id);
if (!$result) {
throw new RestException(404, 'Partnership not found');
}
if (!DolibarrApi::_checkAccessToResource('partnership', $this->partnership->id, 'partnership')) {
throw new RestException(401, 'Access to instance id='.$this->partnership->id.' of object not allowed for login '.DolibarrApiAccess::$user->login);
}
return $this->_cleanObjectDatas($this->partnership);
}
/**
* List partnerships
*
* Get a list of partnerships
*
* @param string $sortfield Sort field
* @param string $sortorder Sort order
* @param int $limit Limit for list
* @param int $page Page number
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.date_creation:<:'20160101')"
* @return array Array of order objects
*
* @throws RestException
*
* @url GET /partnerships/
*/
public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '')
{
global $db, $conf;
$obj_ret = array();
$tmpobject = new Partnership($this->db);
if (!DolibarrApiAccess::$user->rights->partnership->read) {
throw new RestException(401);
}
$socid = DolibarrApiAccess::$user->socid ? DolibarrApiAccess::$user->socid : '';
$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->rights->societe->client->voir && !$socid) {
$search_sale = DolibarrApiAccess::$user->id;
}
$sql = "SELECT t.rowid";
if ($restrictonsocid && (!DolibarrApiAccess::$user->rights->societe->client->voir && !$socid) || $search_sale > 0) {
$sql .= ", sc.fk_soc, sc.fk_user"; // We need these fields in order to filter by sale (including the case where the user can only see his prospects)
}
$sql .= " FROM ".MAIN_DB_PREFIX.$tmpobject->table_element." as t";
if ($restrictonsocid && (!DolibarrApiAccess::$user->rights->societe->client->voir && !$socid) || $search_sale > 0) {
$sql .= ", ".MAIN_DB_PREFIX."societe_commerciaux as sc"; // We need this table joined to the select in order to filter by sale
}
$sql .= " WHERE 1 = 1";
// Example of use $mode
//if ($mode == 1) $sql.= " AND s.client IN (1, 3)";
//if ($mode == 2) $sql.= " AND s.client IN (2, 3)";
if ($tmpobject->ismultientitymanaged) {
$sql .= ' AND t.entity IN ('.getEntity($tmpobject->element).')';
}
if ($restrictonsocid && (!DolibarrApiAccess::$user->rights->societe->client->voir && !$socid) || $search_sale > 0) {
$sql .= " AND t.fk_soc = sc.fk_soc";
}
if ($restrictonsocid && $socid) {
$sql .= " AND t.fk_soc = ".((int) $socid);
}
if ($restrictonsocid && $search_sale > 0) {
$sql .= " AND t.rowid = sc.fk_soc"; // Join for the needed table to filter by sale
}
// Insert sale filter
if ($restrictonsocid && $search_sale > 0) {
$sql .= " AND sc.fk_user = ".((int) $search_sale);
}
if ($sqlfilters) {
$errormessage = '';
if (!DolibarrApi::_checkFilters($sqlfilters, $errormessage)) {
throw new RestException(503, 'Error when validating parameter sqlfilters -> '.$errormessage);
}
$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 + 1, $offset);
}
$result = $this->db->query($sql);
$i = 0;
if ($result) {
$num = $this->db->num_rows($result);
while ($i < $num) {
$obj = $this->db->fetch_object($result);
$tmp_object = new Partnership($this->db);
if ($tmp_object->fetch($obj->rowid)) {
$obj_ret[] = $this->_cleanObjectDatas($tmp_object);
}
$i++;
}
} else {
throw new RestException(503, 'Error when retrieving partnership list: '.$this->db->lasterror());
}
if (!count($obj_ret)) {
throw new RestException(404, 'No partnership found');
}
return $obj_ret;
}
/**
* Create partnership object
*
* @param array $request_data Request datas
* @return int ID of partnership
*
* @throws RestException
*
* @url POST partnerships/
*/
public function post($request_data = null)
{
if (!DolibarrApiAccess::$user->rights->partnership->write) {
throw new RestException(401);
}
// Check mandatory fields
$result = $this->_validate($request_data);
foreach ($request_data as $field => $value) {
$this->partnership->$field = $this->_checkValForAPI($field, $value, $this->partnership);
}
// Clean data
// $this->partnership->abc = sanitizeVal($this->partnership->abc, 'alphanohtml');
if ($this->partnership->create(DolibarrApiAccess::$user)<0) {
throw new RestException(500, "Error creating Partnership", array_merge(array($this->partnership->error), $this->partnership->errors));
}
return $this->partnership->id;
}
/**
* Update partnership
*
* @param int $id Id of partnership to update
* @param array $request_data Datas
* @return int
*
* @throws RestException
*
* @url PUT partnerships/{id}
*/
public function put($id, $request_data = null)
{
if (!DolibarrApiAccess::$user->rights->partnership->write) {
throw new RestException(401);
}
$result = $this->partnership->fetch($id);
if (!$result) {
throw new RestException(404, 'Partnership not found');
}
if (!DolibarrApi::_checkAccessToResource('partnership', $this->partnership->id, 'partnership')) {
throw new RestException(401, 'Access to instance id='.$this->partnership->id.' of object not allowed for login '.DolibarrApiAccess::$user->login);
}
foreach ($request_data as $field => $value) {
if ($field == 'id') {
continue;
}
$this->partnership->$field = $this->_checkValForAPI($field, $value, $this->partnership);
}
// Clean data
// $this->partnership->abc = sanitizeVal($this->partnership->abc, 'alphanohtml');
if ($this->partnership->update(DolibarrApiAccess::$user, false) > 0) {
return $this->get($id);
} else {
throw new RestException(500, $this->partnership->error);
}
}
/**
* Delete partnership
*
* @param int $id Partnership ID
* @return array
*
* @throws RestException
*
* @url DELETE partnerships/{id}
*/
public function delete($id)
{
if (!DolibarrApiAccess::$user->rights->partnership->delete) {
throw new RestException(401);
}
$result = $this->partnership->fetch($id);
if (!$result) {
throw new RestException(404, 'Partnership not found');
}
if (!DolibarrApi::_checkAccessToResource('partnership', $this->partnership->id, 'partnership')) {
throw new RestException(401, 'Access to instance id='.$this->partnership->id.' of object not allowed for login '.DolibarrApiAccess::$user->login);
}
if (!$this->partnership->delete(DolibarrApiAccess::$user)) {
throw new RestException(500, 'Error when deleting Partnership : '.$this->partnership->error);
}
return array(
'success' => array(
'code' => 200,
'message' => 'Partnership deleted'
)
);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
/**
* Clean sensible object datas
*
* @param Object $object Object to clean
* @return Object Object with cleaned properties
*/
protected function _cleanObjectDatas($object)
{
// phpcs:enable
$object = parent::_cleanObjectDatas($object);
unset($object->rowid);
unset($object->canvas);
/*unset($object->name);
unset($object->lastname);
unset($object->firstname);
unset($object->civility_id);
unset($object->statut);
unset($object->state);
unset($object->state_id);
unset($object->state_code);
unset($object->region);
unset($object->region_code);
unset($object->country);
unset($object->country_id);
unset($object->country_code);
unset($object->barcode_type);
unset($object->barcode_type_code);
unset($object->barcode_type_label);
unset($object->barcode_type_coder);
unset($object->total_ht);
unset($object->total_tva);
unset($object->total_localtax1);
unset($object->total_localtax2);
unset($object->total_ttc);
unset($object->fk_account);
unset($object->comments);
unset($object->note);
unset($object->mode_reglement_id);
unset($object->cond_reglement_id);
unset($object->cond_reglement);
unset($object->shipping_method_id);
unset($object->fk_incoterms);
unset($object->label_incoterms);
unset($object->location_incoterms);
*/
// 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);
}
}
return $object;
}
/**
* Validate fields before create or update object
*
* @param array $data Array of data to validate
* @return array
*
* @throws RestException
*/
private function _validate($data)
{
$partnership = array();
foreach ($this->partnership->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");
}
$partnership[$field] = $data[$field];
}
return $partnership;
}
}