NEW Api mass emailing (#35531)
* adding function to set it to draft mode * New API endpoint for controlling mass mailings * report which id we could not find + unset some fields not on this object + write that source was com/propal/class/api_propal.class.php * extending the fetch function for the mailing object so the API can show all columns in the database * filling more data into the object and don't unset it later * adding notrigger to clone creation * still some cleaning up from when cloning api_proposals.class.php * do not unset the ID, because we want the ID so we can use it * adding endpoint to clone a mass mailing * extending count function with 'all' that just returns all rows, no matter the status * API endpoints to delete all targets of a mass mailing * setting which http method to use * pretty print clone endpoint in API explorer * endpoint resetTargetsStatus of mass mailing * Typo receipients fixed * Update api_mailings.class.php * Update api_mailings.class.php * Update api_mailings.class.php --------- Co-authored-by: Jon Bendtsen <xcodeauthor@jonb.dk> Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>
This commit is contained in:
parent
fc1364db56
commit
8f52485172
4 changed files with 752 additions and 4 deletions
|
|
@ -328,6 +328,11 @@ if (!empty($reg[1]) && ($reg[1] != 'explorer' || ($reg[2] != '/swagger.json' &&
|
|||
$moduleobject = strtolower($moduleobject);
|
||||
$moduledirforclass = getModuleDirForApiClass($moduleobject);
|
||||
|
||||
// this works, but is only necessary because I don't know how to get getModuleDirForApiClass to answer correctly with comm/mailing
|
||||
if ($moduleobject == 'mailings') {
|
||||
$moduledirforclass = 'comm/mailing';
|
||||
}
|
||||
|
||||
// Load a dedicated API file
|
||||
dol_syslog("Load a dedicated API file moduleobject=".$moduleobject." moduledirforclass=".$moduledirforclass);
|
||||
|
||||
|
|
|
|||
689
htdocs/comm/mailing/class/api_mailings.class.php
Normal file
689
htdocs/comm/mailing/class/api_mailings.class.php
Normal file
|
|
@ -0,0 +1,689 @@
|
|||
<?php
|
||||
/* Copyright (C) 2025 Cloned from htdocs/comm/propal/class/api_proposals.class.php then modified
|
||||
* Copyright (C) 2025 Jon Bendtsen <jon.bendtsen.github@jonb.dk>
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
|
||||
use Luracast\Restler\RestException;
|
||||
|
||||
require_once DOL_DOCUMENT_ROOT.'/comm/mailing/class/mailing.class.php';
|
||||
|
||||
/**
|
||||
* API class for mass mailings
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @access protected
|
||||
* @class DolibarrApiAccess {@requires user,external}
|
||||
*/
|
||||
class Mailings extends DolibarrApi
|
||||
{
|
||||
/**
|
||||
* @var string[] Mandatory fields, checked when create and update object
|
||||
*/
|
||||
public static $FIELDS = array(
|
||||
'title',
|
||||
'sujet',
|
||||
'body'
|
||||
);
|
||||
|
||||
/**
|
||||
* @var Mailing {@type Mailing}
|
||||
*/
|
||||
public $mailing;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
global $db;
|
||||
$this->db = $db;
|
||||
$this->mailing = new Mailing($this->db);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a mass mailing
|
||||
*
|
||||
* Return an array with mass mailing information
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id ID of mass mailing
|
||||
* @return Object Object with cleaned properties
|
||||
*
|
||||
* @throws RestException
|
||||
*/
|
||||
public function get($id)
|
||||
{
|
||||
return $this->_fetch($id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get properties of an mailing object
|
||||
*
|
||||
* Return an array with mailing information
|
||||
*
|
||||
* @param int $id ID of mailing object
|
||||
* @return Object Object with cleaned properties
|
||||
*
|
||||
* @throws RestException
|
||||
*/
|
||||
private function _fetch($id)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'read')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
|
||||
$this->mailing->fetchObjectLinked();
|
||||
|
||||
return $this->_cleanObjectDatas($this->mailing);
|
||||
}
|
||||
|
||||
/**
|
||||
* List mass mailings
|
||||
*
|
||||
* Get a list of mass mailings
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param string $sortfield Sort field
|
||||
* @param string $sortorder Sort order
|
||||
* @param int $limit Limit for list
|
||||
* @param int $page Page number
|
||||
* @param string $sqlfilters Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:'SO-%') and (t.datec:<:'2016-01-01')"
|
||||
* @param string $properties Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names
|
||||
* @param bool $pagination_data If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0*
|
||||
* @param int $loadlinkedobjects Load also linked object
|
||||
* @return array Array of order objects
|
||||
* @phan-return Mailing[]|array{data:Mailing[],pagination:array{total:int,page:int,page_count:int,limit:int}}
|
||||
* @phpstan-return Mailing[]|array{data:Mailing[],pagination:array{total:int,page:int,page_count:int,limit:int}}
|
||||
*
|
||||
* @throws RestException
|
||||
*/
|
||||
public function index($sortfield = "t.rowid", $sortorder = 'ASC', $limit = 100, $page = 0, $sqlfilters = '', $properties = '', $pagination_data = false, $loadlinkedobjects = 0)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'read')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
|
||||
$obj_ret = array();
|
||||
|
||||
$sql = "SELECT t.rowid";
|
||||
$sql .= " FROM ".MAIN_DB_PREFIX."mailing AS t";
|
||||
$sql .= ' WHERE t.entity IN ('.getEntity('mailing').')';
|
||||
// Add sql filters
|
||||
if ($sqlfilters) {
|
||||
$errormessage = '';
|
||||
$sql .= forgeSQLFromUniversalSearchCriteria($sqlfilters, $errormessage);
|
||||
if ($errormessage) {
|
||||
throw new RestException(400, 'Error when validating parameter sqlfilters -> '.$errormessage);
|
||||
}
|
||||
}
|
||||
|
||||
//this query will return total mass mailings with the filters given
|
||||
$sqlTotals = str_replace('SELECT t.rowid', 'SELECT count(t.rowid) as total', $sql);
|
||||
|
||||
$sql .= $this->db->order($sortfield, $sortorder);
|
||||
if ($limit) {
|
||||
if ($page < 0) {
|
||||
$page = 0;
|
||||
}
|
||||
$offset = $limit * $page;
|
||||
|
||||
$sql .= $this->db->plimit($limit + 1, $offset);
|
||||
}
|
||||
|
||||
dol_syslog("API Rest request mass mailing");
|
||||
$result = $this->db->query($sql);
|
||||
|
||||
if ($result) {
|
||||
$num = $this->db->num_rows($result);
|
||||
$min = min($num, ($limit <= 0 ? $num : $limit));
|
||||
$i = 0;
|
||||
while ($i < $min) {
|
||||
$obj = $this->db->fetch_object($result);
|
||||
$mailing_static = new Mailing($this->db);
|
||||
if ($mailing_static->fetch($obj->rowid) > 0) {
|
||||
if ($loadlinkedobjects) {
|
||||
// retrieve linked objects
|
||||
$mailing_static->fetchObjectLinked();
|
||||
}
|
||||
|
||||
$obj_ret[] = $this->_filterObjectProperties($this->_cleanObjectDatas($mailing_static), $properties);
|
||||
}
|
||||
$i++;
|
||||
}
|
||||
} else {
|
||||
throw new RestException(503, 'Error when retrieve list of mass mailings : '.$this->db->lasterror());
|
||||
}
|
||||
|
||||
//if $pagination_data is true the response will contain element data with all values and element pagination with pagination data(total,page,limit)
|
||||
if ($pagination_data) {
|
||||
$totalsResult = $this->db->query($sqlTotals);
|
||||
$total = $this->db->fetch_object($totalsResult)->total;
|
||||
|
||||
$tmp = $obj_ret;
|
||||
$obj_ret = [];
|
||||
|
||||
$obj_ret['data'] = $tmp;
|
||||
$obj_ret['pagination'] = [
|
||||
'total' => (int) $total,
|
||||
'page' => $page, //count starts from 0
|
||||
'page_count' => ceil((int) $total / $limit),
|
||||
'limit' => $limit
|
||||
];
|
||||
}
|
||||
|
||||
return $obj_ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clone a mass mailing
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Id of object to clone
|
||||
* @param int $cloneContent 1=Clone content (default), 0=Forget content
|
||||
* @param int $cloneRecipients 1=Clone recipients (default), 0=Forget recipients
|
||||
* @param int $notrigger 1=Disable triggers, 0=Active triggers if any (default)
|
||||
* @return Object Object with cleaned properties
|
||||
*
|
||||
* @throws RestException 403
|
||||
* @throws RestException 404
|
||||
* @throws RestException 500 System error
|
||||
*/
|
||||
public function clone($id, $cloneContent = 1, $cloneRecipients = 1, $notrigger = 0)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'write')) {
|
||||
throw new RestException(403, "Insufficient rights");
|
||||
}
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing to clone not found, id='.$id);
|
||||
}
|
||||
|
||||
$cloningResult = $this->mailing->createFromClone(DolibarrApiAccess::$user, ((int) $id), ((int) $cloneContent), ((int) $cloneRecipients), ((int) $notrigger));
|
||||
if ($cloningResult < 0) {
|
||||
throw new RestException(500, "Error cloning mass mailing", array_merge(array($this->mailing->error), $this->mailing->errors));
|
||||
}
|
||||
|
||||
if ($cloningResult > 0) {
|
||||
return $this->get($cloningResult);
|
||||
} else {
|
||||
throw new RestException(500, $this->mailing->error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a mass mailing
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param array $request_data Request data
|
||||
* @phan-param ?array<string,string> $request_data
|
||||
* @phpstan-param ?array<string,string> $request_data
|
||||
* @return int ID of mass mailing
|
||||
*
|
||||
* @throws RestException
|
||||
*/
|
||||
public function post($request_data = null)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'write')) {
|
||||
throw new RestException(403, "Insufficiant rights");
|
||||
}
|
||||
// Check mandatory fields
|
||||
$result = $this->_validate($request_data);
|
||||
|
||||
foreach ($request_data as $field => $value) {
|
||||
if ($field === 'caller') {
|
||||
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
|
||||
$this->mailing->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->mailing->$field = $this->_checkValForAPI($field, $value, $this->mailing);
|
||||
}
|
||||
if ($this->mailing->create(DolibarrApiAccess::$user) < 0) {
|
||||
throw new RestException(500, "Error creating mass mailing", array_merge(array($this->mailing->error), $this->mailing->errors));
|
||||
}
|
||||
|
||||
return ((int) $this->mailing->id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a mass mailing general fields (won't change lines of mass mailing)
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Id of mass mailing to update
|
||||
* @param array $request_data Datas
|
||||
* @phan-param ?array<string,string> $request_data
|
||||
* @phpstan-param ?array<string,string> $request_data
|
||||
* @return Object Object with cleaned properties
|
||||
*
|
||||
* @throws RestException
|
||||
*/
|
||||
public function put($id, $request_data = null)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'write')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
foreach ($request_data as $field => $value) {
|
||||
if ($field == 'id') {
|
||||
continue;
|
||||
}
|
||||
if ($field === 'caller') {
|
||||
// Add a mention of caller so on trigger called after action, we can filter to avoid a loop if we try to sync back again with the caller
|
||||
$this->mailing->context['caller'] = sanitizeVal($request_data['caller'], 'aZ09');
|
||||
continue;
|
||||
}
|
||||
if ($field == 'array_options' && is_array($value)) {
|
||||
foreach ($value as $index => $val) {
|
||||
$this->mailing->array_options[$index] = $this->_checkValForAPI($field, $val, $this->mailing);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
$this->mailing->$field = $this->_checkValForAPI($field, $value, $this->mailing);
|
||||
}
|
||||
|
||||
if ($this->mailing->update(DolibarrApiAccess::$user) > 0) {
|
||||
return $this->get($id);
|
||||
} else {
|
||||
throw new RestException(500, $this->mailing->error);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a mass mailing
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Mass mailing ID
|
||||
* @return array
|
||||
* @phan-return array{success:array{code:int,message:string}}
|
||||
* @phpstan-return array{success:array{code:int,message:string}}
|
||||
*
|
||||
* @throws RestException 403
|
||||
* @throws RestException 404
|
||||
* @throws RestException 500 System error
|
||||
*/
|
||||
public function delete($id)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'delete')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
|
||||
if (!$this->mailing->delete(DolibarrApiAccess::$user)) {
|
||||
throw new RestException(500, 'Error when delete Mass mailing : '.$this->mailing->error);
|
||||
}
|
||||
|
||||
return array(
|
||||
'success' => array(
|
||||
'code' => 200,
|
||||
'message' => 'Mass mailing with id='.$id.' deleted'
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete targets of a mass mailing
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Mass mailing ID
|
||||
* @return array
|
||||
* @phan-return array{success:array{code:int,message:string}}
|
||||
* @phpstan-return array{success:array{code:int,message:string}}
|
||||
*
|
||||
* @url DELETE {id}/deleteTargets
|
||||
*
|
||||
* @throws RestException 403
|
||||
* @throws RestException 404
|
||||
* @throws RestException 500 System error
|
||||
*/
|
||||
public function deleteTargets($id)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'delete')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
|
||||
$count = $this->mailing->countNbOfTargets('all');
|
||||
if (!$this->mailing->delete_targets()) {
|
||||
throw new RestException(500, 'Error when delete targets of Mass mailing : '.$this->mailing->error);
|
||||
}
|
||||
|
||||
return array(
|
||||
'success' => array(
|
||||
'code' => 200,
|
||||
'message' => 'Target recipients ('.$count.') of Mass mailing with id='.$id.' deleted'
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* reset target status of a mass mailing
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Mass mailing ID
|
||||
* @return array
|
||||
* @phan-return array{success:array{code:int,message:string}}
|
||||
* @phpstan-return array{success:array{code:int,message:string}}
|
||||
*
|
||||
* @url PUT {id}/resetTargetsStatus
|
||||
*
|
||||
* @throws RestException 403
|
||||
* @throws RestException 404
|
||||
* @throws RestException 500 System error
|
||||
*/
|
||||
public function resetTargetsStatus($id)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'write')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
|
||||
$count = $this->mailing->countNbOfTargets('all');
|
||||
if (!$this->mailing->reset_targets_status(DolibarrApiAccess::$user)) {
|
||||
throw new RestException(500, 'Error when reset targets status of Mass mailing : '.$this->mailing->error);
|
||||
}
|
||||
|
||||
return array(
|
||||
'success' => array(
|
||||
'code' => 200,
|
||||
'message' => 'Resetting status of '.$count.' target recipients in Mass mailing with id='.$id
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a mass mailing to draft
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Mass mailing ID
|
||||
* @return Object Object with cleaned properties
|
||||
*
|
||||
* @url PUT {id}/settodraft
|
||||
*
|
||||
* @throws RestException 304
|
||||
* @throws RestException 403
|
||||
* @throws RestException 404
|
||||
* @throws RestException 500 System error
|
||||
*/
|
||||
public function settodraft($id)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'write')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
|
||||
$result = $this->mailing->setDraft(DolibarrApiAccess::$user);
|
||||
if ($result == 0) {
|
||||
throw new RestException(304, 'Nothing done. May be object is already draft');
|
||||
}
|
||||
if ($result < 0) {
|
||||
throw new RestException(500, 'Error : '.$this->mailing->error);
|
||||
}
|
||||
|
||||
$this->mailing->fetchObjectLinked();
|
||||
|
||||
return $this->_cleanObjectDatas($this->mailing);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Validate a mass mailing
|
||||
*
|
||||
* If you get a bad value for param notrigger check that ou provide this in body
|
||||
* {
|
||||
* "notrigger": 0
|
||||
* }
|
||||
*
|
||||
* @since 23.0.0 Initial implementation
|
||||
*
|
||||
* @param int $id Mass mailing ID
|
||||
* @return Object Object with cleaned properties
|
||||
*
|
||||
* @url PUT {id}/validate
|
||||
*
|
||||
* @throws RestException 304
|
||||
* @throws RestException 403
|
||||
* @throws RestException 404
|
||||
* @throws RestException 500 System error
|
||||
*/
|
||||
public function validate($id)
|
||||
{
|
||||
if (!DolibarrApiAccess::$user->hasRight('mailing', 'write')) {
|
||||
throw new RestException(403);
|
||||
}
|
||||
$result = $this->mailing->fetch($id);
|
||||
if ($result < 0) {
|
||||
throw new RestException(404, 'Mass mailing not found, id='.$id);
|
||||
}
|
||||
|
||||
if (!DolibarrApi::_checkAccessToResource('mailing', $this->mailing->id)) {
|
||||
throw new RestException(403, 'Access not allowed for login '.DolibarrApiAccess::$user->login);
|
||||
}
|
||||
|
||||
$result = $this->mailing->valid(DolibarrApiAccess::$user);
|
||||
if ($result == 0) {
|
||||
throw new RestException(304, 'Error nothing done. May be object is already validated');
|
||||
}
|
||||
if ($result < 0) {
|
||||
throw new RestException(500, 'Error when validating Mass mailing: '.$this->mailing->error);
|
||||
}
|
||||
|
||||
$this->mailing->fetchObjectLinked();
|
||||
|
||||
return $this->_cleanObjectDatas($this->mailing);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate fields before create or update object
|
||||
*
|
||||
* @param ?array<string,string> $data Array with data to verify
|
||||
* @return array<string,string>
|
||||
*
|
||||
* @throws RestException
|
||||
*/
|
||||
private function _validate($data)
|
||||
{
|
||||
if ($data === null) {
|
||||
$data = array();
|
||||
}
|
||||
$mailing = array();
|
||||
foreach (Mailings::$FIELDS as $field) {
|
||||
if (!isset($data[$field])) {
|
||||
throw new RestException(400, "$field field missing");
|
||||
}
|
||||
$mailing[$field] = $data[$field];
|
||||
}
|
||||
return $mailing;
|
||||
}
|
||||
|
||||
|
||||
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
|
||||
/**
|
||||
* Clean sensible object datas
|
||||
*
|
||||
* @param Object $object Object to clean
|
||||
* @return Object Object with cleaned properties
|
||||
*/
|
||||
protected function _cleanObjectDatas($object)
|
||||
{
|
||||
// phpcs:enable
|
||||
$object = parent::_cleanObjectDatas($object);
|
||||
|
||||
unset($object->actionmsg);
|
||||
unset($object->actionmsg2);
|
||||
unset($object->actiontypecode);
|
||||
unset($object->alreadypaid);
|
||||
unset($object->barcode_type_code);
|
||||
unset($object->barcode_type_coder);
|
||||
unset($object->barcode_type_label);
|
||||
unset($object->barcode_type);
|
||||
unset($object->canvas);
|
||||
unset($object->civility_code);
|
||||
unset($object->civility_id);
|
||||
unset($object->comments);
|
||||
unset($object->cond_reglement_id);
|
||||
unset($object->cond_reglement_supplier_id);
|
||||
unset($object->contact_id);
|
||||
unset($object->contact);
|
||||
unset($object->contacts_ids_internal);
|
||||
unset($object->contacts_ids);
|
||||
unset($object->context);
|
||||
unset($object->country_code);
|
||||
unset($object->country_id);
|
||||
unset($object->country);
|
||||
unset($object->db);
|
||||
unset($object->demand_reason_id);
|
||||
unset($object->deposit_percent);
|
||||
unset($object->element_for_permission);
|
||||
unset($object->element);
|
||||
unset($object->error);
|
||||
unset($object->errorhidden);
|
||||
unset($object->errors);
|
||||
unset($object->fields);
|
||||
unset($object->firstname);
|
||||
unset($object->fk_account);
|
||||
unset($object->fk_bank);
|
||||
unset($object->fk_delivery_address);
|
||||
unset($object->fk_element);
|
||||
unset($object->fk_multicurrency);
|
||||
unset($object->fk_project);
|
||||
unset($object->fk_projet);
|
||||
unset($object->import_key);
|
||||
unset($object->isextrafieldmanaged);
|
||||
unset($object->ismultientitymanaged);
|
||||
unset($object->labelStatus);
|
||||
unset($object->labelStatusShort);
|
||||
unset($object->last_main_doc);
|
||||
unset($object->lastname);
|
||||
unset($object->lines);
|
||||
unset($object->linked_objects);
|
||||
unset($object->linkedObjects);
|
||||
unset($object->linkedObjectsIds);
|
||||
unset($object->mode_reglement_id);
|
||||
unset($object->model_pdf);
|
||||
unset($object->module);
|
||||
unset($object->multicurrency_code);
|
||||
unset($object->multicurrency_total_ht);
|
||||
unset($object->multicurrency_total_localtax1);
|
||||
unset($object->multicurrency_total_localtax2);
|
||||
unset($object->multicurrency_total_ttc);
|
||||
unset($object->multicurrency_total_tva);
|
||||
unset($object->multicurrency_tx);
|
||||
unset($object->name);
|
||||
unset($object->nb);
|
||||
unset($object->nbphoto);
|
||||
unset($object->newref);
|
||||
unset($object->next_prev_filter);
|
||||
unset($object->note);
|
||||
unset($object->oldcopy);
|
||||
unset($object->oldref);
|
||||
unset($object->origin_id);
|
||||
unset($object->origin_object);
|
||||
unset($object->origin_type);
|
||||
unset($object->origin);
|
||||
unset($object->output);
|
||||
unset($object->product);
|
||||
unset($object->project);
|
||||
unset($object->ref_ext);
|
||||
unset($object->ref_next);
|
||||
unset($object->ref_previous);
|
||||
unset($object->ref);
|
||||
unset($object->region_code);
|
||||
unset($object->region_id);
|
||||
unset($object->region);
|
||||
unset($object->restrictiononfksoc);
|
||||
unset($object->retained_warranty_fk_cond_reglement);
|
||||
unset($object->sendtoid);
|
||||
unset($object->shipping_method_id);
|
||||
unset($object->shipping_method);
|
||||
unset($object->showphoto_on_popup);
|
||||
unset($object->specimen);
|
||||
unset($object->state_code);
|
||||
unset($object->state_id);
|
||||
unset($object->state);
|
||||
unset($object->table_element_line);
|
||||
unset($object->table_element);
|
||||
unset($object->thirdparty);
|
||||
unset($object->total_ht);
|
||||
unset($object->total_localtax1);
|
||||
unset($object->total_localtax2);
|
||||
unset($object->total_ttc);
|
||||
unset($object->total_tva);
|
||||
unset($object->totalpaid_multicurrency);
|
||||
unset($object->totalpaid);
|
||||
unset($object->tpl);
|
||||
unset($object->transport_mode_id);
|
||||
unset($object->user);
|
||||
unset($object->warehouse_id);
|
||||
|
||||
return $object;
|
||||
}
|
||||
}
|
||||
|
|
@ -361,15 +361,26 @@ class Mailing extends CommonObject
|
|||
*/
|
||||
public function fetch($rowid, $ref = '')
|
||||
{
|
||||
$sql = "SELECT m.rowid, m.messtype, m.titre as title, m.sujet, m.body, m.bgcolor, m.bgimage, m.evenunsubscribe";
|
||||
$sql = "SELECT m.rowid, m.messtype, m.titre as title, m.entity, m.sujet, m.body, m.bgcolor, m.bgimage, m.evenunsubscribe";
|
||||
$sql .= ", m.note_public, m.note_private";
|
||||
$sql .= ", m.email_from, m.email_replyto, m.email_errorsto";
|
||||
$sql .= ", m.statut as status, m.nbemail";
|
||||
$sql .= ", m.fk_user_creat, m.fk_user_valid";
|
||||
$sql .= ", m.tms as date_modification";
|
||||
$sql .= ", m.date_creat";
|
||||
$sql .= ", m.date_valid";
|
||||
$sql .= ", m.date_envoi";
|
||||
$sql .= ", m.extraparams";
|
||||
$sql .= ", m.tag";
|
||||
$sql .= ", m.name_from";
|
||||
$sql .= ", m.fk_user_modif";
|
||||
$sql .= ", m.fk_user_appro";
|
||||
$sql .= ", m.date_appro";
|
||||
$sql .= ", m.cible";
|
||||
$sql .= ", m.joined_file1";
|
||||
$sql .= ", m.joined_file2";
|
||||
$sql .= ", m.joined_file3";
|
||||
$sql .= ", m.joined_file4";
|
||||
$sql .= " FROM ".MAIN_DB_PREFIX."mailing as m";
|
||||
$sql .= " WHERE entity IN (".getEntity('mailing').")";
|
||||
if ($ref) {
|
||||
|
|
@ -385,6 +396,7 @@ class Mailing extends CommonObject
|
|||
$obj = $this->db->fetch_object($result);
|
||||
|
||||
$this->id = $obj->rowid;
|
||||
$this->entity = $obj->entity;
|
||||
$this->ref = $obj->rowid;
|
||||
$this->title = $obj->title;
|
||||
$this->messtype = $obj->messtype;
|
||||
|
|
@ -417,9 +429,21 @@ class Mailing extends CommonObject
|
|||
$this->date_creation = $this->db->jdate($obj->date_creat);
|
||||
$this->date_validation = $this->db->jdate($obj->date_valid);
|
||||
$this->date_envoi = $this->db->jdate($obj->date_envoi);
|
||||
$this->date_modification = $this->db->jdate($obj->date_modification); // tms
|
||||
|
||||
$this->extraparams = (array) json_decode($obj->extraparams, true);
|
||||
|
||||
$this->tag = $obj->tag;
|
||||
$this->name_from = $obj->name_from;
|
||||
$this->fk_user_modif = $obj->fk_user_modif;
|
||||
$this->fk_user_appro = $obj->fk_user_appro;
|
||||
$this->date_appro = $obj->date_appro;
|
||||
$this->cible = $obj->cible;
|
||||
$this->joined_file1 = $obj->joined_file1;
|
||||
$this->joined_file2 = $obj->joined_file2;
|
||||
$this->joined_file3 = $obj->joined_file3;
|
||||
$this->joined_file4 = $obj->joined_file4;
|
||||
|
||||
if ($this->messtype == 'sms') {
|
||||
$this->picto = 'phone';
|
||||
}
|
||||
|
|
@ -443,9 +467,10 @@ class Mailing extends CommonObject
|
|||
* @param int $fromid Id of object to clone
|
||||
* @param int $option1 1=Clone content, 0=Forget content
|
||||
* @param int $option2 1=Clone recipients
|
||||
* @param int $notrigger Disable triggers
|
||||
* @return int New id of clone
|
||||
*/
|
||||
public function createFromClone(User $user, $fromid, $option1, $option2)
|
||||
public function createFromClone(User $user, $fromid, $option1, $option2, $notrigger = 0)
|
||||
{
|
||||
global $langs;
|
||||
|
||||
|
|
@ -488,7 +513,7 @@ class Mailing extends CommonObject
|
|||
|
||||
// Create clone
|
||||
$object->context['createfromclone'] = 'createfromclone';
|
||||
$result = $object->create($user);
|
||||
$result = $object->create($user, $notrigger);
|
||||
|
||||
// Other options
|
||||
if ($result < 0) {
|
||||
|
|
@ -577,6 +602,28 @@ class Mailing extends CommonObject
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* SetDraft emailing
|
||||
*
|
||||
* @param User $user Object user that makes it draft
|
||||
* @return int Return integer <0 if KO, >0 if OK
|
||||
*/
|
||||
public function setDraft($user)
|
||||
{
|
||||
$now = dol_now();
|
||||
|
||||
$sql = "UPDATE ".MAIN_DB_PREFIX."mailing ";
|
||||
$sql .= " SET statut = 0, fk_user_modif=".$user->id;
|
||||
$sql .= " WHERE rowid = ".((int) $this->id);
|
||||
|
||||
dol_syslog("Mailing::valid", LOG_DEBUG);
|
||||
if ($this->db->query($sql)) {
|
||||
return 1;
|
||||
} else {
|
||||
$this->error = $this->db->lasterror();
|
||||
return -1;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete emailing
|
||||
|
|
@ -726,7 +773,7 @@ class Mailing extends CommonObject
|
|||
/**
|
||||
* Count number of target with status
|
||||
*
|
||||
* @param string $mode Mode ('alreadysent' = Sent success or error, 'alreadysentok' = Sent success, 'alreadysentko' = Sent error)
|
||||
* @param string $mode Mode ('alreadysent' = Sent success or error, 'alreadysentok' = Sent success, 'alreadysentko' = Sent error, 'all' = Just return all no matter status)
|
||||
* @return int Nb of target with status
|
||||
*/
|
||||
public function countNbOfTargets($mode)
|
||||
|
|
@ -739,6 +786,8 @@ class Mailing extends CommonObject
|
|||
$sql .= " AND statut > 0";
|
||||
} elseif ($mode == 'alreadysentko') {
|
||||
$sql .= " AND statut = -1";
|
||||
} elseif ($mode == 'all') {
|
||||
// just want to return all possible recipients
|
||||
} else {
|
||||
$this->error = 'BadValueForParameterMode';
|
||||
return -2;
|
||||
|
|
|
|||
|
|
@ -2107,6 +2107,9 @@ function dolGetElementUrl($objectid, $objecttype, $withpicto = 0, $option = '')
|
|||
$classpath = 'commande/class';
|
||||
$module = 'commande';
|
||||
$myobject = 'commande';
|
||||
} elseif ($objecttype == 'mailing') {
|
||||
$langs->load('mailing');
|
||||
$classpath = 'comm/mailing/class';
|
||||
} elseif ($objecttype == 'propal') {
|
||||
$langs->load('propal');
|
||||
$classpath = 'comm/propal/class';
|
||||
|
|
@ -2656,6 +2659,8 @@ function getModuleDirForApiClass($moduleobject)
|
|||
$moduledirforclass = 'comm/propal';
|
||||
} elseif ($moduleobject == 'agenda' || $moduleobject == 'agendaevents') {
|
||||
$moduledirforclass = 'comm/action';
|
||||
} elseif ($moduleobject == 'mailing') {
|
||||
$moduledirforclass = 'comm/mailing';
|
||||
} elseif ($moduleobject == 'adherent' || $moduleobject == 'members' || $moduleobject == 'memberstypes' || $moduleobject == 'subscriptions') {
|
||||
$moduledirforclass = 'adherents';
|
||||
} elseif ($moduleobject == 'don' || $moduleobject == 'donations') {
|
||||
|
|
|
|||
Loading…
Reference in a new issue