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) ---Put here your own copyright and developer email---
 *
 * 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';
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';


class EmailSenderProfile extends CommonObject
{
  public $element = 'emailsenderprofile';

  public $table_element = 'c_email_senderprofile';

  public $ismultientitymanaged = 1;

  public $picto = 'emailsenderprofile@monmodule';


  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'=>'text', '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 $date_creation;

  public $tms;
  public $private;
  public $signature;
  public $position;
  public $active;
  // END MODULEBUILDER PROPERTIES


  public function __construct(DoliDB $db)
  {
    global $conf;

    $this->db = $db;

    if (empty($conf->global->MAIN_SHOW_TECHNICAL_ID)) $this->fields['rowid']['visible'] = 0;
    if (empty($conf->multicompany->enabled)) $this->fields['entity']['enabled'] = 0;
  }

  public function create(User $user, $notrigger = false)
  {
    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 = false)
  {
    return $this->updateCommon($user, $notrigger);
  }

  public function delete(User $user, $notrigger = false)
  {
    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->trans('Enabled');
    } else {
      $label = $labelshort = $langs->trans('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 .= ' fk_user_creat, fk_user_modif';
    $sql .= ' FROM '.MAIN_DB_PREFIX.$this->table_element.' as t';
    $sql .= ' WHERE t.rowid = '.$id;
    $result = $this->db->query($sql);
    if ($result)
    {
      if ($this->db->num_rows($result))
      {
        $obj = $this->db->fetch_object($result);
        $this->id = $obj->rowid;
        if ($obj->fk_user_author)
        {
          $cuser = new User($this->db);
          $cuser->fetch($obj->fk_user_author);
          $this->user_creation = $cuser;
        }

        if ($obj->fk_user_valid)
        {
          $vuser = new User($this->db);
          $vuser->fetch($obj->fk_user_valid);
          $this->user_validation = $vuser;
        }

        if ($obj->fk_user_cloture)
        {
          $cluser = new User($this->db);
          $cluser->fetch($obj->fk_user_cloture);
          $this->user_cloture = $cluser;
        }

        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->datem);
        $this->date_validation   = $this->db->jdate($obj->datev);
      }

      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }

  public function initAsSpecimen()
  {
    $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;
}
*/