Added possibility to export payment orders as CSV files

Author: jbtronics

src/Controller/Admin/PaymentOrderCrudController.php

@@ -33,6 +33,7 @@
 use App\Helpers\ZIPBinaryFileResponseFacade;
 use App\Message\PaymentOrder\PaymentOrderDeletedNotification;
 use App\Services\EmailConfirmation\ConfirmationEmailSender;
+use App\Services\PaymentOrder\CSVExporter;
 use App\Services\PaymentOrderMailLinkGenerator;
 use App\Services\PaymentReferenceGenerator;
 use Doctrine\ORM\EntityManagerInterface;
@@ -65,6 +66,8 @@
 use EasyCorp\Bundle\EasyAdminBundle\Registry\DashboardControllerRegistry;
 use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
 use RuntimeException;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+use Symfony\Component\HttpFoundation\HeaderUtils;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Messenger\MessageBusInterface;
 
@@ -74,11 +77,12 @@ final class PaymentOrderCrudController extends AbstractCrudController
 {
     public function __construct(
         private readonly PaymentOrderMailLinkGenerator $mailToGenerator,
-        private EntityManagerInterface $entityManager,
+        private readonly EntityManagerInterface $entityManager,
         private readonly ConfirmationEmailSender $confirmationEmailSender,
         private readonly AdminUrlGenerator $adminURLGenerator,
         private readonly MessageBusInterface $messageBus,
         private readonly PaymentReferenceGenerator $paymentReferenceGenerator,
+        private readonly CSVExporter $CSVExporter,
     )
     {
     }
@@ -88,6 +92,24 @@ public static function getEntityFqcn(): string
         return PaymentOrder::class;
     }
 
+    #[AdminAction(routePath: '/action-csv-export', routeName: 'admin_action_payment_order_csv_export', methods: ['POST'])]
+    public function csvExport(BatchActionDto $batchActionDto): Response
+    {
+        $this->denyAccessUnlessGranted('ROLE_SHOW_PAYMENT_ORDERS');
+
+        $entities = $this->entityManager->getRepository(PaymentOrder::class)->findBy(['id' => $batchActionDto->getEntityIds()]);
+
+        $csv = $this->CSVExporter->export($entities);
+        $response = new Response($csv);
+        $response->headers->set('Content-type', 'text/csv');
+        $response->headers->set('Content-length', (string) strlen($csv));
+        $response->headers->set('Cache-Control', 'private');
+        $disposition = HeaderUtils::makeDisposition("attachment", "payment_orders.csv", "payment_orders.csv");
+        $response->headers->set('Content-Disposition', $disposition);
+
+        return $response;
+    }
+
     #[AdminAction(routePath: '/action-sepa-xml-export', routeName: 'admin_action_payment_order_sepa_xml_export', methods: ['POST'])]
     public function sepaXMLExport(BatchActionDto $batchActionDto): Response
     {
@@ -165,9 +187,9 @@ public function configureCrud(Crud $crud): Crud
         return $crud
 
             //Set validation groups for new and edit forms
-                ->setFormOptions([
-                    'validation_groups' => ['Default', 'backend'],
-                ])
+            ->setFormOptions([
+                'validation_groups' => ['Default', 'backend'],
+            ])
 
             ->setEntityLabelInSingular('payment_order.label')
             ->setEntityLabelInPlural('payment_order.labelp')
@@ -250,17 +272,30 @@ public function configureActions(Actions $actions): Actions
         }
 
         //if ($this->isGranted('ROLE_EXPORT_PAYMENT_ORDERS_REFERENCES')) {
-            $actions->addBatchAction(Action::new('referencesExport', 'payment.order.action.export.export_references')
-                    ->linkToCrudAction('referencesExport')
-                    ->addCssClass('btn btn-primary')
-                    //Together with some backend.js logic, this attribute will prevent the modal from showing
-                    ->setHtmlAttributes([
-                        'data-action-batch-no-confirm' => 'true',
-                    ])
-                    ->setIcon('fas fa-file-invoice')
-            );
+        $actions->addBatchAction(Action::new('referencesExport', 'payment.order.action.export.export_references')
+            ->linkToCrudAction('referencesExport')
+            ->addCssClass('btn btn-primary')
+            //Together with some backend.js logic, this attribute will prevent the modal from showing
+            ->setHtmlAttributes([
+                'data-action-batch-no-confirm' => 'true',
+            ])
+            ->setIcon('fas fa-file-invoice')
+        );
         //}
 
+        if ($this->isGranted('ROLE_EXPORT_PAYMENT_ORDERS')) {
+        $actions->addBatchAction(Action::new('csvExport', 'CSV Export')
+            ->linkToCrudAction('csvExport')
+            ->addCssClass('btn btn-secondary')
+            //Together with some backend.js logic, this attribute will prevent the modal from showing
+            ->setHtmlAttributes([
+                'data-action-batch-no-confirm' => 'true',
+            ])
+            ->setIcon('fas fa-file-csv')
+        );
+        }
+
+
         $actions->setPermissions([
             Action::INDEX => 'ROLE_SHOW_PAYMENT_ORDERS',
             Action::DETAIL => 'ROLE_SHOW_PAYMENT_ORDERS',

src/Entity/Department.php

@@ -27,6 +27,8 @@
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
+use Symfony\Component\Serializer\Attribute\Groups;
+use Symfony\Component\Serializer\Attribute\SerializedName;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -50,6 +52,8 @@ class Department implements DBElementInterface, NamedElementInterface, Timestamp
 
 
     #[ORM\Column(type: Types::STRING)]
+    #[Groups('csv_export')]
+    #[SerializedName("Name")]
     private string $name = '';
 
 

src/Entity/Embeddable/Check.php

@@ -7,38 +7,50 @@
 
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Attribute\Groups;
+use Symfony\Component\Serializer\Attribute\SerializedName;
 
 /**
  * This embeddable contains all information about a check (the checks done by the StuRa Finance members).
  */
 #[ORM\Embeddable]
 class Check
 {
+    #[Groups('csv_export')]
+    #[SerializedName("Geprüft?")]
     #[ORM\Column(type: Types::BOOLEAN)]
     private bool $checked = false;
 
     /**
      * @var \DateTime|null The timestamp of the confirmation. Null if not confirmed, or if legacy data.
      */
     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Prüfzeitpunkt")]
     private ?\DateTime $timestamp = null;
 
     /**
      * @var string|null The name of the person who confirmed the confirmation. Null if not confirmed
      */
     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Prüfer")]
     private ?string $confirmerName = null;
 
     /**
      * @var int|null The ID of the user who confirmed this check. Null if not confirmed (or if legacy data)
      */
     #[ORM\Column(type: Types::INTEGER, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Benutzer ID")]
     private ?int $confirmerID = null;
 
     /**
      * @var string|null An optional remark about the confirmation
      */
     #[ORM\Column(type: Types::TEXT, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Anmerkung")]
     private ?string $remark = null;
 
     public function isChecked(): bool

src/Entity/Embeddable/Confirmation.php

@@ -7,6 +7,8 @@
 use App\Entity\ConfirmationToken;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Attribute\Groups;
+use Symfony\Component\Serializer\Attribute\SerializedName;
 
 /**
  * This embeddable contains all information about a confirmation
@@ -18,13 +20,17 @@ class Confirmation
     /**
      * @var \DateTime|null The timestamp of the confirmation. Null if not confirmed.
      */
+    #[Groups('csv_export')]
+    #[SerializedName("Bestätigungszeitpunkt")]
     #[ORM\Column(type: Types::DATETIME_MUTABLE, nullable: true)]
     private ?\DateTime $timestamp = null;
 
     /**
      * @var string|null The name of the person who confirmed the confirmation. Null if not confirmed
      */
     #[ORM\Column(type: Types::STRING, length: 255, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Bestätiger")]
     private ?string $confirmerName = null;
 
     /**
@@ -34,18 +40,24 @@ class Confirmation
     private ?int $confirmationTokenID = null;
 
     #[ORM\Column(type: Types::INTEGER, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Bestätiger ID")]
     private ?int $confirmerID = null;
 
     /**
      * @var bool Whether the confirmation was overridden by an StuRa Finance member
      */
     #[ORM\Column(type: Types::BOOLEAN)]
+    #[Groups('csv_export')]
+    #[SerializedName("Überschrieben?")]
     private bool $confirmationOverriden = false;
 
     /**
      * @var string|null An optional remark about the confirmation
      */
     #[ORM\Column(type: Types::TEXT, nullable: true)]
+    #[Groups('csv_export')]
+    #[SerializedName("Anmerkung")]
     private ?string $remark = null;
 
     public function isConfirmed(): bool

src/Entity/Embeddable/PayeeInfo.php

@@ -20,6 +20,8 @@
 
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Attribute\Groups;
+use Symfony\Component\Serializer\Attribute\SerializedName;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
@@ -33,35 +35,51 @@ class PayeeInfo
 
     #[Assert\NotBlank]
     #[ORM\Column(type: Types::STRING)]
+    #[Groups('csv_export')]
+    #[SerializedName("Name")]
     private string $account_owner = '';
 
     #[Assert\NotBlank]
     #[ORM\Column(type: Types::STRING)]
+    #[Groups('csv_export')]
+    #[SerializedName("Straße")]
     private string $street = '';
 
     #[Assert\NotBlank]
     #[ORM\Column(type: Types::STRING)]
+    #[Groups('csv_export')]
+    #[SerializedName("PLZ")]
     private string $zip_code = '';
 
     #[Assert\NotBlank]
     #[ORM\Column(type: Types::STRING)]
+    #[Groups('csv_export')]
+    #[SerializedName("Stadt")]
     private string $city = '';
 
     #[ORM\Column(type: Types::STRING)]
     #[Assert\NotBlank()]
     #[Assert\Iban]
+    #[Groups('csv_export')]
+    #[SerializedName("IBAN")]
     private string $iban = '';
 
     #[ORM\Column(type: Types::STRING)]
     #[Assert\Bic(ibanPropertyPath: 'iban')]
+    #[Groups('csv_export')]
+    #[SerializedName("BIC")]
     private string $bic = '';
 
     #[Assert\NotBlank]
     #[ORM\Column(type: Types::STRING)]
+    #[Groups('csv_export')]
+    #[SerializedName("Bankname")]
     private string $bank_name = '';
 
     #[ORM\Column(type: Types::STRING)]
     #[Assert\Length(max: 140)]
+    #[Groups('csv_export')]
+    #[SerializedName("Verwendungszweck")]
     private ?string $reference = '';
 
     public function __construct()