improve export filename (#2958)

This commit is contained in:
Kevin Papst
2021-11-19 18:53:43 +01:00
committed by GitHub
parent 56d02673ed
commit 859131308a
10 changed files with 199 additions and 10 deletions

View File

@@ -16,6 +16,7 @@ use App\Event\MetaDisplayEventInterface;
use App\Event\ProjectMetaDisplayEvent;
use App\Event\TimesheetMetaDisplayEvent;
use App\Event\UserPreferenceDisplayEvent;
use App\Export\ExportFilename;
use App\Export\ExportItemInterface;
use App\Repository\Query\CustomerQuery;
use App\Repository\Query\TimesheetQuery;
@@ -753,9 +754,10 @@ abstract class AbstractSpreadsheetRenderer
public function render(array $exportItems, TimesheetQuery $query): Response
{
$spreadsheet = $this->fromArrayToSpreadsheet($exportItems, $query);
$filename = $this->saveSpreadsheet($spreadsheet);
$file = $this->saveSpreadsheet($spreadsheet);
$filename = new ExportFilename($query);
return $this->getFileResponse($filename, 'kimai-export' . $this->getFileExtension());
return $this->getFileResponse($file, $filename->getFilename() . $this->getFileExtension());
}
/**

View File

@@ -10,6 +10,7 @@
namespace App\Export\Base;
use App\Export\ExportContext;
use App\Export\ExportFilename;
use App\Export\ExportItemInterface;
use App\Project\ProjectStatisticService;
use App\Repository\Query\TimesheetQuery;
@@ -94,8 +95,9 @@ class PDFRenderer
*/
public function render(array $timesheets, TimesheetQuery $query): Response
{
$filename = new ExportFilename($query);
$context = new ExportContext();
$context->setOption('filename', 'kimai-export');
$context->setOption('filename', $filename->getFilename());
$summary = $this->calculateSummary($timesheets);
$content = $this->twig->render($this->getTemplate(), array_merge([
@@ -117,7 +119,8 @@ class PDFRenderer
$filename = $context->getOption('filename');
if (empty($filename)) {
$filename = 'kimai-export';
$filename = new ExportFilename($query);
$filename = $filename->getFilename();
}
$filename = FileHelper::convertToAsciiFilename($filename);

View File

@@ -0,0 +1,82 @@
<?php
/*
* This file is part of the Kimai time-tracking app.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace App\Export;
use App\Entity\Customer;
use App\Repository\Query\TimesheetQuery;
use App\Utils\FileHelper;
final class ExportFilename
{
/**
* @var string
*/
private $filename;
public function __construct(TimesheetQuery $query)
{
$filename = date('Ymd');
$hasName = false;
$customers = $query->getCustomers();
if (\count($customers) === 1) {
$filename .= '-' . $this->convert($this->getCustomerName($customers[0]));
$hasName = true;
}
$projects = $query->getProjects();
if (\count($projects) === 1) {
if (!$hasName) {
$filename .= '-' . $this->convert($this->getCustomerName($projects[0]->getCustomer()));
}
$filename .= '-' . $this->convert($projects[0]->getName());
$hasName = true;
}
$users = $query->getUsers();
if (\count($users) === 1) {
$filename .= '-' . $this->convert($users[0]->getDisplayName());
$hasName = true;
}
if (!$hasName) {
$filename .= '-kimai-export';
}
$filename = str_replace(['/', '\\'], '-', $filename);
$this->filename = $filename;
}
private function getCustomerName(Customer $customer): string
{
$company = $customer->getCompany();
if (empty($company)) {
$company = $customer->getName();
}
return $company;
}
private function convert(string $filename): string
{
return FileHelper::convertToAsciiFilename($filename);
}
public function getFilename()
{
return $this->filename;
}
public function __toString()
{
return $this->getFilename();
}
}