partnership.modules.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2018-2018  Andre Schild          <a.schild@aarboard.ch>
 * Copyright (C) 2005-2010  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2009  Regis Houssin         <regis.houssin@inodbox.com>
 * Copyright (C) 2024   MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2026  Frédéric France         <frederic.france@free.fr>
 *
 * 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.
 */
 
// Load Dolibarr Environment
include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
 
 
class mailing_partnership extends MailingTargets
{
  public $name = 'PartnershipThirdpartiesOrMembers';
 
  public $desc = "Thirdparties or members included into a partnership program";
 
  public $require_admin = 0;
 
  public $require_module = array('partnership'); // This module allows to select by categories must be also enabled if category module is not activated
 
  public $picto = 'partnership';
 
  public $enabled = 'isModEnabled("partnership")';
 
 
  public function __construct($db)
  {
    global $langs;
    $langs->load('companies');
 
    $this->db = $db;
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function add_to_target($mailing_id)
  {
    // phpcs:enable
    global $langs;
 
    $cibles = array();
    $addDescription = '';
 
    $sql = "SELECT s.rowid as id, s.email as email, s.nom as name, null as fk_contact, null as firstname, pt.label as label, 'thirdparty' as source";
    $sql .= " FROM ".MAIN_DB_PREFIX."societe as s, ".MAIN_DB_PREFIX."partnership as p, ".MAIN_DB_PREFIX."c_partnership_type as pt";
    $sql .= " WHERE s.email <> ''";
    $sql .= " AND s.entity IN (".getEntity('societe').")";
    $sql .= " AND s.email NOT IN (SELECT email FROM ".MAIN_DB_PREFIX."mailing_cibles WHERE fk_mailing = ".((int) $mailing_id).")";
    $sql .= " AND p.fk_soc = s.rowid";
    $sql .= " AND pt.rowid = p.fk_type";
    if (GETPOSTINT('countryid') > 0) {
      $sql .= " AND s.fk_pays = ".((int) GETPOSTINT('countryid'));
    }
    if (GETPOSTINT('filter') > 0) {
      $sql .= " AND pt.rowid = ".((int) GETPOSTINT('filter'));
    }
    if (GETPOSTISSET('filter_status_partnership') && GETPOSTINT('filter_status_partnership') >= 0) {
      $sql .= " AND p.status = ".((int) GETPOSTINT('filter_status_partnership'));
    }
    $sql .= $this->getSqlToExcludeUnsubscribed('s.email');
 
    $sql .= " UNION ";
 
    $sql .= "SELECT s.rowid as id, s.email as email, s.lastname as name, null as fk_contact, s.firstname as firstname, pt.label as label, 'member' as source";
    $sql .= " FROM ".MAIN_DB_PREFIX."adherent as s, ".MAIN_DB_PREFIX."partnership as p, ".MAIN_DB_PREFIX."c_partnership_type as pt";
    $sql .= " WHERE s.email <> ''";
    $sql .= " AND s.entity IN (".getEntity('member').")";
    $sql .= " AND s.email NOT IN (SELECT email FROM ".MAIN_DB_PREFIX."mailing_cibles WHERE fk_mailing = ".((int) $mailing_id).")";
    $sql .= " AND p.fk_member = s.rowid";
    $sql .= " AND pt.rowid = p.fk_type";
    if (GETPOSTINT('countryid') > 0) {
      $sql .= " AND s.country = ".((int) GETPOSTINT('countryid'));
    }
    if (GETPOSTINT('filter') > 0) {
      $sql .= " AND pt.rowid=".((int) GETPOSTINT('filter'));
    }
    if (GETPOSTISSET('filter_status_partnership') && GETPOSTINT('filter_status_partnership') >= 0) {
      $sql .= " AND p.status = ".((int) GETPOSTINT('filter_status_partnership'));
    }
    $sql .= $this->getSqlToExcludeUnsubscribed('s.email');
 
    $sql .= " ORDER BY email";
 
    // Stock recipients emails into targets table
    $result = $this->db->query($sql);
    if ($result) {
      $num = $this->db->num_rows($result);
      $i = 0;
      $j = 0;
 
      dol_syslog(get_class($this)."::add_to_target mailing ".$num." targets found");
 
      $old = '';
      while ($i < $num) {
        $obj = $this->db->fetch_object($result);
        if ($old != $obj->email) {
          $otherTxt = ($obj->label ? $langs->transnoentities("PartnershipType").'='.$obj->label : '');
          if (strlen($addDescription) > 0 && strlen($otherTxt) > 0) {
            $otherTxt .= ";";
          }
          $otherTxt .= $addDescription;
          $cibles[$j] = array(
                'email' => $obj->email,
                'fk_contact' => (int) $obj->fk_contact,
                'lastname' => $obj->name, // For a thirdparty, we must use name
                'firstname' => '', // For a thirdparty, lastname is ''
                'other' => $otherTxt,
                'source_url' => $this->url($obj->id, $obj->source),
                'source_id' => (int) $obj->id,
                'source_type' => $obj->source
          );
          $old = $obj->email;
          $j++;
        }
 
        $i++;
      }
    } else {
      dol_syslog($this->db->error());
      $this->error = $this->db->error();
      return -1;
    }
 
    return parent::addTargetsToDatabase($mailing_id, $cibles);
  }
 
 
  public function getSqlArrayForStats()
  {
    // CHANGE THIS: Optional
 
    //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 = '')
  {
    $sql = "SELECT count(distinct(s.email)) as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."partnership as p, ".MAIN_DB_PREFIX."societe as s";
    $sql .= " WHERE s.rowid = p.fk_soc AND s.email <> ''";
    $sql .= " AND s.entity IN (".getEntity('societe').")";
    $sql .= $this->getSqlToExcludeUnsubscribed('s.email');
 
    $sql .= " UNION ";
 
    $sql .= "SELECT count(distinct(s.email)) as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."partnership as p, ".MAIN_DB_PREFIX."adherent as s";
    $sql .= " WHERE s.rowid = p.fk_member AND s.email <> ''";
    $sql .= " AND s.entity IN (".getEntity('member').")";
    $sql .= $this->getSqlToExcludeUnsubscribed('s.email');
 
    //print $sql;
 
    // The query must return a field "nb" to be understood by parent::getNbOfRecipients
    return parent::getNbOfRecipients($sql);
  }
 
  public function formFilter()
  {
    global $conf, $langs, $form;
 
    $langs->load("companies");
 
    // Add filter on partnership type
    $s = '<!-- form to filter partnerships -->'."\n";
    $s .= '<select id="filter_partnership" name="filter" class="flat">';
 
    // Get all types of partnership
    $sql = "SELECT rowid, label, code, active";
    $sql .= " FROM ".MAIN_DB_PREFIX."c_partnership_type";
    $sql .= " WHERE active = 1";
    $sql .= " AND entity = ".((int) $conf->entity);
    $sql .= " ORDER BY label";
 
    //print $sql;
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
 
      if (!isModEnabled("partnership")) {
        $num = 0;   // Force empty list if module is not enabled
      }
 
      if ($num) {
        $s .= '<option value="-1">'.$langs->trans("PartnershipType").'</option>';
      }
 
      $i = 0;
      while ($i < $num) {
        $obj = $this->db->fetch_object($resql);
 
        $s .= '<option value="'.$obj->rowid.'"'.($obj->rowid == GETPOST('filter') ? "selected" : "").'>';
        $s .= dolPrintHTML($obj->label);
        $s .= '</option>';
        $i++;
      }
      $s .= ajax_combobox("filter_partnership");
    } else {
      dol_print_error($this->db);
    }
 
    $s .= '</select> ';
 
    // Add filter on thirdparties status
    include_once DOL_DOCUMENT_ROOT.'/partnership/class/partnership.class.php';
    $tmppartnership = new Partnership($this->db);
 
    $tmppartnership->status = 0;
    $tmppartnership->getLibStatut(0); // We call this only to have $tmppartnership->labelStatus loaded
 
    $s .= $form->selectarray('filter_status_partnership', $tmppartnership->labelStatus, GETPOST('filter_status_partnership'), $langs->trans("Status"));
 
    // Add filter on country
    $s .= $form->select_country(GETPOST('countryid'), 'countryid', '', 0, 'minwidth150 maxwidth200', '', $langs->trans("Country"), 0, 0, array(), 0, 0);
 
    return $s;
  }
 
 
  public function url($id, $sourcetype = 'thirdparty')
  {
    if ($sourcetype == 'thirdparty') {
      return '<a href="'.DOL_URL_ROOT.'/societe/card.php?socid='.((int) $id).'">'.img_object('', "societe").'</a>';
    }
    if ($sourcetype == 'member') {
      return '<a href="'.DOL_URL_ROOT.'/adherents/card.php?id='.((int) $id).'">'.img_object('', "member").'</a>';
    }
 
    return '';
  }
}