dolibarr 22.0.5
stocktransfer.class.php
Go to the documentation of this file.
1<?php
2/* Copyright (C) 2017 Laurent Destailleur <eldy@users.sourceforge.net>
3 * Copyright (C) 2021 Gauthier VERDOL <gauthier.verdol@atm-consulting.fr>
4 * Copyright (C) 2022-2024 Frédéric France <frederic.france@free.fr>
5 * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
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
27// Put here all includes required by your class file
28require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
29require_once DOL_DOCUMENT_ROOT.'/core/class/commonincoterm.class.php';
30
31//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
32//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
33
38{
39 use CommonIncoterm;
43 public $element = 'stocktransfer';
44
48 public $table_element = 'stocktransfer_stocktransfer';
49
53 public $table_element_line = 'stocktransfer_stocktransferline';
54
58 public $fk_element = 'fk_stocktransfer';
59
65 protected $childtablesoncascade = array('stocktransfer_stocktransferline');
66
72 public $ref_client;
73
77 public $ref_customer;
78
82 public $picto = 'stock';
83
87 public $date_prevue_depart;
88
92 public $date_prevue_arrivee;
93
97 public $date_reelle_depart;
98
102 public $date_reelle_arrivee;
103
107 public $origin_type;
108
109
110 const STATUS_DRAFT = 0;
111 const STATUS_VALIDATED = 1;
112 const STATUS_TRANSFERED = 2;
113 const STATUS_CLOSED = 3;
114
115
141 // BEGIN MODULEBUILDER PROPERTIES
145 public $fields = array(
146 'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'position' => 1, 'notnull' => 1, 'visible' => 0, 'noteditable' => 1, 'index' => 1, 'comment' => "Id"),
147 'entity' => array('type' => 'integer', 'label' => 'Entity', 'enabled' => 1, 'position' => 1, 'default' => '1', 'notnull' => 1, 'visible' => 0, 'noteditable' => 1, 'index' => 1, 'comment' => "Id"),
148 'ref' => array('type' => 'varchar(128)', 'label' => 'Ref', 'enabled' => 1, 'position' => 10, 'notnull' => 1, 'visible' => 4, 'noteditable' => 1, 'default' => '(PROV)', 'index' => 1, 'searchall' => 1, 'showoncombobox' => 1, 'comment' => "Reference of object"),
149 'label' => array('type' => 'varchar(255)', 'label' => 'Label', 'enabled' => 1, 'position' => 30, 'notnull' => 0, 'visible' => 1, 'searchall' => 1, 'showoncombobox' => 1, 'css' => 'minwidth100', 'csslist' => 'tdoverflowmax125', 'autofocusoncreate' => 1),
150 'description' => array('type' => 'text', 'label' => 'Description', 'enabled' => 1, 'position' => 31, 'notnull' => 0, 'visible' => 3,),
151 'fk_project' => array('type' => 'integer:Project:projet/class/project.class.php:1', 'label' => 'Project', 'enabled' => '$conf->project->enabled', 'position' => 32, 'notnull' => -1, 'visible' => -1, 'index' => 1, 'picto' => 'project', 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax125'),
152 'fk_soc' => array('type' => 'integer:Societe:societe/class/societe.class.php:1:((status:=:1) AND (entity:IN:__SHARED_ENTITIES__))', 'label' => 'ThirdParty', 'enabled' => 1, 'position' => 50, 'notnull' => -1, 'visible' => 1, 'index' => 1/*, 'help'=>"LinkToThirdparty"*/, 'picto' => 'company', 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax125'),
153 'fk_warehouse_source' => array('type' => 'integer:Entrepot:product/stock/class/entrepot.class.php', 'label' => 'Entrepôt source', 'enabled' => 1, 'position' => 50, 'notnull' => 0, 'visible' => 1, 'help' => 'HelpWarehouseStockTransferSource', 'picto' => 'stock', 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150'),
154 'fk_warehouse_destination' => array('type' => 'integer:Entrepot:product/stock/class/entrepot.class.php', 'label' => 'Entrepôt de destination', 'enabled' => 1, 'position' => 51, 'notnull' => 0, 'visible' => 1, 'help' => 'HelpWarehouseStockTransferDestination', 'picto' => 'stock', 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150'),
155 'note_public' => array('type' => 'html', 'label' => 'NotePublic', 'enabled' => 1, 'position' => 61, 'notnull' => 0, 'visible' => 0,),
156 'note_private' => array('type' => 'html', 'label' => 'NotePrivate', 'enabled' => 1, 'position' => 62, 'notnull' => 0, 'visible' => 0,),
157 'date_creation' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'position' => 500, 'notnull' => 1, 'visible' => -2,),
158 'date_prevue_depart' => array('type' => 'date', 'label' => 'DatePrevueDepart', 'enabled' => 1, 'position' => 100, 'notnull' => 0, 'visible' => 1,),
159 'date_reelle_depart' => array('type' => 'date', 'label' => 'DateReelleDepart', 'enabled' => 1, 'position' => 101, 'notnull' => 0, 'visible' => 5,),
160 'date_prevue_arrivee' => array('type' => 'date', 'label' => 'DatePrevueArrivee', 'enabled' => 1, 'position' => 102, 'notnull' => 0, 'visible' => 1,),
161 'date_reelle_arrivee' => array('type' => 'date', 'label' => 'DateReelleArrivee', 'enabled' => 1, 'position' => 103, 'notnull' => 0, 'visible' => 5,),
162 'lead_time_for_warning' => array('type' => 'integer', 'label' => 'LeadTimeForWarning', 'enabled' => 1, 'position' => 200, 'default' => '0', 'notnull' => 0, 'visible' => 1),
163 'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'position' => 501, 'notnull' => 0, 'visible' => -2,),
164 'fk_user_creat' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'position' => 510, 'notnull' => 1, 'visible' => -2, 'foreignkey' => 'user.rowid',),
165 'fk_user_modif' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'ChangedBy', 'enabled' => 1, 'position' => 511, 'notnull' => -1, 'visible' => -2,),
166 'import_key' => array('type' => 'varchar(14)', 'label' => 'ImportId', 'enabled' => 1, 'position' => 1000, 'notnull' => -1, 'visible' => -2,),
167 'model_pdf' => array('type' => 'varchar(255)', 'label' => 'Model pdf', 'enabled' => 1, 'position' => 1010, 'notnull' => -1, 'visible' => 0,),
168 'fk_incoterms' => array('type' => 'integer', 'label' => 'IncotermCode', 'enabled' => '$conf->incoterm->enabled', 'visible' => -2, 'position' => 220),
169 'location_incoterms' => array('type' => 'varchar(255)', 'label' => 'IncotermLabel', 'enabled' => '$conf->incoterm->enabled', 'visible' => -2, 'position' => 225),
170 'status' => array('type' => 'smallint', 'label' => 'Status', 'enabled' => 1, 'position' => 1000, 'notnull' => 1, 'visible' => 5, 'index' => 1, 'arrayofkeyval' => array('0' => 'Draft', '1' => 'Validated', '2' => 'StockStransferDecremented', '3' => 'StockStransferIncremented'),),
171 );
175 public $rowid;
179 public $ref;
183 public $label;
184
188 public $description;
189
193 public $socid;
194
199 public $fk_soc;
203 public $lead_time_for_warning;
207 public $status;
208
212 public $lines;
213
217 public $fk_warehouse_source;
218
222 public $fk_warehouse_destination;
223 // END MODULEBUILDER PROPERTIES
224
225
231 public function __construct(DoliDB $db)
232 {
233 global $conf, $langs;
234
235 $this->db = $db;
236
237 $this->ismultientitymanaged = 0;
238 $this->isextrafieldmanaged = 1;
239
240 $this->origin_type = 'StockTransfer@product/stock/stocktransfer';
241
242 if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid'])) {
243 $this->fields['rowid']['visible'] = 0;
244 }
245 if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
246 $this->fields['entity']['enabled'] = 0;
247 }
248
249 // Example to show how to set values of fields definition dynamically
250 /*if ($user->rights->stocktransfer->stocktransfer->read) {
251 $this->fields['myfield']['visible'] = 1;
252 $this->fields['myfield']['noteditable'] = 0;
253 }*/
254
255 // Unset fields that are disabled
256 foreach ($this->fields as $key => $val) {
257 if (isset($val['enabled']) && empty($val['enabled'])) {
258 unset($this->fields[$key]);
259 }
260 }
261
262 // Translate some data of arrayofkeyval
263 if (is_object($langs)) {
264 foreach ($this->fields as $key => $val) {
265 if (isset($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
266 foreach ($val['arrayofkeyval'] as $key2 => $val2) {
267 $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
268 }
269 }
270 }
271 }
272 }
273
281 public function create(User $user, $notrigger = 0)
282 {
283 $this->status = (int) $this->status;
284 if ($this->fk_warehouse_source <= 0) {
285 $this->fk_warehouse_source = 0;
286 }
287 if ($this->fk_warehouse_destination <= 0) {
288 $this->fk_warehouse_destination = 0;
289 }
290 return $this->createCommon($user, $notrigger);
291 }
292
300 public function createFromClone(User $user, $fromid)
301 {
302 global $langs, $extrafields;
303 $error = 0;
304
305 dol_syslog(__METHOD__, LOG_DEBUG);
306
307 $object = new self($this->db);
308
309 $this->db->begin();
310
311 // Load source object
312 $result = $object->fetchCommon($fromid);
313 if ($result > 0 && !empty($object->table_element_line)) {
314 $object->fetchLines();
315 }
316
317 // get lines so they will be clone
318 //foreach($this->lines as $line)
319 // $line->fetch_optionals();
320
321 // Reset some properties
322 unset($object->id);
323 unset($object->fk_user_creat);
324 unset($object->import_key);
325 unset($object->date_prevue_depart);
326 unset($object->date_prevue_arrivee);
327 unset($object->date_reelle_depart);
328 unset($object->date_reelle_arrivee);
329
330
331 // Clear fields
332 // @phan-suppress-next-line PhanTypeMismatchProperty
333 $object->ref = empty($this->fields['ref']['default']) ? "copy_of_".$object->ref : $this->fields['ref']['default'];
334 // @phan-suppress-next-line PhanTypeInvalidDimOffset
335 $object->label = empty($this->fields['label']['default']) ? $langs->trans("CopyOf")." ".$object->label : $this->fields['label']['default'];
336 $object->status = self::STATUS_DRAFT;
337 // ...
338 // Clear extrafields that are unique
339 if (is_array($object->array_options) && count($object->array_options) > 0) {
340 $extrafields->fetch_name_optionals_label($this->table_element);
341 foreach ($object->array_options as $key => $option) {
342 $shortkey = preg_replace('/options_/', '', $key);
343 if (!empty($extrafields->attributes[$this->table_element]['unique'][$shortkey])) {
344 //var_dump($key); var_dump($clonedObj->array_options[$key]); exit;
345 unset($object->array_options[$key]);
346 }
347 }
348 }
349
350 // Create clone
351 $object->context['createfromclone'] = 'createfromclone';
352 $result = $object->createCommon($user);
353 if ($result < 0) {
354 $error++;
356 }
357
358 if (!$error) {
359 // copy internal contacts
360 if ($this->copy_linked_contact($object, 'internal') < 0) {
361 $error++;
362 }
363 }
364
365 if (!$error) {
366 // copy external contacts if same company
367 if (property_exists($this, 'socid') && $this->socid == $object->socid) {
368 if ($this->copy_linked_contact($object, 'external') < 0) {
369 $error++;
370 }
371 }
372 }
373
374 unset($object->context['createfromclone']);
375
376 // End
377 if (!$error) {
378 $this->db->commit();
379 return $object;
380 } else {
381 $this->db->rollback();
382 return -1;
383 }
384 }
385
393 public function fetch($id, $ref = null)
394 {
395 $result = $this->fetchCommon($id, $ref);
396
397 $this->socid = $this->fk_soc;
398
399 if ($result > 0 && !empty($this->table_element_line)) {
400 $this->fetchLines();
401 }
402 return $result;
403 }
404
410 public function fetchLines()
411 {
412 require_once DOL_DOCUMENT_ROOT . '/product/stock/stocktransfer/class/stocktransferline.class.php';
413 $this->lines = array();
414
415 $result = $this->fetchLinesCommon();
416 usort($this->lines, array('StockTransfer', 'stocktransferCmpRank'));
417 return $result;
418 }
419
427 public static function stocktransferCmpRank($a, $b)
428 {
429 if ($a->rang == $b->rang) {
430 return 0;
431 }
432 return ($a->rang < $b->rang) ? -1 : 1;
433 }
434
440 public function getValorisationTotale()
441 {
442 $total_pmp = 0;
443
444 if (empty($this->lines)) {
445 $this->fetchLines();
446 }
447 if (!empty($this->lines)) {
448 foreach ($this->lines as $l) {
449 $total_pmp += ($l->pmp * $l->qty);
450 }
451 }
452
453 return $total_pmp;
454 }
455
468 public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, $filter = '', $filtermode = 'AND')
469 {
470 dol_syslog(__METHOD__, LOG_DEBUG);
471
472 $records = array();
473
474 $sql = 'SELECT ';
475 $sql .= $this->getFieldList();
476 $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
477 if (isset($this->ismultientitymanaged) && $this->ismultientitymanaged == 1) {
478 $sql .= ' WHERE t.entity IN ('.getEntity($this->element).')';
479 } else {
480 $sql .= ' WHERE 1 = 1';
481 }
482
483 // Manage filter
484 $errormessage = '';
485 $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
486 if ($errormessage) {
487 $this->errors[] = $errormessage;
488 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
489 return -1;
490 }
491
492 if (!empty($sortfield)) {
493 $sql .= $this->db->order($sortfield, $sortorder);
494 }
495 if (!empty($limit)) {
496 $sql .= ' '.$this->db->plimit($limit, $offset);
497 }
498
499 $resql = $this->db->query($sql);
500 if ($resql) {
501 $num = $this->db->num_rows($resql);
502 $i = 0;
503 while ($i < ($limit ? min($limit, $num) : $num)) {
504 $obj = $this->db->fetch_object($resql);
505
506 $record = new self($this->db);
507 $record->setVarsFromFetchObj($obj);
508
509 $records[$record->id] = $record;
510
511 $i++;
512 }
513 $this->db->free($resql);
514
515 return $records;
516 } else {
517 $this->errors[] = 'Error '.$this->db->lasterror();
518 dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
519
520 return -1;
521 }
522 }
523
531 public function update(User $user, $notrigger = 0)
532 {
533 $this->tms = 0; // Will be done automatically because tms field is on update cascade
534 $res = $this->updateCommon($user, $notrigger);
535 if (($this->socid > 0 || $this->fk_soc > 0) && empty($this->thirdparty)) {
536 $this->fetch_thirdparty();
537 }
538 if (empty($this->socid) && empty($this->fk_soc)) {
539 unset($this->thirdparty);
540 }
541 return $res;
542 }
543
551 public function delete(User $user, $notrigger = 0)
552 {
553 if ($this->status > self::STATUS_VALIDATED) {
554 return 0;
555 } else {
556 return $this->deleteCommon($user, $notrigger);
557 }
558 }
559
568 public function deleteLine(User $user, $idline, $notrigger = 0)
569 {
570 if ($this->status != self::STATUS_DRAFT) { // Lines are used for the stock movements once the transfer is validated
571 $this->error = 'ErrorDeleteLineNotAllowedByObjectStatus';
572 return -2;
573 }
574 require_once DOL_DOCUMENT_ROOT.'/product/stock/stocktransfer/class/stocktransferline.class.php';
575 $line = new StockTransferLine($this->db);
576 if ($line->fetch($idline) <= 0 || $line->fk_stocktransfer != $this->id) {
577 $this->error = 'ErrorRecordNotFound';
578 return -1;
579 }
580
581 $res = $this->deleteLineCommon($user, $idline, $notrigger);
582 $this->line_order(true);
583 return $res;
584 }
585
586
594 public function validate($user, $notrigger = 0)
595 {
596 global $conf, $langs;
597
598 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
599
600 $error = 0;
601
602 // Protection
603 if ($this->status == self::STATUS_VALIDATED) {
604 dol_syslog(get_class($this)."::validate action abandoned: already validated", LOG_WARNING);
605 return 0;
606 }
607
608 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->stocktransfer->write))
609 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->stocktransfer->stocktransfer_advance->validate))))
610 {
611 $this->error='NotEnoughPermissions';
612 dol_syslog(get_class($this)."::valid ".$this->error, LOG_ERR);
613 return -1;
614 }*/
615
616 $now = dol_now();
617
618 $this->db->begin();
619
620 // Define new ref
621 if (!$error && (preg_match('/^[\‍(]?PROV/i', $this->ref) || empty($this->ref))) { // empty should not happened, but when it occurs, the test save life
622 $num = $this->getNextNumRef();
623 } else {
624 $num = $this->ref;
625 }
626 $this->newref = $num;
627
628 if (!empty($num)) {
629 // Validate
630 $sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element;
631 $sql .= " SET ref = '".$this->db->escape($num)."',";
632 $sql .= " status = ".self::STATUS_VALIDATED;
633 if (!empty($this->fields['date_validation'])) {
634 $sql .= ", date_validation = '".$this->db->idate($now)."',";
635 }
636 if (!empty($this->fields['fk_user_valid'])) { // @phan-suppress-current-line PhanTypeMismatchProperty
637 $sql .= ", fk_user_valid = ".((int) $user->id);
638 }
639 $sql .= " WHERE rowid = ".((int) $this->id);
640
641 dol_syslog(get_class($this)."::validate()", LOG_DEBUG);
642 $resql = $this->db->query($sql);
643 if (!$resql) {
644 dol_print_error($this->db);
645 $this->error = $this->db->lasterror();
646 $error++;
647 }
648
649 if (!$error && !$notrigger) {
650 // Call trigger
651 $result = $this->call_trigger('STOCKTRANSFER_VALIDATE', $user);
652 if ($result < 0) {
653 $error++;
654 }
655 // End call triggers
656 }
657 }
658
659 if (!$error) {
660 $this->oldref = $this->ref;
661
662 // Rename directory if dir was a temporary ref
663 if (preg_match('/^[\‍(]?PROV/i', $this->ref)) {
664 // Now we rename also files into index
665 $sql = 'UPDATE '.MAIN_DB_PREFIX."ecm_files set filename = CONCAT('".$this->db->escape($this->newref)."', SUBSTR(filename, ".(strlen($this->ref) + 1).")), filepath = 'stocktransfer/".$this->db->escape($this->newref)."'";
666 $sql .= " WHERE filename LIKE '".$this->db->escape($this->ref)."%' AND filepath = 'stocktransfer/".$this->db->escape($this->ref)."' and entity = ".((int) $conf->entity);
667 $resql = $this->db->query($sql);
668 if (!$resql) {
669 $error++;
670 $this->error = $this->db->lasterror();
671 }
672 $sql = 'UPDATE '.MAIN_DB_PREFIX."ecm_files set filepath = 'stocktransfer/".$this->db->escape($this->newref)."'";
673 $sql .= " WHERE filepath = 'stocktransfer/".$this->db->escape($this->ref)."' and entity = ".$conf->entity;
674 $resql = $this->db->query($sql);
675 if (!$resql) {
676 $error++;
677 $this->error = $this->db->lasterror();
678 }
679
680 // We rename directory ($this->ref = old ref, $num = new ref) in order not to lose the attachments
681 $oldref = dol_sanitizeFileName($this->ref);
682 $newref = dol_sanitizeFileName($num);
683 $dirsource = $conf->stocktransfer->dir_output.'/stocktransfer/'.$oldref;
684 $dirdest = $conf->stocktransfer->dir_output.'/stocktransfer/'.$newref;
685 if (!$error && file_exists($dirsource)) {
686 dol_syslog(get_class($this)."::validate() rename dir ".$dirsource." into ".$dirdest);
687
688 if (@rename($dirsource, $dirdest)) {
689 dol_syslog("Rename ok");
690 // Rename docs starting with $oldref with $newref
691 $listoffiles = dol_dir_list($conf->stocktransfer->dir_output.'/stocktransfer/'.$newref, 'files', 1, '^'.preg_quote($oldref, '/'));
692 foreach ($listoffiles as $fileentry) {
693 $dirsource = $fileentry['name'];
694 $dirdest = preg_replace('/^'.preg_quote($oldref, '/').'/', $newref, $dirsource);
695 $dirsource = $fileentry['path'].'/'.$dirsource;
696 $dirdest = $fileentry['path'].'/'.$dirdest;
697 @rename($dirsource, $dirdest);
698 }
699 }
700 }
701 }
702 }
703
704 // Set new ref and current status
705 if (!$error) {
706 $this->ref = $num;
707 $this->status = self::STATUS_VALIDATED;
708 }
709
710 if (!$error) {
711 $this->db->commit();
712 return 1;
713 } else {
714 $this->db->rollback();
715 return -1;
716 }
717 }
718
719
727 public function setDraft($user, $notrigger = 0)
728 {
729 // Protection
730 if ($this->status <= self::STATUS_DRAFT) {
731 return 0;
732 }
733
734 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->write))
735 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->stocktransfer_advance->validate))))
736 {
737 $this->error='Permission denied';
738 return -1;
739 }*/
740
741 return $this->setStatusCommon($user, self::STATUS_DRAFT, $notrigger, 'STOCKTRANSFER_UNVALIDATE');
742 }
743
751 public function cancel($user, $notrigger = 0)
752 {
753 // Protection
754 if ($this->status != self::STATUS_VALIDATED) {
755 return 0;
756 }
757
758 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->write))
759 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->stocktransfer_advance->validate))))
760 {
761 $this->error='Permission denied';
762 return -1;
763 }*/
764
765 return $this->setStatusCommon($user, self::STATUS_CLOSED, $notrigger, 'STOCKTRANSFER_CLOSE');
766 }
767
775 public function reopen($user, $notrigger = 0)
776 {
777 // Protection
778 if ($this->status != self::STATUS_CLOSED) {
779 return 0;
780 }
781
782 /*if (! ((empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->write))
783 || (!empty($conf->global->MAIN_USE_ADVANCED_PERMS) && !empty($user->rights->stocktransfer->stocktransfer_advance->validate))))
784 {
785 $this->error='Permission denied';
786 return -1;
787 }*/
788
789 return $this->setStatusCommon($user, self::STATUS_VALIDATED, $notrigger, 'STOCKTRANSFER_REOPEN');
790 }
791
802 public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
803 {
804 global $conf, $langs, $hookmanager;
805
806 if (!empty($conf->dol_no_mouse_hover)) {
807 $notooltip = 1;
808 } // Force disable tooltips
809
810 $result = '';
811
812 $label = '<u>'.$langs->trans("StockTransfer").'</u>';
813 $label .= '<br>';
814 $label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref;
815 if (isset($this->status)) {
816 $label .= '<br><b>'.$langs->trans("Status").":</b> ".$this->getLibStatut(5);
817 }
818
819 $url = dol_buildpath('/product/stock/stocktransfer/stocktransfer_card.php', 1).'?id='.$this->id;
820
821 if ($option != 'nolink') {
822 // Add param to save lastsearch_values or not
823 $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
824 if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
825 $add_save_lastsearch_values = 1;
826 }
827 if ($add_save_lastsearch_values) {
828 $url .= '&save_lastsearch_values=1';
829 }
830 }
831
832 $linkclose = '';
833 if (empty($notooltip)) {
834 if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
835 $label = $langs->trans("ShowStockTransfer");
836 $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
837 }
838 $linkclose .= ' title="'.dolPrintHTMLForAttribute($label).'"';
839 $linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
840 } else {
841 $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
842 }
843
844 $linkstart = '<a href="'.$url.'"';
845 $linkstart .= $linkclose.'>';
846 $linkend = '</a>';
847
848 $result .= $linkstart;
849
850 if (empty($this->showphoto_on_popup)) {
851 if ($withpicto) {
852 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
853 }
854 } else {
855 if ($withpicto) {
856 require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
857
858 list($class, $module) = explode('@', $this->picto);
859 $upload_dir = $conf->$module->multidir_output[$conf->entity]."/$class/".dol_sanitizeFileName($this->ref);
860 $filearray = dol_dir_list($upload_dir, "files");
861 $filename = $filearray[0]['name'];
862 if (!empty($filename)) {
863 $pospoint = strpos($filearray[0]['name'], '.');
864
865 $pathtophoto = $class.'/'.$this->ref.'/thumbs/'.substr($filename, 0, $pospoint).'_mini'.substr($filename, $pospoint);
866 if (!getDolGlobalString(strtoupper($module.'_'.$class).'_FORMATLISTPHOTOSASUSERS')) {
867 $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo'.$module.'" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div></div>';
868 } else {
869 $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photouserphoto userphoto" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div>';
870 }
871
872 $result .= '</div>';
873 } else {
874 $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
875 }
876 }
877 }
878
879 if ($withpicto != 2) {
880 $result .= $this->ref;
881 }
882
883 $result .= $linkend;
884 //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
885
886 global $action, $hookmanager;
887 $hookmanager->initHooks(array('stocktransferdao'));
888 $parameters = array('id' => $this->id, 'getnomurl' => $result);
889 $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
890 if ($reshook > 0) {
891 $result = $hookmanager->resPrint;
892 } else {
893 $result .= $hookmanager->resPrint;
894 }
895
896 return $result;
897 }
898
905 public function getLibStatut($mode = 0)
906 {
907 return $this->LibStatut($this->status, $mode);
908 }
909
910 // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
918 public function LibStatut($status, $mode = 0)
919 {
920 // phpcs:enable
921 if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
922 global $langs;
923 //$langs->load("stocktransfer@stocktransfer");
924 $this->labelStatus[self::STATUS_DRAFT] = $langs->trans('Draft');
925 $this->labelStatus[self::STATUS_VALIDATED] = $langs->trans('Validated');
926 $this->labelStatus[self::STATUS_TRANSFERED] = $langs->trans('StockStransferDecremented');
927 $this->labelStatus[self::STATUS_CLOSED] = $langs->trans('StockStransferIncremented');
928 $this->labelStatusShort[self::STATUS_DRAFT] = $langs->trans('Draft');
929 $this->labelStatusShort[self::STATUS_VALIDATED] = $langs->trans('Validated');
930 $this->labelStatusShort[self::STATUS_TRANSFERED] = $langs->trans('StockStransferDecremented');
931 $this->labelStatusShort[self::STATUS_CLOSED] = $langs->trans('StockStransferIncremented');
932 }
933
934 $statusType = 'status'.$status;
935 //if ($status == self::STATUS_VALIDATED) $statusType = 'status1';
936 if ($status == self::STATUS_CLOSED) {
937 $statusType = 'status6';
938 }
939
940 return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
941 }
942
949 public function info($id)
950 {
951 $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
952 $sql .= ' fk_user_creat, fk_user_modif';
953 $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
954 $sql .= ' WHERE t.rowid = '.((int) $id);
955 $result = $this->db->query($sql);
956 if ($result) {
957 if ($this->db->num_rows($result)) {
958 $obj = $this->db->fetch_object($result);
959 $this->id = $obj->rowid;
960
961 $this->user_creation_id = $obj->fk_user_creat;
962 $this->user_modification_id = $obj->fk_user_modif;
963 $this->date_creation = $this->db->jdate($obj->datec);
964 $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
965 }
966
967 $this->db->free($result);
968 } else {
969 dol_print_error($this->db);
970 }
971 }
972
979 public function initAsSpecimen()
980 {
981 return $this->initAsSpecimenCommon();
982 }
983
989 public function getLinesArray()
990 {
991 $this->lines = array();
992
993 $objectline = new StockTransferLine($this->db);
994 $result = $objectline->fetchAll('ASC', 'rang', 0, 0, "(fk_stocktransfer:=:".((int) $this->id).")");
995
996 if (is_numeric($result)) {
997 $this->error = $objectline->error;
998 $this->errors = $objectline->errors;
999 return $result;
1000 } else {
1001 $this->lines = $result;
1002 return $this->lines;
1003 }
1004 }
1005
1011 public function getNextNumRef()
1012 {
1013 global $langs, $conf;
1014 $langs->load("stocks");
1015
1016 if (!getDolGlobalString('STOCKTRANSFER_STOCKTRANSFER_ADDON')) {
1017 $conf->global->STOCKTRANSFER_STOCKTRANSFER_ADDON = 'mod_stocktransfer_standard';
1018 }
1019
1020 if (getDolGlobalString('STOCKTRANSFER_STOCKTRANSFER_ADDON')) {
1021 $mybool = false;
1022
1023 $file = getDolGlobalString('STOCKTRANSFER_STOCKTRANSFER_ADDON') . ".php";
1024 $classname = getDolGlobalString('STOCKTRANSFER_STOCKTRANSFER_ADDON');
1025
1026 // Include file with class
1027 $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
1028 foreach ($dirmodels as $reldir) {
1029 $dir = dol_buildpath($reldir."core/modules/stocktransfer/");
1030
1031 // Load file with numbering class (if found)
1032 $mybool = ((bool) @include_once $dir.$file) || $mybool;
1033 }
1034
1035 if (!$mybool) {
1036 dol_print_error(null, "Failed to include file ".$file);
1037 return '';
1038 }
1039
1040 if (class_exists($classname)) {
1041 $obj = new $classname();
1042 '@phan-var-force ModeleNumRefStockTransfer $obj';
1043 $numref = $obj->getNextValue($this);
1044
1045 if ($numref != '' && $numref != '-1') {
1046 return $numref;
1047 } else {
1048 $this->error = $obj->error;
1049 //dol_print_error($this->db,get_class($this)."::getNextNumRef ".$obj->error);
1050 return "";
1051 }
1052 } else {
1053 print $langs->trans("Error")." ".$langs->trans("ClassNotFound").' '.$classname;
1054 return "";
1055 }
1056 } else {
1057 print $langs->trans("ErrorNumberingModuleNotSetup", $this->element);
1058 return "";
1059 }
1060 }
1061
1073 public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null)
1074 {
1075 global $conf, $langs;
1076
1077 $result = 0;
1078 $includedocgeneration = 1;
1079
1080 $langs->load("stocks");
1081
1082 if (!dol_strlen($modele)) {
1083 $modele = 'eagle';
1084
1085 if ($this->model_pdf) {
1086 $modele = $this->model_pdf;
1087 } elseif (getDolGlobalString('STOCKTRANSFER_ADDON_PDF')) {
1088 $modele = getDolGlobalString('STOCKTRANSFER_ADDON_PDF');
1089 }
1090 }
1091
1092 $modelpath = "core/modules/stocktransfer/doc/";
1093
1094 if ($includedocgeneration) {
1095 $result = $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams);
1096 }
1097
1098 return $result;
1099 }
1100
1108 public function doScheduledJob()
1109 {
1110 global $conf, $langs;
1111
1112 //$conf->global->SYSLOG_FILE = 'DOL_DATA_ROOT/dolibarr_mydedicatedlofile.log';
1113
1114 $error = 0;
1115 $this->output = '';
1116 $this->error = '';
1117
1118 dol_syslog(__METHOD__, LOG_DEBUG);
1119
1120 $now = dol_now();
1121
1122 $this->db->begin();
1123
1124 // ...
1125
1126 $this->db->commit();
1127
1128 return $error;
1129 }
1130}
if( $user->socid > 0) if(! $user->hasRight('accounting', 'chartofaccount')) $object
Definition card.php:67
$object ref
Definition info.php:90
Parent class of all other business classes (invoices, contracts, proposals, orders,...
line_order($renum=false, $rowidorder='ASC', $fk_parent_line=true)
Save a new position (field rang) for details lines.
deleteLineCommon(User $user, $idline, $notrigger=0)
Delete a line of object in database.
commonGenerateDocument($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
Common function for all objects extending CommonObject for generating documents.
fetch_thirdparty($force_thirdparty_id=0)
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
setErrorsFromObject($object)
setErrorsFromObject
createCommon(User $user, $notrigger=0)
Create object in the database.
getFieldList($alias='', $excludefields=array())
Function to concat keys of fields.
updateCommon(User $user, $notrigger=0)
Update object into database.
setStatusCommon($user, $status, $notrigger=0, $triggercode='')
Set to a status.
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen.
copy_linked_contact($objFrom, $source='internal')
Copy contact from one element to current.
fetchLinesCommon($morewhere='', $noextrafields=0)
Load object in memory from the database.
fetchCommon($id, $ref=null, $morewhere='', $noextrafields=0)
Load object in memory from the database.
deleteCommon(User $user, $notrigger=0, $forcechilddeletion=0)
Delete object in database.
call_trigger($triggerName, $user)
Call trigger based on this instance.
Class to manage Dolibarr database access.
Class for StockTransfer.
getValorisationTotale()
Used to get total PMP amount of all quantities of products of Stock Transfer.
update(User $user, $notrigger=0)
Update object into database.
static stocktransferCmpRank($a, $b)
Used to sort lines by rank.
fetch($id, $ref=null)
Load object in memory from the database.
deleteLine(User $user, $idline, $notrigger=0)
Delete a line of object in database.
LibStatut($status, $mode=0)
Return the status.
fetchLines()
Load object lines in memory from the database.
validate($user, $notrigger=0)
Validate object.
generateDocument($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
Create a document onto disk according to template module.
doScheduledJob()
Action executed by scheduler CAN BE A CRON TASK.
setDraft($user, $notrigger=0)
Set draft status.
initAsSpecimen()
Initialise object with example values Id must be 0 if object instance is a specimen.
create(User $user, $notrigger=0)
Create object into database.
reopen($user, $notrigger=0)
Set back to validated status.
getLibStatut($mode=0)
Return label of the status.
info($id)
Load the info information in the object.
fetchAll($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
Load list of objects in memory from the database.
getNomUrl($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
Return a link to the object card (with optionally the picto)
getNextNumRef()
Returns the reference to the following non used object depending on the active numbering module.
__construct(DoliDB $db)
Constructor.
createFromClone(User $user, $fromid)
Clone an object into another one.
getLinesArray()
Create an array of lines.
cancel($user, $notrigger=0)
Set cancel status.
Class for StockTransferLine.
Class to manage Dolibarr users.
print $langs trans("Ref").' m titre as m m statut as status
Or an array listing all the potential status of the object: array: int of the status => translated la...
Definition index.php:171
dol_dir_list($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition files.lib.php:63
img_object($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $allowothertags=array())
Show a picto called object_picto (generic function)
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
forgeSQLFromUniversalSearchCriteria($filter, &$errorstr='', $noand=0, $nopar=0, $noerror=0)
forgeSQLFromUniversalSearchCriteria
dol_now($mode='auto')
Return date for now.
dolGetStatus($statusLabel='', $statusLabelShort='', $html='', $statusType='status0', $displayMode=0, $url='', $params=array())
Output the badge of a status.
dol_buildpath($path, $type=0, $returnemptyifnotfound=0)
Return path of url or filesystem.
dol_print_error($db=null, $error='', $errors=null)
Displays error message system with all the information to facilitate the diagnosis and the escalation...
dol_sanitizeFileName($str, $newstr='_', $unaccent=1, $includequotes=0)
Clean a string to use it as a file name.
getDolGlobalString($key, $default='')
Return a Dolibarr global constant string value.
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
global $conf
The following vars must be defined: $type2label $form $conf, $lang, The following vars may also be de...
Definition member.php:79