On remplace Mailjet par MailChimp
This commit is contained in:
1
local/modules/Mailchimp/.gitignore
vendored
Normal file
1
local/modules/Mailchimp/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.DS_Store
|
||||
265
local/modules/Mailchimp/Api/MailChimp.php
Normal file
265
local/modules/Mailchimp/Api/MailChimp.php
Normal file
@@ -0,0 +1,265 @@
|
||||
<?php
|
||||
|
||||
namespace Mailchimp\Api;
|
||||
|
||||
/**
|
||||
* Super-simple, minimum abstraction MailChimp API v3 wrapper
|
||||
* MailChimp API v3: http://developer.mailchimp.com
|
||||
* This wrapper: https://github.com/drewm/mailchimp-api
|
||||
*
|
||||
* @author Drew McLellan <drew.mclellan@gmail.com>
|
||||
* @version 2.1
|
||||
*/
|
||||
class MailChimp
|
||||
{
|
||||
private $api_key;
|
||||
private $api_endpoint = 'https://<dc>.api.mailchimp.com/3.0';
|
||||
|
||||
/* SSL Verification
|
||||
Read before disabling:
|
||||
http://snippets.webaware.com.au/howto/stop-turning-off-curlopt_ssl_verifypeer-and-fix-your-php-config/
|
||||
*/
|
||||
public $verify_ssl = true;
|
||||
|
||||
private $last_error = '';
|
||||
private $last_response = array();
|
||||
private $last_request = array();
|
||||
|
||||
/**
|
||||
* Create a new instance
|
||||
* @param string $api_key Your MailChimp API key
|
||||
*/
|
||||
public function __construct($api_key)
|
||||
{
|
||||
$this->api_key = $api_key;
|
||||
|
||||
list(, $datacentre) = explode('-', $this->api_key);
|
||||
$this->api_endpoint = str_replace('<dc>', $datacentre, $this->api_endpoint);
|
||||
|
||||
$this->last_response = array('headers'=>null, 'body'=>null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new instance of a Batch request. Optionally with the ID of an existing batch.
|
||||
* @param string $batch_id Optional ID of an existing batch, if you need to check its status for example.
|
||||
* @return Batch New Batch object.
|
||||
*/
|
||||
public function new_batch($batch_id=null)
|
||||
{
|
||||
return new Batch($this, $batch_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an email address into a 'subscriber hash' for identifying the subscriber in a method URL
|
||||
* @param string $email The subscriber's email address
|
||||
* @return string Hashed version of the input
|
||||
*/
|
||||
public function subscriberHash($email)
|
||||
{
|
||||
return md5(strtolower($email));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the last error returned by either the network transport, or by the API.
|
||||
* If something didn't work, this should contain the string describing the problem.
|
||||
* @return array|false describing the error
|
||||
*/
|
||||
public function getLastError()
|
||||
{
|
||||
if ($this->last_error) return $this->last_error;
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array containing the HTTP headers and the body of the API response.
|
||||
* @return array Assoc array with keys 'headers' and 'body'
|
||||
*/
|
||||
public function getLastResponse()
|
||||
{
|
||||
return $this->last_response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array containing the HTTP headers and the body of the API request.
|
||||
* @return array Assoc array
|
||||
*/
|
||||
public function getLastRequest()
|
||||
{
|
||||
return $this->last_request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an HTTP DELETE request - for deleting data
|
||||
* @param string $method URL of the API request method
|
||||
* @param array $args Assoc array of arguments (if any)
|
||||
* @param int $timeout Timeout limit for request in seconds
|
||||
* @return array|false Assoc array of API response, decoded from JSON
|
||||
*/
|
||||
public function delete($method, $args=array(), $timeout=10)
|
||||
{
|
||||
return $this->makeRequest('delete', $method, $args, $timeout);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an HTTP GET request - for retrieving data
|
||||
* @param string $method URL of the API request method
|
||||
* @param array $args Assoc array of arguments (usually your data)
|
||||
* @param int $timeout Timeout limit for request in seconds
|
||||
* @return array|false Assoc array of API response, decoded from JSON
|
||||
*/
|
||||
public function get($method, $args=array(), $timeout=10)
|
||||
{
|
||||
return $this->makeRequest('get', $method, $args, $timeout);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an HTTP PATCH request - for performing partial updates
|
||||
* @param string $method URL of the API request method
|
||||
* @param array $args Assoc array of arguments (usually your data)
|
||||
* @param int $timeout Timeout limit for request in seconds
|
||||
* @return array|false Assoc array of API response, decoded from JSON
|
||||
*/
|
||||
public function patch($method, $args=array(), $timeout=10)
|
||||
{
|
||||
return $this->makeRequest('patch', $method, $args, $timeout);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an HTTP POST request - for creating and updating items
|
||||
* @param string $method URL of the API request method
|
||||
* @param array $args Assoc array of arguments (usually your data)
|
||||
* @param int $timeout Timeout limit for request in seconds
|
||||
* @return array|false Assoc array of API response, decoded from JSON
|
||||
*/
|
||||
public function post($method, $args=array(), $timeout=10)
|
||||
{
|
||||
return $this->makeRequest('post', $method, $args, $timeout);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an HTTP PUT request - for creating new items
|
||||
* @param string $method URL of the API request method
|
||||
* @param array $args Assoc array of arguments (usually your data)
|
||||
* @param int $timeout Timeout limit for request in seconds
|
||||
* @return array|false Assoc array of API response, decoded from JSON
|
||||
*/
|
||||
public function put($method, $args=array(), $timeout=10)
|
||||
{
|
||||
return $this->makeRequest('put', $method, $args, $timeout);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs the underlying HTTP request. Not very exciting.
|
||||
* @param string $http_verb The HTTP verb to use: get, post, put, patch, delete
|
||||
* @param string $method The API method to be called
|
||||
* @param array $args Assoc array of parameters to be passed
|
||||
* @return array|false Assoc array of decoded result
|
||||
*/
|
||||
private function makeRequest($http_verb, $method, $args=array(), $timeout=10)
|
||||
{
|
||||
if (!function_exists('curl_init') || !function_exists('curl_setopt')) {
|
||||
throw new \Exception("cURL support is required, but can't be found.");
|
||||
}
|
||||
|
||||
$url = $this->api_endpoint.'/'.$method;
|
||||
|
||||
$this->last_error = '';
|
||||
$response = array('headers'=>null, 'body'=>null);
|
||||
$this->last_response = $response;
|
||||
|
||||
$this->last_request = array(
|
||||
'method' => $http_verb,
|
||||
'path' => $method,
|
||||
'url' => $url,
|
||||
'body' => '',
|
||||
'timeout'=> $timeout,
|
||||
);
|
||||
|
||||
$ch = curl_init();
|
||||
curl_setopt($ch, CURLOPT_URL, $url);
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Accept: application/vnd.api+json',
|
||||
'Content-Type: application/vnd.api+json',
|
||||
'Authorization: apikey '.$this->api_key));
|
||||
curl_setopt($ch, CURLOPT_USERAGENT, 'DrewM/MailChimp-API/3.0 (github.com/drewm/mailchimp-api)');
|
||||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
|
||||
curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
|
||||
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->verify_ssl);
|
||||
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
|
||||
curl_setopt($ch, CURLOPT_ENCODING, '');
|
||||
curl_setopt($ch, CURLINFO_HEADER_OUT, true);
|
||||
|
||||
switch($http_verb) {
|
||||
case 'post':
|
||||
curl_setopt($ch, CURLOPT_POST, true);
|
||||
$this->attachRequestPayload($ch, $args);
|
||||
break;
|
||||
|
||||
case 'get':
|
||||
$query = http_build_query($args);
|
||||
curl_setopt($ch, CURLOPT_URL, $url.'?'.$query);
|
||||
break;
|
||||
|
||||
case 'delete':
|
||||
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
|
||||
break;
|
||||
|
||||
case 'patch':
|
||||
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
|
||||
$this->attachRequestPayload($ch, $args);
|
||||
break;
|
||||
|
||||
case 'put':
|
||||
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
|
||||
$this->attachRequestPayload($ch, $args);
|
||||
break;
|
||||
}
|
||||
|
||||
$response['body'] = curl_exec($ch);
|
||||
$response['headers'] = curl_getinfo($ch);
|
||||
|
||||
$this->last_request['headers'] = $response['headers']['request_header'];
|
||||
|
||||
if ($response['body'] === false) {
|
||||
$this->last_error = curl_error($ch);
|
||||
}
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
return $this->formatResponse($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode the data and attach it to the request
|
||||
* @param resource $ch cURL session handle, used by reference
|
||||
* @param array $data Assoc array of data to attach
|
||||
*/
|
||||
private function attachRequestPayload(&$ch, $data)
|
||||
{
|
||||
$encoded = json_encode($data);
|
||||
$this->last_request['body'] = $encoded;
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS, $encoded);
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode the response and format any error messages for debugging
|
||||
* @param array $response The response from the curl request
|
||||
* @return array|false The JSON decoded into an array
|
||||
*/
|
||||
private function formatResponse($response)
|
||||
{
|
||||
$this->last_response = $response;
|
||||
|
||||
if (!empty($response['body'])) {
|
||||
|
||||
$d = json_decode($response['body'], true);
|
||||
|
||||
if (isset($d['status']) && $d['status']!='200' && isset($d['detail'])) {
|
||||
$this->last_error = sprintf('%d: %s', $d['status'], $d['detail']);
|
||||
}
|
||||
|
||||
return $d;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -5,20 +5,14 @@
|
||||
xsi:schemaLocation="http://thelia.net/schema/dic/config http://thelia.net/schema/dic/config/thelia-1.0.xsd">
|
||||
|
||||
<forms>
|
||||
<form name="mailjet.configuration" class="Mailjet\Form\MailjetConfigurationForm" />
|
||||
<form name="mailchimp.configuration" class="Mailchimp\Form\MailchimpConfigurationForm" />
|
||||
</forms>
|
||||
|
||||
<services>
|
||||
<service id="action.mailjet.newsletter" class="Mailjet\EventListeners\NewsletterListener">
|
||||
<service id="action.mailchimp.newsletter" class="Mailchimp\EventListeners\NewsletterListener">
|
||||
<argument type="service" id="thelia.translator" />
|
||||
|
||||
<tag name="kernel.event_subscriber" />
|
||||
</service>
|
||||
</services>
|
||||
|
||||
<hooks>
|
||||
<hook id="mailjet.configuration.hook" class="Mailjet\Hook\HookManager" scope="request">
|
||||
<tag name="hook.event_listener" event="module.configuration" type="back" method="onModuleConfiguration" />
|
||||
</hook>
|
||||
</hooks>
|
||||
</config>
|
||||
27
local/modules/Mailchimp/Config/module.xml
Normal file
27
local/modules/Mailchimp/Config/module.xml
Normal file
@@ -0,0 +1,27 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module xmlns="http://thelia.net/schema/dic/module"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://thelia.net/schema/dic/module http://thelia.net/schema/dic/module/module-2_1.xsd">
|
||||
<fullnamespace>Mailchimp\Mailchimp</fullnamespace>
|
||||
<descriptive locale="en_US">
|
||||
<title>Mailchimp</title>
|
||||
<description>Thelia 2 plugin to add newsletter subscribers email to a Mailchimp diffusion list</description>
|
||||
</descriptive>
|
||||
<descriptive locale="fr_FR">
|
||||
<title>Mailchimp</title>
|
||||
<description>Thelia 2 plugin pour ajouter les emails abonnés à la newsletter à une liste de diffusion Mailchimp</description>
|
||||
</descriptive>
|
||||
|
||||
<languages>
|
||||
<language>en_US</language>
|
||||
<language>fr_FR</language>
|
||||
</languages>
|
||||
<version>1.0</version>
|
||||
<author>
|
||||
<name>Loïc Berthelot</name>
|
||||
<email>loic.berthelot@blumug.com</email>
|
||||
</author>
|
||||
<type>classic</type>
|
||||
<thelia>2.0.0</thelia>
|
||||
<stability>beta</stability>
|
||||
</module>
|
||||
15
local/modules/Mailchimp/Config/routing.xml
Normal file
15
local/modules/Mailchimp/Config/routing.xml
Normal file
@@ -0,0 +1,15 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<routes xmlns="http://symfony.com/schema/routing"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">
|
||||
<!-- Thelia 2.0 backward compatibility -->
|
||||
|
||||
<route id="mailchimp.show" path="/admin/module/Mailchimp" methods="get">
|
||||
<default key="_controller">Mailchimp\Controller\MailchimpConfigController::showAction</default>
|
||||
</route>
|
||||
|
||||
<route id="mailchimp.save" path="/admin/module/Mailchimp" methods="post">
|
||||
<default key="_controller">Mailchimp\Controller\MailchimpConfigController::saveAction</default>
|
||||
</route>
|
||||
</routes>
|
||||
@@ -10,41 +10,40 @@
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailjet\Controller;
|
||||
namespace Mailchimp\Controller;
|
||||
|
||||
use Mailjet\Form\MailjetConfigurationForm;
|
||||
use Mailjet\Mailjet;
|
||||
use Mailchimp\Form\MailchimpConfigurationForm;
|
||||
use Mailchimp\Mailchimp;
|
||||
use Symfony\Component\HttpFoundation\RedirectResponse;
|
||||
use Thelia\Controller\Admin\BaseAdminController;
|
||||
use Thelia\Model\ConfigQuery;
|
||||
use Thelia\Tools\URL;
|
||||
|
||||
/**
|
||||
* Class MailjetConfigController
|
||||
* @package Mailjet\Controller
|
||||
* @author Benjamin Perche <bperche@openstudio.com>
|
||||
* Class MailchimpConfigController
|
||||
* @package Mailchimp\Controller
|
||||
* @author Loïc Berthelot <loic.berthelot@blumug.com>
|
||||
*/
|
||||
class MailjetConfigController extends BaseAdminController
|
||||
class MailchimpConfigController extends BaseAdminController
|
||||
{
|
||||
public function showAction()
|
||||
{
|
||||
return $this->render("mailchimp-configuration");
|
||||
}
|
||||
|
||||
public function saveAction()
|
||||
{
|
||||
$baseForm = new MailjetConfigurationForm($this->getRequest());
|
||||
$baseForm = new MailchimpConfigurationForm($this->getRequest());
|
||||
|
||||
try {
|
||||
$form = $this->validateForm($baseForm);
|
||||
$data = $form->getData();
|
||||
|
||||
ConfigQuery::write(Mailjet::CONFIG_API_KEY, $data["api_key"]);
|
||||
ConfigQuery::write(Mailjet::CONFIG_API_SECRET, $data["api_secret"]);
|
||||
ConfigQuery::write(Mailjet::CONFIG_API_WS_ADDRESS, $data["ws_address"]);
|
||||
ConfigQuery::write(Mailjet::CONFIG_NEWSLETTER_LIST, $data["newsletter_list"]);
|
||||
ConfigQuery::write(Mailjet::CONFIG_THROW_EXCEPTION_ON_ERROR, $data["exception_on_errors"] ? true : false);
|
||||
ConfigQuery::write(Mailchimp::CONFIG_NEWSLETTER_LIST_ID, $data["newsletter_list_id"]);
|
||||
ConfigQuery::write(Mailchimp::CONFIG_API_KEY, $data["api_key"]);
|
||||
ConfigQuery::write(Mailchimp::CONFIG_API_URL, $data["api_url"]);
|
||||
|
||||
$this->getParserContext()->set("success", true);
|
||||
|
||||
if ("close" === $this->getRequest()->request->get("save_mode")) {
|
||||
return new RedirectResponse(URL::getInstance()->absoluteUrl("/admin/modules"));
|
||||
}
|
||||
} catch (\Exception $e) {
|
||||
$this->getParserContext()
|
||||
->setGeneralError($e->getMessage())
|
||||
@@ -52,6 +51,10 @@ class MailjetConfigController extends BaseAdminController
|
||||
;
|
||||
}
|
||||
|
||||
return $this->render('module-configure', [ 'module_code' => 'Mailjet' ]);
|
||||
if ("close" === $this->getRequest()->request->get("save_mode")) {
|
||||
return new RedirectResponse(URL::getInstance()->absoluteUrl("/admin/modules"));
|
||||
}
|
||||
|
||||
return $this->showAction();
|
||||
}
|
||||
}
|
||||
143
local/modules/Mailchimp/EventListeners/NewsletterListener.php
Normal file
143
local/modules/Mailchimp/EventListeners/NewsletterListener.php
Normal file
@@ -0,0 +1,143 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailchimp\EventListeners;
|
||||
|
||||
use Mailchimp\Api\MailChimp;
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\Translation\TranslatorInterface;
|
||||
use Thelia\Core\Event\TheliaEvents;
|
||||
use Thelia\Core\Event\Newsletter\NewsletterEvent;
|
||||
use Mailchimp\Mailchimp as MailchimpModule;
|
||||
use Thelia\Log\Tlog;
|
||||
use Thelia\Model\ConfigQuery;
|
||||
use Thelia\Model\NewsletterQuery;
|
||||
|
||||
/**
|
||||
* Class NewsletterListener
|
||||
* @package Mailchimp\EventListeners
|
||||
* @author Loïc Berthelot <loic.berthelot@blumug.com>
|
||||
*/
|
||||
class NewsletterListener implements EventSubscriberInterface
|
||||
{
|
||||
/**
|
||||
* @var TranslatorInterface
|
||||
*/
|
||||
protected $translator;
|
||||
|
||||
/**
|
||||
* @var MailChimp
|
||||
*/
|
||||
protected $api;
|
||||
|
||||
public function __construct(TranslatorInterface $translator)
|
||||
{
|
||||
$this->translator = $translator;
|
||||
|
||||
$this->api = new MailChimp(ConfigQuery::read(MailchimpModule::CONFIG_API_KEY));
|
||||
}
|
||||
|
||||
public function subscribe(NewsletterEvent $event)
|
||||
{
|
||||
$list_id = ConfigQuery::read(MailchimpModule::CONFIG_NEWSLETTER_LIST_ID);
|
||||
$email = $event->getEmail();
|
||||
|
||||
$result = $this->api->post("lists/$list_id/members", [
|
||||
'email_address' => $email,
|
||||
'status' => 'subscribed',
|
||||
]);
|
||||
|
||||
TLog::getInstance()->addDebug("Mailchimp subscribe result ".json_encode($result));
|
||||
|
||||
$status = $result["status"];
|
||||
|
||||
if (!strcmp($status, "subscribed")) {
|
||||
$status = 200;
|
||||
}
|
||||
|
||||
$errorMessage = "An error occurred during the newsletter registration process";
|
||||
if ($status >= 300) {
|
||||
|
||||
$title = $result["title"];
|
||||
TLog::getInstance()->addError("Mailchimp subscribe error ".$status." : ".$title);
|
||||
|
||||
if (!strcmp($title, "Member Exists")) {
|
||||
|
||||
$errorMessage = "Your email address has already been registered.";
|
||||
}
|
||||
else {
|
||||
TLog::getInstance()->addError("Mailchimp subscribe getLastError ".$this->api->getLastError());
|
||||
$string = json_encode($this->api->getLastResponse());
|
||||
TLog::getInstance()->addDebug("Mailchimp subscribe getLastResponse ". $string);
|
||||
$string = json_encode($this->api->getLastRequest());
|
||||
TLog::getInstance()->addDebug("Mailchimp subscribe getLastRequest ". $string);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
$this->logAfterAction(
|
||||
|
||||
$this->translator->trans(
|
||||
"You have successfully registered to the newsletter",
|
||||
[],
|
||||
MailchimpModule::MESSAGE_DOMAIN
|
||||
),
|
||||
|
||||
$this->translator->trans(
|
||||
$errorMessage,
|
||||
[],
|
||||
MailchimpModule::MESSAGE_DOMAIN
|
||||
),
|
||||
|
||||
$status
|
||||
);
|
||||
|
||||
|
||||
}
|
||||
|
||||
protected function logAfterAction($successMessage, $errorMessage, $status)
|
||||
{
|
||||
if ($status >= 200 && $status < 300) {
|
||||
Tlog::getInstance()->info($successMessage);
|
||||
} else {
|
||||
Tlog::getInstance()->error(sprintf("%s. Status code: %d", $errorMessage, $status));
|
||||
throw new \InvalidArgumentException($errorMessage);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of event names this subscriber wants to listen to.
|
||||
*
|
||||
* The array keys are event names and the value can be:
|
||||
*
|
||||
* * The method name to call (priority defaults to 0)
|
||||
* * An array composed of the method name to call and the priority
|
||||
* * An array of arrays composed of the method names to call and respective
|
||||
* priorities, or 0 if unset
|
||||
*
|
||||
* For instance:
|
||||
*
|
||||
* * array('eventName' => 'methodName')
|
||||
* * array('eventName' => array('methodName', $priority))
|
||||
* * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
|
||||
*
|
||||
* @return array The event names to listen to
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
public static function getSubscribedEvents()
|
||||
{
|
||||
return array(
|
||||
TheliaEvents::NEWSLETTER_SUBSCRIBE => array("subscribe", 192)
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -10,20 +10,20 @@
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailjet\Form;
|
||||
namespace Mailchimp\Form;
|
||||
|
||||
use Mailjet\Mailjet;
|
||||
use Mailchimp\Mailchimp;
|
||||
use Symfony\Component\Validator\Constraints\NotBlank;
|
||||
use Thelia\Core\Translation\Translator;
|
||||
use Thelia\Form\BaseForm;
|
||||
use Thelia\Model\ConfigQuery;
|
||||
|
||||
/**
|
||||
* Class MailjetConfigurationForm
|
||||
* @package Mailjet\Form
|
||||
* @author Benjamin Perche <bperche@openstudio.com>
|
||||
* Class MailchimpConfigurationForm
|
||||
* @package Mailchimp\Form
|
||||
* @author Loïc Berthelot <loic.berthelot@blumug.com>
|
||||
*/
|
||||
class MailjetConfigurationForm extends BaseForm
|
||||
class MailchimpConfigurationForm extends BaseForm
|
||||
{
|
||||
/**
|
||||
*
|
||||
@@ -50,59 +50,32 @@ class MailjetConfigurationForm extends BaseForm
|
||||
$translator = Translator::getInstance();
|
||||
|
||||
$this->formBuilder
|
||||
->add("newsletter_list_id", "text", array(
|
||||
"label" => $translator->trans("Newsletter list ID", [], Mailchimp::MESSAGE_DOMAIN),
|
||||
"label_attr" => ["for" => "newsletter_list_id"],
|
||||
"required" => true,
|
||||
"constraints" => array(
|
||||
new NotBlank(),
|
||||
),
|
||||
"data" => ConfigQuery::read(Mailchimp::CONFIG_NEWSLETTER_LIST_ID)
|
||||
))
|
||||
->add("api_key", "text", array(
|
||||
"label" => $translator->trans("Api key", [], Mailjet::MESSAGE_DOMAIN),
|
||||
"label" => $translator->trans("Api key", [], Mailchimp::MESSAGE_DOMAIN),
|
||||
"label_attr" => ["for" => "api_key"],
|
||||
"required" => true,
|
||||
"constraints" => array(
|
||||
new NotBlank(),
|
||||
),
|
||||
"data" => ConfigQuery::read(Mailjet::CONFIG_API_KEY)
|
||||
"data" => ConfigQuery::read(Mailchimp::CONFIG_API_KEY)
|
||||
))
|
||||
->add("api_secret", "text", array(
|
||||
"label" => $translator->trans("Api secret", [], Mailjet::MESSAGE_DOMAIN),
|
||||
"label_attr" => ["for" => "api_secret"],
|
||||
->add("api_url", "text", array(
|
||||
"label" => $translator->trans("Api URL", [], Mailchimp::MESSAGE_DOMAIN),
|
||||
"label_attr" => ["for" => "api_url"],
|
||||
"required" => true,
|
||||
"constraints" => array(
|
||||
new NotBlank(),
|
||||
),
|
||||
"data" => ConfigQuery::read(Mailjet::CONFIG_API_SECRET)
|
||||
))
|
||||
->add("newsletter_list", "text", array(
|
||||
"label" => $translator->trans("Newsletter list address name", [], Mailjet::MESSAGE_DOMAIN),
|
||||
"required" => true,
|
||||
"constraints" => array(
|
||||
new NotBlank(),
|
||||
),
|
||||
"data" => ConfigQuery::read(Mailjet::CONFIG_NEWSLETTER_LIST),
|
||||
'label_attr' => [
|
||||
'help' => $translator->trans(
|
||||
"This value is the name of your list mail address (example: the 'xxxxxx' of xxxxxx@lists.mailjet.com)",
|
||||
[],
|
||||
Mailjet::MESSAGE_DOMAIN
|
||||
)
|
||||
]
|
||||
))
|
||||
->add("ws_address", "text", array(
|
||||
"label" => $translator->trans("Webservice address", [], Mailjet::MESSAGE_DOMAIN),
|
||||
"label_attr" => ["for" => "ws_address"],
|
||||
"required" => true,
|
||||
"constraints" => array(
|
||||
new NotBlank(),
|
||||
),
|
||||
"data" => ConfigQuery::read(Mailjet::CONFIG_API_WS_ADDRESS)
|
||||
))
|
||||
->add("exception_on_errors", "checkbox", array(
|
||||
"label" => $translator->trans("Throw exception on Mailjet error", [], Mailjet::MESSAGE_DOMAIN),
|
||||
"data" => ConfigQuery::read(Mailjet::CONFIG_THROW_EXCEPTION_ON_ERROR, false) ? true : false,
|
||||
'required' => false,
|
||||
"label_attr" => [
|
||||
'help' => $translator->trans(
|
||||
"The module will throw an error if something wrong happens whan talking to MailJet. Warning ! This could prevent user registration if Mailjet server is down or unreachable !",
|
||||
[],
|
||||
Mailjet::MESSAGE_DOMAIN
|
||||
)
|
||||
]
|
||||
"data" => ConfigQuery::read(Mailchimp::CONFIG_API_URL)
|
||||
))
|
||||
;
|
||||
}
|
||||
@@ -112,6 +85,6 @@ class MailjetConfigurationForm extends BaseForm
|
||||
*/
|
||||
public function getName()
|
||||
{
|
||||
return "mailjet_configuration";
|
||||
return "mailchimp_configuration";
|
||||
}
|
||||
}
|
||||
4
local/modules/Mailchimp/I18n/en_US.php
Normal file
4
local/modules/Mailchimp/I18n/en_US.php
Normal file
@@ -0,0 +1,4 @@
|
||||
<?php
|
||||
return array(
|
||||
// 'an english string' => 'The displayed english string',
|
||||
);
|
||||
7
local/modules/Mailchimp/I18n/fr_FR.php
Normal file
7
local/modules/Mailchimp/I18n/fr_FR.php
Normal file
@@ -0,0 +1,7 @@
|
||||
<?php
|
||||
return array(
|
||||
'You have successfully registered to the newsletter' => 'Votre abonnement à la newsletter a bien été enregistré.',
|
||||
'An error occurred during the newsletter registration process' => 'Une erreur est survenue, votre abonnement à la newsletter n\'a pas pu être enregistré.',
|
||||
'Your email address has already been registered.' => 'Vous êtes déjà abonné à la newsletter.',
|
||||
'Thanks for signing up! We\'ll keep you posted whenever we have any new updates.' => 'Merci de votre inscription ! Nous vous tiendrons informé dès qu\'il y aura des nouveautés.'
|
||||
);
|
||||
85
local/modules/Mailchimp/Mailchimp.php
Normal file
85
local/modules/Mailchimp/Mailchimp.php
Normal file
@@ -0,0 +1,85 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailchimp;
|
||||
|
||||
use Propel\Runtime\Connection\ConnectionInterface;
|
||||
use Thelia\Install\Database;
|
||||
use Thelia\Model\Config;
|
||||
use Thelia\Model\ConfigQuery;
|
||||
use Thelia\Module\BaseModule;
|
||||
|
||||
/**
|
||||
* Class Mailchimp
|
||||
* @package Mailchimp
|
||||
* @author Loïc Berthelot <loic.berthelot@blumug.com>
|
||||
*/
|
||||
class Mailchimp extends BaseModule
|
||||
{
|
||||
const MESSAGE_DOMAIN = "mailchimp";
|
||||
|
||||
const CONFIG_NEWSLETTER_LIST_ID = "mailchimp.newsletter_list_id";
|
||||
const CONFIG_API_KEY = "mailchimp.api.key";
|
||||
const CONFIG_API_URL = "mailchimp.api.url";
|
||||
|
||||
public function postActivation(ConnectionInterface $con = null)
|
||||
{
|
||||
$con->beginTransaction();
|
||||
|
||||
try {
|
||||
|
||||
if (null === ConfigQuery::read(static::CONFIG_NEWSLETTER_LIST_ID)) {
|
||||
$this->createConfigValue(static::CONFIG_NEWSLETTER_LIST_ID, [
|
||||
"fr_FR" => "ID de votre liste de diffusion Mailchimp",
|
||||
"en_US" => "Mailchimp diffusion list ID",
|
||||
]);
|
||||
}
|
||||
|
||||
if (null === ConfigQuery::read(static::CONFIG_API_KEY)) {
|
||||
$this->createConfigValue(static::CONFIG_API_KEY, [
|
||||
"fr_FR" => "Clé d'API pour Mailchimp",
|
||||
"en_US" => "Api key for Mailchimp",
|
||||
]);
|
||||
}
|
||||
|
||||
if (null === ConfigQuery::read(static::CONFIG_API_URL)) {
|
||||
$this->createConfigValue(static::CONFIG_API_URL, [
|
||||
"fr_FR" => "URL de l'API Mailchimp",
|
||||
"en_US" => "Mailchimp API URL",
|
||||
]);
|
||||
}
|
||||
|
||||
$con->commit();
|
||||
} catch (\Exception $e) {
|
||||
$con->rollBack();
|
||||
|
||||
throw $e;
|
||||
}
|
||||
}
|
||||
|
||||
protected function createConfigValue($name, array $translation, $value = '')
|
||||
{
|
||||
$config = new Config();
|
||||
$config
|
||||
->setName($name)
|
||||
->setValue($value)
|
||||
;
|
||||
|
||||
foreach ($translation as $locale => $title) {
|
||||
$config->getTranslation($locale)
|
||||
->setTitle($title)
|
||||
;
|
||||
}
|
||||
|
||||
$config->save();
|
||||
}
|
||||
}
|
||||
15
local/modules/Mailchimp/README.md
Normal file
15
local/modules/Mailchimp/README.md
Normal file
@@ -0,0 +1,15 @@
|
||||
Mailchimp for Thelia
|
||||
===
|
||||
author: Loïc Berthelot <loic.berthelot@blumug.com>
|
||||
|
||||
A minimalist Thelia 2 plugin to redirect newsletter subscriptions to a Mailchimp account.
|
||||
Based on the APIv3 Documentation of MailChimp.
|
||||
|
||||
Prerequisites:
|
||||
|
||||
You must have a Mailchimp account and have created a mailing list.
|
||||
Get your mailing list ID from your Mailchimp mailing list settings.
|
||||
|
||||
Once the module is installed, configure your mailist list ID, Api Key et Api URL from the module configuration form.
|
||||
|
||||
The API url should be something like "https://XXXX.api.mailchimp.com/3.0/lists/newsletter/members", where "XXXX" is the last part of your API key, as mentioned in the Mailchimp API documentation.
|
||||
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"name": "thelia/mailjet-module",
|
||||
"name": "thelia/mailchimp-module",
|
||||
"license": "LGPL-3.0+",
|
||||
"type": "thelia-module",
|
||||
"require": {
|
||||
"thelia/installer": "~1.1"
|
||||
},
|
||||
"extra": {
|
||||
"installer-name": "Mailjet"
|
||||
"installer-name": "Mailchimp"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,109 @@
|
||||
{extends file="admin-layout.tpl"}
|
||||
|
||||
{block name="no-return-functions"}
|
||||
{$admin_current_location = 'modules'}
|
||||
{/block}
|
||||
|
||||
{block name="page-title"}{intl d="mailchimp.bo.default" l='Mailchimp configuration'}{/block}
|
||||
|
||||
{block name="check-resource"}admin.module{/block}
|
||||
{block name="check-access"}view{/block}
|
||||
{block name="check-module"}Mailchimp{/block}
|
||||
|
||||
{block name="main-content"}
|
||||
<div class="container" id="wrapper">
|
||||
<ul class="breadcrumb">
|
||||
<li><a href="{url path='/admin'}">{intl l="Home" d="mailchimp.bo.default"}</a></li>
|
||||
<li><a href="{url path='/admin/modules'}">{intl l="Modules" d="mailchimp.bo.default"}</a></li>
|
||||
<li>{intl l="Mailchimp configuration" d="mailchimp.bo.default"}</li>
|
||||
</ul>
|
||||
|
||||
<div class="general-block-decorator">
|
||||
<div class="title title-without-tabs">
|
||||
{intl l="Configure Mailchimp"}
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
{if $success}
|
||||
<div class="alert alert-success">
|
||||
{intl l="Configuration correctly saved" d="mailchimp.bo.default"}
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
{form name="mailchimp.configuration"}
|
||||
<form action="{$current_url}" method="post">
|
||||
{include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'}}
|
||||
<br/>
|
||||
|
||||
{form_field form=$form field="success_url"}
|
||||
<input type="hidden" name="{$name}" value="{url path='/admin/modules'}" />
|
||||
{/form_field}
|
||||
|
||||
{form_hidden_fields form=$form}
|
||||
|
||||
{form_field form=$form field="newsletter_list_id"}
|
||||
<div class="form-group {if $error}has-error{/if}">
|
||||
<div class="row">
|
||||
<div class="col-md-3">
|
||||
<label for="{$label_attr.for}">
|
||||
{$label}
|
||||
</label>
|
||||
</div>
|
||||
<div class="col-md-9">
|
||||
{if $error}<span class="help-block">{$message}</span>{/if}
|
||||
<input type="text" class="form-control" id="{$label_attr.for}" name="{$name}" value="{$value}" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{/form_field}
|
||||
|
||||
{form_field form=$form field="api_key"}
|
||||
<div class="form-group {if $error}has-error{/if}">
|
||||
<div class="row">
|
||||
<div class="col-md-3">
|
||||
<label for="{$label_attr.for}">
|
||||
{$label}
|
||||
</label>
|
||||
</div>
|
||||
<div class="col-md-9">
|
||||
{if $error}<span class="help-block">{$message}</span>{/if}
|
||||
<input type="text" class="form-control" id="{$label_attr.for}" name="{$name}" value="{$value}" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{/form_field}
|
||||
|
||||
{form_field form=$form field="api_url"}
|
||||
<div class="form-group {if $error}has-error{/if}">
|
||||
<div class="row">
|
||||
<div class="col-md-3">
|
||||
<label for="{$label_attr.for}">
|
||||
{$label}
|
||||
</label>
|
||||
</div>
|
||||
<div class="col-md-9">
|
||||
{if $error}<span class="help-block">{$message}</span>{/if}
|
||||
<input type="text" class="form-control" id="{$label_attr.for}" name="{$name}" value="{$value}" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{/form_field}
|
||||
|
||||
{include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'} page_bottom = 1}
|
||||
</form>
|
||||
{/form}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{/block}
|
||||
|
||||
{block name="javascript-initialization"}
|
||||
<script>
|
||||
$(function()
|
||||
{
|
||||
$(".tooltip-link").tooltip();
|
||||
});
|
||||
</script>
|
||||
{/block}
|
||||
@@ -1,138 +0,0 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailjet\Api;
|
||||
|
||||
/**
|
||||
* Class MailjetClient
|
||||
* @package Mailjet\Api
|
||||
* @author Benjamin Perche <bperche@openstudio.com>
|
||||
*/
|
||||
class MailjetClient
|
||||
{
|
||||
const RESOURCE_CONTACT = "contact";
|
||||
const RESOURCE_LIST_RECIPIENT = "listrecipient";
|
||||
|
||||
/**
|
||||
* @var resource
|
||||
*/
|
||||
protected $curlHandler;
|
||||
|
||||
protected $auth;
|
||||
protected $wsAddress;
|
||||
|
||||
public function __construct($apiKey, $apiSecret, $wsAddress)
|
||||
{
|
||||
$this->wsAddress = $wsAddress;
|
||||
$this->auth = sprintf("%s:%s", $apiKey, $apiSecret);
|
||||
}
|
||||
|
||||
protected function initilize($address)
|
||||
{
|
||||
/**
|
||||
* Initialize connection
|
||||
*/
|
||||
$this->curlHandler = curl_init($address);
|
||||
curl_setopt_array($this->curlHandler, [
|
||||
CURLOPT_USERPWD => $this->auth,
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
]);
|
||||
}
|
||||
|
||||
public function get($resource, $id = null, array $params = array())
|
||||
{
|
||||
$address = $this->lazyBuildAddress($resource, $id, $params);
|
||||
|
||||
$this->initilize($address);
|
||||
return $this->getResponse();
|
||||
}
|
||||
|
||||
public function post($resource, array $params = array())
|
||||
{
|
||||
$address = $this->lazyBuildAddress($resource, null, []);
|
||||
|
||||
$this->initilize($address);
|
||||
$this->initializePostFields($params);
|
||||
|
||||
curl_setopt($this->curlHandler, CURLOPT_POST, count($params));
|
||||
|
||||
return $this->getResponse();
|
||||
}
|
||||
|
||||
public function put($resource, $id, array $params = array())
|
||||
{
|
||||
$address = $this->lazyBuildAddress($resource, $id, []);
|
||||
|
||||
$this->initilize($address);
|
||||
$this->initializePostFields($params);
|
||||
|
||||
curl_setopt($this->curlHandler, CURLOPT_CUSTOMREQUEST, "PUT");
|
||||
|
||||
return $this->getResponse();
|
||||
}
|
||||
|
||||
public function delete($resource, $id, array $params = array())
|
||||
{
|
||||
$address = $this->lazyBuildAddress($resource, $id, $params);
|
||||
|
||||
$this->initilize($address);
|
||||
|
||||
curl_setopt($this->curlHandler, CURLOPT_CUSTOMREQUEST, "DELETE");
|
||||
|
||||
return $this->getResponse();
|
||||
}
|
||||
|
||||
protected function initializePostFields(array $params)
|
||||
{
|
||||
// sanitize
|
||||
$string = '';
|
||||
foreach ($params as $key => $value) {
|
||||
if ('' !== trim($value)) {
|
||||
$string .= $key . '=' . urlencode($value) . '&';
|
||||
}
|
||||
}
|
||||
|
||||
$string = substr($string, 0, -1);
|
||||
curl_setopt($this->curlHandler, CURLOPT_POSTFIELDS, $string);
|
||||
}
|
||||
|
||||
protected function getResponse()
|
||||
{
|
||||
$response = curl_exec($this->curlHandler);
|
||||
$code = curl_getinfo($this->curlHandler, CURLINFO_HTTP_CODE);
|
||||
|
||||
$error = curl_error($this->curlHandler);
|
||||
$errno = curl_errno($this->curlHandler);
|
||||
|
||||
curl_close($this->curlHandler);
|
||||
|
||||
return [$code, $response ?: $error . " (errno $errno)"];
|
||||
}
|
||||
|
||||
protected function lazyBuildAddress($resource, $id = null, $params = array())
|
||||
{
|
||||
$address = sprintf("%s/%s", $this->wsAddress, $resource);
|
||||
|
||||
if (null !== $id) {
|
||||
$address = sprintf("%s/%s", $address, $id);
|
||||
}
|
||||
|
||||
$address .= "?";
|
||||
foreach ($params as $name => $value) {
|
||||
if ('' !== trim($value)) {
|
||||
$address .= $name . "=" . $value . "&";
|
||||
}
|
||||
}
|
||||
|
||||
return $address;
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module xmlns="http://thelia.net/schema/dic/module"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://thelia.net/schema/dic/module http://thelia.net/schema/dic/module/module-2_1.xsd">
|
||||
<fullnamespace>Mailjet\Mailjet</fullnamespace>
|
||||
<descriptive locale="en_US">
|
||||
<title>Mailjet</title>
|
||||
</descriptive>
|
||||
<descriptive locale="fr_FR">
|
||||
<title>Mailjet</title>
|
||||
</descriptive>
|
||||
<languages>
|
||||
<language>en_US</language>
|
||||
<language>fr_FR</language>
|
||||
</languages>
|
||||
<version>1.3.2</version>
|
||||
<author>
|
||||
<name>Benjamin Perche, Franck Allimant</name>
|
||||
<email>bperche@openstudio.fr, thelia@cqfdev.fr</email>
|
||||
</author>
|
||||
<type>classic</type>
|
||||
<thelia>2.3.4</thelia>
|
||||
<stability>other</stability>
|
||||
</module>
|
||||
@@ -1,11 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<routes xmlns="http://symfony.com/schema/routing"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">
|
||||
<!-- Thelia 2.0 backward compatibility -->
|
||||
|
||||
<route id="mailjet.save" path="/admin/module/Mailjet" methods="post">
|
||||
<default key="_controller">Mailjet\Controller\MailjetConfigController::saveAction</default>
|
||||
</route>
|
||||
</routes>
|
||||
@@ -1,28 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<database defaultIdMethod="native" name="thelia">
|
||||
<table name="mailjet_newsletter" namespace="Mailjet\Model">
|
||||
<column name="id" autoIncrement="true" type="INTEGER" required="true" primaryKey="true" />
|
||||
<column name="mailjet_id" type="VARCHAR" size="255" required="true" />
|
||||
<column name="email" type="VARCHAR" size="255" required="true" />
|
||||
<column name="relation_id" type="VARCHAR" size="255" />
|
||||
|
||||
<index name="idx_mailjet_newsletter_email">
|
||||
<index-column name="email" />
|
||||
</index>
|
||||
<index name="idx_mailjet_newsletter_relation_id">
|
||||
<index-column name="relation_id" />
|
||||
</index>
|
||||
|
||||
<unique name="email_UNIQUE">
|
||||
<unique-column name="email" />
|
||||
</unique>
|
||||
<unique name="relation_id_UNIQUE">
|
||||
<unique-column name="relation_id" />
|
||||
</unique>
|
||||
</table>
|
||||
|
||||
<!--
|
||||
See propel documentation on http://propelorm.org for all information about schema file
|
||||
-->
|
||||
<external-schema filename="local/config/schema.xml" referenceOnly="true" />
|
||||
</database>
|
||||
@@ -1,26 +0,0 @@
|
||||
|
||||
# This is a fix for InnoDB in MySQL >= 4.1.x
|
||||
# It "suspends judgement" for fkey relationships until are tables are set.
|
||||
SET FOREIGN_KEY_CHECKS = 0;
|
||||
|
||||
-- ---------------------------------------------------------------------
|
||||
-- mailjet_newsletter
|
||||
-- ---------------------------------------------------------------------
|
||||
|
||||
DROP TABLE IF EXISTS `mailjet_newsletter`;
|
||||
|
||||
CREATE TABLE `mailjet_newsletter`
|
||||
(
|
||||
`id` INTEGER NOT NULL AUTO_INCREMENT,
|
||||
`mailjet_id` VARCHAR(255) NOT NULL,
|
||||
`email` VARCHAR(255) NOT NULL,
|
||||
`relation_id` VARCHAR(255),
|
||||
PRIMARY KEY (`id`),
|
||||
UNIQUE INDEX `email_UNIQUE` (`email`),
|
||||
UNIQUE INDEX `relation_id_UNIQUE` (`relation_id`),
|
||||
INDEX `idx_mailjet_newsletter_email` (`email`),
|
||||
INDEX `idx_mailjet_newsletter_relation_id` (`relation_id`)
|
||||
) ENGINE=InnoDB;
|
||||
|
||||
# This restores the fkey checks, after having unset them earlier
|
||||
SET FOREIGN_KEY_CHECKS = 1;
|
||||
@@ -1,22 +0,0 @@
|
||||
# This is a fix for InnoDB in MySQL >= 4.1.x
|
||||
# It "suspends judgement" for fkey relationships until are tables are set.
|
||||
SET FOREIGN_KEY_CHECKS = 0;
|
||||
|
||||
-- ---------------------------------------------------------------------
|
||||
-- mailjet_newsletter
|
||||
-- ---------------------------------------------------------------------
|
||||
|
||||
ALTER TABLE `mailjet_newsletter` MODIFY `relation_id` INT;
|
||||
|
||||
ALTER TABLE `mailjet_newsletter` MODIFY `id` VARCHAR(255);
|
||||
|
||||
ALTER TABLE `mailjet_newsletter` CHANGE `id` `mailjet_id` VARCHAR(255);
|
||||
|
||||
ALTER TABLE `mailjet_newsletter` ADD COLUMN `id` INT NOT NULL AUTO_INCREMENT UNIQUE FIRST;
|
||||
|
||||
ALTER TABLE `mailjet_newsletter`
|
||||
DROP PRIMARY KEY,
|
||||
ADD PRIMARY KEY (`id`);
|
||||
|
||||
# This restores the fkey checks, after having unset them earlier
|
||||
SET FOREIGN_KEY_CHECKS = 1;
|
||||
@@ -1,262 +0,0 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailjet\EventListeners;
|
||||
|
||||
use Mailjet\Mailjet;
|
||||
use Mailjet\Model\MailjetNewsletter;
|
||||
use Mailjet\Model\MailjetNewsletterQuery;
|
||||
use Mailjet\Api\MailjetClient;
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\Translation\TranslatorInterface;
|
||||
use Thelia\Core\Event\TheliaEvents;
|
||||
use Thelia\Core\Event\Newsletter\NewsletterEvent;
|
||||
use Mailjet\Mailjet as MailjetModule;
|
||||
use Thelia\Log\Tlog;
|
||||
use Thelia\Model\ConfigQuery;
|
||||
use Thelia\Model\NewsletterQuery;
|
||||
|
||||
/**
|
||||
* Class NewsletterListener
|
||||
* @package Mailjet\EventListeners
|
||||
* @author Benjamin Perche <bperche@openstudio.com>
|
||||
*/
|
||||
class NewsletterListener implements EventSubscriberInterface
|
||||
{
|
||||
/**
|
||||
* @var TranslatorInterface
|
||||
*/
|
||||
protected $translator;
|
||||
|
||||
/**
|
||||
* @var MailjetClient
|
||||
*/
|
||||
protected $api;
|
||||
|
||||
public function __construct(TranslatorInterface $translator)
|
||||
{
|
||||
$this->translator = $translator;
|
||||
|
||||
// We can't do some beautiful DI because we can't read config variables through the config.xml
|
||||
$this->api = new MailjetClient(
|
||||
ConfigQuery::read(MailjetModule::CONFIG_API_KEY),
|
||||
ConfigQuery::read(MailjetModule::CONFIG_API_SECRET),
|
||||
ConfigQuery::read(MailjetModule::CONFIG_API_WS_ADDRESS)
|
||||
);
|
||||
}
|
||||
|
||||
public function subscribe(NewsletterEvent $event)
|
||||
{
|
||||
// Create contact
|
||||
if (null !== $model = $this->apiAddUser($event, "registration")) {
|
||||
// Add contact to the thelia list
|
||||
$this->apiAddContactList($event, $model);
|
||||
}
|
||||
}
|
||||
|
||||
public function update(NewsletterEvent $event)
|
||||
{
|
||||
$previousEmail = NewsletterQuery::create()->findPk($event->getId())->getEmail();
|
||||
|
||||
if ($event->getEmail() !== $previousEmail) {
|
||||
if (null !== $model = MailjetNewsletterQuery::create()->findOneByEmail($previousEmail)) {
|
||||
/**
|
||||
* Delete the relation
|
||||
*/
|
||||
$id = $model->getRelationId();
|
||||
|
||||
list ($status, $data) = $this->api->delete(MailjetClient::RESOURCE_LIST_RECIPIENT, $id);
|
||||
|
||||
if ($this->logAfterAction(
|
||||
sprintf("The email address '%s' was successfully removed from the list", $event->getEmail()),
|
||||
sprintf("The email address '%s' was not removed from the list", $event->getEmail()),
|
||||
$status,
|
||||
$data
|
||||
)
|
||||
) {
|
||||
// Reset relation ID.
|
||||
$model
|
||||
->setRelationId(null)
|
||||
->save();
|
||||
/**
|
||||
* Then create a new client
|
||||
*/
|
||||
$this->subscribe($event);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function unsubscribe(NewsletterEvent $event)
|
||||
{
|
||||
if (null !== $model = MailjetNewsletterQuery::create()->findOneByEmail($event->getEmail())) {
|
||||
// Remove the contact from the contact list. The contact will still exist in Mailjet
|
||||
$params = [
|
||||
"IsActive" => "False",
|
||||
"IsUnsubscribed" => "True",
|
||||
];
|
||||
|
||||
list ($status, $data) = $this->api->put(MailjetClient::RESOURCE_LIST_RECIPIENT, $model->getRelationId(), $params);
|
||||
|
||||
$this->logAfterAction(
|
||||
sprintf("The email address '%s' was successfully unsubscribed from the list", $event->getEmail()),
|
||||
sprintf("The email address '%s' was not unsubscribed from the list", $event->getEmail()),
|
||||
$status,
|
||||
$data
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
protected function apiAddContactList(NewsletterEvent $event, MailjetNewsletter $model)
|
||||
{
|
||||
$params = [
|
||||
"IsActive" => "True",
|
||||
"IsUnsubscribed" => "False",
|
||||
];
|
||||
|
||||
if (($model->getRelationId()) === null) {
|
||||
$params["ContactID"] = $model->getMailjetId();
|
||||
$params["ListALT"] = ConfigQuery::read(MailjetModule::CONFIG_NEWSLETTER_LIST);
|
||||
|
||||
// Add the contact to the contact list
|
||||
list ($status, $data) = $this->api->post(MailjetClient::RESOURCE_LIST_RECIPIENT, $params);
|
||||
} else {
|
||||
// Update the contact status to reactivate it
|
||||
list ($status, $data) = $this->api->put(MailjetClient::RESOURCE_LIST_RECIPIENT, $model->getRelationId(), $params);
|
||||
}
|
||||
|
||||
if ($this->logAfterAction(
|
||||
sprintf(
|
||||
"The email address %s was added to mailjet list %s",
|
||||
ConfigQuery::read(MailjetModule::CONFIG_NEWSLETTER_LIST),
|
||||
$event->getEmail()
|
||||
),
|
||||
sprintf(
|
||||
"The email address %s was refused by mailjet for addition to the list %s, params:%s",
|
||||
$event->getEmail(),
|
||||
ConfigQuery::read(MailjetModule::CONFIG_NEWSLETTER_LIST),
|
||||
json_encode($params)
|
||||
),
|
||||
$status,
|
||||
$data
|
||||
)) {
|
||||
$data = json_decode($data, true);
|
||||
|
||||
// Save the contact/contact-list relation ID, we'll need it for unsubscription.
|
||||
$model
|
||||
->setRelationId($data["Data"][0]["ID"])
|
||||
->save()
|
||||
;
|
||||
}
|
||||
}
|
||||
|
||||
protected function apiAddUser(NewsletterEvent $event, $function)
|
||||
{
|
||||
// Check if the email is already registred
|
||||
$model = MailjetNewsletterQuery::create()->findOneByEmail($event->getEmail());
|
||||
|
||||
if (null === $model) {
|
||||
// Check if user exists before trying to create it (fixes sync. problems)
|
||||
list ($status, $data) = $this->api->get(MailjetClient::RESOURCE_CONTACT, $event->getEmail());
|
||||
|
||||
if ($status == 404) {
|
||||
list ($status, $data) = $this->api->post(MailjetClient::RESOURCE_CONTACT, [
|
||||
"Email" => $event->getEmail(),
|
||||
"Name" => $event->getLastname() . " " . $event->getFirstname(),
|
||||
]);
|
||||
}
|
||||
|
||||
if ($this->logAfterAction(
|
||||
sprintf("Email address successfully added for %s '%s'", $function, $event->getEmail()),
|
||||
sprintf(
|
||||
"The email address %s was refused by mailjet for action '%s'",
|
||||
$event->getEmail(),
|
||||
$function
|
||||
),
|
||||
$status,
|
||||
$data
|
||||
)) {
|
||||
$data = json_decode($data, true);
|
||||
|
||||
$model = new MailjetNewsletter();
|
||||
$model
|
||||
->setRelationId($data["Data"][0]["ID"])
|
||||
->setEmail($event->getEmail())
|
||||
->save();
|
||||
}
|
||||
}
|
||||
|
||||
return $model;
|
||||
}
|
||||
|
||||
protected function isStatusOk($status)
|
||||
{
|
||||
return $status >= 200 && $status < 300;
|
||||
}
|
||||
|
||||
protected function logAfterAction($successMessage, $errorMessage, $status, $data)
|
||||
{
|
||||
if ($this->isStatusOk($status)) {
|
||||
Tlog::getInstance()->info($successMessage);
|
||||
|
||||
return true;
|
||||
} else {
|
||||
Tlog::getInstance()->error(sprintf("%s. Status code: %d, data: %s", $errorMessage, $status, $data));
|
||||
|
||||
if (ConfigQuery::read(Mailjet::CONFIG_THROW_EXCEPTION_ON_ERROR, false)) {
|
||||
throw new \InvalidArgumentException(
|
||||
$this->translator->trans(
|
||||
"An error occurred during the newsletter registration process",
|
||||
[],
|
||||
MailjetModule::MESSAGE_DOMAIN
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
protected function getEmailFromEvent(NewsletterEvent $event)
|
||||
{
|
||||
return NewsletterQuery::create()->findPk($event->getId())->getEmail();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of event names this subscriber wants to listen to.
|
||||
*
|
||||
* The array keys are event names and the value can be:
|
||||
*
|
||||
* * The method name to call (priority defaults to 0)
|
||||
* * An array composed of the method name to call and the priority
|
||||
* * An array of arrays composed of the method names to call and respective
|
||||
* priorities, or 0 if unset
|
||||
*
|
||||
* For instance:
|
||||
*
|
||||
* * array('eventName' => 'methodName')
|
||||
* * array('eventName' => array('methodName', $priority))
|
||||
* * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
|
||||
*
|
||||
* @return array The event names to listen to
|
||||
*
|
||||
* @api
|
||||
*/
|
||||
public static function getSubscribedEvents()
|
||||
{
|
||||
return array(
|
||||
TheliaEvents::NEWSLETTER_SUBSCRIBE => array("subscribe", 192), // Come before, as if it crashes, it won't be saved by thelia
|
||||
TheliaEvents::NEWSLETTER_UPDATE => array("update", 192),
|
||||
TheliaEvents::NEWSLETTER_UNSUBSCRIBE => array("unsubscribe", 192),
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailjet\Hook;
|
||||
|
||||
use Thelia\Core\Event\Hook\HookRenderEvent;
|
||||
use Thelia\Core\Hook\BaseHook;
|
||||
|
||||
class HookManager extends BaseHook
|
||||
{
|
||||
public function onModuleConfiguration(HookRenderEvent $event)
|
||||
{
|
||||
$event->add(
|
||||
$this->render("mailjet-configuration.html")
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
<?php
|
||||
return array(
|
||||
'Configuration correctly saved' => 'Configuration successfully saved !',
|
||||
'Configure mailjet' => 'Configure Mailjet',
|
||||
);
|
||||
@@ -1,5 +0,0 @@
|
||||
<?php
|
||||
return array(
|
||||
'Configuration correctly saved' => 'La configuration a bien été enregistrée !',
|
||||
'Configure mailjet' => 'Configuration Mailjet',
|
||||
);
|
||||
@@ -1,12 +0,0 @@
|
||||
<?php
|
||||
|
||||
return array(
|
||||
'An error occurred during the newsletter registration process' => 'An error occurred during the newsletter registration process',
|
||||
'Api key' => 'Api key',
|
||||
'Api secret' => 'Api secret',
|
||||
'Newsletter list address name' => 'Newsletter list address name',
|
||||
'The module will throw an error if something wrong happens whan talking to MailJet. Warning ! This could prevent user registration if Mailjet server is down or unreachable !' => 'The module will throw an error if something wrong happens whan talking to MailJet. Warning ! This could prevent user registration if Mailjet server is down or unreachable !',
|
||||
'This value is the name of your list mail address (example: the \'xxxxxx\' of xxxxxx@lists.mailjet.com)' => 'This value is the name of your list mail address (example: the \'xxxxxx\' of xxxxxx@lists.mailjet.com)',
|
||||
'Throw exception on Mailjet error' => 'Throw exception on Mailjet error',
|
||||
'Webservice address' => 'Webservice address',
|
||||
);
|
||||
@@ -1,12 +0,0 @@
|
||||
<?php
|
||||
|
||||
return array(
|
||||
'An error occurred during the newsletter registration process' => 'Une erreur s\'est produit pendant l\'enregistrement de votre adresse email',
|
||||
'Api key' => 'Clef API',
|
||||
'Api secret' => 'Clef secrète API',
|
||||
'Newsletter list address name' => 'Adresse de la liste de contacts Mailjet',
|
||||
'The module will throw an error if something wrong happens whan talking to MailJet. Warning ! This could prevent user registration if Mailjet server is down or unreachable !' => 'A utiliser en développement uniquement. Le module lèvera une exception si si Mailjet retourne une erreur, ou est injoignable. Attention, cela peut empe^cher les utilisateurs de se connecter si le serveur Mailjet est hors service ou injoignable !',
|
||||
'This value is the name of your list mail address (example: the \'xxxxxx\' of xxxxxx@lists.mailjet.com)' => 'Il s\'agit du nom de la liste de contacts qui sera mise à jour. Par exemple: xxxx@lists.mailjet.com',
|
||||
'Throw exception on Mailjet error' => 'Lever une exception en cas d\'erreur Mailjet',
|
||||
'Webservice address' => 'Adresse du Web Service Mailjet',
|
||||
);
|
||||
@@ -1,121 +0,0 @@
|
||||
<?php
|
||||
/*************************************************************************************/
|
||||
/* This file is part of the Thelia package. */
|
||||
/* */
|
||||
/* Copyright (c) OpenStudio */
|
||||
/* email : dev@thelia.net */
|
||||
/* web : http://www.thelia.net */
|
||||
/* */
|
||||
/* For the full copyright and license information, please view the LICENSE.txt */
|
||||
/* file that was distributed with this source code. */
|
||||
/*************************************************************************************/
|
||||
|
||||
namespace Mailjet;
|
||||
|
||||
use Propel\Runtime\Connection\ConnectionInterface;
|
||||
use Symfony\Component\Filesystem\Filesystem;
|
||||
use Thelia\Install\Database;
|
||||
use Thelia\Model\Config;
|
||||
use Thelia\Model\ConfigQuery;
|
||||
use Thelia\Module\BaseModule;
|
||||
|
||||
/**
|
||||
* Class Mailjet
|
||||
* @package Mailjet
|
||||
* @author Benjamin Perche <bperche@openstudio.com>
|
||||
*/
|
||||
class Mailjet extends BaseModule
|
||||
{
|
||||
const MESSAGE_DOMAIN = "mailjet";
|
||||
|
||||
const CONFIG_NEWSLETTER_LIST = "mailjet.newsletter_list";
|
||||
const CONFIG_API_KEY = "mailjet.api.key";
|
||||
const CONFIG_API_SECRET = "mailjet.api.secret";
|
||||
const CONFIG_API_WS_ADDRESS = "mail.api.webservice_address";
|
||||
const CONFIG_THROW_EXCEPTION_ON_ERROR = "mailjet.throw_exception_on_error";
|
||||
|
||||
public function postActivation(ConnectionInterface $con = null)
|
||||
{
|
||||
$con->beginTransaction();
|
||||
|
||||
try {
|
||||
if (null === ConfigQuery::read(static::CONFIG_API_KEY)) {
|
||||
$this->createConfigValue(static::CONFIG_API_KEY, [
|
||||
"fr_FR" => "Clé d'API pour mailjet",
|
||||
"en_US" => "Api key for mailjet",
|
||||
]);
|
||||
}
|
||||
|
||||
if (null === ConfigQuery::read(static::CONFIG_API_SECRET)) {
|
||||
$this->createConfigValue(static::CONFIG_API_SECRET, [
|
||||
"fr_FR" => "Secret d'API pour mailjet",
|
||||
"en_US" => "Api secret for mailjet",
|
||||
]);
|
||||
}
|
||||
|
||||
if (null === ConfigQuery::read(static::CONFIG_NEWSLETTER_LIST)) {
|
||||
$this->createConfigValue(static::CONFIG_NEWSLETTER_LIST, [
|
||||
"fr_FR" => "ALT de la liste de diffusion mailjet",
|
||||
"en_US" => "Diffusion list ALT of mailjet",
|
||||
]);
|
||||
}
|
||||
|
||||
if (null === ConfigQuery::read(static::CONFIG_API_WS_ADDRESS)) {
|
||||
$this->createConfigValue(
|
||||
static::CONFIG_API_WS_ADDRESS,
|
||||
[
|
||||
"fr_FR" => "Adresse du webservice mailjet",
|
||||
"en_US" => "Address of the mailjet webservice",
|
||||
],
|
||||
"https://api.mailjet.com/v3/REST"
|
||||
);
|
||||
}
|
||||
|
||||
$database = new Database($con);
|
||||
$database->insertSql(null, [__DIR__ . "/Config/thelia.sql"]);
|
||||
|
||||
$con->commit();
|
||||
} catch (\Exception $e) {
|
||||
$con->rollBack();
|
||||
|
||||
throw $e;
|
||||
}
|
||||
}
|
||||
|
||||
protected function createConfigValue($name, array $translation, $value = '')
|
||||
{
|
||||
$config = new Config();
|
||||
$config
|
||||
->setName($name)
|
||||
->setValue($value)
|
||||
;
|
||||
|
||||
foreach ($translation as $locale => $title) {
|
||||
$config->getTranslation($locale)
|
||||
->setTitle($title)
|
||||
;
|
||||
}
|
||||
|
||||
$config->save();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @param string $currentVersion
|
||||
* @param string $newVersion
|
||||
* @param ConnectionInterface $con
|
||||
*/
|
||||
public function update($currentVersion, $newVersion, ConnectionInterface $con = null)
|
||||
{
|
||||
if ($newVersion === '1.3.2') {
|
||||
$db = new Database($con);
|
||||
|
||||
$tableExists = $db->execute("SHOW TABLES LIKE 'mailjet_newsletter'")->rowCount();
|
||||
|
||||
if ($tableExists) {
|
||||
// Le champ relation ID change de format.
|
||||
$db->execute("ALTER TABLE `mailjet_newsletter` CHANGE `relation_id` `relation_id` varchar(255) NOT NULL AFTER `email`");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,455 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Mailjet\Model\Base;
|
||||
|
||||
use \Exception;
|
||||
use \PDO;
|
||||
use Mailjet\Model\MailjetNewsletter as ChildMailjetNewsletter;
|
||||
use Mailjet\Model\MailjetNewsletterQuery as ChildMailjetNewsletterQuery;
|
||||
use Mailjet\Model\Map\MailjetNewsletterTableMap;
|
||||
use Propel\Runtime\Propel;
|
||||
use Propel\Runtime\ActiveQuery\Criteria;
|
||||
use Propel\Runtime\ActiveQuery\ModelCriteria;
|
||||
use Propel\Runtime\Connection\ConnectionInterface;
|
||||
use Propel\Runtime\Exception\PropelException;
|
||||
|
||||
/**
|
||||
* Base class that represents a query for the 'mailjet_newsletter' table.
|
||||
*
|
||||
*
|
||||
*
|
||||
* @method ChildMailjetNewsletterQuery orderById($order = Criteria::ASC) Order by the id column
|
||||
* @method ChildMailjetNewsletterQuery orderByMailjetId($order = Criteria::ASC) Order by the mailjet_id column
|
||||
* @method ChildMailjetNewsletterQuery orderByEmail($order = Criteria::ASC) Order by the email column
|
||||
* @method ChildMailjetNewsletterQuery orderByRelationId($order = Criteria::ASC) Order by the relation_id column
|
||||
*
|
||||
* @method ChildMailjetNewsletterQuery groupById() Group by the id column
|
||||
* @method ChildMailjetNewsletterQuery groupByMailjetId() Group by the mailjet_id column
|
||||
* @method ChildMailjetNewsletterQuery groupByEmail() Group by the email column
|
||||
* @method ChildMailjetNewsletterQuery groupByRelationId() Group by the relation_id column
|
||||
*
|
||||
* @method ChildMailjetNewsletterQuery leftJoin($relation) Adds a LEFT JOIN clause to the query
|
||||
* @method ChildMailjetNewsletterQuery rightJoin($relation) Adds a RIGHT JOIN clause to the query
|
||||
* @method ChildMailjetNewsletterQuery innerJoin($relation) Adds a INNER JOIN clause to the query
|
||||
*
|
||||
* @method ChildMailjetNewsletter findOne(ConnectionInterface $con = null) Return the first ChildMailjetNewsletter matching the query
|
||||
* @method ChildMailjetNewsletter findOneOrCreate(ConnectionInterface $con = null) Return the first ChildMailjetNewsletter matching the query, or a new ChildMailjetNewsletter object populated from the query conditions when no match is found
|
||||
*
|
||||
* @method ChildMailjetNewsletter findOneById(int $id) Return the first ChildMailjetNewsletter filtered by the id column
|
||||
* @method ChildMailjetNewsletter findOneByMailjetId(string $mailjet_id) Return the first ChildMailjetNewsletter filtered by the mailjet_id column
|
||||
* @method ChildMailjetNewsletter findOneByEmail(string $email) Return the first ChildMailjetNewsletter filtered by the email column
|
||||
* @method ChildMailjetNewsletter findOneByRelationId(int $relation_id) Return the first ChildMailjetNewsletter filtered by the relation_id column
|
||||
*
|
||||
* @method array findById(int $id) Return ChildMailjetNewsletter objects filtered by the id column
|
||||
* @method array findByMailjetId(string $mailjet_id) Return ChildMailjetNewsletter objects filtered by the mailjet_id column
|
||||
* @method array findByEmail(string $email) Return ChildMailjetNewsletter objects filtered by the email column
|
||||
* @method array findByRelationId(int $relation_id) Return ChildMailjetNewsletter objects filtered by the relation_id column
|
||||
*
|
||||
*/
|
||||
abstract class MailjetNewsletterQuery extends ModelCriteria
|
||||
{
|
||||
|
||||
/**
|
||||
* Initializes internal state of \Mailjet\Model\Base\MailjetNewsletterQuery object.
|
||||
*
|
||||
* @param string $dbName The database name
|
||||
* @param string $modelName The phpName of a model, e.g. 'Book'
|
||||
* @param string $modelAlias The alias for the model in this query, e.g. 'b'
|
||||
*/
|
||||
public function __construct($dbName = 'thelia', $modelName = '\\Mailjet\\Model\\MailjetNewsletter', $modelAlias = null)
|
||||
{
|
||||
parent::__construct($dbName, $modelName, $modelAlias);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a new ChildMailjetNewsletterQuery object.
|
||||
*
|
||||
* @param string $modelAlias The alias of a model in the query
|
||||
* @param Criteria $criteria Optional Criteria to build the query from
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery
|
||||
*/
|
||||
public static function create($modelAlias = null, $criteria = null)
|
||||
{
|
||||
if ($criteria instanceof \Mailjet\Model\MailjetNewsletterQuery) {
|
||||
return $criteria;
|
||||
}
|
||||
$query = new \Mailjet\Model\MailjetNewsletterQuery();
|
||||
if (null !== $modelAlias) {
|
||||
$query->setModelAlias($modelAlias);
|
||||
}
|
||||
if ($criteria instanceof Criteria) {
|
||||
$query->mergeWith($criteria);
|
||||
}
|
||||
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find object by primary key.
|
||||
* Propel uses the instance pool to skip the database if the object exists.
|
||||
* Go fast if the query is untouched.
|
||||
*
|
||||
* <code>
|
||||
* $obj = $c->findPk(12, $con);
|
||||
* </code>
|
||||
*
|
||||
* @param mixed $key Primary key to use for the query
|
||||
* @param ConnectionInterface $con an optional connection object
|
||||
*
|
||||
* @return ChildMailjetNewsletter|array|mixed the result, formatted by the current formatter
|
||||
*/
|
||||
public function findPk($key, $con = null)
|
||||
{
|
||||
if ($key === null) {
|
||||
return null;
|
||||
}
|
||||
if ((null !== ($obj = MailjetNewsletterTableMap::getInstanceFromPool((string) $key))) && !$this->formatter) {
|
||||
// the object is already in the instance pool
|
||||
return $obj;
|
||||
}
|
||||
if ($con === null) {
|
||||
$con = Propel::getServiceContainer()->getReadConnection(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
}
|
||||
$this->basePreSelect($con);
|
||||
if ($this->formatter || $this->modelAlias || $this->with || $this->select
|
||||
|| $this->selectColumns || $this->asColumns || $this->selectModifiers
|
||||
|| $this->map || $this->having || $this->joins) {
|
||||
return $this->findPkComplex($key, $con);
|
||||
} else {
|
||||
return $this->findPkSimple($key, $con);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Find object by primary key using raw SQL to go fast.
|
||||
* Bypass doSelect() and the object formatter by using generated code.
|
||||
*
|
||||
* @param mixed $key Primary key to use for the query
|
||||
* @param ConnectionInterface $con A connection object
|
||||
*
|
||||
* @return ChildMailjetNewsletter A model object, or null if the key is not found
|
||||
*/
|
||||
protected function findPkSimple($key, $con)
|
||||
{
|
||||
$sql = 'SELECT ID, MAILJET_ID, EMAIL, RELATION_ID FROM mailjet_newsletter WHERE ID = :p0';
|
||||
try {
|
||||
$stmt = $con->prepare($sql);
|
||||
$stmt->bindValue(':p0', $key, PDO::PARAM_INT);
|
||||
$stmt->execute();
|
||||
} catch (Exception $e) {
|
||||
Propel::log($e->getMessage(), Propel::LOG_ERR);
|
||||
throw new PropelException(sprintf('Unable to execute SELECT statement [%s]', $sql), 0, $e);
|
||||
}
|
||||
$obj = null;
|
||||
if ($row = $stmt->fetch(\PDO::FETCH_NUM)) {
|
||||
$obj = new ChildMailjetNewsletter();
|
||||
$obj->hydrate($row);
|
||||
MailjetNewsletterTableMap::addInstanceToPool($obj, (string) $key);
|
||||
}
|
||||
$stmt->closeCursor();
|
||||
|
||||
return $obj;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find object by primary key.
|
||||
*
|
||||
* @param mixed $key Primary key to use for the query
|
||||
* @param ConnectionInterface $con A connection object
|
||||
*
|
||||
* @return ChildMailjetNewsletter|array|mixed the result, formatted by the current formatter
|
||||
*/
|
||||
protected function findPkComplex($key, $con)
|
||||
{
|
||||
// As the query uses a PK condition, no limit(1) is necessary.
|
||||
$criteria = $this->isKeepQuery() ? clone $this : $this;
|
||||
$dataFetcher = $criteria
|
||||
->filterByPrimaryKey($key)
|
||||
->doSelect($con);
|
||||
|
||||
return $criteria->getFormatter()->init($criteria)->formatOne($dataFetcher);
|
||||
}
|
||||
|
||||
/**
|
||||
* Find objects by primary key
|
||||
* <code>
|
||||
* $objs = $c->findPks(array(12, 56, 832), $con);
|
||||
* </code>
|
||||
* @param array $keys Primary keys to use for the query
|
||||
* @param ConnectionInterface $con an optional connection object
|
||||
*
|
||||
* @return ObjectCollection|array|mixed the list of results, formatted by the current formatter
|
||||
*/
|
||||
public function findPks($keys, $con = null)
|
||||
{
|
||||
if (null === $con) {
|
||||
$con = Propel::getServiceContainer()->getReadConnection($this->getDbName());
|
||||
}
|
||||
$this->basePreSelect($con);
|
||||
$criteria = $this->isKeepQuery() ? clone $this : $this;
|
||||
$dataFetcher = $criteria
|
||||
->filterByPrimaryKeys($keys)
|
||||
->doSelect($con);
|
||||
|
||||
return $criteria->getFormatter()->init($criteria)->format($dataFetcher);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the query by primary key
|
||||
*
|
||||
* @param mixed $key Primary key to use for the query
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function filterByPrimaryKey($key)
|
||||
{
|
||||
|
||||
return $this->addUsingAlias(MailjetNewsletterTableMap::ID, $key, Criteria::EQUAL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the query by a list of primary keys
|
||||
*
|
||||
* @param array $keys The list of primary key to use for the query
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function filterByPrimaryKeys($keys)
|
||||
{
|
||||
|
||||
return $this->addUsingAlias(MailjetNewsletterTableMap::ID, $keys, Criteria::IN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the query on the id column
|
||||
*
|
||||
* Example usage:
|
||||
* <code>
|
||||
* $query->filterById(1234); // WHERE id = 1234
|
||||
* $query->filterById(array(12, 34)); // WHERE id IN (12, 34)
|
||||
* $query->filterById(array('min' => 12)); // WHERE id > 12
|
||||
* </code>
|
||||
*
|
||||
* @param mixed $id The value to use as filter.
|
||||
* Use scalar values for equality.
|
||||
* Use array values for in_array() equivalent.
|
||||
* Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
|
||||
* @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function filterById($id = null, $comparison = null)
|
||||
{
|
||||
if (is_array($id)) {
|
||||
$useMinMax = false;
|
||||
if (isset($id['min'])) {
|
||||
$this->addUsingAlias(MailjetNewsletterTableMap::ID, $id['min'], Criteria::GREATER_EQUAL);
|
||||
$useMinMax = true;
|
||||
}
|
||||
if (isset($id['max'])) {
|
||||
$this->addUsingAlias(MailjetNewsletterTableMap::ID, $id['max'], Criteria::LESS_EQUAL);
|
||||
$useMinMax = true;
|
||||
}
|
||||
if ($useMinMax) {
|
||||
return $this;
|
||||
}
|
||||
if (null === $comparison) {
|
||||
$comparison = Criteria::IN;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->addUsingAlias(MailjetNewsletterTableMap::ID, $id, $comparison);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the query on the mailjet_id column
|
||||
*
|
||||
* Example usage:
|
||||
* <code>
|
||||
* $query->filterByMailjetId('fooValue'); // WHERE mailjet_id = 'fooValue'
|
||||
* $query->filterByMailjetId('%fooValue%'); // WHERE mailjet_id LIKE '%fooValue%'
|
||||
* </code>
|
||||
*
|
||||
* @param string $mailjetId The value to use as filter.
|
||||
* Accepts wildcards (* and % trigger a LIKE)
|
||||
* @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function filterByMailjetId($mailjetId = null, $comparison = null)
|
||||
{
|
||||
if (null === $comparison) {
|
||||
if (is_array($mailjetId)) {
|
||||
$comparison = Criteria::IN;
|
||||
} elseif (preg_match('/[\%\*]/', $mailjetId)) {
|
||||
$mailjetId = str_replace('*', '%', $mailjetId);
|
||||
$comparison = Criteria::LIKE;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->addUsingAlias(MailjetNewsletterTableMap::MAILJET_ID, $mailjetId, $comparison);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the query on the email column
|
||||
*
|
||||
* Example usage:
|
||||
* <code>
|
||||
* $query->filterByEmail('fooValue'); // WHERE email = 'fooValue'
|
||||
* $query->filterByEmail('%fooValue%'); // WHERE email LIKE '%fooValue%'
|
||||
* </code>
|
||||
*
|
||||
* @param string $email The value to use as filter.
|
||||
* Accepts wildcards (* and % trigger a LIKE)
|
||||
* @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function filterByEmail($email = null, $comparison = null)
|
||||
{
|
||||
if (null === $comparison) {
|
||||
if (is_array($email)) {
|
||||
$comparison = Criteria::IN;
|
||||
} elseif (preg_match('/[\%\*]/', $email)) {
|
||||
$email = str_replace('*', '%', $email);
|
||||
$comparison = Criteria::LIKE;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->addUsingAlias(MailjetNewsletterTableMap::EMAIL, $email, $comparison);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the query on the relation_id column
|
||||
*
|
||||
* Example usage:
|
||||
* <code>
|
||||
* $query->filterByRelationId(1234); // WHERE relation_id = 1234
|
||||
* $query->filterByRelationId(array(12, 34)); // WHERE relation_id IN (12, 34)
|
||||
* $query->filterByRelationId(array('min' => 12)); // WHERE relation_id > 12
|
||||
* </code>
|
||||
*
|
||||
* @param mixed $relationId The value to use as filter.
|
||||
* Use scalar values for equality.
|
||||
* Use array values for in_array() equivalent.
|
||||
* Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
|
||||
* @param string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function filterByRelationId($relationId = null, $comparison = null)
|
||||
{
|
||||
if (is_array($relationId)) {
|
||||
$useMinMax = false;
|
||||
if (isset($relationId['min'])) {
|
||||
$this->addUsingAlias(MailjetNewsletterTableMap::RELATION_ID, $relationId['min'], Criteria::GREATER_EQUAL);
|
||||
$useMinMax = true;
|
||||
}
|
||||
if (isset($relationId['max'])) {
|
||||
$this->addUsingAlias(MailjetNewsletterTableMap::RELATION_ID, $relationId['max'], Criteria::LESS_EQUAL);
|
||||
$useMinMax = true;
|
||||
}
|
||||
if ($useMinMax) {
|
||||
return $this;
|
||||
}
|
||||
if (null === $comparison) {
|
||||
$comparison = Criteria::IN;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->addUsingAlias(MailjetNewsletterTableMap::RELATION_ID, $relationId, $comparison);
|
||||
}
|
||||
|
||||
/**
|
||||
* Exclude object from result
|
||||
*
|
||||
* @param ChildMailjetNewsletter $mailjetNewsletter Object to remove from the list of results
|
||||
*
|
||||
* @return ChildMailjetNewsletterQuery The current query, for fluid interface
|
||||
*/
|
||||
public function prune($mailjetNewsletter = null)
|
||||
{
|
||||
if ($mailjetNewsletter) {
|
||||
$this->addUsingAlias(MailjetNewsletterTableMap::ID, $mailjetNewsletter->getId(), Criteria::NOT_EQUAL);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes all rows from the mailjet_newsletter table.
|
||||
*
|
||||
* @param ConnectionInterface $con the connection to use
|
||||
* @return int The number of affected rows (if supported by underlying database driver).
|
||||
*/
|
||||
public function doDeleteAll(ConnectionInterface $con = null)
|
||||
{
|
||||
if (null === $con) {
|
||||
$con = Propel::getServiceContainer()->getWriteConnection(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
}
|
||||
$affectedRows = 0; // initialize var to track total num of affected rows
|
||||
try {
|
||||
// use transaction because $criteria could contain info
|
||||
// for more than one table or we could emulating ON DELETE CASCADE, etc.
|
||||
$con->beginTransaction();
|
||||
$affectedRows += parent::doDeleteAll($con);
|
||||
// Because this db requires some delete cascade/set null emulation, we have to
|
||||
// clear the cached instance *after* the emulation has happened (since
|
||||
// instances get re-added by the select statement contained therein).
|
||||
MailjetNewsletterTableMap::clearInstancePool();
|
||||
MailjetNewsletterTableMap::clearRelatedInstancePool();
|
||||
|
||||
$con->commit();
|
||||
} catch (PropelException $e) {
|
||||
$con->rollBack();
|
||||
throw $e;
|
||||
}
|
||||
|
||||
return $affectedRows;
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a DELETE on the database, given a ChildMailjetNewsletter or Criteria object OR a primary key value.
|
||||
*
|
||||
* @param mixed $values Criteria or ChildMailjetNewsletter object or primary key or array of primary keys
|
||||
* which is used to create the DELETE statement
|
||||
* @param ConnectionInterface $con the connection to use
|
||||
* @return int The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows
|
||||
* if supported by native driver or if emulated using Propel.
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
*/
|
||||
public function delete(ConnectionInterface $con = null)
|
||||
{
|
||||
if (null === $con) {
|
||||
$con = Propel::getServiceContainer()->getWriteConnection(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
}
|
||||
|
||||
$criteria = $this;
|
||||
|
||||
// Set the correct dbName
|
||||
$criteria->setDbName(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
|
||||
$affectedRows = 0; // initialize var to track total num of affected rows
|
||||
|
||||
try {
|
||||
// use transaction because $criteria could contain info
|
||||
// for more than one table or we could emulating ON DELETE CASCADE, etc.
|
||||
$con->beginTransaction();
|
||||
|
||||
|
||||
MailjetNewsletterTableMap::removeInstanceFromPool($criteria);
|
||||
|
||||
$affectedRows += ModelCriteria::delete($con);
|
||||
MailjetNewsletterTableMap::clearRelatedInstancePool();
|
||||
$con->commit();
|
||||
|
||||
return $affectedRows;
|
||||
} catch (PropelException $e) {
|
||||
$con->rollBack();
|
||||
throw $e;
|
||||
}
|
||||
}
|
||||
|
||||
} // MailjetNewsletterQuery
|
||||
@@ -1,10 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Mailjet\Model;
|
||||
|
||||
use Mailjet\Model\Base\MailjetNewsletter as BaseMailjetNewsletter;
|
||||
|
||||
class MailjetNewsletter extends BaseMailjetNewsletter
|
||||
{
|
||||
|
||||
}
|
||||
@@ -1,21 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Mailjet\Model;
|
||||
|
||||
use Mailjet\Model\Base\MailjetNewsletterQuery as BaseMailjetNewsletterQuery;
|
||||
|
||||
|
||||
/**
|
||||
* Skeleton subclass for performing query and update operations on the 'mailjet_newsletter' table.
|
||||
*
|
||||
*
|
||||
*
|
||||
* You should add additional methods to this class to meet the
|
||||
* application requirements. This class will only be generated as
|
||||
* long as it does not already exist in the output directory.
|
||||
*
|
||||
*/
|
||||
class MailjetNewsletterQuery extends BaseMailjetNewsletterQuery
|
||||
{
|
||||
|
||||
} // MailjetNewsletterQuery
|
||||
@@ -1,426 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Mailjet\Model\Map;
|
||||
|
||||
use Mailjet\Model\MailjetNewsletter;
|
||||
use Mailjet\Model\MailjetNewsletterQuery;
|
||||
use Propel\Runtime\Propel;
|
||||
use Propel\Runtime\ActiveQuery\Criteria;
|
||||
use Propel\Runtime\ActiveQuery\InstancePoolTrait;
|
||||
use Propel\Runtime\Connection\ConnectionInterface;
|
||||
use Propel\Runtime\DataFetcher\DataFetcherInterface;
|
||||
use Propel\Runtime\Exception\PropelException;
|
||||
use Propel\Runtime\Map\RelationMap;
|
||||
use Propel\Runtime\Map\TableMap;
|
||||
use Propel\Runtime\Map\TableMapTrait;
|
||||
|
||||
|
||||
/**
|
||||
* This class defines the structure of the 'mailjet_newsletter' table.
|
||||
*
|
||||
*
|
||||
*
|
||||
* This map class is used by Propel to do runtime db structure discovery.
|
||||
* For example, the createSelectSql() method checks the type of a given column used in an
|
||||
* ORDER BY clause to know whether it needs to apply SQL to make the ORDER BY case-insensitive
|
||||
* (i.e. if it's a text column type).
|
||||
*
|
||||
*/
|
||||
class MailjetNewsletterTableMap extends TableMap
|
||||
{
|
||||
use InstancePoolTrait;
|
||||
use TableMapTrait;
|
||||
/**
|
||||
* The (dot-path) name of this class
|
||||
*/
|
||||
const CLASS_NAME = 'Mailjet.Model.Map.MailjetNewsletterTableMap';
|
||||
|
||||
/**
|
||||
* The default database name for this class
|
||||
*/
|
||||
const DATABASE_NAME = 'thelia';
|
||||
|
||||
/**
|
||||
* The table name for this class
|
||||
*/
|
||||
const TABLE_NAME = 'mailjet_newsletter';
|
||||
|
||||
/**
|
||||
* The related Propel class for this table
|
||||
*/
|
||||
const OM_CLASS = '\\Mailjet\\Model\\MailjetNewsletter';
|
||||
|
||||
/**
|
||||
* A class that can be returned by this tableMap
|
||||
*/
|
||||
const CLASS_DEFAULT = 'Mailjet.Model.MailjetNewsletter';
|
||||
|
||||
/**
|
||||
* The total number of columns
|
||||
*/
|
||||
const NUM_COLUMNS = 4;
|
||||
|
||||
/**
|
||||
* The number of lazy-loaded columns
|
||||
*/
|
||||
const NUM_LAZY_LOAD_COLUMNS = 0;
|
||||
|
||||
/**
|
||||
* The number of columns to hydrate (NUM_COLUMNS - NUM_LAZY_LOAD_COLUMNS)
|
||||
*/
|
||||
const NUM_HYDRATE_COLUMNS = 4;
|
||||
|
||||
/**
|
||||
* the column name for the ID field
|
||||
*/
|
||||
const ID = 'mailjet_newsletter.ID';
|
||||
|
||||
/**
|
||||
* the column name for the MAILJET_ID field
|
||||
*/
|
||||
const MAILJET_ID = 'mailjet_newsletter.MAILJET_ID';
|
||||
|
||||
/**
|
||||
* the column name for the EMAIL field
|
||||
*/
|
||||
const EMAIL = 'mailjet_newsletter.EMAIL';
|
||||
|
||||
/**
|
||||
* the column name for the RELATION_ID field
|
||||
*/
|
||||
const RELATION_ID = 'mailjet_newsletter.RELATION_ID';
|
||||
|
||||
/**
|
||||
* The default string format for model objects of the related table
|
||||
*/
|
||||
const DEFAULT_STRING_FORMAT = 'YAML';
|
||||
|
||||
/**
|
||||
* holds an array of fieldnames
|
||||
*
|
||||
* first dimension keys are the type constants
|
||||
* e.g. self::$fieldNames[self::TYPE_PHPNAME][0] = 'Id'
|
||||
*/
|
||||
protected static $fieldNames = array (
|
||||
self::TYPE_PHPNAME => array('Id', 'MailjetId', 'Email', 'RelationId', ),
|
||||
self::TYPE_STUDLYPHPNAME => array('id', 'mailjetId', 'email', 'relationId', ),
|
||||
self::TYPE_COLNAME => array(MailjetNewsletterTableMap::ID, MailjetNewsletterTableMap::MAILJET_ID, MailjetNewsletterTableMap::EMAIL, MailjetNewsletterTableMap::RELATION_ID, ),
|
||||
self::TYPE_RAW_COLNAME => array('ID', 'MAILJET_ID', 'EMAIL', 'RELATION_ID', ),
|
||||
self::TYPE_FIELDNAME => array('id', 'mailjet_id', 'email', 'relation_id', ),
|
||||
self::TYPE_NUM => array(0, 1, 2, 3, )
|
||||
);
|
||||
|
||||
/**
|
||||
* holds an array of keys for quick access to the fieldnames array
|
||||
*
|
||||
* first dimension keys are the type constants
|
||||
* e.g. self::$fieldKeys[self::TYPE_PHPNAME]['Id'] = 0
|
||||
*/
|
||||
protected static $fieldKeys = array (
|
||||
self::TYPE_PHPNAME => array('Id' => 0, 'MailjetId' => 1, 'Email' => 2, 'RelationId' => 3, ),
|
||||
self::TYPE_STUDLYPHPNAME => array('id' => 0, 'mailjetId' => 1, 'email' => 2, 'relationId' => 3, ),
|
||||
self::TYPE_COLNAME => array(MailjetNewsletterTableMap::ID => 0, MailjetNewsletterTableMap::MAILJET_ID => 1, MailjetNewsletterTableMap::EMAIL => 2, MailjetNewsletterTableMap::RELATION_ID => 3, ),
|
||||
self::TYPE_RAW_COLNAME => array('ID' => 0, 'MAILJET_ID' => 1, 'EMAIL' => 2, 'RELATION_ID' => 3, ),
|
||||
self::TYPE_FIELDNAME => array('id' => 0, 'mailjet_id' => 1, 'email' => 2, 'relation_id' => 3, ),
|
||||
self::TYPE_NUM => array(0, 1, 2, 3, )
|
||||
);
|
||||
|
||||
/**
|
||||
* Initialize the table attributes and columns
|
||||
* Relations are not initialized by this method since they are lazy loaded
|
||||
*
|
||||
* @return void
|
||||
* @throws PropelException
|
||||
*/
|
||||
public function initialize()
|
||||
{
|
||||
// attributes
|
||||
$this->setName('mailjet_newsletter');
|
||||
$this->setPhpName('MailjetNewsletter');
|
||||
$this->setClassName('\\Mailjet\\Model\\MailjetNewsletter');
|
||||
$this->setPackage('Mailjet.Model');
|
||||
$this->setUseIdGenerator(true);
|
||||
// columns
|
||||
$this->addPrimaryKey('ID', 'Id', 'INTEGER', true, null, null);
|
||||
$this->addColumn('MAILJET_ID', 'MailjetId', 'VARCHAR', true, 255, null);
|
||||
$this->addColumn('EMAIL', 'Email', 'VARCHAR', true, 255, null);
|
||||
$this->addColumn('RELATION_ID', 'RelationId', 'INTEGER', false, null, null);
|
||||
} // initialize()
|
||||
|
||||
/**
|
||||
* Build the RelationMap objects for this table relationships
|
||||
*/
|
||||
public function buildRelations()
|
||||
{
|
||||
} // buildRelations()
|
||||
|
||||
/**
|
||||
* Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table.
|
||||
*
|
||||
* For tables with a single-column primary key, that simple pkey value will be returned. For tables with
|
||||
* a multi-column primary key, a serialize()d version of the primary key will be returned.
|
||||
*
|
||||
* @param array $row resultset row.
|
||||
* @param int $offset The 0-based offset for reading from the resultset row.
|
||||
* @param string $indexType One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME
|
||||
* TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM
|
||||
*/
|
||||
public static function getPrimaryKeyHashFromRow($row, $offset = 0, $indexType = TableMap::TYPE_NUM)
|
||||
{
|
||||
// If the PK cannot be derived from the row, return NULL.
|
||||
if ($row[TableMap::TYPE_NUM == $indexType ? 0 + $offset : static::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)] === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return (string) $row[TableMap::TYPE_NUM == $indexType ? 0 + $offset : static::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)];
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the primary key from the DB resultset row
|
||||
* For tables with a single-column primary key, that simple pkey value will be returned. For tables with
|
||||
* a multi-column primary key, an array of the primary key columns will be returned.
|
||||
*
|
||||
* @param array $row resultset row.
|
||||
* @param int $offset The 0-based offset for reading from the resultset row.
|
||||
* @param string $indexType One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME
|
||||
* TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM
|
||||
*
|
||||
* @return mixed The primary key of the row
|
||||
*/
|
||||
public static function getPrimaryKeyFromRow($row, $offset = 0, $indexType = TableMap::TYPE_NUM)
|
||||
{
|
||||
|
||||
return (int) $row[
|
||||
$indexType == TableMap::TYPE_NUM
|
||||
? 0 + $offset
|
||||
: self::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* The class that the tableMap will make instances of.
|
||||
*
|
||||
* If $withPrefix is true, the returned path
|
||||
* uses a dot-path notation which is translated into a path
|
||||
* relative to a location on the PHP include_path.
|
||||
* (e.g. path.to.MyClass -> 'path/to/MyClass.php')
|
||||
*
|
||||
* @param boolean $withPrefix Whether or not to return the path with the class name
|
||||
* @return string path.to.ClassName
|
||||
*/
|
||||
public static function getOMClass($withPrefix = true)
|
||||
{
|
||||
return $withPrefix ? MailjetNewsletterTableMap::CLASS_DEFAULT : MailjetNewsletterTableMap::OM_CLASS;
|
||||
}
|
||||
|
||||
/**
|
||||
* Populates an object of the default type or an object that inherit from the default.
|
||||
*
|
||||
* @param array $row row returned by DataFetcher->fetch().
|
||||
* @param int $offset The 0-based offset for reading from the resultset row.
|
||||
* @param string $indexType The index type of $row. Mostly DataFetcher->getIndexType().
|
||||
One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME
|
||||
* TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM.
|
||||
*
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
* @return array (MailjetNewsletter object, last column rank)
|
||||
*/
|
||||
public static function populateObject($row, $offset = 0, $indexType = TableMap::TYPE_NUM)
|
||||
{
|
||||
$key = MailjetNewsletterTableMap::getPrimaryKeyHashFromRow($row, $offset, $indexType);
|
||||
if (null !== ($obj = MailjetNewsletterTableMap::getInstanceFromPool($key))) {
|
||||
// We no longer rehydrate the object, since this can cause data loss.
|
||||
// See http://www.propelorm.org/ticket/509
|
||||
// $obj->hydrate($row, $offset, true); // rehydrate
|
||||
$col = $offset + MailjetNewsletterTableMap::NUM_HYDRATE_COLUMNS;
|
||||
} else {
|
||||
$cls = MailjetNewsletterTableMap::OM_CLASS;
|
||||
$obj = new $cls();
|
||||
$col = $obj->hydrate($row, $offset, false, $indexType);
|
||||
MailjetNewsletterTableMap::addInstanceToPool($obj, $key);
|
||||
}
|
||||
|
||||
return array($obj, $col);
|
||||
}
|
||||
|
||||
/**
|
||||
* The returned array will contain objects of the default type or
|
||||
* objects that inherit from the default.
|
||||
*
|
||||
* @param DataFetcherInterface $dataFetcher
|
||||
* @return array
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
*/
|
||||
public static function populateObjects(DataFetcherInterface $dataFetcher)
|
||||
{
|
||||
$results = array();
|
||||
|
||||
// set the class once to avoid overhead in the loop
|
||||
$cls = static::getOMClass(false);
|
||||
// populate the object(s)
|
||||
while ($row = $dataFetcher->fetch()) {
|
||||
$key = MailjetNewsletterTableMap::getPrimaryKeyHashFromRow($row, 0, $dataFetcher->getIndexType());
|
||||
if (null !== ($obj = MailjetNewsletterTableMap::getInstanceFromPool($key))) {
|
||||
// We no longer rehydrate the object, since this can cause data loss.
|
||||
// See http://www.propelorm.org/ticket/509
|
||||
// $obj->hydrate($row, 0, true); // rehydrate
|
||||
$results[] = $obj;
|
||||
} else {
|
||||
$obj = new $cls();
|
||||
$obj->hydrate($row);
|
||||
$results[] = $obj;
|
||||
MailjetNewsletterTableMap::addInstanceToPool($obj, $key);
|
||||
} // if key exists
|
||||
}
|
||||
|
||||
return $results;
|
||||
}
|
||||
/**
|
||||
* Add all the columns needed to create a new object.
|
||||
*
|
||||
* Note: any columns that were marked with lazyLoad="true" in the
|
||||
* XML schema will not be added to the select list and only loaded
|
||||
* on demand.
|
||||
*
|
||||
* @param Criteria $criteria object containing the columns to add.
|
||||
* @param string $alias optional table alias
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
*/
|
||||
public static function addSelectColumns(Criteria $criteria, $alias = null)
|
||||
{
|
||||
if (null === $alias) {
|
||||
$criteria->addSelectColumn(MailjetNewsletterTableMap::ID);
|
||||
$criteria->addSelectColumn(MailjetNewsletterTableMap::MAILJET_ID);
|
||||
$criteria->addSelectColumn(MailjetNewsletterTableMap::EMAIL);
|
||||
$criteria->addSelectColumn(MailjetNewsletterTableMap::RELATION_ID);
|
||||
} else {
|
||||
$criteria->addSelectColumn($alias . '.ID');
|
||||
$criteria->addSelectColumn($alias . '.MAILJET_ID');
|
||||
$criteria->addSelectColumn($alias . '.EMAIL');
|
||||
$criteria->addSelectColumn($alias . '.RELATION_ID');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the TableMap related to this object.
|
||||
* This method is not needed for general use but a specific application could have a need.
|
||||
* @return TableMap
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
*/
|
||||
public static function getTableMap()
|
||||
{
|
||||
return Propel::getServiceContainer()->getDatabaseMap(MailjetNewsletterTableMap::DATABASE_NAME)->getTable(MailjetNewsletterTableMap::TABLE_NAME);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a TableMap instance to the database for this tableMap class.
|
||||
*/
|
||||
public static function buildTableMap()
|
||||
{
|
||||
$dbMap = Propel::getServiceContainer()->getDatabaseMap(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
if (!$dbMap->hasTable(MailjetNewsletterTableMap::TABLE_NAME)) {
|
||||
$dbMap->addTableObject(new MailjetNewsletterTableMap());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs a DELETE on the database, given a MailjetNewsletter or Criteria object OR a primary key value.
|
||||
*
|
||||
* @param mixed $values Criteria or MailjetNewsletter object or primary key or array of primary keys
|
||||
* which is used to create the DELETE statement
|
||||
* @param ConnectionInterface $con the connection to use
|
||||
* @return int The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows
|
||||
* if supported by native driver or if emulated using Propel.
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
*/
|
||||
public static function doDelete($values, ConnectionInterface $con = null)
|
||||
{
|
||||
if (null === $con) {
|
||||
$con = Propel::getServiceContainer()->getWriteConnection(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
}
|
||||
|
||||
if ($values instanceof Criteria) {
|
||||
// rename for clarity
|
||||
$criteria = $values;
|
||||
} elseif ($values instanceof \Mailjet\Model\MailjetNewsletter) { // it's a model object
|
||||
// create criteria based on pk values
|
||||
$criteria = $values->buildPkeyCriteria();
|
||||
} else { // it's a primary key, or an array of pks
|
||||
$criteria = new Criteria(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
$criteria->add(MailjetNewsletterTableMap::ID, (array) $values, Criteria::IN);
|
||||
}
|
||||
|
||||
$query = MailjetNewsletterQuery::create()->mergeWith($criteria);
|
||||
|
||||
if ($values instanceof Criteria) { MailjetNewsletterTableMap::clearInstancePool();
|
||||
} elseif (!is_object($values)) { // it's a primary key, or an array of pks
|
||||
foreach ((array) $values as $singleval) { MailjetNewsletterTableMap::removeInstanceFromPool($singleval);
|
||||
}
|
||||
}
|
||||
|
||||
return $query->delete($con);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes all rows from the mailjet_newsletter table.
|
||||
*
|
||||
* @param ConnectionInterface $con the connection to use
|
||||
* @return int The number of affected rows (if supported by underlying database driver).
|
||||
*/
|
||||
public static function doDeleteAll(ConnectionInterface $con = null)
|
||||
{
|
||||
return MailjetNewsletterQuery::create()->doDeleteAll($con);
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs an INSERT on the database, given a MailjetNewsletter or Criteria object.
|
||||
*
|
||||
* @param mixed $criteria Criteria or MailjetNewsletter object containing data that is used to create the INSERT statement.
|
||||
* @param ConnectionInterface $con the ConnectionInterface connection to use
|
||||
* @return mixed The new primary key.
|
||||
* @throws PropelException Any exceptions caught during processing will be
|
||||
* rethrown wrapped into a PropelException.
|
||||
*/
|
||||
public static function doInsert($criteria, ConnectionInterface $con = null)
|
||||
{
|
||||
if (null === $con) {
|
||||
$con = Propel::getServiceContainer()->getWriteConnection(MailjetNewsletterTableMap::DATABASE_NAME);
|
||||
}
|
||||
|
||||
if ($criteria instanceof Criteria) {
|
||||
$criteria = clone $criteria; // rename for clarity
|
||||
} else {
|
||||
$criteria = $criteria->buildCriteria(); // build Criteria from MailjetNewsletter object
|
||||
}
|
||||
|
||||
if ($criteria->containsKey(MailjetNewsletterTableMap::ID) && $criteria->keyContainsValue(MailjetNewsletterTableMap::ID) ) {
|
||||
throw new PropelException('Cannot insert a value for auto-increment primary key ('.MailjetNewsletterTableMap::ID.')');
|
||||
}
|
||||
|
||||
|
||||
// Set the correct dbName
|
||||
$query = MailjetNewsletterQuery::create()->mergeWith($criteria);
|
||||
|
||||
try {
|
||||
// use transaction because $criteria could contain info
|
||||
// for more than one table (I guess, conceivably)
|
||||
$con->beginTransaction();
|
||||
$pk = $query->doInsert($con);
|
||||
$con->commit();
|
||||
} catch (PropelException $e) {
|
||||
$con->rollBack();
|
||||
throw $e;
|
||||
}
|
||||
|
||||
return $pk;
|
||||
}
|
||||
|
||||
} // MailjetNewsletterTableMap
|
||||
// This is the static code needed to register the TableMap for this table with the main Propel class.
|
||||
//
|
||||
MailjetNewsletterTableMap::buildTableMap();
|
||||
@@ -1,36 +0,0 @@
|
||||
Mailjet for Thelia
|
||||
===
|
||||
Authors:
|
||||
- Benjamin Perche <bperche@openstudio.fr>
|
||||
- Franck Allimant <franck@cqfdev.fr>
|
||||
|
||||
This module keep a Mailjet contact list of your choice synchronized whith the newsletter subscriptions and unsubscriptions
|
||||
on your shop :
|
||||
|
||||
- When a user subscribe to your newsletter on your shop, it is automatically added to the Mailjet contact list.
|
||||
|
||||
- When a user unsubscribe from your list, it is also deleted from the Mailjet contact list. The user is nor deleted from Mailjet contacts, but is only removed from the contact list.
|
||||
|
||||
The module is based on the [APIv3 Documentation of Mailjet](https://dev.mailjet.com/email-api/v3/apikey/).
|
||||
|
||||
0. Prerequisites
|
||||
|
||||
You must have a Mailjet account and have created a contact list.
|
||||
Get your mailing list address on the contact list page, which is like ```xxxxxx@lists.mailjet.com``` and take note of the 'xxxxxx' part.
|
||||
|
||||
You'll also need your API Key and Secret key. You'll find them in your Mailjet account, see the REST API section.
|
||||
|
||||
1. Installation
|
||||
|
||||
There is two ways to install the mailjet module:
|
||||
- Download the zip archive of the file, import it from your backoffice or extract it in ```thelia/local/modules```
|
||||
- require it with composer:
|
||||
```
|
||||
"require": {
|
||||
"thelia/mailjet-module": "~1.0"
|
||||
}
|
||||
```
|
||||
|
||||
Then go to the configuration panel, give your API key and secret. You can leave the webservice address as its default value. Then enter your mailing list name (the 'xxxxxx') into the 4th field.
|
||||
|
||||
Save and you're done !
|
||||
@@ -1,33 +0,0 @@
|
||||
<div class="row">
|
||||
<div class="col-md-12 general-block-decorator">
|
||||
<div class="title">
|
||||
{intl d="mailjet.bo.default" l="Configure mailjet"}
|
||||
</div>
|
||||
|
||||
{if $success}
|
||||
<div class="alert alert-success">
|
||||
{intl l="Configuration correctly saved" d="mailjet.bo.default"}
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
{form name="mailjet.configuration"}
|
||||
<form action="{$current_url}" method="post">
|
||||
{include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'}}
|
||||
<br/>
|
||||
|
||||
{form_field field="success_url"}
|
||||
<input type="hidden" name="{$name}" value="{url path='/admin/modules'}" />
|
||||
{/form_field}
|
||||
|
||||
{form_hidden_fields}
|
||||
|
||||
{render_form_field field="api_key"}
|
||||
{render_form_field field="api_secret"}
|
||||
{render_form_field field="ws_address"}
|
||||
{render_form_field field="newsletter_list"}
|
||||
{render_form_field field="exception_on_errors"}
|
||||
|
||||
{include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'} page_bottom = 1}
|
||||
</form>
|
||||
{/form}
|
||||
</div>
|
||||
Reference in New Issue
Block a user