added annotation based exporter (#1831)

* added user exporter
* added project exporter
* added customer exporter
* added activity exporter

src/Controller/ActivityController.php

@@ -16,6 +16,9 @@ use App\Entity\MetaTableTypeInterface;
 use App\Entity\Project;
 use App\Event\ActivityMetaDefinitionEvent;
 use App\Event\ActivityMetaDisplayEvent;
+use App\Export\Spreadsheet\EntityWithMetaFieldsExporter;
+use App\Export\Spreadsheet\Writer\BinaryFileResponseWriter;
+use App\Export\Spreadsheet\Writer\XlsxWriter;
 use App\Form\ActivityEditForm;
 use App\Form\ActivityRateForm;
 use App\Form\Toolbar\ActivityToolbarForm;
@@ -256,6 +259,34 @@ final class ActivityController extends AbstractController
         );
     }
 
+    /**
+     * @Route(path="/export", name="activity_export", methods={"GET"})
+     */
+    public function exportAction(Request $request, EntityWithMetaFieldsExporter $exporter)
+    {
+        $query = new ActivityQuery();
+        $query->setCurrentUser($this->getUser());
+
+        $form = $this->getToolbarForm($query);
+        $form->setData($query);
+        $form->submit($request->query->all(), false);
+
+        if (!$form->isValid()) {
+            $query->resetByFormError($form->getErrors());
+        }
+
+        $entries = $this->repository->getActivitiesForQuery($query);
+
+        $spreadsheet = $exporter->export(
+            Activity::class,
+            $entries,
+            new ActivityMetaDisplayEvent($query, ActivityMetaDisplayEvent::EXPORT)
+        );
+        $writer = new BinaryFileResponseWriter(new XlsxWriter(), 'kimai-activities');
+
+        return $writer->getFileResponse($spreadsheet);
+    }
+
     /**
      * @param Activity $activity
      * @param Request $request

src/Controller/CustomerController.php

@@ -14,10 +14,12 @@ use App\Entity\Customer;
 use App\Entity\CustomerComment;
 use App\Entity\CustomerRate;
 use App\Entity\MetaTableTypeInterface;
-use App\Entity\Rate;
 use App\Entity\Team;
 use App\Event\CustomerMetaDefinitionEvent;
 use App\Event\CustomerMetaDisplayEvent;
+use App\Export\Spreadsheet\EntityWithMetaFieldsExporter;
+use App\Export\Spreadsheet\Writer\BinaryFileResponseWriter;
+use App\Export\Spreadsheet\Writer\XlsxWriter;
 use App\Form\CustomerCommentForm;
 use App\Form\CustomerEditForm;
 use App\Form\CustomerRateForm;
@@ -407,6 +409,34 @@ final class CustomerController extends AbstractController
         ]);
     }
 
+    /**
+     * @Route(path="/export", name="customer_export", methods={"GET"})
+     */
+    public function exportAction(Request $request, EntityWithMetaFieldsExporter $exporter)
+    {
+        $query = new CustomerQuery();
+        $query->setCurrentUser($this->getUser());
+
+        $form = $this->getToolbarForm($query);
+        $form->setData($query);
+        $form->submit($request->query->all(), false);
+
+        if (!$form->isValid()) {
+            $query->resetByFormError($form->getErrors());
+        }
+
+        $entries = $this->repository->getCustomersForQuery($query);
+
+        $spreadsheet = $exporter->export(
+            Customer::class,
+            $entries,
+            new CustomerMetaDisplayEvent($query, CustomerMetaDisplayEvent::EXPORT)
+        );
+        $writer = new BinaryFileResponseWriter(new XlsxWriter(), 'kimai-customers');
+
+        return $writer->getFileResponse($spreadsheet);
+    }
+
     /**
      * @param Customer $customer
      * @param Request $request

src/Controller/ProjectController.php

@@ -19,6 +19,9 @@ use App\Entity\Rate;
 use App\Entity\Team;
 use App\Event\ProjectMetaDefinitionEvent;
 use App\Event\ProjectMetaDisplayEvent;
+use App\Export\Spreadsheet\EntityWithMetaFieldsExporter;
+use App\Export\Spreadsheet\Writer\BinaryFileResponseWriter;
+use App\Export\Spreadsheet\Writer\XlsxWriter;
 use App\Form\ProjectCommentForm;
 use App\Form\ProjectEditForm;
 use App\Form\ProjectRateForm;
@@ -418,6 +421,34 @@ final class ProjectController extends AbstractController
         ]);
     }
 
+    /**
+     * @Route(path="/export", name="project_export", methods={"GET"})
+     */
+    public function exportAction(Request $request, EntityWithMetaFieldsExporter $exporter)
+    {
+        $query = new ProjectQuery();
+        $query->setCurrentUser($this->getUser());
+
+        $form = $this->getToolbarForm($query);
+        $form->setData($query);
+        $form->submit($request->query->all(), false);
+
+        if (!$form->isValid()) {
+            $query->resetByFormError($form->getErrors());
+        }
+
+        $entries = $this->repository->getProjectsForQuery($query);
+
+        $spreadsheet = $exporter->export(
+            Project::class,
+            $entries,
+            new ProjectMetaDisplayEvent($query, ProjectMetaDisplayEvent::EXPORT)
+        );
+        $writer = new BinaryFileResponseWriter(new XlsxWriter(), 'kimai-projects');
+
+        return $writer->getFileResponse($spreadsheet);
+    }
+
     /**
      * @param Project $project
      * @param Request $request

src/Controller/UserController.php

@@ -12,6 +12,9 @@ namespace App\Controller;
 use App\Configuration\FormConfiguration;
 use App\Entity\User;
 use App\Event\UserPreferenceDisplayEvent;
+use App\Export\Spreadsheet\UserExporter;
+use App\Export\Spreadsheet\Writer\BinaryFileResponseWriter;
+use App\Export\Spreadsheet\Writer\XlsxWriter;
 use App\Form\Toolbar\UserToolbarForm;
 use App\Form\UserCreateType;
 use App\Repository\Query\UserQuery;
@@ -65,7 +68,6 @@ final class UserController extends AbstractController
     /**
      * @Route(path="/", defaults={"page": 1}, name="admin_user", methods={"GET"})
      * @Route(path="/page/{page}", requirements={"page": "[1-9]\d*"}, name="admin_user_paginated", methods={"GET"})
-     * @Security("is_granted('view_user')")
      */
     public function indexAction($page, Request $request): Response
     {
@@ -191,6 +193,34 @@ final class UserController extends AbstractController
         );
     }
 
+    /**
+     * @Route(path="/export", name="user_export", methods={"GET"})
+     * @Security("is_granted('view_user')")
+     */
+    public function exportAction(Request $request, UserExporter $exporter)
+    {
+        $query = new UserQuery();
+        $query->setCurrentUser($this->getUser());
+
+        $form = $this->getToolbarForm($query);
+        $form->setData($query);
+        $form->submit($request->query->all(), false);
+
+        if (!$form->isValid()) {
+            $query->resetByFormError($form->getErrors());
+        }
+
+        $entries = $this->getRepository()->getUsersForQuery($query);
+
+        $spreadsheet = $exporter->export(
+            $entries,
+            new UserPreferenceDisplayEvent(UserPreferenceDisplayEvent::EXPORT)
+        );
+        $writer = new BinaryFileResponseWriter(new XlsxWriter(), 'kimai-users');
+
+        return $writer->getFileResponse($spreadsheet);
+    }
+
     protected function getToolbarForm(UserQuery $query): FormInterface
     {
         return $this->createForm(UserToolbarForm::class, $query, [