thirdparties_services_expired.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2005-2010 Laurent Destailleur  <eldy@users.sourceforge.net>
 *
* This file is an example to follow to add your own email selector inside
* the Dolibarr email tool.
* Follow instructions given in README file to know what to change to build
* your own emailing list selector.
* Code that need to be changed in this file are marked by "CHANGE THIS" tag.
*/

include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
require_once DOL_DOCUMENT_ROOT.'/core/lib/functions2.lib.php';


class mailing_thirdparties_services_expired extends MailingTargets
{
  public $name = 'DolibarrContractsLinesExpired';
  // This label is used if no translation is found for key XXX neither MailingModuleDescXXX where XXX=name is found
  public $desc = 'Third parties with expired contract\'s lines';
  public $require_admin = 0;

  public $require_module = array('contrat');

  public $picto = 'company';

  public $db;

  public $arrayofproducts = array();


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

    $this->db = $db;

    $this->arrayofproducts = array();

    // List of services
    $sql = "SELECT ref FROM ".MAIN_DB_PREFIX."product";
    $sql .= " WHERE entity IN (".getEntity('product').")";
    if (empty($conf->global->CONTRACT_SUPPORT_PRODUCTS)) $sql .= " AND fk_product_type = 1"; // By default, only services
    $sql .= " ORDER BY ref";
    $result = $this->db->query($sql);
    if ($result)
    {
      $num = $this->db->num_rows($result);
      dol_syslog("dolibarr_services_expired.modules.php:mailing_dolibarr_services_expired ".$num." services found");

      $i = 0;
      while ($i < $num)
      {
        $obj = $this->db->fetch_object($result);
        $i++;
        $this->arrayofproducts[$i] = $obj->ref;
      }
    } else {
      dol_print_error($this->db);
    }
  }


  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function add_to_target($mailing_id)
  {
    // phpcs:enable
    $key = GETPOST('filter', 'int');

    $cibles = array();
    $j = 0;

    $product = '';
    if ($key == '0')
    {
      $this->error = "Error: You must choose a filter";
      $this->errors[] = $this->error;
      return $this->error;
    }

    $product = $this->arrayofproducts[$key];

    $now = dol_now();

    // La requete doit retourner: id, email, name
    $sql = "SELECT s.rowid as id, s.email, s.nom as name, cd.rowid as cdid, cd.date_ouverture, cd.date_fin_validite, cd.fk_contrat";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c";
    $sql .= ", ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p";
    $sql .= " WHERE s.entity IN (".getEntity('societe').")";
    $sql .= " AND s.email NOT IN (SELECT email FROM ".MAIN_DB_PREFIX."mailing_cibles WHERE fk_mailing=".$mailing_id.")";
    $sql .= " AND s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''";
    $sql .= " AND cd.statut= 4 AND cd.fk_product=p.rowid AND p.ref = '".$this->db->escape($product)."'";
    $sql .= " AND cd.date_fin_validite < '".$this->db->idate($now)."'";
    $sql .= " ORDER BY s.email";

    // Stocke destinataires dans cibles
    $result = $this->db->query($sql);
    if ($result)
    {
      $num = $this->db->num_rows($result);
      $i = 0;

      dol_syslog(get_class($this)."::add_to_target ".$num." targets found");

      $old = '';
      while ($i < $num)
      {
        $obj = $this->db->fetch_object($result);
        if ($old <> $obj->email)
        {
          $cibles[$j] = array(
          'email' => $obj->email,
          'lastname' => $obj->name, // For thirdparties, lastname must be name
          'firstname' => '', // For thirdparties, firstname is ''
          'other' =>
          ('DateStart='.dol_print_date($this->db->jdate($obj->date_ouverture), 'day')).';'.
          ('DateEnd='.dol_print_date($this->db->jdate($obj->date_fin_validite), 'day')).';'.
          ('Contract='.$obj->fk_contrat).';'.
          ('ContactLine='.$obj->cdid),
          'source_url' => $this->url($obj->id),
          'source_id' => $obj->id,
          'source_type' => 'thirdparty'
          );
          $old = $obj->email;
          $j++;
        }

        $i++;
      }
    } else {
      dol_syslog($this->db->lasterror());
      $this->error = $this->db->lasterror();
      return -1;
    }

    // ----- Your code end here -----

    return parent::addTargetsToDatabase($mailing_id, $cibles);
  }


  public function getSqlArrayForStats()
  {

    //var $statssql=array();
    //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL";

    return array();
  }


  public function getNbOfRecipients($sql = '')
  {
    $now = dol_now();

    // Example: return parent::getNbOfRecipients("SELECT count(*) as nb from dolibarr_table");
    // Example: return 500;
    $sql = "SELECT count(*) as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."contrat as c";
    $sql .= ", ".MAIN_DB_PREFIX."contratdet as cd, ".MAIN_DB_PREFIX."product as p";
    $sql .= " WHERE s.entity IN (".getEntity('societe').")";
    $sql .= " AND s.rowid = c.fk_soc AND cd.fk_contrat = c.rowid AND s.email != ''";
    $sql .= " AND cd.statut= 4 AND cd.fk_product=p.rowid";
    $sql .= " AND p.ref IN ('".join("','", $this->arrayofproducts)."')";
    $sql .= " AND cd.date_fin_validite < '".$this->db->idate($now)."'";

    $a = parent::getNbOfRecipients($sql);

    return $a;
  }

  public function formFilter()
  {
    global $langs;

    $s = $langs->trans("ProductOrService");
    $s .= '<select name="filter" class="flat">';
    if (count($this->arrayofproducts)) $s .= '<option value="0">&nbsp;</option>';
    else $s .= '<option value="0">'.$langs->trans("ContactsAllShort").'</option>';
    foreach ($this->arrayofproducts as $key => $val)
    {
      $s .= '<option value="'.$key.'">'.$val.'</option>';
    }
    $s .= '</select>';
    return $s;
  }


  public function url($id)
  {
    return '<a href="'.DOL_URL_ROOT.'/societe/card.php?socid='.$id.'">'.img_object('', "company").'</a>';
  }
}