From 42114e640df60625d167f1c37ae3101adfac4d34 Mon Sep 17 00:00:00 2001 From: TheCoreDev Date: Fri, 30 Apr 2021 18:08:31 +0200 Subject: [PATCH] On remplace Mailjet par MailChimp --- local/modules/Mailchimp/.gitignore | 1 + local/modules/Mailchimp/Api/MailChimp.php | 265 ++++ .../{Mailjet => Mailchimp}/Config/config.xml | 10 +- local/modules/Mailchimp/Config/module.xml | 27 + local/modules/Mailchimp/Config/routing.xml | 15 + .../Controller/MailchimpConfigController.php} | 39 +- .../EventListeners/NewsletterListener.php | 143 ++ .../Form/MailchimpConfigurationForm.php} | 71 +- local/modules/Mailchimp/I18n/en_US.php | 4 + local/modules/Mailchimp/I18n/fr_FR.php | 7 + .../{Mailjet => Mailchimp}/LICENSE.txt | 0 local/modules/Mailchimp/Mailchimp.php | 85 ++ local/modules/Mailchimp/README.md | 15 + .../{Mailjet => Mailchimp}/composer.json | 4 +- .../default/mailchimp-configuration.html | 109 ++ local/modules/Mailjet/Api/MailjetClient.php | 138 -- local/modules/Mailjet/Config/module.xml | 24 - local/modules/Mailjet/Config/routing.xml | 11 - local/modules/Mailjet/Config/schema.xml | 28 - local/modules/Mailjet/Config/thelia.sql | 26 - local/modules/Mailjet/Config/update/1.3.sql | 22 - .../EventListeners/NewsletterListener.php | 262 ---- local/modules/Mailjet/Hook/HookManager.php | 26 - .../Mailjet/I18n/backOffice/default/en_US.php | 5 - .../Mailjet/I18n/backOffice/default/fr_FR.php | 5 - local/modules/Mailjet/I18n/en_US.php | 12 - local/modules/Mailjet/I18n/fr_FR.php | 12 - local/modules/Mailjet/Mailjet.php | 121 -- .../Mailjet/Model/Base/MailjetNewsletter.php | 1226 ----------------- .../Model/Base/MailjetNewsletterQuery.php | 455 ------ .../Mailjet/Model/MailjetNewsletter.php | 10 - .../Mailjet/Model/MailjetNewsletterQuery.php | 21 - .../Model/Map/MailjetNewsletterTableMap.php | 426 ------ local/modules/Mailjet/README.md | 36 - .../default/mailjet-configuration.html | 33 - 35 files changed, 718 insertions(+), 2976 deletions(-) create mode 100644 local/modules/Mailchimp/.gitignore create mode 100644 local/modules/Mailchimp/Api/MailChimp.php rename local/modules/{Mailjet => Mailchimp}/Config/config.xml (51%) create mode 100644 local/modules/Mailchimp/Config/module.xml create mode 100644 local/modules/Mailchimp/Config/routing.xml rename local/modules/{Mailjet/Controller/MailjetConfigController.php => Mailchimp/Controller/MailchimpConfigController.php} (57%) create mode 100644 local/modules/Mailchimp/EventListeners/NewsletterListener.php rename local/modules/{Mailjet/Form/MailjetConfigurationForm.php => Mailchimp/Form/MailchimpConfigurationForm.php} (51%) create mode 100644 local/modules/Mailchimp/I18n/en_US.php create mode 100644 local/modules/Mailchimp/I18n/fr_FR.php rename local/modules/{Mailjet => Mailchimp}/LICENSE.txt (100%) create mode 100644 local/modules/Mailchimp/Mailchimp.php create mode 100644 local/modules/Mailchimp/README.md rename local/modules/{Mailjet => Mailchimp}/composer.json (63%) create mode 100644 local/modules/Mailchimp/templates/backOffice/default/mailchimp-configuration.html delete mode 100644 local/modules/Mailjet/Api/MailjetClient.php delete mode 100644 local/modules/Mailjet/Config/module.xml delete mode 100644 local/modules/Mailjet/Config/routing.xml delete mode 100644 local/modules/Mailjet/Config/schema.xml delete mode 100644 local/modules/Mailjet/Config/thelia.sql delete mode 100644 local/modules/Mailjet/Config/update/1.3.sql delete mode 100644 local/modules/Mailjet/EventListeners/NewsletterListener.php delete mode 100644 local/modules/Mailjet/Hook/HookManager.php delete mode 100644 local/modules/Mailjet/I18n/backOffice/default/en_US.php delete mode 100644 local/modules/Mailjet/I18n/backOffice/default/fr_FR.php delete mode 100644 local/modules/Mailjet/I18n/en_US.php delete mode 100644 local/modules/Mailjet/I18n/fr_FR.php delete mode 100644 local/modules/Mailjet/Mailjet.php delete mode 100644 local/modules/Mailjet/Model/Base/MailjetNewsletter.php delete mode 100644 local/modules/Mailjet/Model/Base/MailjetNewsletterQuery.php delete mode 100644 local/modules/Mailjet/Model/MailjetNewsletter.php delete mode 100644 local/modules/Mailjet/Model/MailjetNewsletterQuery.php delete mode 100644 local/modules/Mailjet/Model/Map/MailjetNewsletterTableMap.php delete mode 100644 local/modules/Mailjet/README.md delete mode 100644 local/modules/Mailjet/templates/backOffice/default/mailjet-configuration.html diff --git a/local/modules/Mailchimp/.gitignore b/local/modules/Mailchimp/.gitignore new file mode 100644 index 00000000..e43b0f98 --- /dev/null +++ b/local/modules/Mailchimp/.gitignore @@ -0,0 +1 @@ +.DS_Store diff --git a/local/modules/Mailchimp/Api/MailChimp.php b/local/modules/Mailchimp/Api/MailChimp.php new file mode 100644 index 00000000..051b6fa7 --- /dev/null +++ b/local/modules/Mailchimp/Api/MailChimp.php @@ -0,0 +1,265 @@ + + * @version 2.1 + */ +class MailChimp +{ + private $api_key; + private $api_endpoint = 'https://.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('', $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; + } +} diff --git a/local/modules/Mailjet/Config/config.xml b/local/modules/Mailchimp/Config/config.xml similarity index 51% rename from local/modules/Mailjet/Config/config.xml rename to local/modules/Mailchimp/Config/config.xml index 357d5e00..49ae72ba 100644 --- a/local/modules/Mailjet/Config/config.xml +++ b/local/modules/Mailchimp/Config/config.xml @@ -5,20 +5,14 @@ xsi:schemaLocation="http://thelia.net/schema/dic/config http://thelia.net/schema/dic/config/thelia-1.0.xsd"> -
+ - + - - - - - - diff --git a/local/modules/Mailchimp/Config/module.xml b/local/modules/Mailchimp/Config/module.xml new file mode 100644 index 00000000..3217630e --- /dev/null +++ b/local/modules/Mailchimp/Config/module.xml @@ -0,0 +1,27 @@ + + + Mailchimp\Mailchimp + + Mailchimp + Thelia 2 plugin to add newsletter subscribers email to a Mailchimp diffusion list + + + Mailchimp + Thelia 2 plugin pour ajouter les emails abonnés à la newsletter à une liste de diffusion Mailchimp + + + + en_US + fr_FR + + 1.0 + + Loïc Berthelot + loic.berthelot@blumug.com + + classic + 2.0.0 + beta + diff --git a/local/modules/Mailchimp/Config/routing.xml b/local/modules/Mailchimp/Config/routing.xml new file mode 100644 index 00000000..7b5afe6d --- /dev/null +++ b/local/modules/Mailchimp/Config/routing.xml @@ -0,0 +1,15 @@ + + + + + + + Mailchimp\Controller\MailchimpConfigController::showAction + + + + Mailchimp\Controller\MailchimpConfigController::saveAction + + diff --git a/local/modules/Mailjet/Controller/MailjetConfigController.php b/local/modules/Mailchimp/Controller/MailchimpConfigController.php similarity index 57% rename from local/modules/Mailjet/Controller/MailjetConfigController.php rename to local/modules/Mailchimp/Controller/MailchimpConfigController.php index bd9dc363..60d4a492 100644 --- a/local/modules/Mailjet/Controller/MailjetConfigController.php +++ b/local/modules/Mailchimp/Controller/MailchimpConfigController.php @@ -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 + * Class MailchimpConfigController + * @package Mailchimp\Controller + * @author Loïc Berthelot */ -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(); } } diff --git a/local/modules/Mailchimp/EventListeners/NewsletterListener.php b/local/modules/Mailchimp/EventListeners/NewsletterListener.php new file mode 100644 index 00000000..0b3351ee --- /dev/null +++ b/local/modules/Mailchimp/EventListeners/NewsletterListener.php @@ -0,0 +1,143 @@ + + */ +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) + ); + } +} diff --git a/local/modules/Mailjet/Form/MailjetConfigurationForm.php b/local/modules/Mailchimp/Form/MailchimpConfigurationForm.php similarity index 51% rename from local/modules/Mailjet/Form/MailjetConfigurationForm.php rename to local/modules/Mailchimp/Form/MailchimpConfigurationForm.php index 77501421..ccc275be 100644 --- a/local/modules/Mailjet/Form/MailjetConfigurationForm.php +++ b/local/modules/Mailchimp/Form/MailchimpConfigurationForm.php @@ -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 + * Class MailchimpConfigurationForm + * @package Mailchimp\Form + * @author Loïc Berthelot */ -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"; } } diff --git a/local/modules/Mailchimp/I18n/en_US.php b/local/modules/Mailchimp/I18n/en_US.php new file mode 100644 index 00000000..0b4fa142 --- /dev/null +++ b/local/modules/Mailchimp/I18n/en_US.php @@ -0,0 +1,4 @@ + 'The displayed english string', +); diff --git a/local/modules/Mailchimp/I18n/fr_FR.php b/local/modules/Mailchimp/I18n/fr_FR.php new file mode 100644 index 00000000..84a9e3ec --- /dev/null +++ b/local/modules/Mailchimp/I18n/fr_FR.php @@ -0,0 +1,7 @@ + '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.' +); diff --git a/local/modules/Mailjet/LICENSE.txt b/local/modules/Mailchimp/LICENSE.txt similarity index 100% rename from local/modules/Mailjet/LICENSE.txt rename to local/modules/Mailchimp/LICENSE.txt diff --git a/local/modules/Mailchimp/Mailchimp.php b/local/modules/Mailchimp/Mailchimp.php new file mode 100644 index 00000000..9ac149e5 --- /dev/null +++ b/local/modules/Mailchimp/Mailchimp.php @@ -0,0 +1,85 @@ + + */ +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(); + } +} diff --git a/local/modules/Mailchimp/README.md b/local/modules/Mailchimp/README.md new file mode 100644 index 00000000..9ad5fa8a --- /dev/null +++ b/local/modules/Mailchimp/README.md @@ -0,0 +1,15 @@ +Mailchimp for Thelia +=== +author: Loïc Berthelot + +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. diff --git a/local/modules/Mailjet/composer.json b/local/modules/Mailchimp/composer.json similarity index 63% rename from local/modules/Mailjet/composer.json rename to local/modules/Mailchimp/composer.json index ee5b5edd..312cacba 100644 --- a/local/modules/Mailjet/composer.json +++ b/local/modules/Mailchimp/composer.json @@ -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" } } \ No newline at end of file diff --git a/local/modules/Mailchimp/templates/backOffice/default/mailchimp-configuration.html b/local/modules/Mailchimp/templates/backOffice/default/mailchimp-configuration.html new file mode 100644 index 00000000..4e587fd6 --- /dev/null +++ b/local/modules/Mailchimp/templates/backOffice/default/mailchimp-configuration.html @@ -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"} +
+ + +
+
+ {intl l="Configure Mailchimp"} +
+ +
+
+ {if $success} +
+ {intl l="Configuration correctly saved" d="mailchimp.bo.default"} +
+ {/if} + + {form name="mailchimp.configuration"} + + {include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'}} +
+ + {form_field form=$form field="success_url"} + + {/form_field} + + {form_hidden_fields form=$form} + + {form_field form=$form field="newsletter_list_id"} +
+
+
+ +
+
+ {if $error}{$message}{/if} + +
+
+
+ {/form_field} + + {form_field form=$form field="api_key"} +
+
+
+ +
+
+ {if $error}{$message}{/if} + +
+
+
+ {/form_field} + + {form_field form=$form field="api_url"} +
+
+
+ +
+
+ {if $error}{$message}{/if} + +
+
+
+ {/form_field} + + {include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'} page_bottom = 1} + + {/form} +
+
+
+
+{/block} + +{block name="javascript-initialization"} + +{/block} \ No newline at end of file diff --git a/local/modules/Mailjet/Api/MailjetClient.php b/local/modules/Mailjet/Api/MailjetClient.php deleted file mode 100644 index bdd8015d..00000000 --- a/local/modules/Mailjet/Api/MailjetClient.php +++ /dev/null @@ -1,138 +0,0 @@ - - */ -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; - } -} diff --git a/local/modules/Mailjet/Config/module.xml b/local/modules/Mailjet/Config/module.xml deleted file mode 100644 index 1887d452..00000000 --- a/local/modules/Mailjet/Config/module.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - Mailjet\Mailjet - - Mailjet - - - Mailjet - - - en_US - fr_FR - - 1.3.2 - - Benjamin Perche, Franck Allimant - bperche@openstudio.fr, thelia@cqfdev.fr - - classic - 2.3.4 - other - diff --git a/local/modules/Mailjet/Config/routing.xml b/local/modules/Mailjet/Config/routing.xml deleted file mode 100644 index 40b7fe40..00000000 --- a/local/modules/Mailjet/Config/routing.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - Mailjet\Controller\MailjetConfigController::saveAction - - diff --git a/local/modules/Mailjet/Config/schema.xml b/local/modules/Mailjet/Config/schema.xml deleted file mode 100644 index 0c18f374..00000000 --- a/local/modules/Mailjet/Config/schema.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - -
- - - - diff --git a/local/modules/Mailjet/Config/thelia.sql b/local/modules/Mailjet/Config/thelia.sql deleted file mode 100644 index ed68aba6..00000000 --- a/local/modules/Mailjet/Config/thelia.sql +++ /dev/null @@ -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; diff --git a/local/modules/Mailjet/Config/update/1.3.sql b/local/modules/Mailjet/Config/update/1.3.sql deleted file mode 100644 index 9c9b8469..00000000 --- a/local/modules/Mailjet/Config/update/1.3.sql +++ /dev/null @@ -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; \ No newline at end of file diff --git a/local/modules/Mailjet/EventListeners/NewsletterListener.php b/local/modules/Mailjet/EventListeners/NewsletterListener.php deleted file mode 100644 index bda995e5..00000000 --- a/local/modules/Mailjet/EventListeners/NewsletterListener.php +++ /dev/null @@ -1,262 +0,0 @@ - - */ -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), - ); - } -} diff --git a/local/modules/Mailjet/Hook/HookManager.php b/local/modules/Mailjet/Hook/HookManager.php deleted file mode 100644 index ef7c0905..00000000 --- a/local/modules/Mailjet/Hook/HookManager.php +++ /dev/null @@ -1,26 +0,0 @@ -add( - $this->render("mailjet-configuration.html") - ); - } -} diff --git a/local/modules/Mailjet/I18n/backOffice/default/en_US.php b/local/modules/Mailjet/I18n/backOffice/default/en_US.php deleted file mode 100644 index 164cd5ac..00000000 --- a/local/modules/Mailjet/I18n/backOffice/default/en_US.php +++ /dev/null @@ -1,5 +0,0 @@ - 'Configuration successfully saved !', - 'Configure mailjet' => 'Configure Mailjet', -); diff --git a/local/modules/Mailjet/I18n/backOffice/default/fr_FR.php b/local/modules/Mailjet/I18n/backOffice/default/fr_FR.php deleted file mode 100644 index 68bff984..00000000 --- a/local/modules/Mailjet/I18n/backOffice/default/fr_FR.php +++ /dev/null @@ -1,5 +0,0 @@ - 'La configuration a bien été enregistrée !', - 'Configure mailjet' => 'Configuration Mailjet', -); diff --git a/local/modules/Mailjet/I18n/en_US.php b/local/modules/Mailjet/I18n/en_US.php deleted file mode 100644 index bd72c974..00000000 --- a/local/modules/Mailjet/I18n/en_US.php +++ /dev/null @@ -1,12 +0,0 @@ - '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', -); diff --git a/local/modules/Mailjet/I18n/fr_FR.php b/local/modules/Mailjet/I18n/fr_FR.php deleted file mode 100644 index c8f191fc..00000000 --- a/local/modules/Mailjet/I18n/fr_FR.php +++ /dev/null @@ -1,12 +0,0 @@ - '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', -); diff --git a/local/modules/Mailjet/Mailjet.php b/local/modules/Mailjet/Mailjet.php deleted file mode 100644 index 66bcf755..00000000 --- a/local/modules/Mailjet/Mailjet.php +++ /dev/null @@ -1,121 +0,0 @@ - - */ -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`"); - } - } - } -} diff --git a/local/modules/Mailjet/Model/Base/MailjetNewsletter.php b/local/modules/Mailjet/Model/Base/MailjetNewsletter.php deleted file mode 100644 index 36e8643d..00000000 --- a/local/modules/Mailjet/Model/Base/MailjetNewsletter.php +++ /dev/null @@ -1,1226 +0,0 @@ -modifiedColumns; - } - - /** - * Has specified column been modified? - * - * @param string $col column fully qualified name (TableMap::TYPE_COLNAME), e.g. Book::AUTHOR_ID - * @return boolean True if $col has been modified. - */ - public function isColumnModified($col) - { - return $this->modifiedColumns && isset($this->modifiedColumns[$col]); - } - - /** - * Get the columns that have been modified in this object. - * @return array A unique list of the modified column names for this object. - */ - public function getModifiedColumns() - { - return $this->modifiedColumns ? array_keys($this->modifiedColumns) : []; - } - - /** - * Returns whether the object has ever been saved. This will - * be false, if the object was retrieved from storage or was created - * and then saved. - * - * @return boolean true, if the object has never been persisted. - */ - public function isNew() - { - return $this->new; - } - - /** - * Setter for the isNew attribute. This method will be called - * by Propel-generated children and objects. - * - * @param boolean $b the state of the object. - */ - public function setNew($b) - { - $this->new = (Boolean) $b; - } - - /** - * Whether this object has been deleted. - * @return boolean The deleted state of this object. - */ - public function isDeleted() - { - return $this->deleted; - } - - /** - * Specify whether this object has been deleted. - * @param boolean $b The deleted state of this object. - * @return void - */ - public function setDeleted($b) - { - $this->deleted = (Boolean) $b; - } - - /** - * Sets the modified state for the object to be false. - * @param string $col If supplied, only the specified column is reset. - * @return void - */ - public function resetModified($col = null) - { - if (null !== $col) { - if (isset($this->modifiedColumns[$col])) { - unset($this->modifiedColumns[$col]); - } - } else { - $this->modifiedColumns = array(); - } - } - - /** - * Compares this with another MailjetNewsletter instance. If - * obj is an instance of MailjetNewsletter, delegates to - * equals(MailjetNewsletter). Otherwise, returns false. - * - * @param mixed $obj The object to compare to. - * @return boolean Whether equal to the object specified. - */ - public function equals($obj) - { - $thisclazz = get_class($this); - if (!is_object($obj) || !($obj instanceof $thisclazz)) { - return false; - } - - if ($this === $obj) { - return true; - } - - if (null === $this->getPrimaryKey() - || null === $obj->getPrimaryKey()) { - return false; - } - - return $this->getPrimaryKey() === $obj->getPrimaryKey(); - } - - /** - * If the primary key is not null, return the hashcode of the - * primary key. Otherwise, return the hash code of the object. - * - * @return int Hashcode - */ - public function hashCode() - { - if (null !== $this->getPrimaryKey()) { - return crc32(serialize($this->getPrimaryKey())); - } - - return crc32(serialize(clone $this)); - } - - /** - * Get the associative array of the virtual columns in this object - * - * @return array - */ - public function getVirtualColumns() - { - return $this->virtualColumns; - } - - /** - * Checks the existence of a virtual column in this object - * - * @param string $name The virtual column name - * @return boolean - */ - public function hasVirtualColumn($name) - { - return array_key_exists($name, $this->virtualColumns); - } - - /** - * Get the value of a virtual column in this object - * - * @param string $name The virtual column name - * @return mixed - * - * @throws PropelException - */ - public function getVirtualColumn($name) - { - if (!$this->hasVirtualColumn($name)) { - throw new PropelException(sprintf('Cannot get value of inexistent virtual column %s.', $name)); - } - - return $this->virtualColumns[$name]; - } - - /** - * Set the value of a virtual column in this object - * - * @param string $name The virtual column name - * @param mixed $value The value to give to the virtual column - * - * @return MailjetNewsletter The current object, for fluid interface - */ - public function setVirtualColumn($name, $value) - { - $this->virtualColumns[$name] = $value; - - return $this; - } - - /** - * Logs a message using Propel::log(). - * - * @param string $msg - * @param int $priority One of the Propel::LOG_* logging levels - * @return boolean - */ - protected function log($msg, $priority = Propel::LOG_INFO) - { - return Propel::log(get_class($this) . ': ' . $msg, $priority); - } - - /** - * Populate the current object from a string, using a given parser format - * - * $book = new Book(); - * $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); - * - * - * @param mixed $parser A AbstractParser instance, - * or a format name ('XML', 'YAML', 'JSON', 'CSV') - * @param string $data The source data to import from - * - * @return MailjetNewsletter The current object, for fluid interface - */ - public function importFrom($parser, $data) - { - if (!$parser instanceof AbstractParser) { - $parser = AbstractParser::getParser($parser); - } - - $this->fromArray($parser->toArray($data), TableMap::TYPE_PHPNAME); - - return $this; - } - - /** - * Export the current object properties to a string, using a given parser format - * - * $book = BookQuery::create()->findPk(9012); - * echo $book->exportTo('JSON'); - * => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); - * - * - * @param mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV') - * @param boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE. - * @return string The exported data - */ - public function exportTo($parser, $includeLazyLoadColumns = true) - { - if (!$parser instanceof AbstractParser) { - $parser = AbstractParser::getParser($parser); - } - - return $parser->fromArray($this->toArray(TableMap::TYPE_PHPNAME, $includeLazyLoadColumns, array(), true)); - } - - /** - * Clean up internal collections prior to serializing - * Avoids recursive loops that turn into segmentation faults when serializing - */ - public function __sleep() - { - $this->clearAllReferences(); - - return array_keys(get_object_vars($this)); - } - - /** - * Get the [id] column value. - * - * @return int - */ - public function getId() - { - - return $this->id; - } - - /** - * Get the [mailjet_id] column value. - * - * @return string - */ - public function getMailjetId() - { - - return $this->mailjet_id; - } - - /** - * Get the [email] column value. - * - * @return string - */ - public function getEmail() - { - - return $this->email; - } - - /** - * Get the [relation_id] column value. - * - * @return int - */ - public function getRelationId() - { - - return $this->relation_id; - } - - /** - * Set the value of [id] column. - * - * @param int $v new value - * @return \Mailjet\Model\MailjetNewsletter The current object (for fluent API support) - */ - public function setId($v) - { - if ($v !== null) { - $v = (int) $v; - } - - if ($this->id !== $v) { - $this->id = $v; - $this->modifiedColumns[MailjetNewsletterTableMap::ID] = true; - } - - - return $this; - } // setId() - - /** - * Set the value of [mailjet_id] column. - * - * @param string $v new value - * @return \Mailjet\Model\MailjetNewsletter The current object (for fluent API support) - */ - public function setMailjetId($v) - { - if ($v !== null) { - $v = (string) $v; - } - - if ($this->mailjet_id !== $v) { - $this->mailjet_id = $v; - $this->modifiedColumns[MailjetNewsletterTableMap::MAILJET_ID] = true; - } - - - return $this; - } // setMailjetId() - - /** - * Set the value of [email] column. - * - * @param string $v new value - * @return \Mailjet\Model\MailjetNewsletter The current object (for fluent API support) - */ - public function setEmail($v) - { - if ($v !== null) { - $v = (string) $v; - } - - if ($this->email !== $v) { - $this->email = $v; - $this->modifiedColumns[MailjetNewsletterTableMap::EMAIL] = true; - } - - - return $this; - } // setEmail() - - /** - * Set the value of [relation_id] column. - * - * @param int $v new value - * @return \Mailjet\Model\MailjetNewsletter The current object (for fluent API support) - */ - public function setRelationId($v) - { - if ($v !== null) { - $v = (int) $v; - } - - if ($this->relation_id !== $v) { - $this->relation_id = $v; - $this->modifiedColumns[MailjetNewsletterTableMap::RELATION_ID] = true; - } - - - return $this; - } // setRelationId() - - /** - * Indicates whether the columns in this object are only set to default values. - * - * This method can be used in conjunction with isModified() to indicate whether an object is both - * modified _and_ has some values set which are non-default. - * - * @return boolean Whether the columns in this object are only been set with default values. - */ - public function hasOnlyDefaultValues() - { - // otherwise, everything was equal, so return TRUE - return true; - } // hasOnlyDefaultValues() - - /** - * Hydrates (populates) the object variables with values from the database resultset. - * - * An offset (0-based "start column") is specified so that objects can be hydrated - * with a subset of the columns in the resultset rows. This is needed, for example, - * for results of JOIN queries where the resultset row includes columns from two or - * more tables. - * - * @param array $row The row returned by DataFetcher->fetch(). - * @param int $startcol 0-based offset column which indicates which restultset column to start with. - * @param boolean $rehydrate Whether this object is being re-hydrated from the database. - * @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. - * - * @return int next starting column - * @throws PropelException - Any caught Exception will be rewrapped as a PropelException. - */ - public function hydrate($row, $startcol = 0, $rehydrate = false, $indexType = TableMap::TYPE_NUM) - { - try { - - - $col = $row[TableMap::TYPE_NUM == $indexType ? 0 + $startcol : MailjetNewsletterTableMap::translateFieldName('Id', TableMap::TYPE_PHPNAME, $indexType)]; - $this->id = (null !== $col) ? (int) $col : null; - - $col = $row[TableMap::TYPE_NUM == $indexType ? 1 + $startcol : MailjetNewsletterTableMap::translateFieldName('MailjetId', TableMap::TYPE_PHPNAME, $indexType)]; - $this->mailjet_id = (null !== $col) ? (string) $col : null; - - $col = $row[TableMap::TYPE_NUM == $indexType ? 2 + $startcol : MailjetNewsletterTableMap::translateFieldName('Email', TableMap::TYPE_PHPNAME, $indexType)]; - $this->email = (null !== $col) ? (string) $col : null; - - $col = $row[TableMap::TYPE_NUM == $indexType ? 3 + $startcol : MailjetNewsletterTableMap::translateFieldName('RelationId', TableMap::TYPE_PHPNAME, $indexType)]; - $this->relation_id = (null !== $col) ? (int) $col : null; - $this->resetModified(); - - $this->setNew(false); - - if ($rehydrate) { - $this->ensureConsistency(); - } - - return $startcol + 4; // 4 = MailjetNewsletterTableMap::NUM_HYDRATE_COLUMNS. - - } catch (Exception $e) { - throw new PropelException("Error populating \Mailjet\Model\MailjetNewsletter object", 0, $e); - } - } - - /** - * Checks and repairs the internal consistency of the object. - * - * This method is executed after an already-instantiated object is re-hydrated - * from the database. It exists to check any foreign keys to make sure that - * the objects related to the current object are correct based on foreign key. - * - * You can override this method in the stub class, but you should always invoke - * the base method from the overridden method (i.e. parent::ensureConsistency()), - * in case your model changes. - * - * @throws PropelException - */ - public function ensureConsistency() - { - } // ensureConsistency - - /** - * Reloads this object from datastore based on primary key and (optionally) resets all associated objects. - * - * This will only work if the object has been saved and has a valid primary key set. - * - * @param boolean $deep (optional) Whether to also de-associated any related objects. - * @param ConnectionInterface $con (optional) The ConnectionInterface connection to use. - * @return void - * @throws PropelException - if this object is deleted, unsaved or doesn't have pk match in db - */ - public function reload($deep = false, ConnectionInterface $con = null) - { - if ($this->isDeleted()) { - throw new PropelException("Cannot reload a deleted object."); - } - - if ($this->isNew()) { - throw new PropelException("Cannot reload an unsaved object."); - } - - if ($con === null) { - $con = Propel::getServiceContainer()->getReadConnection(MailjetNewsletterTableMap::DATABASE_NAME); - } - - // We don't need to alter the object instance pool; we're just modifying this instance - // already in the pool. - - $dataFetcher = ChildMailjetNewsletterQuery::create(null, $this->buildPkeyCriteria())->setFormatter(ModelCriteria::FORMAT_STATEMENT)->find($con); - $row = $dataFetcher->fetch(); - $dataFetcher->close(); - if (!$row) { - throw new PropelException('Cannot find matching row in the database to reload object values.'); - } - $this->hydrate($row, 0, true, $dataFetcher->getIndexType()); // rehydrate - - if ($deep) { // also de-associate any related objects? - - } // if (deep) - } - - /** - * Removes this object from datastore and sets delete attribute. - * - * @param ConnectionInterface $con - * @return void - * @throws PropelException - * @see MailjetNewsletter::setDeleted() - * @see MailjetNewsletter::isDeleted() - */ - public function delete(ConnectionInterface $con = null) - { - if ($this->isDeleted()) { - throw new PropelException("This object has already been deleted."); - } - - if ($con === null) { - $con = Propel::getServiceContainer()->getWriteConnection(MailjetNewsletterTableMap::DATABASE_NAME); - } - - $con->beginTransaction(); - try { - $deleteQuery = ChildMailjetNewsletterQuery::create() - ->filterByPrimaryKey($this->getPrimaryKey()); - $ret = $this->preDelete($con); - if ($ret) { - $deleteQuery->delete($con); - $this->postDelete($con); - $con->commit(); - $this->setDeleted(true); - } else { - $con->commit(); - } - } catch (Exception $e) { - $con->rollBack(); - throw $e; - } - } - - /** - * Persists this object to the database. - * - * If the object is new, it inserts it; otherwise an update is performed. - * All modified related objects will also be persisted in the doSave() - * method. This method wraps all precipitate database operations in a - * single transaction. - * - * @param ConnectionInterface $con - * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations. - * @throws PropelException - * @see doSave() - */ - public function save(ConnectionInterface $con = null) - { - if ($this->isDeleted()) { - throw new PropelException("You cannot save an object that has been deleted."); - } - - if ($con === null) { - $con = Propel::getServiceContainer()->getWriteConnection(MailjetNewsletterTableMap::DATABASE_NAME); - } - - $con->beginTransaction(); - $isInsert = $this->isNew(); - try { - $ret = $this->preSave($con); - if ($isInsert) { - $ret = $ret && $this->preInsert($con); - } else { - $ret = $ret && $this->preUpdate($con); - } - if ($ret) { - $affectedRows = $this->doSave($con); - if ($isInsert) { - $this->postInsert($con); - } else { - $this->postUpdate($con); - } - $this->postSave($con); - MailjetNewsletterTableMap::addInstanceToPool($this); - } else { - $affectedRows = 0; - } - $con->commit(); - - return $affectedRows; - } catch (Exception $e) { - $con->rollBack(); - throw $e; - } - } - - /** - * Performs the work of inserting or updating the row in the database. - * - * If the object is new, it inserts it; otherwise an update is performed. - * All related objects are also updated in this method. - * - * @param ConnectionInterface $con - * @return int The number of rows affected by this insert/update and any referring fk objects' save() operations. - * @throws PropelException - * @see save() - */ - protected function doSave(ConnectionInterface $con) - { - $affectedRows = 0; // initialize var to track total num of affected rows - if (!$this->alreadyInSave) { - $this->alreadyInSave = true; - - if ($this->isNew() || $this->isModified()) { - // persist changes - if ($this->isNew()) { - $this->doInsert($con); - } else { - $this->doUpdate($con); - } - $affectedRows += 1; - $this->resetModified(); - } - - $this->alreadyInSave = false; - - } - - return $affectedRows; - } // doSave() - - /** - * Insert the row in the database. - * - * @param ConnectionInterface $con - * - * @throws PropelException - * @see doSave() - */ - protected function doInsert(ConnectionInterface $con) - { - $modifiedColumns = array(); - $index = 0; - - $this->modifiedColumns[MailjetNewsletterTableMap::ID] = true; - if (null !== $this->id) { - throw new PropelException('Cannot insert a value for auto-increment primary key (' . MailjetNewsletterTableMap::ID . ')'); - } - - // check the columns in natural order for more readable SQL queries - if ($this->isColumnModified(MailjetNewsletterTableMap::ID)) { - $modifiedColumns[':p' . $index++] = 'ID'; - } - if ($this->isColumnModified(MailjetNewsletterTableMap::MAILJET_ID)) { - $modifiedColumns[':p' . $index++] = 'MAILJET_ID'; - } - if ($this->isColumnModified(MailjetNewsletterTableMap::EMAIL)) { - $modifiedColumns[':p' . $index++] = 'EMAIL'; - } - if ($this->isColumnModified(MailjetNewsletterTableMap::RELATION_ID)) { - $modifiedColumns[':p' . $index++] = 'RELATION_ID'; - } - - $sql = sprintf( - 'INSERT INTO mailjet_newsletter (%s) VALUES (%s)', - implode(', ', $modifiedColumns), - implode(', ', array_keys($modifiedColumns)) - ); - - try { - $stmt = $con->prepare($sql); - foreach ($modifiedColumns as $identifier => $columnName) { - switch ($columnName) { - case 'ID': - $stmt->bindValue($identifier, $this->id, PDO::PARAM_INT); - break; - case 'MAILJET_ID': - $stmt->bindValue($identifier, $this->mailjet_id, PDO::PARAM_STR); - break; - case 'EMAIL': - $stmt->bindValue($identifier, $this->email, PDO::PARAM_STR); - break; - case 'RELATION_ID': - $stmt->bindValue($identifier, $this->relation_id, PDO::PARAM_INT); - break; - } - } - $stmt->execute(); - } catch (Exception $e) { - Propel::log($e->getMessage(), Propel::LOG_ERR); - throw new PropelException(sprintf('Unable to execute INSERT statement [%s]', $sql), 0, $e); - } - - try { - $pk = $con->lastInsertId(); - } catch (Exception $e) { - throw new PropelException('Unable to get autoincrement id.', 0, $e); - } - $this->setId($pk); - - $this->setNew(false); - } - - /** - * Update the row in the database. - * - * @param ConnectionInterface $con - * - * @return Integer Number of updated rows - * @see doSave() - */ - protected function doUpdate(ConnectionInterface $con) - { - $selectCriteria = $this->buildPkeyCriteria(); - $valuesCriteria = $this->buildCriteria(); - - return $selectCriteria->doUpdate($valuesCriteria, $con); - } - - /** - * Retrieves a field from the object by name passed in as a string. - * - * @param string $name name - * @param string $type The type of fieldname the $name is of: - * one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME - * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. - * Defaults to TableMap::TYPE_PHPNAME. - * @return mixed Value of field. - */ - public function getByName($name, $type = TableMap::TYPE_PHPNAME) - { - $pos = MailjetNewsletterTableMap::translateFieldName($name, $type, TableMap::TYPE_NUM); - $field = $this->getByPosition($pos); - - return $field; - } - - /** - * Retrieves a field from the object by Position as specified in the xml schema. - * Zero-based. - * - * @param int $pos position in xml schema - * @return mixed Value of field at $pos - */ - public function getByPosition($pos) - { - switch ($pos) { - case 0: - return $this->getId(); - break; - case 1: - return $this->getMailjetId(); - break; - case 2: - return $this->getEmail(); - break; - case 3: - return $this->getRelationId(); - break; - default: - return null; - break; - } // switch() - } - - /** - * Exports the object as an array. - * - * You can specify the key type of the array by passing one of the class - * type constants. - * - * @param string $keyType (optional) One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, - * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. - * Defaults to TableMap::TYPE_PHPNAME. - * @param boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE. - * @param array $alreadyDumpedObjects List of objects to skip to avoid recursion - * - * @return array an associative array containing the field names (as keys) and field values - */ - public function toArray($keyType = TableMap::TYPE_PHPNAME, $includeLazyLoadColumns = true, $alreadyDumpedObjects = array()) - { - if (isset($alreadyDumpedObjects['MailjetNewsletter'][$this->getPrimaryKey()])) { - return '*RECURSION*'; - } - $alreadyDumpedObjects['MailjetNewsletter'][$this->getPrimaryKey()] = true; - $keys = MailjetNewsletterTableMap::getFieldNames($keyType); - $result = array( - $keys[0] => $this->getId(), - $keys[1] => $this->getMailjetId(), - $keys[2] => $this->getEmail(), - $keys[3] => $this->getRelationId(), - ); - $virtualColumns = $this->virtualColumns; - foreach ($virtualColumns as $key => $virtualColumn) { - $result[$key] = $virtualColumn; - } - - - return $result; - } - - /** - * Sets a field from the object by name passed in as a string. - * - * @param string $name - * @param mixed $value field value - * @param string $type The type of fieldname the $name is of: - * one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME - * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. - * Defaults to TableMap::TYPE_PHPNAME. - * @return void - */ - public function setByName($name, $value, $type = TableMap::TYPE_PHPNAME) - { - $pos = MailjetNewsletterTableMap::translateFieldName($name, $type, TableMap::TYPE_NUM); - - return $this->setByPosition($pos, $value); - } - - /** - * Sets a field from the object by Position as specified in the xml schema. - * Zero-based. - * - * @param int $pos position in xml schema - * @param mixed $value field value - * @return void - */ - public function setByPosition($pos, $value) - { - switch ($pos) { - case 0: - $this->setId($value); - break; - case 1: - $this->setMailjetId($value); - break; - case 2: - $this->setEmail($value); - break; - case 3: - $this->setRelationId($value); - break; - } // switch() - } - - /** - * Populates the object using an array. - * - * This is particularly useful when populating an object from one of the - * request arrays (e.g. $_POST). This method goes through the column - * names, checking to see whether a matching key exists in populated - * array. If so the setByName() method is called for that column. - * - * You can specify the key type of the array by additionally passing one - * of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, - * TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. - * The default key type is the column's TableMap::TYPE_PHPNAME. - * - * @param array $arr An array to populate the object from. - * @param string $keyType The type of keys the array uses. - * @return void - */ - public function fromArray($arr, $keyType = TableMap::TYPE_PHPNAME) - { - $keys = MailjetNewsletterTableMap::getFieldNames($keyType); - - if (array_key_exists($keys[0], $arr)) $this->setId($arr[$keys[0]]); - if (array_key_exists($keys[1], $arr)) $this->setMailjetId($arr[$keys[1]]); - if (array_key_exists($keys[2], $arr)) $this->setEmail($arr[$keys[2]]); - if (array_key_exists($keys[3], $arr)) $this->setRelationId($arr[$keys[3]]); - } - - /** - * Build a Criteria object containing the values of all modified columns in this object. - * - * @return Criteria The Criteria object containing all modified values. - */ - public function buildCriteria() - { - $criteria = new Criteria(MailjetNewsletterTableMap::DATABASE_NAME); - - if ($this->isColumnModified(MailjetNewsletterTableMap::ID)) $criteria->add(MailjetNewsletterTableMap::ID, $this->id); - if ($this->isColumnModified(MailjetNewsletterTableMap::MAILJET_ID)) $criteria->add(MailjetNewsletterTableMap::MAILJET_ID, $this->mailjet_id); - if ($this->isColumnModified(MailjetNewsletterTableMap::EMAIL)) $criteria->add(MailjetNewsletterTableMap::EMAIL, $this->email); - if ($this->isColumnModified(MailjetNewsletterTableMap::RELATION_ID)) $criteria->add(MailjetNewsletterTableMap::RELATION_ID, $this->relation_id); - - return $criteria; - } - - /** - * Builds a Criteria object containing the primary key for this object. - * - * Unlike buildCriteria() this method includes the primary key values regardless - * of whether or not they have been modified. - * - * @return Criteria The Criteria object containing value(s) for primary key(s). - */ - public function buildPkeyCriteria() - { - $criteria = new Criteria(MailjetNewsletterTableMap::DATABASE_NAME); - $criteria->add(MailjetNewsletterTableMap::ID, $this->id); - - return $criteria; - } - - /** - * Returns the primary key for this object (row). - * @return int - */ - public function getPrimaryKey() - { - return $this->getId(); - } - - /** - * Generic method to set the primary key (id column). - * - * @param int $key Primary key. - * @return void - */ - public function setPrimaryKey($key) - { - $this->setId($key); - } - - /** - * Returns true if the primary key for this object is null. - * @return boolean - */ - public function isPrimaryKeyNull() - { - - return null === $this->getId(); - } - - /** - * Sets contents of passed object to values from current object. - * - * If desired, this method can also make copies of all associated (fkey referrers) - * objects. - * - * @param object $copyObj An object of \Mailjet\Model\MailjetNewsletter (or compatible) type. - * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. - * @param boolean $makeNew Whether to reset autoincrement PKs and make the object new. - * @throws PropelException - */ - public function copyInto($copyObj, $deepCopy = false, $makeNew = true) - { - $copyObj->setMailjetId($this->getMailjetId()); - $copyObj->setEmail($this->getEmail()); - $copyObj->setRelationId($this->getRelationId()); - if ($makeNew) { - $copyObj->setNew(true); - $copyObj->setId(NULL); // this is a auto-increment column, so set to default value - } - } - - /** - * Makes a copy of this object that will be inserted as a new row in table when saved. - * It creates a new object filling in the simple attributes, but skipping any primary - * keys that are defined for the table. - * - * If desired, this method can also make copies of all associated (fkey referrers) - * objects. - * - * @param boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. - * @return \Mailjet\Model\MailjetNewsletter Clone of current object. - * @throws PropelException - */ - public function copy($deepCopy = false) - { - // we use get_class(), because this might be a subclass - $clazz = get_class($this); - $copyObj = new $clazz(); - $this->copyInto($copyObj, $deepCopy); - - return $copyObj; - } - - /** - * Clears the current object and sets all attributes to their default values - */ - public function clear() - { - $this->id = null; - $this->mailjet_id = null; - $this->email = null; - $this->relation_id = null; - $this->alreadyInSave = false; - $this->clearAllReferences(); - $this->resetModified(); - $this->setNew(true); - $this->setDeleted(false); - } - - /** - * Resets all references to other model objects or collections of model objects. - * - * This method is a user-space workaround for PHP's inability to garbage collect - * objects with circular references (even in PHP 5.3). This is currently necessary - * when using Propel in certain daemon or large-volume/high-memory operations. - * - * @param boolean $deep Whether to also clear the references on all referrer objects. - */ - public function clearAllReferences($deep = false) - { - if ($deep) { - } // if ($deep) - - } - - /** - * Return the string representation of this object - * - * @return string - */ - public function __toString() - { - return (string) $this->exportTo(MailjetNewsletterTableMap::DEFAULT_STRING_FORMAT); - } - - /** - * Code to be run before persisting the object - * @param ConnectionInterface $con - * @return boolean - */ - public function preSave(ConnectionInterface $con = null) - { - return true; - } - - /** - * Code to be run after persisting the object - * @param ConnectionInterface $con - */ - public function postSave(ConnectionInterface $con = null) - { - - } - - /** - * Code to be run before inserting to database - * @param ConnectionInterface $con - * @return boolean - */ - public function preInsert(ConnectionInterface $con = null) - { - return true; - } - - /** - * Code to be run after inserting to database - * @param ConnectionInterface $con - */ - public function postInsert(ConnectionInterface $con = null) - { - - } - - /** - * Code to be run before updating the object in database - * @param ConnectionInterface $con - * @return boolean - */ - public function preUpdate(ConnectionInterface $con = null) - { - return true; - } - - /** - * Code to be run after updating the object in database - * @param ConnectionInterface $con - */ - public function postUpdate(ConnectionInterface $con = null) - { - - } - - /** - * Code to be run before deleting the object in database - * @param ConnectionInterface $con - * @return boolean - */ - public function preDelete(ConnectionInterface $con = null) - { - return true; - } - - /** - * Code to be run after deleting the object in database - * @param ConnectionInterface $con - */ - public function postDelete(ConnectionInterface $con = null) - { - - } - - - /** - * Derived method to catches calls to undefined methods. - * - * Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). - * Allows to define default __call() behavior if you overwrite __call() - * - * @param string $name - * @param mixed $params - * - * @return array|string - */ - public function __call($name, $params) - { - if (0 === strpos($name, 'get')) { - $virtualColumn = substr($name, 3); - if ($this->hasVirtualColumn($virtualColumn)) { - return $this->getVirtualColumn($virtualColumn); - } - - $virtualColumn = lcfirst($virtualColumn); - if ($this->hasVirtualColumn($virtualColumn)) { - return $this->getVirtualColumn($virtualColumn); - } - } - - if (0 === strpos($name, 'from')) { - $format = substr($name, 4); - - return $this->importFrom($format, reset($params)); - } - - if (0 === strpos($name, 'to')) { - $format = substr($name, 2); - $includeLazyLoadColumns = isset($params[0]) ? $params[0] : true; - - return $this->exportTo($format, $includeLazyLoadColumns); - } - - throw new BadMethodCallException(sprintf('Call to undefined method: %s.', $name)); - } - -} diff --git a/local/modules/Mailjet/Model/Base/MailjetNewsletterQuery.php b/local/modules/Mailjet/Model/Base/MailjetNewsletterQuery.php deleted file mode 100644 index a4769d41..00000000 --- a/local/modules/Mailjet/Model/Base/MailjetNewsletterQuery.php +++ /dev/null @@ -1,455 +0,0 @@ -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. - * - * - * $obj = $c->findPk(12, $con); - * - * - * @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 - * - * $objs = $c->findPks(array(12, 56, 832), $con); - * - * @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: - * - * $query->filterById(1234); // WHERE id = 1234 - * $query->filterById(array(12, 34)); // WHERE id IN (12, 34) - * $query->filterById(array('min' => 12)); // WHERE id > 12 - * - * - * @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: - * - * $query->filterByMailjetId('fooValue'); // WHERE mailjet_id = 'fooValue' - * $query->filterByMailjetId('%fooValue%'); // WHERE mailjet_id LIKE '%fooValue%' - * - * - * @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: - * - * $query->filterByEmail('fooValue'); // WHERE email = 'fooValue' - * $query->filterByEmail('%fooValue%'); // WHERE email LIKE '%fooValue%' - * - * - * @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: - * - * $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 - * - * - * @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 diff --git a/local/modules/Mailjet/Model/MailjetNewsletter.php b/local/modules/Mailjet/Model/MailjetNewsletter.php deleted file mode 100644 index 996483f0..00000000 --- a/local/modules/Mailjet/Model/MailjetNewsletter.php +++ /dev/null @@ -1,10 +0,0 @@ - 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(); diff --git a/local/modules/Mailjet/README.md b/local/modules/Mailjet/README.md deleted file mode 100644 index 66dd7874..00000000 --- a/local/modules/Mailjet/README.md +++ /dev/null @@ -1,36 +0,0 @@ -Mailjet for Thelia -=== -Authors: -- Benjamin Perche -- Franck Allimant - -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 ! diff --git a/local/modules/Mailjet/templates/backOffice/default/mailjet-configuration.html b/local/modules/Mailjet/templates/backOffice/default/mailjet-configuration.html deleted file mode 100644 index d7cc1c69..00000000 --- a/local/modules/Mailjet/templates/backOffice/default/mailjet-configuration.html +++ /dev/null @@ -1,33 +0,0 @@ -
-
-
- {intl d="mailjet.bo.default" l="Configure mailjet"} -
- - {if $success} -
- {intl l="Configuration correctly saved" d="mailjet.bo.default"} -
- {/if} - - {form name="mailjet.configuration"} -
- {include "includes/inner-form-toolbar.html" hide_flags = 1 close_url={url path='/admin/modules'}} -
- - {form_field field="success_url"} - - {/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} -
\ No newline at end of file