actioncommreminder.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024   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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
 
class ActionCommReminder extends CommonObject
{
  public $element = 'actioncomm_reminder';
 
  public $table_element = 'actioncomm_reminder';
 
  public $picto = 'generic';
 
  const STATUS_TODO = 0;
  const STATUS_DONE = 1;
  const STATUS_ERROR = -1;
 
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'visible' => -1, 'enabled' => 1, 'position' => 1, 'notnull' => 1, 'index' => 1, 'comment' => "Id",),
    'entity' => array('type' => 'integer', 'label' => 'Entity', 'visible' => 0, 'enabled' => 1, 'position' => 20, 'notnull' => 1, 'index' => 1,),
    'dateremind' => array('type' => 'datetime', 'label' => 'DateRemind', 'visible' => 1, 'enabled' => 1, 'position' => 60, 'notnull' => 1, 'index' => 1,),
    'typeremind' => array('type' => 'varchar(32)', 'label' => 'TypeRemind', 'visible' => -1, 'enabled' => 1, 'position' => 55, 'notnull' => 1, 'comment' => "email, browser, sms",),
    'fk_user' => array('type' => 'integer', 'label' => 'User', 'visible' => -1, 'enabled' => 1, 'position' => 65, 'notnull' => 1, 'index' => 1,),
    'offsetvalue' => array('type' => 'integer', 'label' => 'OffsetValue', 'visible' => 1, 'enabled' => 1, 'position' => 56, 'notnull' => 1,),
    'offsetunit' => array('type' => 'varchar(1)', 'label' => 'OffsetUnit', 'visible' => 1, 'enabled' => 1, 'position' => 57, 'notnull' => 1, 'comment' => "y, m, d, w, h, i",),
    'status' => array('type' => 'integer', 'label' => 'Status', 'visible' => 1, 'enabled' => 1, 'position' => 58, 'notnull' => 1, 'default' => '0', 'index' => 0, 'arrayofkeyval' => array('0' => 'ToDo', '1' => 'Done')),
    'lasterror' => array('type' => 'varchar(128)', 'label' => 'LastError', 'visible' => -1, 'enabled' => 1, 'position' => 59, 'index' => 0),
    'fk_actioncomm' => array('type' => 'integer', 'label' => 'Project', 'visible' => 1, 'enabled' => 1, 'position' => 70, 'notnull' => 1, 'index' => 1,),
    'fk_email_template' => array('type' => 'integer', 'label' => 'EmailTemplate', 'visible' => 1, 'enabled' => 1, 'position' => 80, 'notnull' => 0),
  );
 
  public $rowid;
 
  public $entity;
 
  public $dateremind;
 
  public $typeremind;
 
  public $fk_user;
 
  public $offsetvalue;
 
  public $offsetunit;
 
  public $status;
 
  public $lasterror;
 
  public $fk_actioncomm;
 
  public $fk_email_template;
  // END MODULEBUILDER PROPERTIES
 
  public function __construct(DoliDB $db)
  {
    global $conf;
 
    $this->db = $db;
 
    $this->ismultientitymanaged = 0;
 
    if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID')) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (!isModEnabled('multicompany')) {
      $this->fields['entity']['enabled'] = 0;
    }
  }
 
  public function create(User $user, $notrigger = 0)
  {
    return $this->createCommon($user, $notrigger);
  }
 
 
  public function fetch($id, $ref = null)
  {
    $result = $this->fetchCommon($id, $ref);
    return $result;
  }
 
  public function update(User $user, $notrigger = 0)
  {
    return $this->updateCommon($user, $notrigger);
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    return $this->deleteCommon($user, $notrigger);
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
 
    $labelStatus = $langs->transnoentitiesnoconv('ToDo');
    if ($status == 1) {
      $labelStatus = $langs->transnoentitiesnoconv('Done');
    } elseif ($status == -1) {
      $labelStatus = $langs->transnoentitiesnoconv('Error');
    }
 
    $labelStatusShort = $langs->transnoentitiesnoconv('ToDo');
    if ($status == 1) {
      $labelStatus = $langs->transnoentitiesnoconv('Done');
    } elseif ($status == -1) {
      $labelStatus = $langs->transnoentitiesnoconv('Error');
    }
 
    $statusType = 'status5';
    if ($status == 1) {
      $statusType = 'status4';
    } elseif ($status == -1) {
      $statusType = 'status8';
    }
 
    return dolGetStatus($labelStatus, $labelStatusShort, '', $statusType, $mode);
  }
 
  public function initAsSpecimen()
  {
    return $this->initAsSpecimenCommon();
  }
}