/htdocs/core/modules/mailings/framboise.modules.php
PHP | 227 lines | 118 code | 37 blank | 72 comment | 13 complexity | 81e09f8a6cd0d3a747fe1b412af602ec MD5 | raw file
Possible License(s): LGPL-2.0
- <?php
- /* Copyright (C) 2005-2010 Laurent Destailleur <eldy@users.sourceforge.net>
- * Copyright (C) 2005-2009 Regis Houssin <regis@dolibarr.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.
- */
- /**
- * \file htdocs/core/modules/mailings/framboise.modules.php
- * \ingroup mailing
- * \brief Example file to provide a list of recipients for mailing module
- */
- include_once DOL_DOCUMENT_ROOT.'/core/modules/mailings/modules_mailings.php';
- /**
- * \class mailing_framboise
- * \brief Class to manage a list of personalised recipients for mailing feature
- */
- class mailing_framboise extends MailingTargets
- {
- // CHANGE THIS: Put here a name not already used
- var $name='MembersCategories';
- // CHANGE THIS: Put here a description of your selector module.
- // This label is used if no translation found for key MailingModuleDescXXX where XXX=name is found
- var $desc="Foundation members with emails (by categories)";
- // CHANGE THIS: Set to 1 if selector is available for admin users only
- var $require_admin=0;
- var $require_module=array("adherent","categorie");
- var $picto='user';
- var $db;
- /**
- * Constructor
- *
- * @param DoliDB $db Database handler
- */
- function mailing_framboise($db)
- {
- $this->db=$db;
- }
- /**
- * \brief This is the main function that returns the array of emails
- * \param mailing_id Id of mailing. No need to use it.
- * \param filterarray If you used the formFilter function. Empty otherwise.
- * \return int <0 if error, number of emails added if ok
- */
- function add_to_target($mailing_id,$filtersarray=array())
- {
- global $conf, $langs;
- $cibles = array();
- // CHANGE THIS
- // Select the members from category
- $sql = "SELECT s.rowid as id, s.email as email, s.nom as name, null as fk_contact, null as firstname,";
- if ($_POST['filter']) $sql.= " llx_categorie.label as label";
- else $sql.=" null as label";
- $sql.= " FROM llx_adherent as s";
- if ($_POST['filter']) $sql.= " LEFT JOIN llx_categorie_member ON llx_categorie_member.fk_member=s.rowid";
- if ($_POST['filter']) $sql.= " LEFT JOIN llx_categorie ON llx_categorie.rowid = llx_categorie_member.fk_categorie";
- $sql.= " WHERE s.email != ''";
- $sql.= " AND s.entity = ".$conf->entity;
- if ($_POST['filter']) $sql.= " AND llx_categorie.rowid='".$_POST['filter']."'";
- $sql.= " ORDER BY s.email";
- // Stocke destinataires dans cibles
- $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)
- {
- $cibles[$j] = array(
- 'email' => $obj->email,
- 'fk_contact' => $obj->fk_contact,
- 'name' => $obj->name,
- 'firstname' => $obj->firstname,
- 'other' => ($obj->label?$langs->transnoentities("Category").'='.$obj->label:''),
- 'source_url' => $this->url($obj->id),
- 'source_id' => $obj->id,
- 'source_type' => 'member'
- );
- $old = $obj->email;
- $j++;
- }
- $i++;
- }
- }
- else
- {
- dol_syslog($this->db->error());
- $this->error=$this->db->error();
- return -1;
- }
- return parent::add_to_target($mailing_id, $cibles);
- }
- /**
- * On the main mailing area, there is a box with statistics.
- * If you want to add a line in this report you must provide an
- * array of SQL request that returns two field:
- * One called "label", One called "nb".
- *
- * @return array Array with SQL requests
- */
- function getSqlArrayForStats()
- {
- // CHANGE THIS: Optionnal
- //var $statssql=array();
- //$this->statssql[0]="SELECT field1 as label, count(distinct(email)) as nb FROM mytable WHERE email IS NOT NULL";
- return array();
- }
- /*
- * \brief Return here number of distinct emails returned by your selector.
- * For example if this selector is used to extract 500 different
- * emails from a text file, this function must return 500.
- * \return int
- */
- function getNbOfRecipients()
- {
- global $conf;
- $sql = "SELECT count(distinct(s.email)) as nb";
- $sql.= " FROM ".MAIN_DB_PREFIX."adherent as s";
- $sql.= " WHERE s.email != ''";
- $sql.= " AND s.entity = ".$conf->entity;
- // La requete doit retourner un champ "nb" pour etre comprise
- // par parent::getNbOfRecipients
- return parent::getNbOfRecipients($sql);
- }
- /**
- * \brief This is to add a form filter to provide variant of selector
- * If used, the HTML select must be called "filter"
- * \return string A html select zone
- */
- function formFilter()
- {
- global $conf, $langs;
- $langs->load("companies");
- $langs->load("categories");
- $s='';
- $s.='<select name="filter" class="flat">';
- // Show categories
- $sql = "SELECT rowid, label, type, visible";
- $sql.= " FROM ".MAIN_DB_PREFIX."categorie";
- $sql.= " WHERE type = 3"; // We keep only categories for members
- // $sql.= " AND visible > 0"; // We ignore the property visible because member's categories does not use this property (only products categories use it).
- $sql.= " AND entity = ".$conf->entity;
- $sql.= " ORDER BY label";
- //print $sql;
- $resql = $this->db->query($sql);
- if ($resql)
- {
- $num = $this->db->num_rows($resql);
- $s.='<option value="0"> </option>';
- if (! $num) $s.='<option value="0" disabled="disabled">'.$langs->trans("NoCategoriesDefined").'</option>';
- $i = 0;
- while ($i < $num)
- {
- $obj = $this->db->fetch_object($resql);
- $s.='<option value="'.$obj->rowid.'">'.dol_trunc($obj->label,38,'middle');
- $s.='</option>';
- $i++;
- }
- }
- else
- {
- dol_print_error($db);
- }
- $s.='</select>';
- return $s;
- }
- /**
- * \brief Can include an URL link on each record provided by selector
- * shown on target page.
- * \return string Url link
- */
- function url($id)
- {
- //$companystatic=new Societe($this->db);
- //$companystatic->id=$id;
- //$companystatic->nom='';
- //return $companystatic->getNomUrl(1); // Url too long
- return '<a href="'.DOL_URL_ROOT.'/adherents/fiche.php?rowid='.$id.'">'.img_object('',"user").'</a>';
- }
- }
- ?>