commonsignedobject.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2024   William Mead      <william.mead@manchenumerique.fr>
 * Copyright (C) 2025       Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2025   MDW           <mdeweerd@users.noreply.github.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/>.
 */
 
trait CommonSignedObject
{
  public $signed_status = 0;
 
  public static $SIGNED_STATUSES = [
    'STATUS_NO_SIGNATURE' => 0,
    'STATUS_SIGNED_SENDER' => 1,
    'STATUS_SIGNED_RECEIVER' => 2,
    'STATUS_SIGNED_RECEIVER_ONLINE' => 3,
    'STATUS_SIGNED_ALL' => 9, // To handle future kind of signature (ex: tripartite contract)
  ];
 
  public function getSignedStatusLocalisedArray(): array
  {
    global $langs;
    $langs->load("commercial");
 
    $l10n_signed_status_labels = [
      self::$SIGNED_STATUSES['STATUS_NO_SIGNATURE']     => 'NoSignature',
      self::$SIGNED_STATUSES['STATUS_SIGNED_SENDER']      => 'SignedSender',
      self::$SIGNED_STATUSES['STATUS_SIGNED_RECEIVER']    => 'SignedReceiver',
      self::$SIGNED_STATUSES['STATUS_SIGNED_RECEIVER_ONLINE'] => 'SignedReceiverOnline',
      self::$SIGNED_STATUSES['STATUS_SIGNED_ALL']       => 'SignedAll'
    ];
 
    $l10n_signed_status = [];
    foreach (self::$SIGNED_STATUSES as $signed_status_code) {
      $l10n_signed_status[$signed_status_code] = $langs->transnoentitiesnoconv($l10n_signed_status_labels[$signed_status_code]);
    }
    return $l10n_signed_status;
  }
 
  public function setSignedStatus(User $user, int $status = 0, int $notrigger = 0, string $triggercode = ''): int
  {
    global $langs;
 
    $langs->loadLangs(array('commercial'));
 
    $this->signed_status = $status;
    $this->context['signature'] = $status;
 
    switch ($status) {
      case 0:
        $this->context['actionmsg2'] = $langs->transnoentitiesnoconv('UnsignedInDolibarr');
        break;
      case 1:
        $this->context['actionmsg2'] = $langs->transnoentitiesnoconv('SignedSender');
        break;
      case 2:
        $this->context['actionmsg2'] = $langs->transnoentitiesnoconv('SignedReceiver');
        break;
      case 3:
        $this->context['actionmsg2'] = $langs->transnoentitiesnoconv('SignedReceiverOnline');
        break;
      case 9:
        $this->context['actionmsg2'] = $langs->transnoentitiesnoconv('SignedAll');
        break;
    }
    return $this->setSignedStatusCommon($user, $status, $notrigger, $triggercode);
  }
 
  public function setSignedStatusCommon(User $user, int $status, int $notrigger = 0, string $triggercode = ''): int
  {
    global $langs;
    $langs->loadLangs(array('commercial'));
 
    $error = 0;
 
    if ($this instanceof CommonObject) {
      $this->db->begin();
      $statusfield = 'signed_status';
 
      $sql = "UPDATE ".$this->db->prefix().$this->table_element;
      $sql .= " SET ".$this->db->sanitize($statusfield)." = ".((int) $status);
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      if ($this->db->query($sql)) {
        $this->oldcopy = clone $this;
 
        if (!$notrigger) {
          // Call trigger
          $result = $this->call_trigger($triggercode, $user);
          if ($result < 0) {
            $error++;
          }
        }
 
        if (!$error) {
          $this->signed_status = $status;
          $this->db->commit();
 
          setEventMessages($langs->transnoentitiesnoconv($status == 0 ? 'DocumentUnsigned' : 'DocumentSigned'), null, 'warnings');
          return 1;
        } else {
          $this->db->rollback();
          return -1;
        }
      } else {
        $this->error = $this->db->error();
        $this->db->rollback();
        return -1;
      }
    } else {
      return $error;
    }
  }
 
  public function getLibSignedStatus(int $mode = 0): string
  {
    global $langs;
    $langs->load("commercial");
    $list_signed_status = $this->getSignedStatusLocalisedArray();
    $signed_status_label = $this->signed_status != '' ? $list_signed_status[$this->signed_status] : '';
    $signed_status_label_short = $this->signed_status != '' ? $list_signed_status[$this->signed_status] : '';
    $signed_status_code = 'status'.$this->signed_status;
    return dolGetStatus($signed_status_label, $signed_status_label_short, '', $signed_status_code, $mode);
  }
}