emailsenderprofile.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2017  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2014-2016  Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2015       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2015       Raphaël Doursenaud  <rdoursenaud@gpcsolutions.fr>
 * 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 EmailSenderProfile extends CommonObject
{
  public $element = 'emailsenderprofile';
 
  public $table_element = 'c_email_senderprofile';
 
  public $picto = 'emailsenderprofile';
 
  public $fk_user_creat;
 
 
  const STATUS_DISABLED = 0;
  const STATUS_ENABLED = 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' => -1, 'enabled' => 1, 'position' => 20, 'notnull' => 1, 'index' => 1,),
    'label' => array('type' => 'varchar(255)', 'label' => 'Label', 'visible' => 1, 'enabled' => 1, 'position' => 30, 'notnull' => 1),
    'email' => array('type' => 'varchar(255)', 'label' => 'Email', 'visible' => 1, 'enabled' => 1, 'position' => 40, 'notnull' => -1),
    'private' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'User', 'visible' => 1, 'enabled' => 1, 'position' => 50, 'default' => '0', 'notnull' => 1),
    'signature' => array('type' => 'html', 'label' => 'Signature', 'visible' => 3, 'enabled' => 1, 'position' => 400, 'notnull' => -1, 'index' => 1,),
    'position' => array('type' => 'integer', 'label' => 'Position', 'visible' => 1, 'enabled' => 1, 'position' => 405, 'notnull' => -1, 'index' => 1,),
    'date_creation' => array('type' => 'datetime', 'label' => 'DateCreation', 'visible' => -1, 'enabled' => 1, 'position' => 500, 'notnull' => 1,),
    'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'visible' => -1, 'enabled' => 1, 'position' => 500, 'notnull' => 1,),
    'active' => array('type' => 'integer', 'label' => 'Status', 'visible' => 1, 'enabled' => 1, 'default' => 1, 'position' => 1000, 'notnull' => 1, 'index' => 1, 'arrayofkeyval' => array(0 => 'Disabled', 1 => 'Enabled')),
  );
 
  public $rowid;
 
  public $entity;
 
  public $label;
 
  public $email;
 
  public $private;
  public $signature;
  public $position;
  public $active;
  // END MODULEBUILDER PROPERTIES
 
 
  public function __construct(DoliDB $db)
  {
    global $conf;
 
    $this->db = $db;
 
    $this->ismultientitymanaged = 1;
 
    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 createFromClone(User $user, $fromid)
  {
    global $hookmanager, $langs;
    $error = 0;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $object = new self($this->db);
 
    $this->db->begin();
 
    // Load source object
    $object->fetchCommon($fromid);
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
    unset($object->import_key);
 
    // Clear fields
    $object->ref = "copy_of_".$object->ref;
    $object->title = $langs->trans("CopyOf")." ".$object->title;
    // ...
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->error = $object->error;
      $this->errors = $object->errors;
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id, $ref = null)
  {
    $result = $this->fetchCommon($id, $ref);
    if ($result > 0 && !empty($this->table_element_line)) {
      $this->fetchLines();
    }
    return $result;
  }
 
  public function fetchLines()
  {
    $this->lines = array();
 
    // Load lines with object EmailSenderProfileLine
 
    return count($this->lines) ? 1 : 0;
  }
 
  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 getNomUrl($withpicto = 0)
  {
    global $db, $conf, $langs;
    global $dolibarr_main_authentication, $dolibarr_main_demo;
    global $menumanager;
 
    $result = '';
    $companylink = '';
 
    $label = $this->label;
 
    $url = '';
    //$url = dol_buildpath('/monmodule/emailsenderprofile_card.php',1).'?id='.$this->id;
 
    $linkstart = '';
    $linkend = '';
 
    if ($withpicto) {
      $result .= ($linkstart.img_object($label, 'label', 'class="classfortooltip"').$linkend);
      if ($withpicto != 2) {
        $result .= ' ';
      }
    }
    $result .= $linkstart.$this->label.$linkend;
    return $result;
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->active, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function LibStatut($status, $mode = 0)
  {
    global $langs;
 
    if ($status == 1) {
      $label = $labelshort = $langs->transnoentitiesnoconv('Enabled');
    } else {
      $label = $labelshort = $langs->transnoentitiesnoconv('Disabled');
    }
 
    $statusType = 'status'.$status;
    if ($status == self::STATUS_ENABLED) {
      $statusType = 'status4';
    }
 
    return dolGetStatus($label, $labelshort, '', $statusType, $mode);
  }
 
  public function info($id)
  {
    $sql = "SELECT rowid, date_creation as datec, tms as datem";
    $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
    $sql .= " WHERE t.rowid = ".((int) $id);
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
        $this->id = $obj->rowid;
 
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->datem);
      }
 
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }
 
  public function initAsSpecimen()
  {
    return $this->initAsSpecimenCommon();
  }
}
 
/*
class EmailSenderProfileLine
{
  // @var int ID
  public $id;
  // @var mixed Sample line property 1
  public $prop1;
  // @var mixed Sample line property 2
  public $prop2;
}
*/