ref #92124 Added currency validation (#260)

This commit is contained in:
Uryvskiy Dima 2023-10-06 14:00:10 +03:00 committed by GitHub
parent 571263ca2c
commit 3a30986e4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 101 additions and 88 deletions

View File

@ -1,3 +1,6 @@
## v4.1.14
* Added currency validation when configuring the module
## v4.1.13
* Changed the logic of customer subscriptions to promotional newsletters

View File

@ -1 +1 @@
4.1.13
4.1.14

View File

@ -2,7 +2,7 @@
class ControllerExtensionModuleRetailcrm extends Controller
{
private $_error = array();
private $_error = [];
protected $log, $statuses, $payments, $deliveryTypes, $retailcrmApiClient, $moduleTitle, $tokenTitle;
public $children, $template;
@ -25,10 +25,10 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->model_setting_setting->editSetting(
$this->moduleTitle,
array(
[
$this->moduleTitle . '_status' => 1,
$this->moduleTitle . '_country' => array($this->config->get('config_country_id'))
)
$this->moduleTitle . '_country' => [$this->config->get('config_country_id')]
]
);
$this->addEvents();
@ -59,7 +59,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->uninstall_collector();
$this->model_setting_setting->editSetting(
$this->moduleTitle,
array($this->moduleTitle . '_status' => 0)
[$this->moduleTitle . '_status' => 0]
);
}
@ -79,7 +79,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->loadModels();
$this->load->model('setting/setting');
$this->{'model_' . $this->modelExtension}->install('analytics', 'daemon_collector');
$this->model_setting_setting->editSetting($collector, array($collector . '_status' => 1));
$this->model_setting_setting->editSetting($collector, [$collector . '_status' => 1]);
}
/**
@ -92,7 +92,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$collector = $this->getCollectorTitle();
$this->loadModels();
$this->load->model('setting/setting');
$this->model_setting_setting->editSetting($collector, array($collector . '_status' => 0));
$this->model_setting_setting->editSetting($collector, [$collector . '_status' => 0]);
$this->{'model_' . $this->modelExtension}->uninstall('analytics', 'daemon_collector');
}
@ -107,7 +107,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->loadModels();
$this->load->model('setting/setting');
$this->{'model_' . $this->modelExtension}->install('analytics', 'online_consultant');
$this->model_setting_setting->editSetting($consultant, array($consultant . '_status' => 1));
$this->model_setting_setting->editSetting($consultant, [$consultant . '_status' => 1]);
}
/**
@ -120,7 +120,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$consultant = $this->getConsultantTitle();
$this->loadModels();
$this->load->model('setting/setting');
$this->model_setting_setting->editSetting($consultant, array($consultant . '_status' => 0));
$this->model_setting_setting->editSetting($consultant, [$consultant . '_status' => 0]);
$this->{'model_' . $this->modelExtension}->uninstall('analytics', 'online_consultant');
}
@ -221,12 +221,12 @@ class ControllerExtensionModuleRetailcrm extends Controller
if ($result === true) {
$this->model_setting_setting->editSetting(
'retailcrm_setting',
array(
[
'retailcrm_setting_active_in_crm' => true,
'retailcrm_setting_client_id' => $clientId,
'retailcrm_setting_url' => $this->request->post[$this->moduleTitle . '_url'],
'retailcrm_setting_key' => $this->request->post[$this->moduleTitle . '_apikey']
)
]
);
}
}
@ -240,7 +240,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->response->redirect($redirect);
}
$text_strings = array(
$text_strings = [
'heading_title',
'text_enabled',
'text_disabled',
@ -312,8 +312,8 @@ class ControllerExtensionModuleRetailcrm extends Controller
'text_retailcrm_label_discount',
'default_retailcrm_label_discount',
'sum_payment',
'text_sum_payment'
);
'text_sum_payment',
];
$_data = &$data;
@ -322,18 +322,16 @@ class ControllerExtensionModuleRetailcrm extends Controller
}
$_data['currencies'] = $this->model_localisation_currency->getCurrencies(0);
$_data['retailcrm_errors'] = array();
$_data['retailcrm_errors'] = [];
$_data['saved_settings'] = $this->model_setting_setting
->getSetting($this->moduleTitle);
$url = isset($_data['saved_settings'][$this->moduleTitle . '_url'])
? $_data['saved_settings'][$this->moduleTitle . '_url']
: null;
$key = isset($_data['saved_settings'][$this->moduleTitle . '_apikey'])
? $_data['saved_settings'][$this->moduleTitle . '_apikey']
: null;
$url = $_data['saved_settings'][$this->moduleTitle . '_url'] ?? null;
$key = $_data['saved_settings'][$this->moduleTitle . '_apikey'] ?? null;
if (!empty($url) && !empty($key)) {
$this->validate($url, $key);
$site = $this->model_extension_retailcrm_references->getApiSite();
$_data['delivery'] = $this->getAvailableTypes(
$site,
@ -354,9 +352,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$_data['customerGroups'] = $this->model_customer_customer_group->getCustomerGroups();
}
$config_data = array(
$this->moduleTitle . '_status'
);
$config_data = [$this->moduleTitle . '_status'];
foreach ($config_data as $conf) {
if (isset($this->request->post[$conf])) {
@ -366,40 +362,35 @@ class ControllerExtensionModuleRetailcrm extends Controller
}
}
if (isset($this->_error['warning'])) {
$_data['error_warning'] = $this->_error['warning'];
} else {
$_data['error_warning'] = '';
}
$_data['error_warning'] = $this->_error['warning'] ?? '';
$_data['breadcrumbs'] = [];
$_data['breadcrumbs'] = array();
$_data['breadcrumbs'][] = array(
$_data['breadcrumbs'][] = [
'text' => $this->language->get('text_home'),
'href' => $this->url->link(
'common/dashboard',
$this->tokenTitle . '=' . $this->session->data[$this->tokenTitle], 'SSL'
),
'separator' => false
);
];
$_data['breadcrumbs'][] = array(
$_data['breadcrumbs'][] = [
'text' => $this->language->get('text_module'),
'href' => $this->url->link(
'extension/extension',
$this->tokenTitle . '=' . $this->session->data[$this->tokenTitle], 'SSL'
),
'separator' => ' :: '
);
];
$_data['breadcrumbs'][] = array(
$_data['breadcrumbs'][] = [
'text' => $this->language->get('retailcrm_title'),
'href' => $this->url->link(
'extension/module/retailcrm',
$this->tokenTitle . '=' . $this->session->data[$this->tokenTitle], 'SSL'
),
'separator' => ' :: '
);
];
$_data['action'] = $this->url->link(
'extension/module/retailcrm',
@ -411,7 +402,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->tokenTitle . '=' . $this->session->data[$this->tokenTitle], 'SSL'
);
$_data['modules'] = array();
$_data['modules'] = [];
if (isset($this->request->post['retailcrm_module'])) {
$_data['modules'] = $this->request->post['retailcrm_module'];
@ -435,11 +426,11 @@ class ControllerExtensionModuleRetailcrm extends Controller
$_data['export_file'] = true;
}
$collectorFields = array(
$collectorFields = [
'name' => $this->language->get('field_name'),
'email' => $this->language->get('field_email'),
'phone' => $this->language->get('field_phone')
);
];
$_data['collectorFields'] = $collectorFields;
@ -558,20 +549,12 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->response->setOutput(
json_encode(
array(
'status_code' => $response->getStatusCode(),
'error_msg' => $error
)
['status_code' => $response->getStatusCode(), 'error_msg' => $error],
JSON_THROW_ON_ERROR
)
);
} else {
$this->response->setOutput(
json_encode(
array(
'status_code' => $response->getStatusCode()
)
)
);
$this->response->setOutput(json_encode(['status_code' => $response->getStatusCode()]));
}
}
}
@ -591,7 +574,7 @@ class ControllerExtensionModuleRetailcrm extends Controller
$this->model_extension_retailcrm_customer->uploadToCrm($customers, $this->retailcrm->getApiClient());
$orders = $this->model_sale_order->getOrders();
$fullOrders = array();
$fullOrders = [];
foreach ($orders as $order) {
$fullOrder = $this->model_sale_order->getOrder($order['order_id']);
@ -634,39 +617,57 @@ class ControllerExtensionModuleRetailcrm extends Controller
*
* @return bool
*/
private function validate()
private function validate($apiUrl = null, $apiKey = null)
{
if (!empty($this->request->post[$this->moduleTitle . '_url']) && !empty($this->request->post[$this->moduleTitle . '_apikey'])) {
$apiClient = $this->retailcrm->getApiClient(
$this->request->post[$this->moduleTitle . '_url'],
$this->request->post[$this->moduleTitle . '_apikey']
$warningMessage = '';
$apiUrl = $this->request->post[$this->moduleTitle . '_url'] ?? $apiUrl;
$apiKey = $this->request->post[$this->moduleTitle . '_apikey'] ?? $apiKey;
try {
if ( !empty($apiUrl) && !empty($apiKey)) {
$apiClient = $this->retailcrm->getApiClient($apiUrl, $apiKey);
$response = $apiClient->sitesList();
if (empty($response['sites']) || !$response->isSuccessful()) {
$warningMessage = 'text_error_api_key';
} elseif (count($response['sites']) > 1) {
$warningMessage = 'text_error_api_key_site';
} else {
$site = current($response['sites']);
if ($this->config->get('config_currency') !== $site['currency']) {
$warningMessage = 'text_error_api_key_currency';
}
}
if (!$this->user->hasPermission('modify', 'extension/module/retailcrm')) {
$this->_error['warning'] = $this->language->get('error_permission');
}
if (isset($this->request->post[$this->moduleTitle . '_collector']['custom']) &&
$this->request->post[$this->moduleTitle . '_collector']['custom_form'] == 1) {
$customField = $this->request->post[$this->moduleTitle . '_collector']['custom'];
if (empty($customField['name']) && empty($customField['email']) && empty($customField['phone'])) {
$this->_error['fields'] = $this->language->get('text_error_collector_fields');
}
}
} else {
$warningMessage = 'text_error_api_empty';
}
} catch (Throwable $exception) {
$warningMessage = sprintf(
'An error has occurred! In file: %s, on line: %s. Error message: %s',
$exception->getFile(), $exception->getLine(), $exception->getMessage()
);
}
$response = $apiClient->apiVersions();
if (!$response || !$response->isSuccessful()) {
$this->_error['warning'] = $this->language->get('text_error_api');
if ('' !== $warningMessage) {
$this->_error['warning'] = $this->language->get($warningMessage);
}
if (!$this->user->hasPermission('modify', 'extension/module/retailcrm')) {
$this->_error['warning'] = $this->language->get('error_permission');
}
if (isset($this->request->post[$this->moduleTitle . '_collector']['custom']) &&
$this->request->post[$this->moduleTitle . '_collector']['custom_form'] == 1) {
$customField = $this->request->post[$this->moduleTitle . '_collector']['custom'];
if (empty($customField['name']) && empty($customField['email']) && empty($customField['phone'])) {
$this->_error['fields'] = $this->language->get('text_error_collector_fields');
}
}
if (!$this->_error) {
return true;
} else {
return false;
}
return empty($this->_error);
}
/**
@ -902,15 +903,15 @@ class ControllerExtensionModuleRetailcrm extends Controller
$name = 'Opencart';
$accountUrl = $scheme . $this->request->server['HTTP_HOST'] . '/admin';
$configuration = array(
$configuration = [
'clientId' => $clientId,
'code' => $integrationCode . '-' . $clientId,
'integrationCode' => $integrationCode,
'active' => $active,
'name' => $name,
'logo' => $logo,
'accountUrl' => $accountUrl
);
'accountUrl' => $accountUrl,
];
$response = $apiClient->integrationModulesEdit($configuration);

View File

@ -50,8 +50,11 @@ $_['text_payment'] = 'Payment';
$_['text_shipping'] = 'Delivery';
$_['text_orders_custom_fields'] = 'Custom fields of orders';
$_['text_customers_custom_fields'] = 'Custom fields of customers';
$_['text_error_collector_fields']= 'Fill in the names of fields of Demon Collector form';
$_['text_error_api'] = 'The selected API version is not available.';
$_['text_error_collector_fields'] = 'Fill in the names of fields of Demon Collector form';
$_['text_error_api_empty'] = 'The "RetailCRM URL" and "RetailCRM API key" fields cannot be empty, enter the correct value';
$_['text_error_api_key'] = 'Invalid API key';
$_['text_error_api_key_site'] = 'API key with one-shop access required';
$_['text_error_api_key_currency'] = 'The currency of the site differs from the currency of the store in CRM. For the integration to work correctly, the currencies in CRM and CMS must match';
$_['text_error_custom_field'] = 'Create custom fields on a customer page in Opencart and RetailCRM in order to set up their transfer';
$_['text_error_cf_opencart'] = 'There are no custom fields in Opencart';
$_['text_error_cf_retailcrm'] = 'There are no custom fields in RetailCRM';

View File

@ -51,7 +51,10 @@ $_['text_shipping'] = 'Envío';
$_['text_orders_custom_fields'] = 'Los campos de pedidos personalizados';
$_['text_customers_custom_fields'] = 'Los campos de clientes personalizados';
$_['text_error_collector_fields']= 'Rellene los nombres de los campos del formulario Daemon Collector';
$_['text_error_api'] = 'La versión seleccionada de la API no está disponible.';
$_['text_error_api_empty'] = 'Los campos "URL de RetailCRM" y "Clave de API de RetailCRM" no pueden estar vacíos, ingrese el valor correcto';
$_['text_error_api_key'] = 'Clave API del CRM no válida';
$_['text_error_api_key_site'] = 'Se requiere clave API con acceso a una tienda';
$_['text_error_api_key_currency'] = 'La moneda del sitio web es distinto a la tienda del CRM. Para el funcionamiento correcto de la integración, las monedas del CMS y CRM deben coincid';
$_['text_error_custom_field'] = 'Cree campos personalizados en la ficha del cliente en Opencart y RetailCRM para configurar sus transmisión.';
$_['text_error_cf_opencart'] = 'Faltan campos personalizados en Opencart';
$_['text_error_cf_retailcrm'] = 'Faltan campos personalizados en RetailCRM';

View File

@ -50,8 +50,11 @@ $_['text_payment'] = 'Оплата';
$_['text_shipping'] = 'Доставка';
$_['text_orders_custom_fields'] = 'Кастомные поля заказов';
$_['text_customers_custom_fields'] = 'Кастомные поля клиентов';
$_['text_error_collector_fields']= 'Заполните названия полей формы Демон Collector';
$_['text_error_api'] = 'Недоступна выбранная версия API.';
$_['text_error_collector_fields'] = 'Заполните названия полей формы Демон Collector';
$_['text_error_api_empty'] = 'Поля "URL RetailCRM" и "Ключ API RetailCRM" не могут быть пустыми, введите корректное значение';
$_['text_error_api_key'] = 'Неверный API ключ';
$_['text_error_api_key_site'] = 'Требуется API ключ с доступом к одному магазину';
$_['text_error_api_key_currency'] = 'Валюта сайта отличается от валюты магазина в CRM. Для корректной работы интеграции, валюты в CRM и CMS должны совпадать';
$_['text_error_custom_field'] = 'Создайте пользовательские поля в карточке клиента в Opencart и RetailCRM, чтобы настроить их передачу';
$_['text_error_cf_opencart'] = 'Отсутствуют пользовательские поля в Opencart';
$_['text_error_cf_retailcrm'] = 'Отсутствуют пользовательские поля в RetailCRM';