vignesh/dolibarr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
dolibarr/htdocs/resource/class/dolresource.class.php
Frédéric FRANCE 047344bf82
NEW: Add phpunit test for Dolresource class (#39520) 
* NEW: Add phpunit test for Dolresource class

Add a CRUD test (create/fetch/update/delete) for the Dolresource
class, which had no test coverage yet.

Note: the update() test intentionally does not exercise note_public/
note_private - Dolresource::update()'s SQL UPDATE statement omits
these 2 columns, so changes to them are silently not persisted.

* FIX Dolresource::update() does not persist note_public/note_private

The SQL UPDATE statement was missing these 2 columns while every
other property of the object was included, so changes to a
resource's notes were silently dropped on update. Add them following
the same pattern as the other fields, and extend the phpunit test to
cover it.

* FIX pre-commit PHPStan hook errors on commits with no file in scope

phpstan.neon.dist only analyzes htdocs/ and scripts/, but the
pre-commit wrapper passed every staged file straight to phpstan
regardless of path. A commit touching only files outside that scope
(e.g. test/phpunit/) made phpstan exit with "No files found to
analyse", failing the hook for reasons unrelated to the change being
committed. Filter to htdocs/ and scripts/ first, and skip cleanly
when nothing remains.

* NEW: Auto-activate module resource in DolresourceTest if needed

Activate module resource in setUpBeforeClass() when it is not
already enabled, so the test does not depend on the environment's
module configuration. Same pattern as
OpensurveysondageTest::setUpBeforeClass().

Note: this activation is real and persists after the test run - it
is not undone by the transaction rollback in tearDownAfterClass().
Activating a module re-runs its SQL install scripts (CREATE/ALTER
TABLE), which causes an implicit commit in MySQL/InnoDB, same as an
admin enabling it from Setup > Modules would do.

* fix
2026-08-14 20:31:06 +02:00

1054 lines
31 KiB
PHP
Raw Permalink Blame History

<?php
/* Copyright (C) 2013-2015 Jean-François Ferry <jfefe@aternatik.fr>
* Copyright (C) 2023-2024 William Mead <william.mead@manchenumerique.fr>
* Copyright (C) 2024-2026 MDW <mdeweerd@users.noreply.github.com>
* Copyright (C) 2024-2026 Frédéric France <frederic.france@free.fr>
*
* 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/>.
*/
/**
* \file htdocs/resource/class/dolresource.class.php
* \ingroup resource
* \brief Class file for resource object
*/
require_once DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php";
require_once DOL_DOCUMENT_ROOT."/core/lib/functions2.lib.php";
require_once DOL_DOCUMENT_ROOT.'/core/class/commonpeople.class.php';
/**
* DAO Resource object
*/
class Dolresource extends CommonObject
{
use CommonPeople;
/**
* @var string ID to identify managed object
*/
public $element = 'dolresource';
/**
* @var string Name of table without prefix where object is stored
*/
public $table_element = 'resource';
/**
* @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
*/
public $picto = 'resource';
/**
* @var string Description
*/
public $description;
/**
* @var string Phone number
*/
public $phone;
/**
* @var ?int Maximum users
*/
public $max_users;
/**
* @var string ID
*/
public $fk_code_type_resource;
/**
* @var ?string
*/
public $type_label;
/**
* @var int resource ID
* For resource-element link
* @see updateElementResource()
* @see fetchElementResource()
*/
public $resource_id;
/**
* @var string resource type
*/
public $resource_type;
/**
* @var int element ID
* For resource-element link
* @see updateElementResource()
* @see fetchElementResource()
*/
public $element_id;
/**
* @var string element type
*/
public $element_type;
/**
* @var int
*/
public $busy;
/**
* @var int
*/
public $mandatory;
/**
* @var int
*/
public $fulldayevent;
/**
* @var int ID
*/
public $fk_user_create;
/**
* @var CommonObject Used by fetchElementResource() to return an object
*/
public $objelement;
/**
* @var array<int,array{code:string,label:string,active:int}> Cache of type of resources. TODO Use->cache['type_of_resources'] instead
*/
public $cache_code_type_resource;
/**
* Constructor
*
* @param DoliDB $db Database handler
*/
public function __construct(DoliDB $db)
{
$this->db = $db;
$this->status = 0;
$this->cache_code_type_resource = array();
}
/**
* Create object in database
*
* @param User $user User that creates
* @param int<0,1> $no_trigger 0=launch triggers after, 1=disable triggers
* @return int if KO: <0 || if OK: Id of created object
*/
public function create(User $user, int $no_trigger = 0)
{
global $conf;
$error = 0;
$this->date_creation = dol_now();
// Clean parameters
$new_resource_values = [
$this->ref,
$this->address,
$this->zip,
$this->town,
$this->country_id,
$this->state_id,
$this->description,
$this->phone,
$this->email,
$this->max_users,
$this->url,
$this->fk_code_type_resource,
$this->note_public,
$this->note_private,
];
foreach ($new_resource_values as $key => $value) {
if (isset($value)) {
$new_resource_values[$key] = trim($value);
}
}
// Insert request
$sql = "INSERT INTO ".MAIN_DB_PREFIX.$this->table_element."(";
$sql .= "entity,";
$sql .= "ref,";
$sql .= "address,";
$sql .= "zip,";
$sql .= "town,";
$sql .= "fk_country,";
$sql .= "fk_state,";
$sql .= "description,";
$sql .= "phone,";
$sql .= "email,";
$sql .= "max_users,";
$sql .= "url,";
$sql .= "fk_code_type_resource,";
$sql .= "note_public,";
$sql .= "note_private, ";
$sql .= "datec, ";
$sql .= "fk_user_author ";
$sql .= ") VALUES (";
$sql .= (int) (empty($this->entity) ? ((int) $conf->entity) : ((int) $this->entity)) . ", ";
foreach ($new_resource_values as $value) {
$sql .= " " . (!empty($value) ? "'" . $this->db->escape($value) . "'" : 'NULL') . ",";
}
$sql .= " '" . $this->db->idate($this->date_creation) . "',";
$sql .= " " . (!empty($user->id) ? ((int) $user->id) : "null");
$sql .= ")";
// Database session
$this->db->begin();
try {
dol_syslog(get_class($this) . "::create", LOG_DEBUG);
} catch (Exception $exception) {
error_log('dol_syslog error: ' . $exception->getMessage());
}
$resql = $this->db->query($sql);
if (!$resql) {
$error++;
$this->errors[] = "Error ".$this->db->lasterror();
}
if (!$error) {
$this->id = $this->db->last_insert_id(MAIN_DB_PREFIX.$this->table_element);
$result = $this->insertExtraFields();
if ($result < 0) {
$error = -1;
}
}
if (!$error && !$no_trigger) {
$result = $this->call_trigger('RESOURCE_CREATE', $user);
if ($result < 0) {
$error = -1;
}
}
// Commit or rollback
if ($error) {
foreach ($this->errors as $errmsg) {
try {
dol_syslog(get_class($this) . "::create " . $errmsg, LOG_ERR);
} catch (Exception $exception) {
error_log('dol_syslog error: ' . $exception->getMessage());
}
$this->error .= ($this->error ? ', '.$errmsg : $errmsg);
}
$this->db->rollback();
return $error;
} else {
$this->db->commit();
return $this->id;
}
}
/**
* Load object into memory from database
*
* @param int $id Id of object
* @param string $ref Ref of object
* @return int if KO: <0 || if OK: >0
*/
public function fetch(int $id, string $ref = '')
{
$sql = "SELECT";
$sql .= " t.rowid,";
$sql .= " t.entity,";
$sql .= " t.ref,";
$sql .= " t.address,";
$sql .= " t.zip,";
$sql .= " t.town,";
$sql .= " t.fk_country,";
$sql .= " t.fk_state,";
$sql .= " t.description,";
$sql .= " t.phone,";
$sql .= " t.email,";
$sql .= " t.max_users,";
$sql .= " t.url,";
$sql .= " t.fk_code_type_resource,";
$sql .= " t.note_public,";
$sql .= " t.note_private,";
$sql .= " t.tms as date_modification,";
$sql .= " t.datec as date_creation,";
$sql .= " ty.label as type_label";
$sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element." as t";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_type_resource as ty ON ty.code=t.fk_code_type_resource";
if ($id) {
$sql .= " WHERE t.rowid = ".((int) $id);
} else {
$sql .= " WHERE t.ref = '".$this->db->escape($ref)."'";
}
dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
if ($this->db->num_rows($resql)) {
$obj = $this->db->fetch_object($resql);
$this->id = $obj->rowid;
$this->entity = $obj->entity;
$this->ref = $obj->ref;
$this->address = $obj->address;
$this->zip = $obj->zip;
$this->town = $obj->town;
$this->country_id = $obj->fk_country;
$this->state_id = $obj->fk_state;
$this->description = $obj->description;
$this->phone = $obj->phone;
$this->email = $obj->email;
$this->max_users = $obj->max_users;
$this->url = $obj->url;
$this->fk_code_type_resource = $obj->fk_code_type_resource;
$this->note_public = $obj->note_public;
$this->note_private = $obj->note_private;
$this->date_creation = $this->db->jdate($obj->date_creation);
$this->date_modification = $this->db->jdate($obj->date_modification);
$this->type_label = $obj->type_label;
// Retrieve all extrafield
// fetch optionals attributes and labels
$this->fetch_optionals();
}
$this->db->free($resql);
return $this->id;
} else {
$this->error = "Error ".$this->db->lasterror();
dol_syslog(get_class($this)."::fetch ".$this->error, LOG_ERR);
return -1;
}
}
/**
* Update object in database
*
* @param ?User $user User that modifies
* @param int<0,1> $notrigger 0=launch triggers after, 1=disable triggers
* @return int if KO: <0 || if OK: >0
*/
public function update($user = null, int $notrigger = 0)
{
global $conf, $langs;
$error = 0;
$this->date_modification = dol_now();
// Clean parameters
if (isset($this->ref)) {
$this->ref = trim($this->ref);
}
if (isset($this->address)) {
$this->address = trim($this->address);
}
if (isset($this->zip)) {
$this->zip = trim($this->zip);
}
if (isset($this->town)) {
$this->town = trim($this->town);
}
if (!is_numeric($this->country_id)) {
$this->country_id = 0;
}
if (!is_numeric($this->state_id)) {
$this->state_id = 0;
}
if (isset($this->description)) {
$this->description = trim($this->description);
}
if (isset($this->phone)) {
$this->phone = trim($this->phone);
}
if (isset($this->email)) {
$this->email = trim($this->email);
}
if (isset($this->url)) {
$this->url = trim($this->url);
}
if (isset($this->fk_code_type_resource)) {
$this->fk_code_type_resource = trim($this->fk_code_type_resource);
}
if (isset($this->note_public)) {
$this->note_public = trim($this->note_public);
}
if (isset($this->note_private)) {
$this->note_private = trim($this->note_private);
}
// $this->oldcopy should have been set by the caller of update (here properties were already modified)
if (is_null($this->oldcopy) || (is_object($this->oldcopy) && $this->oldcopy->isEmpty())) {
$this->oldcopy = dol_clone($this, 2);
}
// Update request
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET";
$sql .= " ref=".(isset($this->ref) ? "'".$this->db->escape($this->ref)."'" : "null").",";
$sql .= " address=".(isset($this->address) ? "'".$this->db->escape($this->address)."'" : "null").",";
$sql .= " zip=".(isset($this->zip) ? "'".$this->db->escape($this->zip)."'" : "null").",";
$sql .= " town=".(isset($this->town) ? "'".$this->db->escape($this->town)."'" : "null").",";
$sql .= " fk_country=".($this->country_id > 0 ? (int) $this->country_id : "null").",";
$sql .= " fk_state=".($this->state_id > 0 ? (int) $this->state_id : "null").",";
$sql .= " description=".(isset($this->description) ? "'".$this->db->escape($this->description)."'" : "null").",";
$sql .= " phone=".(isset($this->phone) ? "'".$this->db->escape($this->phone)."'" : "null").",";
$sql .= " email=".(isset($this->email) ? "'".$this->db->escape($this->email)."'" : "null").",";
$sql .= " max_users=".(isset($this->max_users) ? (int) $this->max_users : "null").",";
$sql .= " url=".(isset($this->url) ? "'".$this->db->escape($this->url)."'" : "null").",";
$sql .= " fk_code_type_resource=".(isset($this->fk_code_type_resource) ? "'".$this->db->escape($this->fk_code_type_resource)."'" : "null").",";
$sql .= " note_public=".(isset($this->note_public) ? "'".$this->db->escape($this->note_public)."'" : "null").",";
$sql .= " note_private=".(isset($this->note_private) ? "'".$this->db->escape($this->note_private)."'" : "null").",";
$sql .= " tms=" . ("'" . $this->db->idate($this->date_modification) . "',");
$sql .= " fk_user_modif=" . (!empty($user->id) ? ((int) $user->id) : "null");
$sql .= " WHERE rowid=".((int) $this->id);
$this->db->begin();
dol_syslog(get_class($this)."::update", LOG_DEBUG);
$resql = $this->db->query($sql);
if (!$resql) {
$error++;
$this->errors[] = "Error ".$this->db->lasterror();
}
if (!$error && $user !== null) {
if (!$notrigger) {
// Call trigger
$result = $this->call_trigger('RESOURCE_MODIFY', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
}
if (!$error && (is_object($this->oldcopy) && $this->oldcopy->ref !== $this->ref)) {
// We remove directory
if (!empty($conf->resource->dir_output)) {
$olddir = $conf->resource->dir_output."/".dol_sanitizeFileName($this->oldcopy->ref);
$newdir = $conf->resource->dir_output."/".dol_sanitizeFileName($this->ref);
if (file_exists($olddir)) {
$res = @rename($olddir, $newdir);
if (!$res) {
$langs->load("errors");
$this->error = $langs->trans('ErrorFailToRenameDir', $olddir, $newdir);
$error++;
}
}
}
}
if (!$error) {
// Actions on extra fields
$result = $this->insertExtraFields();
if ($result < 0) {
$error++;
}
}
// Commit or rollback
if ($error) {
foreach ($this->errors as $errmsg) {
dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
$this->error .= ($this->error ? ', '.$errmsg : $errmsg);
}
$this->db->rollback();
return -1 * $error;
} else {
$this->db->commit();
return 1;
}
}
/**
* Load data of resource links into memory from database
*
* @param int $id Id of link element_resources
* @return int if KO: <0 || if OK: >0
*/
public function fetchElementResource(int $id)
{
$sql = "SELECT";
$sql .= " t.rowid,";
$sql .= " t.resource_id,";
$sql .= " t.resource_type,";
$sql .= " t.element_id,";
$sql .= " t.element_type,";
$sql .= " t.busy,";
$sql .= " t.mandatory,";
$sql .= " t.fk_user_create,";
$sql .= " t.tms as date_modification";
$sql .= " FROM ".MAIN_DB_PREFIX."element_resources as t";
$sql .= " WHERE t.rowid = ".((int) $id);
dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
if ($this->db->num_rows($resql)) {
$obj = $this->db->fetch_object($resql);
$this->id = $obj->rowid;
$this->resource_id = $obj->resource_id;
$this->resource_type = $obj->resource_type;
$this->element_id = $obj->element_id;
$this->element_type = $obj->element_type;
$this->busy = $obj->busy;
$this->mandatory = $obj->mandatory;
$this->fk_user_create = $obj->fk_user_create;
$this->date_modification = $obj->date_modification;
/*if ($obj->resource_id && $obj->resource_type) {
$this->objresource = fetchObjectByElement($obj->resource_id, $obj->resource_type);
}*/
if ($obj->element_id && $obj->element_type) {
$this->objelement = fetchObjectByElement($obj->element_id, $obj->element_type);
}
}
$this->db->free($resql);
return $this->id;
} else {
$this->error = "Error ".$this->db->lasterror();
return -1;
}
}
/**
* Delete a resource object
*
* @param User $user User making the change
* @param int<0,1> $notrigger Disable all triggers
* @return int if OK: >0 || if KO: <0
*/
public function delete(User $user, int $notrigger = 0)
{
global $conf;
require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
$rowid = $this->id;
$error = 0;
$this->db->begin();
$sql = "DELETE FROM ".MAIN_DB_PREFIX.$this->table_element;
$sql .= " WHERE rowid = ".((int) $rowid);
dol_syslog(get_class($this), LOG_DEBUG);
if ($this->db->query($sql)) {
$sql = "DELETE FROM ".MAIN_DB_PREFIX."element_resources";
$sql .= " WHERE element_type='resource' AND resource_id = ".((int) $rowid);
dol_syslog(get_class($this)."::delete", LOG_DEBUG);
$resql = $this->db->query($sql);
if (!$resql) {
$this->error = $this->db->lasterror();
$error++;
}
} else {
$this->error = $this->db->lasterror();
$error++;
}
// Removed extrafields
if (!$error) {
$result = $this->deleteExtraFields();
if ($result < 0) {
$error++;
dol_syslog(get_class($this)."::delete error -3 ".$this->error, LOG_ERR);
}
}
if (!$notrigger) {
// Call trigger
$result = $this->call_trigger('RESOURCE_DELETE', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
if (!$error) {
// We remove directory
dol_sanitizeFileName($this->ref);
if (!empty($conf->resource->dir_output)) {
$dir = $conf->resource->dir_output."/".dol_sanitizeFileName($this->ref);
if (file_exists($dir)) {
$res = @dol_delete_dir_recursive($dir);
if (!$res) {
$this->errors[] = 'ErrorFailToDeleteDir';
$error++;
}
}
}
}
if (!$error) {
$this->db->commit();
return 1;
} else {
$this->db->rollback();
return -1;
}
}
/**
* Load resource objects into $this->lines
*
* @param string $sortorder Sort order
* @param string $sortfield Sort field
* @param int $limit Limit page
* @param int $offset Offset page
* @param string|array<string,mixed> $filter Filter USF.
* @return int If KO: <0 || if OK number of lines loaded
*/
public function fetchAll(string $sortorder, string $sortfield, int $limit, int $offset, $filter = '')
{
require_once DOL_DOCUMENT_ROOT.'/core/class/extrafields.class.php';
$extrafields = new ExtraFields($this->db);
$sql = "SELECT ";
$sql .= " t.rowid,";
$sql .= " t.entity,";
$sql .= " t.ref,";
$sql .= " t.address,";
$sql .= " t.zip,";
$sql .= " t.town,";
$sql .= " t.fk_country,";
$sql .= " t.fk_state,";
$sql .= " t.description,";
$sql .= " t.phone,";
$sql .= " t.email,";
$sql .= " t.max_users,";
$sql .= " t.url,";
$sql .= " t.fk_code_type_resource,";
$sql .= " t.tms as date_modification,";
$sql .= " t.datec as date_creation,";
// Add fields from extrafields
if (!empty($extrafields->attributes[$this->table_element]) && !empty($extrafields->attributes[$this->table_element]['label'])) {
foreach ($extrafields->attributes[$this->table_element]['label'] as $key => $val) {
$sql .= ($extrafields->attributes[$this->table_element]['type'][$key] != 'separate' ? "ef.".$key." as options_".$key.', ' : '');
}
}
$sql .= " ty.label as type_label";
$sql .= " FROM ".MAIN_DB_PREFIX.$this->table_element." as t";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX."c_type_resource as ty ON ty.code=t.fk_code_type_resource";
$sql .= " LEFT JOIN ".MAIN_DB_PREFIX.$this->table_element."_extrafields as ef ON ef.fk_object=t.rowid";
$sql .= " WHERE t.entity IN (".getEntity('resource').")";
// Manage filter
if (is_array($filter)) {
foreach ($filter as $key => $value) {
if (strpos($key, 'date')) {
$sql .= " AND ".$this->db->sanitize($key)." = '".$this->db->idate($value)."'";
} elseif (strpos($key, 'ef.') !== false) {
$sql .= " AND ".$this->db->sanitize($key)." = ".((float) $value);
} else {
$sql .= " AND ".$this->db->sanitize($key)." LIKE '%".$this->db->escape($this->db->escapeforlike($value))."%'";
}
}
$filter = '';
}
// Manage filter
$errormessage = '';
$sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
if ($errormessage) {
$this->errors[] = $errormessage;
dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
return -1;
}
$sql .= $this->db->order($sortfield, $sortorder);
if ($limit) {
$sql .= $this->db->plimit($limit, $offset);
}
dol_syslog(get_class($this)."::fetchAll", LOG_DEBUG);
$this->lines = array();
$resql = $this->db->query($sql);
if ($resql) {
$num = $this->db->num_rows($resql);
if ($num) {
while ($obj = $this->db->fetch_object($resql)) {
$line = new Dolresource($this->db);
$line->id = $obj->rowid;
$line->ref = $obj->ref;
$line->address = $obj->address;
$line->zip = $obj->zip;
$line->town = $obj->town;
$line->country_id = $obj->fk_country;
$line->state_id = $obj->fk_state;
$line->description = $obj->description;
$this->phone = $obj->phone;
$this->email = $obj->email;
$this->max_users = $obj->max_users;
$this->url = $obj->url;
$line->fk_code_type_resource = $obj->fk_code_type_resource;
$line->date_modification = $obj->date_modification;
$line->date_creation = $obj->date_creation;
$line->type_label = $obj->type_label;
// fetch optionals attributes and labels
$line->fetch_optionals();
$this->lines[] = $line;
}
$this->db->free($resql);
}
return $num;
} else {
$this->error = $this->db->lasterror();
return -1;
}
}
/**
* Update element resource in database
*
* @param ?User $user User that modifies
* @param int<0,1> $notrigger 0=launch triggers after, 1=disable triggers
* @return int if KO: <0 || if OK: >0
*/
public function updateElementResource($user = null, int $notrigger = 0)
{
$error = 0;
$this->date_modification = dol_now();
// Clean parameters
if (!is_numeric($this->resource_id)) {
$this->resource_id = 0;
}
if (isset($this->resource_type)) {
$this->resource_type = trim($this->resource_type);
}
if (!is_numeric($this->element_id)) {
$this->element_id = 0;
}
if (isset($this->element_type)) {
$this->element_type = trim($this->element_type);
}
if (isset($this->busy)) {
$this->busy = (int) $this->busy;
}
if (isset($this->mandatory)) {
$this->mandatory = (int) $this->mandatory;
}
// Update request
$sql = "UPDATE ".MAIN_DB_PREFIX."element_resources SET";
$sql .= " resource_id = ".(isset($this->resource_id) ? (int) $this->resource_id : "null").",";
$sql .= " resource_type = ".(isset($this->resource_type) ? "'".$this->db->escape($this->resource_type)."'" : "null").",";
$sql .= " element_id = ".(isset($this->element_id) ? (int) $this->element_id : "null").",";
$sql .= " element_type = ".(isset($this->element_type) ? "'".$this->db->escape($this->element_type)."'" : "null").",";
$sql .= " busy = ".(isset($this->busy) ? (int) $this->busy : "null").",";
$sql .= " mandatory = ".(isset($this->mandatory) ? (int) $this->mandatory : "null").",";
$sql .= " tms = ".(dol_strlen((string) $this->date_modification) != 0 ? "'".$this->db->idate($this->date_modification)."'" : 'null');
$sql .= " WHERE rowid=".((int) $this->id);
$this->db->begin();
dol_syslog(get_class($this)."::update", LOG_DEBUG);
$resql = $this->db->query($sql);
if (!$resql) {
$error++;
$this->errors[] = "Error ".$this->db->lasterror();
}
if (!$error && $user !== null) {
if (!$notrigger) {
// Call trigger
$result = $this->call_trigger('RESOURCE_MODIFY', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
}
// Commit or rollback
if ($error) {
foreach ($this->errors as $errmsg) {
dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
$this->error .= ($this->error ? ', '.$errmsg : $errmsg);
}
$this->db->rollback();
return -1 * $error;
} else {
$this->db->commit();
return 1;
}
}
/**
* Return an array with resources linked to the element
*
* @param string $element Element
* @param int $element_id Id
* @param string $resource_type Type
* @return array<array{rowid:int,resource_id:int,resource_type:string,busy:int<0,1>,mandatory:int<0,1>}> Array of resources
*/
public function getElementResources(string $element, int $element_id, string $resource_type = '')
{
// Links between objects are stored in this table
$sql = 'SELECT rowid, resource_id, resource_type, busy, mandatory';
$sql .= ' FROM '.MAIN_DB_PREFIX.'element_resources';
$sql .= " WHERE element_id=".((int) $element_id)." AND element_type='".$this->db->escape($element)."'";
if ($resource_type) {
$sql .= " AND resource_type LIKE '%".$this->db->escape($resource_type)."%'";
}
$sql .= ' ORDER BY resource_type';
dol_syslog(get_class($this)."::getElementResources", LOG_DEBUG);
$resources = array();
$resql = $this->db->query($sql);
if ($resql) {
$num = $this->db->num_rows($resql);
$i = 0;
while ($i < $num) {
$obj = $this->db->fetch_object($resql);
$resources[$i] = array(
'rowid' => $obj->rowid,
'resource_id' => $obj->resource_id,
'resource_type' => $obj->resource_type,
'busy' => $obj->busy,
'mandatory' => $obj->mandatory
);
$i++;
}
}
return $resources;
}
/**
* Return an int number of resources linked to the element
*
* @param string $elementType Element type
* @param int $elementId Element id
* @return int Nb of resources loaded
*/
public function fetchElementResources(string $elementType, int $elementId)
{
$resources = $this->getElementResources($elementType, $elementId);
$i = 0;
foreach ($resources as $resource) {
$this->lines[$i] = fetchObjectByElement($resource['resource_id'], $resource['resource_type']);
$i++;
}
return $i;
}
/**
* Load in cache resource type code (setup in dictionary)
*
* @return int if KO: <0 || if already loaded: 0 || Number of lines loaded
*/
public function loadCacheCodeTypeResource()
{
global $langs;
if (is_array($this->cache_code_type_resource) && count($this->cache_code_type_resource)) {
return 0; // Cache deja charge
}
$sql = "SELECT rowid, code, label, active";
$sql .= " FROM ".MAIN_DB_PREFIX."c_type_resource";
$sql .= " WHERE active > 0";
$sql .= " ORDER BY rowid";
dol_syslog(get_class($this)."::load_cache_code_type_resource", LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
$num = $this->db->num_rows($resql);
$i = 0;
while ($i < $num) {
$obj = $this->db->fetch_object($resql);
$label = ($langs->trans("ResourceTypeShort".$obj->code) != "ResourceTypeShort".$obj->code ? $langs->trans("ResourceTypeShort".$obj->code) : ($obj->label != '-' ? $obj->label : ''));
$this->cache_code_type_resource[$obj->rowid]['code'] = $obj->code;
$this->cache_code_type_resource[$obj->rowid]['label'] = $label;
$this->cache_code_type_resource[$obj->rowid]['active'] = $obj->active;
$i++;
}
return $num;
} else {
dol_print_error($this->db);
return -1;
}
}
/**
* getTooltipContentArray
* @param array<string,mixed> $params params to construct tooltip data
* @since v18
* @return array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}
*/
public function getTooltipContentArray($params)
{
global $langs;
$langs->load('resource');
$datas = [];
$datas['picto'] = img_picto('', $this->picto).' <u>'.$langs->trans("Resource").'</u>';
$datas['ref'] = '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
/*if (isset($this->status)) {
$datas['status'] = '<br><b>' . $langs->trans("Status").":</b> ".$this->getLibStatut(5);
}*/
if (isset($this->type_label)) {
$datas['label'] = '<br><b>'.$langs->trans("ResourceType").":</b> ".$this->type_label;
}
return $datas;
}
/**
* Return clickable link of object (with optional picto)
*
* @param int<0,2> $withpicto Add picto into link
* @param string $option Where point the link ('compta', 'expedition', 'document', ...)
* @param string $get_params Parameters added to url
* @param int<0,1> $notooltip 1=Disable tooltip
* @param string $morecss Add more css on link
* @param int<-1,1> $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
* @return string String with URL
*/
public function getNomUrl($withpicto = 0, string $option = '', string $get_params = '', int $notooltip = 0, string $morecss = '', int $save_lastsearch_value = -1)
{
global $langs, $hookmanager, $action;
$result = '';
$params = [
'id' => $this->id,
'objecttype' => $this->element,
];
$classfortooltip = 'classfortooltip';
$dataparams = '';
if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
$classfortooltip = 'classforajaxtooltip';
$dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
$label = '';
} else {
$label = implode($this->getTooltipContentArray($params));
}
$url = DOL_URL_ROOT.'/resource/card.php?id='.$this->id;
if ($option != 'nolink') {
// Add param to save lastsearch_values or not
$add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
$add_save_lastsearch_values = 1;
}
if ($add_save_lastsearch_values) {
$url .= '&save_lastsearch_values=1';
}
}
$linkclose = '';
if (empty($notooltip)) {
if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
$label = $langs->trans("ShowResource");
$linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
}
$linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
$linkclose .= $dataparams.' class="'.$classfortooltip.($morecss ? ' '.$morecss : '').'"';
} else {
$linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
}
$linkstart = '<a href="'.$url.$get_params.'"';
$linkstart .= $linkclose.'>';
$linkend = '</a>';
/*$linkstart = '<a href="'.DOL_URL_ROOT.'/resource/card.php?id='.$this->id.$get_params.'" title="'.dol_escape_htmltag($label, 1).'" class="classfortooltip">';
$linkend = '</a>';*/
$result .= $linkstart;
if ($withpicto) {
$result .= img_object(($notooltip ? '' : $label), ($this->picto ?: 'generic'), (($withpicto != 2) ? 'class="paddingright"' : ''), 0, 0, $notooltip ? 0 : 1);
}
if ($withpicto != 2) {
$result .= $this->ref;
}
$result .= $linkend;
$hookmanager->initHooks(array($this->element . 'dao'));
$parameters = array('id' => $this->id, 'getnomurl' => &$result);
$reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
if ($reshook > 0) {
$result = $hookmanager->resPrint;
} else {
$result .= $hookmanager->resPrint;
}
return $result;
}
/**
* Get status label
*
* @param int<0,6> $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
* @return string Label of status
*/
public function getLibStatut(int $mode = 0)
{
return $this->getLibStatusLabel($this->status, $mode);
}
/**
* Get status
*
* @param int $status Id status
* @param int<0,6> $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 5=Long label + Picto
* @return string Label of status
*/
public static function getLibStatusLabel(int $status, int $mode = 0)
{
return '';
}
/**
* Load indicators this->nb for state board
*
* @return int if KO: <0 || if OK: >0
*/
public function loadStateBoard()
{
$this->nb = array();
$sql = "SELECT count(r.rowid) as nb";
$sql .= " FROM ".MAIN_DB_PREFIX."resource as r";
$sql .= " WHERE r.entity IN (".getEntity('resource').")";
$resql = $this->db->query($sql);
if ($resql) {
while ($obj = $this->db->fetch_object($resql)) {
$this->nb["dolresource"] = $obj->nb;
}
$this->db->free($resql);
return 1;
} else {
dol_print_error($this->db);
$this->error = $this->db->error();
return -1;
}
}
}
Reference in a new issue View git blame Copy permalink