DataWizard/Application/Model/ExportBase.php

275 regels
7.9 KiB
PHP

2021-04-16 14:04:30 +02:00
<?php
/**
2021-04-20 11:20:34 +02:00
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
2022-01-17 10:59:18 +01:00
*
2021-04-20 11:20:34 +02:00
* https://www.d3data.de
2021-04-16 14:04:30 +02:00
*
* @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
2021-04-20 11:20:34 +02:00
* @author D3 Data Development - Daniel Seifert <info@shopmodule.com>
* @link https://www.oxidmodule.com
2021-04-16 14:04:30 +02:00
*/
2021-04-20 09:57:44 +02:00
declare(strict_types=1);
2021-04-16 14:04:30 +02:00
namespace D3\DataWizard\Application\Model;
2024-05-13 15:26:19 +02:00
use Assert\Assert;
2021-07-14 12:21:12 +02:00
use D3\DataWizard\Application\Model\Exceptions\ExportFileException;
use D3\DataWizard\Application\Model\Exceptions\InputUnvalidException;
2024-03-04 13:57:10 +01:00
use D3\DataWizard\Application\Model\Exceptions\NoSuitableRendererException;
use D3\DataWizard\Application\Model\ExportRenderer\RendererBridge;
2024-03-04 13:57:10 +01:00
use D3\DataWizard\Application\Model\ExportRenderer\RendererInterface;
use D3\ModCfg\Application\Model\d3filesystem;
use D3\ModCfg\Application\Model\Exception\d3_cfg_mod_exception;
use D3\ModCfg\Application\Model\Exception\d3ShopCompatibilityAdapterException;
2024-03-04 13:57:10 +01:00
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\Exception;
use Doctrine\DBAL\Exception as DBALException;
use FormManager\Inputs\Checkbox;
use FormManager\Inputs\Input;
use FormManager\Inputs\Radio;
use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
use OxidEsales\Eshop\Core\Exception\DatabaseErrorException;
use OxidEsales\Eshop\Core\Exception\StandardException;
use OxidEsales\Eshop\Core\Registry;
2024-03-04 13:57:10 +01:00
use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory;
use OxidEsales\EshopCommunity\Internal\Framework\Database\ConnectionProviderInterface;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
2021-04-16 14:04:30 +02:00
abstract class ExportBase implements QueryBase
{
2024-03-04 13:57:10 +01:00
protected array $formElements = [];
/**
2021-10-31 23:16:03 +01:00
* Ensure that the translations are equally available in the frontend and the backend
* @return string
*/
2022-01-17 10:59:18 +01:00
public function getDescription(): string
{
return '';
}
2022-01-17 10:59:18 +01:00
/**
* @param string $format
2024-03-04 13:57:10 +01:00
* @param null $path
*
2024-03-04 13:57:10 +01:00
* @return string
* @throws ContainerExceptionInterface
* @throws DBALException
* @throws DatabaseConnectionException
* @throws DatabaseErrorException
2024-03-04 13:57:10 +01:00
* @throws Exception
* @throws NoSuitableRendererException
* @throws NotFoundExceptionInterface
* @throws StandardException
* @throws d3ShopCompatibilityAdapterException
* @throws d3_cfg_mod_exception
*/
2022-01-17 10:59:18 +01:00
public function run(string $format = RendererBridge::FORMAT_CSV, $path = null): string
2021-04-16 14:04:30 +02:00
{
if ($this->hasFormElements()) {
/** @var Input $element */
foreach ($this->getFormElements() as $element) {
if (false === $element->isValid()) {
throw oxNew(InputUnvalidException::class, $this, $element);
}
}
}
2021-11-28 23:02:15 +01:00
return $this->executeExport($format, $path);
2021-04-16 14:04:30 +02:00
}
/**
* @return string
*/
2022-01-17 10:59:18 +01:00
public function getButtonText(): string
2021-04-16 14:04:30 +02:00
{
return "D3_DATAWIZARD_EXPORT_SUBMIT";
}
/**
2024-03-04 13:57:10 +01:00
* @throws NoSuitableRendererException
*/
2024-03-04 13:57:10 +01:00
public function getRenderer(string $format): RendererInterface
{
return $this->getRendererBridge()->getRenderer($format);
}
2021-12-20 13:41:24 +01:00
public function getRendererBridge(): RendererBridge
{
return oxNew(RendererBridge::class);
}
/**
2024-03-04 13:57:10 +01:00
* @throws NoSuitableRendererException
*/
2024-03-04 13:57:10 +01:00
public function getFileExtension(string $format): string
{
return $this->getRenderer($format)->getFileExtension();
}
/**
* @param $rows
* @param $fieldnames
* @param $format
*
* @return string
* @throws Exceptions\NoSuitableRendererException
*/
public function renderContent($rows, $fieldnames, $format): string
{
$renderer = $this->getRenderer($format);
return $renderer->getContent($rows, $fieldnames);
}
2021-04-19 14:36:25 +02:00
/**
* @return string
*/
2022-01-17 10:59:18 +01:00
public function getExportFilenameBase(): string
{
return $this->getTitle();
}
2021-04-19 14:36:25 +02:00
/**
* @param $format
*
* @return string
* @throws Exceptions\NoSuitableRendererException
2021-04-19 14:36:25 +02:00
*/
2022-01-17 10:59:18 +01:00
public function getExportFileName($format): string
2021-04-19 14:36:25 +02:00
{
return $this->getExportFilenameBase().'_'.date('Y-m-d_H-i-s').'.'.$this->getFileExtension($format);
}
/**
* @param array $query
*
* @return array
2024-03-04 13:57:10 +01:00
* @throws DBALException
* @throws Exception
*/
2022-01-17 10:59:18 +01:00
public function getExportData(array $query): array
{
[ $queryString, $parameters ] = $query;
2024-05-13 15:26:19 +02:00
Assert::that($queryString)->string();
Assert::that($parameters)->isArray();
$queryString = trim($queryString);
2022-01-17 10:59:18 +01:00
if (strtolower(substr($queryString, 0, 6)) !== 'select') {
throw oxNew(
Exceptions\TaskException::class,
$this,
2022-01-17 10:59:18 +01:00
Registry::getLang()->translateString('D3_DATAWIZARD_ERR_NOEXPORTSELECT')
);
}
2024-05-10 16:48:29 +02:00
$rows = $this->getConnection()->executeQuery($queryString, $parameters)->fetchAllAssociative();
2022-01-17 10:59:18 +01:00
if (count($rows) <= 0) {
throw oxNew(
Exceptions\TaskException::class,
$this,
2022-01-17 10:59:18 +01:00
Registry::getLang()->translateString('D3_DATAWIZARD_ERR_NOEXPORTCONTENT', null, true)
);
}
2022-01-17 10:59:18 +01:00
$fieldNames = array_keys($rows[0]);
return [ $rows, $fieldNames ];
}
2024-05-10 16:48:29 +02:00
protected function getConnection(): Connection
{
return ContainerFactory::getInstance()->getContainer()->get(ConnectionProviderInterface::class)->get();
}
2024-03-04 13:57:10 +01:00
public function registerFormElement(Input $input): void
{
2021-11-28 23:02:15 +01:00
if ($input instanceof Radio || $input instanceof Checkbox) {
$input->setTemplate('<p class="form-check">{{ input }} {{ label }}</p>');
$input->setAttribute('class', 'form-check-input');
} else {
$input->setTemplate('<p class="formElements">{{ label }} {{ input }}</p>');
$input->setAttribute('class', 'form-control');
}
$this->formElements[] = $input;
}
/**
* @return bool
*/
public function hasFormElements(): bool
{
return (bool) count($this->formElements);
}
/**
* @return array
*/
public function getFormElements(): array
{
return $this->formElements;
}
2021-11-28 23:02:15 +01:00
/**
* @param string $format
2024-03-04 13:57:10 +01:00
* @param $path
*
2021-11-28 23:02:15 +01:00
* @return string
2024-03-04 13:57:10 +01:00
* @throws ContainerExceptionInterface
2021-11-28 23:02:15 +01:00
* @throws DBALException
* @throws DatabaseConnectionException
* @throws DatabaseErrorException
2024-03-04 13:57:10 +01:00
* @throws Exception
* @throws NoSuitableRendererException
* @throws NotFoundExceptionInterface
2021-11-28 23:02:15 +01:00
* @throws StandardException
* @throws d3ShopCompatibilityAdapterException
* @throws d3_cfg_mod_exception
*/
protected function executeExport(string $format, $path): string
{
2022-01-17 10:59:18 +01:00
$content = $this->getContent($format);
2021-11-28 23:02:15 +01:00
$oFS = $this->getFileSystem();
if (is_null($path)) {
$oFS->startDirectDownload($oFS->filterFilename($this->getExportFileName($format)), $content);
} else {
$filePath = $oFS->trailingslashit($path) . $oFS->filterFilename($this->getExportFileName($format));
2024-03-04 13:57:10 +01:00
if (false === $oFS->createFile($filePath, $content)) {
2021-11-28 23:02:15 +01:00
throw oxNew(ExportFileException::class, $filePath);
}
return $filePath;
}
return '';
}
2024-03-04 13:57:10 +01:00
protected function getFileSystem(): d3filesystem
2021-11-28 23:02:15 +01:00
{
return oxNew(d3filesystem::class);
}
/**
* @param string $format
*
* @return string
2024-03-04 13:57:10 +01:00
* @throws ContainerExceptionInterface
* @throws DBALException
* @throws Exception
* @throws NoSuitableRendererException
* @throws NotFoundExceptionInterface
*/
2022-01-17 10:59:18 +01:00
public function getContent(string $format): string
{
2022-01-17 10:59:18 +01:00
[ $rows, $fieldNames ] = $this->getExportData($this->getQuery());
2024-03-04 13:57:10 +01:00
return $this->renderContent($rows, $fieldNames, $format);
}
2022-01-17 10:59:18 +01:00
}