apply users timezone to toolbar queries (#716)

This commit is contained in:
Kevin Papst
2019-04-22 16:21:22 +02:00
committed by GitHub
parent 46cb021260
commit 215d4fc8bf
11 changed files with 69 additions and 81 deletions

View File

@@ -27,6 +27,7 @@ install:
- composer install - composer install
script: script:
- php -r "echo date(DATE_RFC850);"
- vendor/bin/phpunit tests/ - vendor/bin/phpunit tests/
- cp tests/.env.dist.sqlite .env - cp tests/.env.dist.sqlite .env
- bin/console doctrine:database:create -n - bin/console doctrine:database:create -n

View File

@@ -13,6 +13,7 @@ use App\Calendar\Service;
use App\Calendar\TimesheetEntity; use App\Calendar\TimesheetEntity;
use App\Entity\Timesheet; use App\Entity\Timesheet;
use App\Repository\Query\TimesheetQuery; use App\Repository\Query\TimesheetQuery;
use App\Repository\TimesheetRepository;
use App\Timesheet\UserDateTimeFactory; use App\Timesheet\UserDateTimeFactory;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
@@ -27,35 +28,16 @@ use Symfony\Component\Routing\Annotation\Route;
*/ */
class CalendarController extends AbstractController class CalendarController extends AbstractController
{ {
/**
* @var Service
*/
protected $calendar;
/**
* @var UserDateTimeFactory
*/
protected $dateTime;
/**
* @param Service $calendar
* @param UserDateTimeFactory $dateTime
*/
public function __construct(Service $calendar, UserDateTimeFactory $dateTime)
{
$this->calendar = $calendar;
$this->dateTime = $dateTime;
}
/** /**
* @Route(path="/", name="calendar", methods={"GET"}) * @Route(path="/", name="calendar", methods={"GET"})
* @Cache(smaxage="10") * @Cache(smaxage="10")
*/ */
public function userCalendar() public function userCalendar(Service $calendar, UserDateTimeFactory $dateTime)
{ {
return $this->render('calendar/user.html.twig', [ return $this->render('calendar/user.html.twig', [
'config' => $this->calendar->getConfig(), 'config' => $calendar->getConfig(),
'google' => $this->calendar->getGoogle(), 'google' => $calendar->getGoogle(),
'now' => $this->dateTime->createDateTime(), 'now' => $dateTime->createDateTime(),
]); ]);
} }
@@ -63,18 +45,18 @@ class CalendarController extends AbstractController
* @Route(path="/user", name="calendar_entries", methods={"GET"}) * @Route(path="/user", name="calendar_entries", methods={"GET"})
* @Cache(smaxage="10") * @Cache(smaxage="10")
*/ */
public function calendarEntries(Request $request) public function calendarEntries(Request $request, UserDateTimeFactory $dateTime, TimesheetRepository $repository)
{ {
$start = $request->get('start'); $start = $request->get('start');
$end = $request->get('end'); $end = $request->get('end');
$start = \DateTime::createFromFormat('Y-m-d', $start); $start = $dateTime->createDateTimeFromFormat('Y-m-d', $start);
if ($start === false) { if ($start === false) {
$start = new \DateTime('first day of this month'); $start = $dateTime->createDateTime('first day of this month');
} }
$start->setTime(0, 0, 0); $start->setTime(0, 0, 0);
$end = \DateTime::createFromFormat('Y-m-d', $end); $end = $dateTime->createDateTimeFromFormat('Y-m-d', $end);
if ($end === false) { if ($end === false) {
$end = clone $start; $end = clone $start;
$end = $end->modify('last day of this month'); $end = $end->modify('last day of this month');
@@ -90,8 +72,6 @@ class CalendarController extends AbstractController
->setEnd($end) ->setEnd($end)
; ;
$repository = $this->getDoctrine()->getRepository(Timesheet::class);
/* @var $entries Timesheet[] */ /* @var $entries Timesheet[] */
$entries = $repository->findByQuery($query)->getQuery()->execute(); $entries = $repository->findByQuery($query)->getQuery()->execute();
$result = []; $result = [];

View File

@@ -14,6 +14,7 @@ use App\Export\ServiceExport;
use App\Form\Toolbar\ExportToolbarForm; use App\Form\Toolbar\ExportToolbarForm;
use App\Repository\Query\ExportQuery; use App\Repository\Query\ExportQuery;
use App\Repository\TimesheetRepository; use App\Repository\TimesheetRepository;
use App\Timesheet\UserDateTimeFactory;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route; use Symfony\Component\Routing\Annotation\Route;
@@ -35,15 +36,20 @@ class ExportController extends AbstractController
* @var ServiceExport * @var ServiceExport
*/ */
protected $export; protected $export;
/**
* @var UserDateTimeFactory
*/
protected $dateFactory;
/** /**
* @param TimesheetRepository $timesheet * @param TimesheetRepository $timesheet
* @param ServiceExport $export * @param ServiceExport $export
*/ */
public function __construct(TimesheetRepository $timesheet, ServiceExport $export) public function __construct(TimesheetRepository $timesheet, ServiceExport $export, UserDateTimeFactory $dateTime)
{ {
$this->timesheetRepository = $timesheet; $this->timesheetRepository = $timesheet;
$this->export = $export; $this->export = $export;
$this->dateFactory = $dateTime;
} }
/** /**
@@ -52,8 +58,8 @@ class ExportController extends AbstractController
*/ */
protected function getDefaultQuery() protected function getDefaultQuery()
{ {
$begin = new \DateTime('first day of this month'); $begin = $this->dateFactory->createDateTime('first day of this month 00:00:00');
$end = new \DateTime('last day of this month'); $end = $this->dateFactory->createDateTime('last day of this month 23:59:59');
$query = new ExportQuery(); $query = new ExportQuery();
$query->setOrder(ExportQuery::ORDER_ASC); $query->setOrder(ExportQuery::ORDER_ASC);

View File

@@ -20,6 +20,7 @@ use App\Repository\Query\BaseQuery;
use App\Repository\Query\InvoiceQuery; use App\Repository\Query\InvoiceQuery;
use App\Repository\Query\TimesheetQuery; use App\Repository\Query\TimesheetQuery;
use App\Repository\TimesheetRepository; use App\Repository\TimesheetRepository;
use App\Timesheet\UserDateTimeFactory;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route; use Symfony\Component\Routing\Annotation\Route;
@@ -44,17 +45,17 @@ class InvoiceController extends AbstractController
* @var TimesheetRepository * @var TimesheetRepository
*/ */
protected $timesheetRepository; protected $timesheetRepository;
protected $dateTimeFactory;
/** /**
* @param ServiceInvoice $service * @param ServiceInvoice $service
* @param InvoiceTemplateRepository $invoice * @param InvoiceTemplateRepository $invoice
* @param TimesheetRepository $timesheet
*/ */
public function __construct(ServiceInvoice $service, InvoiceTemplateRepository $invoice, TimesheetRepository $timesheet) public function __construct(ServiceInvoice $service, InvoiceTemplateRepository $invoice, UserDateTimeFactory $dateTimeFactory)
{ {
$this->service = $service; $this->service = $service;
$this->invoiceRepository = $invoice; $this->invoiceRepository = $invoice;
$this->timesheetRepository = $timesheet; $this->dateTimeFactory = $dateTimeFactory;
} }
/** /**
@@ -63,8 +64,8 @@ class InvoiceController extends AbstractController
*/ */
protected function getDefaultQuery() protected function getDefaultQuery()
{ {
$begin = new \DateTime('first day of this month'); $begin = $this->dateTimeFactory->createDateTime('first day of this month');
$end = new \DateTime('last day of this month'); $end = $this->dateTimeFactory->createDateTime('last day of this month');
$query = new InvoiceQuery(); $query = new InvoiceQuery();
$query->setOrder(InvoiceQuery::ORDER_ASC); $query->setOrder(InvoiceQuery::ORDER_ASC);
@@ -83,7 +84,7 @@ class InvoiceController extends AbstractController
* @return \Symfony\Component\HttpFoundation\Response * @return \Symfony\Component\HttpFoundation\Response
* @throws \Exception * @throws \Exception
*/ */
public function indexAction(Request $request) public function indexAction(Request $request, TimesheetRepository $repository)
{ {
if (!$this->invoiceRepository->hasTemplate()) { if (!$this->invoiceRepository->hasTemplate()) {
return $this->redirectToRoute('admin_invoice_template_create'); return $this->redirectToRoute('admin_invoice_template_create');
@@ -98,7 +99,7 @@ class InvoiceController extends AbstractController
if ($form->isSubmitted() && $form->isValid()) { if ($form->isSubmitted() && $form->isValid()) {
/** @var InvoiceQuery $query */ /** @var InvoiceQuery $query */
$query = $form->getData(); $query = $form->getData();
$entries = $this->getEntries($query); $entries = $this->getEntries($query, $repository);
} }
$model = $this->prepareModel($query, $entries); $model = $this->prepareModel($query, $entries);
@@ -117,7 +118,7 @@ class InvoiceController extends AbstractController
* @return \Symfony\Component\HttpFoundation\Response * @return \Symfony\Component\HttpFoundation\Response
* @throws \Exception * @throws \Exception
*/ */
public function printAction(Request $request) public function printAction(Request $request, TimesheetRepository $repository)
{ {
if (!$this->invoiceRepository->hasTemplate()) { if (!$this->invoiceRepository->hasTemplate()) {
return $this->redirectToRoute('admin_invoice_template_create'); return $this->redirectToRoute('admin_invoice_template_create');
@@ -133,7 +134,7 @@ class InvoiceController extends AbstractController
/** @var InvoiceQuery $query */ /** @var InvoiceQuery $query */
$query = $form->getData(); $query = $form->getData();
$entries = $this->getEntries($query); $entries = $this->getEntries($query, $repository);
$model = $this->prepareModel($query, $entries); $model = $this->prepareModel($query, $entries);
$document = $this->service->getDocumentByName($model->getTemplate()->getRenderer()); $document = $this->service->getDocumentByName($model->getTemplate()->getRenderer());
@@ -159,7 +160,7 @@ class InvoiceController extends AbstractController
* @param InvoiceQuery $query * @param InvoiceQuery $query
* @return Timesheet[] * @return Timesheet[]
*/ */
protected function getEntries(InvoiceQuery $query) protected function getEntries(InvoiceQuery $query, TimesheetRepository $repository)
{ {
// customer needs to be defined, as we need the currency for the invoice // customer needs to be defined, as we need the currency for the invoice
if (null === $query->getCustomer()) { if (null === $query->getCustomer()) {
@@ -169,15 +170,15 @@ class InvoiceController extends AbstractController
$query->setResultType(TimesheetQuery::RESULT_TYPE_QUERYBUILDER); $query->setResultType(TimesheetQuery::RESULT_TYPE_QUERYBUILDER);
if (null === $query->getBegin()) { if (null === $query->getBegin()) {
$query->setBegin(new \DateTime('first day of this month')); $query->setBegin($this->dateTimeFactory->createDateTime('first day of this month'));
} }
if (null === $query->getEnd()) { if (null === $query->getEnd()) {
$query->setEnd(new \DateTime('last day of this month')); $query->setEnd($this->dateTimeFactory->createDateTime('last day of this month'));
} }
$query->getBegin()->setTime(0, 0, 0); $query->getBegin()->setTime(0, 0, 0);
$query->getEnd()->setTime(23, 59, 59); $query->getEnd()->setTime(23, 59, 59);
$queryBuilder = $this->timesheetRepository->findByQuery($query); $queryBuilder = $repository->findByQuery($query);
return $queryBuilder->getQuery()->getResult(); return $queryBuilder->getQuery()->getResult();
} }

View File

@@ -10,47 +10,27 @@
namespace App\Controller; namespace App\Controller;
use App\Repository\ActivityRepository; use App\Repository\ActivityRepository;
use App\Timesheet\UserDateTimeFactory;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security; use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\Response;
/** /**
* Controller used to manage navigation-bar contents. * Controller used to render recent activities and quick-start new recordings in the navigation-bar.
* *
* @Security("is_granted('ROLE_USER')") * @Security("is_granted('ROLE_USER')")
*/ */
class NavbarController extends AbstractController class NavbarController extends AbstractController
{ {
/**
* @var ActivityRepository
*/
private $repository;
/** /**
* @param ActivityRepository $repository * @param ActivityRepository $repository
*/ * @param UserDateTimeFactory $dateTimeFactory
public function __construct(ActivityRepository $repository)
{
$this->repository = $repository;
}
/**
* @return ActivityRepository
*/
protected function getRepository()
{
return $this->repository;
}
/**
* The flyout to render recent activities and quick-start new recordings.
*
* @return Response * @return Response
* @throws \Doctrine\ORM\Query\QueryException * @throws \Doctrine\ORM\Query\QueryException
*/ */
public function recentActivitiesAction() public function recentActivitiesAction(ActivityRepository $repository, UserDateTimeFactory $dateTimeFactory)
{ {
$user = $this->getUser(); $user = $this->getUser();
$entries = $this->getRepository()->getRecentActivities($user, new \DateTime('-1 year')); $entries = $repository->getRecentActivities($user, $dateTimeFactory->createDateTime('-1 year'));
return $this->render( return $this->render(
'navbar/recent-activities.html.twig', 'navbar/recent-activities.html.twig',

View File

@@ -94,12 +94,12 @@ class TimesheetController extends AbstractController
// by default the current month is exported, but it can be overwritten // by default the current month is exported, but it can be overwritten
if (null === $query->getBegin()) { if (null === $query->getBegin()) {
$query->setBegin(new \DateTime('first day of this month')); $query->setBegin($this->dateTime->createDateTime('first day of this month'));
} }
$query->getBegin()->setTime(0, 0, 0); $query->getBegin()->setTime(0, 0, 0);
if (null === $query->getEnd()) { if (null === $query->getEnd()) {
$query->setEnd(new \DateTime('last day of this month')); $query->setEnd($this->dateTime->createDateTime('last day of this month'));
} }
$query->getEnd()->setTime(23, 59, 59); $query->getEnd()->setTime(23, 59, 59);

View File

@@ -126,7 +126,7 @@ trait TimesheetControllerTrait
$start = $request->get('begin'); $start = $request->get('begin');
if ($start !== null) { if ($start !== null) {
$start = \DateTime::createFromFormat('Y-m-d', $start); $start = $this->dateTime->createDateTimeFromFormat('Y-m-d', $start);
if ($start !== false) { if ($start !== false) {
$start->setTime(10, 0, 0); // TODO make me configurable $start->setTime(10, 0, 0); // TODO make me configurable
$entry->setBegin($start); $entry->setBegin($start);
@@ -135,7 +135,7 @@ trait TimesheetControllerTrait
$end = $request->get('end'); $end = $request->get('end');
if ($end !== null) { if ($end !== null) {
$end = \DateTime::createFromFormat('Y-m-d', $end); $end = $this->dateTime->createDateTimeFromFormat('Y-m-d', $end);
if ($end !== false) { if ($end !== false) {
$end->setTime(18, 0, 0); // TODO make me configurable $end->setTime(18, 0, 0); // TODO make me configurable
$entry->setEnd($end); $entry->setEnd($end);
@@ -144,7 +144,7 @@ trait TimesheetControllerTrait
$from = $request->get('from'); $from = $request->get('from');
if ($from !== null) { if ($from !== null) {
$from = new \DateTime($from); $from = $this->dateTime->createDateTime($from);
if ($from !== false) { if ($from !== false) {
$entry->setBegin($from); $entry->setBegin($from);
} }
@@ -152,7 +152,7 @@ trait TimesheetControllerTrait
$to = $request->get('to'); $to = $request->get('to');
if ($to !== null) { if ($to !== null) {
$to = new \DateTime($to); $to = $this->dateTime->createDateTime($to);
if ($to !== false) { if ($to !== false) {
$entry->setEnd($to); $entry->setEnd($to);
} }

View File

@@ -89,12 +89,12 @@ class TimesheetTeamController extends AbstractController
// by default the current month is exported, but it can be overwritten // by default the current month is exported, but it can be overwritten
if (null === $query->getBegin()) { if (null === $query->getBegin()) {
$query->setBegin(new \DateTime('first day of this month')); $query->setBegin($this->dateTime->createDateTime('first day of this month'));
} }
$query->getBegin()->setTime(0, 0, 0); $query->getBegin()->setTime(0, 0, 0);
if (null === $query->getEnd()) { if (null === $query->getEnd()) {
$query->setEnd(new \DateTime('last day of this month')); $query->setEnd($this->dateTime->createDateTime('last day of this month'));
} }
$query->getEnd()->setTime(23, 59, 59); $query->getEnd()->setTime(23, 59, 59);

View File

@@ -29,6 +29,7 @@ class UTCDateTimeType extends DateTimeType
public function convertToDatabaseValue($value, AbstractPlatform $platform) public function convertToDatabaseValue($value, AbstractPlatform $platform)
{ {
if ($value instanceof \DateTime) { if ($value instanceof \DateTime) {
$value = clone $value;
$value->setTimezone(self::getUtc()); $value->setTimezone(self::getUtc());
} }

View File

@@ -10,6 +10,7 @@
namespace App\Form\Type; namespace App\Form\Type;
use App\Form\Model\DateRange; use App\Form\Model\DateRange;
use App\Timesheet\UserDateTimeFactory;
use App\Utils\LocaleSettings; use App\Utils\LocaleSettings;
use Symfony\Component\Form\AbstractType; use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\CallbackTransformer; use Symfony\Component\Form\CallbackTransformer;
@@ -30,13 +31,19 @@ class DateRangeType extends AbstractType
* @var LocaleSettings * @var LocaleSettings
*/ */
protected $localeSettings; protected $localeSettings;
/**
* @var UserDateTimeFactory
*/
protected $dateFactory;
/** /**
* @param LocaleSettings $localeSettings * @param LocaleSettings $localeSettings
* @param UserDateTimeFactory $dateTime
*/ */
public function __construct(LocaleSettings $localeSettings) public function __construct(LocaleSettings $localeSettings, UserDateTimeFactory $dateTime)
{ {
$this->localeSettings = $localeSettings; $this->localeSettings = $localeSettings;
$this->dateFactory = $dateTime;
} }
/** /**
@@ -164,13 +171,13 @@ class DateRangeType extends AbstractType
throw new TransformationFailedException('Invalid date range given'); throw new TransformationFailedException('Invalid date range given');
} }
$begin = \DateTime::createFromFormat($formatDate, $values[0]); $begin = \DateTime::createFromFormat($formatDate, $values[0], $this->dateFactory->getTimezone());
if ($begin === false) { if ($begin === false) {
throw new TransformationFailedException('Invalid begin date given'); throw new TransformationFailedException('Invalid begin date given');
} }
$range->setBegin($begin); $range->setBegin($begin);
$end = \DateTime::createFromFormat($formatDate, $values[1]); $end = \DateTime::createFromFormat($formatDate, $values[1], $this->dateFactory->getTimezone());
if ($end === false) { if ($end === false) {
throw new TransformationFailedException('Invalid end date given'); throw new TransformationFailedException('Invalid end date given');
} }

View File

@@ -74,4 +74,16 @@ class UserDateTimeFactory
return $date; return $date;
} }
/**
* @param string $format
* @param null|string $datetime
* @return bool|\DateTime
*/
public function createDateTimeFromFormat(string $format, ?string $datetime = 'now')
{
$date = \DateTime::createFromFormat($format, $datetime, $this->timezone);
return $date;
}
} }