Current path: home/webdevt/prestashop17/src/PrestaShopBundle/Form/Admin/Configure/ShopParameters/TrafficSeo/Meta/
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
*/
namespace PrestaShopBundle\Form\Admin\Configure\ShopParameters\TrafficSeo\Meta;
use PrestaShop\PrestaShop\Adapter\Routes\RouteValidator;
use PrestaShop\PrestaShop\Adapter\Validate;
use PrestaShop\PrestaShop\Core\Configuration\DataConfigurationInterface;
use PrestaShop\PrestaShop\Core\Form\FormDataProviderInterface;
use PrestaShopException;
use Symfony\Component\Translation\TranslatorInterface;
/**
* Class MetaSettingsFormDataProvider is responsible for providing configurations data and responsible for persisting data
* in configuration database.
*
* @deprecated since 1.7.8, will be removed in the next major version
*/
final class MetaSettingsFormDataProvider implements FormDataProviderInterface
{
/**
* @var DataConfigurationInterface
*/
private $setUpUrlDataConfiguration;
/**
* @var DataConfigurationInterface
*/
private $shopUrlsDataConfiguration;
/**
* @var DataConfigurationInterface
*/
private $urlSchemaDataConfiguration;
/**
* @var DataConfigurationInterface
*/
private $seoOptionsDataConfiguration;
/**
* @var RouteValidator
*/
private $routeValidator;
/**
* @var TranslatorInterface
*/
private $translator;
/**
* @var Validate
*/
private $validate;
/**
* MetaFormDataProvider constructor.
*
* @param DataConfigurationInterface $setUpUrlDataConfiguration
* @param DataConfigurationInterface $shopUrlsDataConfiguration
* @param DataConfigurationInterface $urlSchemaDataConfiguration
* @param DataConfigurationInterface $seoOptionsDataConfiguration
* @param TranslatorInterface $translator
* @param RouteValidator $routeValidator
* @param Validate $validate
*/
public function __construct(
DataConfigurationInterface $setUpUrlDataConfiguration,
DataConfigurationInterface $shopUrlsDataConfiguration,
DataConfigurationInterface $urlSchemaDataConfiguration,
DataConfigurationInterface $seoOptionsDataConfiguration,
TranslatorInterface $translator,
RouteValidator $routeValidator,
Validate $validate
) {
$this->setUpUrlDataConfiguration = $setUpUrlDataConfiguration;
$this->shopUrlsDataConfiguration = $shopUrlsDataConfiguration;
$this->urlSchemaDataConfiguration = $urlSchemaDataConfiguration;
$this->seoOptionsDataConfiguration = $seoOptionsDataConfiguration;
$this->routeValidator = $routeValidator;
$this->translator = $translator;
$this->validate = $validate;
}
/**
* {@inheritdoc}
*/
public function getData()
{
return [
'set_up_urls' => $this->setUpUrlDataConfiguration->getConfiguration(),
'shop_urls' => $this->shopUrlsDataConfiguration->getConfiguration(),
'url_schema' => $this->urlSchemaDataConfiguration->getConfiguration(),
'seo_options' => $this->seoOptionsDataConfiguration->getConfiguration(),
];
}
/**
* {@inheritdoc}
*/
public function setData(array $data)
{
$errors = $this->validateData($data);
if (!empty($errors)) {
return $errors;
}
return array_merge(
$this->setUpUrlDataConfiguration->updateConfiguration($data['set_up_urls']),
$this->shopUrlsDataConfiguration->updateConfiguration($data['shop_urls']),
$this->urlSchemaDataConfiguration->updateConfiguration($data['url_schema']),
$this->seoOptionsDataConfiguration->updateConfiguration($data['seo_options'])
);
}
/**
* Implements custom validation for configuration form.
*
* @param array $data
*
* @return array - if array is not empty then error strings are returned
*
* @throws PrestaShopException
*/
private function validateData(array $data)
{
$urlSchemaErrors = $this->validateUrlSchema($data['url_schema']);
$shopUrlErrors = $this->validateShopUrl($data['shop_urls']);
return array_merge(
$urlSchemaErrors,
$shopUrlErrors
);
}
/**
* Validates if configuration matches route pattern and if route has mandatory fields.
*
* @param array $configuration
*
* @return array
*
* @throws PrestaShopException
*/
private function validateUrlSchema(array $configuration)
{
$patternErrors = [];
$requiredFieldErrors = [];
foreach ($configuration as $routeId => $rule) {
if (!$this->routeValidator->isRoutePattern($rule)) {
$patternErrors[] = $this->translator->trans(
'The route %routeRule% is not valid',
[
'%routeRule%' => htmlspecialchars($rule),
],
'Admin.Shopparameters.Feature'
);
}
$missingKeywords = $this->routeValidator->doesRouteContainsRequiredKeywords($routeId, $rule);
if (!empty($missingKeywords)) {
foreach ($missingKeywords as $keyword) {
$requiredFieldErrors[] = $this->translator->trans(
'Keyword "{%keyword%}" required for route "%routeName%" (rule: "%routeRule%")',
[
'%keyword%' => $keyword,
'%routeName%' => $routeId,
'%routeRule%' => $rule,
],
'Admin.Shopparameters.Feature'
);
}
}
}
if (!empty($patternErrors)) {
return $patternErrors;
}
return $requiredFieldErrors;
}
/**
* Validates shop url form data.
*
* @param array $configuration
*
* @return array
*/
private function validateShopUrl(array $configuration)
{
$errors = [];
if (!$this->validate->isCleanHtml($configuration['domain'])) {
$errors[] = $this->translator->trans(
'This domain is not valid.',
[],
'Admin.Notifications.Error'
);
}
if (!$this->validate->isCleanHtml($configuration['domain_ssl'])) {
$errors[] = $this->translator->trans(
'The SSL domain is not valid.',
[],
'Admin.Notifications.Error'
);
}
return $errors;
}
}