Merge pull request #39 from itk-dev/feature/5267-in-platform-documentation

5267: In-platform documentation

Author: jeppekroghitk

.gitignore

@@ -4,6 +4,7 @@
 /.env.*.local
 /config/secrets/prod/prod.decrypt.private.php
 /public/bundles/
+/public/uploads/qr-logos/
 /var/
 /vendor/
 ###< symfony/framework-bundle ###

CHANGELOG.md

@@ -8,6 +8,12 @@ See [keep a changelog] for information about writing changes to this log.
 
 ## [Unreleased]
 
+[PR-41](https://github.com/itk-dev/itqr/pull/41)
+    - Added archived concept
+[PR-40](https://github.com/itk-dev/itqr/pull/40)
+    - Added styling to static page.
+[PR-39](https://github.com/itk-dev/itqr/pull/39)
+    - Added various help texts and in-platform-documentation.
 [PR-38](https://github.com/itk-dev/itqr/pull/38)
     - Limit number of URLs to 1
     - Increase URL data type from varchar to text

assets/styles/archived.css

@@ -0,0 +1,95 @@
+:root {
+    --spacer-md: 1rem;
+    --spacer-lg: calc(var(--spacer-md) * 2);
+    --shadow-color: 240deg 27% 62%;
+    --shadow-elevation-low:
+            0.3px 0.3px 0.4px hsl(var(--shadow-color) / 0.34),
+            0.4px 0.4px 0.6px -1.7px hsl(var(--shadow-color) / 0.28),
+            0.9px 1px 1.3px -3.5px hsl(var(--shadow-color) / 0.21);
+    --shadow-elevation-medium:
+            0.3px 0.3px 0.4px hsl(var(--shadow-color) / 0.29),
+            0.5px 0.6px 0.8px -0.9px hsl(var(--shadow-color) / 0.25),
+            1px 1.2px 1.5px -1.7px hsl(var(--shadow-color) / 0.22),
+            2.2px 2.6px 3.3px -2.6px hsl(var(--shadow-color) / 0.19),
+            4.5px 5.2px 6.7px -3.5px hsl(var(--shadow-color) / 0.16);
+    --shadow-elevation-high:
+            0.3px 0.3px 0.4px hsl(var(--shadow-color) / 0.27),
+            0.7px 0.8px 1px -0.4px hsl(var(--shadow-color) / 0.25),
+            1.2px 1.4px 1.8px -0.8px hsl(var(--shadow-color) / 0.24),
+            1.9px 2.2px 2.8px -1.2px hsl(var(--shadow-color) / 0.22),
+            2.9px 3.4px 4.4px -1.6px hsl(var(--shadow-color) / 0.21),
+            4.5px 5.2px 6.7px -1.9px hsl(var(--shadow-color) / 0.19),
+            6.7px 7.8px 10px -2.3px hsl(var(--shadow-color) / 0.18),
+            9.7px 11.3px 14.5px -2.7px hsl(var(--shadow-color) / 0.16),
+            13.6px 16px 20.5px -3.1px hsl(var(--shadow-color) / 0.14),
+            18.7px 21.9px 28.1px -3.5px hsl(var(--shadow-color) / 0.13);
+}
+*, *::before, *::after {
+    box-sizing: border-box;
+}
+
+* {
+    margin: 0;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+    html {
+        interpolate-size: allow-keywords;
+    }
+}
+
+body {
+    line-height: 1.5;
+    -webkit-font-smoothing: antialiased;
+    font-family: 'Roboto', sans-serif;
+    background-color: ghostwhite;
+}
+
+img, picture, video, canvas, svg {
+    display: block;
+    max-width: 100%;
+}
+
+input, button, textarea, select {
+    font: inherit;
+}
+
+p, h1, h2, h3, h4, h5, h6 {
+    overflow-wrap: break-word;
+}
+
+p {
+    text-wrap: pretty;
+}
+
+h1, h2, h3, h4, h5, h6 {
+    text-wrap: balance;
+}
+
+#root, #__next {
+    isolation: isolate;
+}
+
+.container {
+    background-color: #fff;
+    display: flex;
+    flex-direction: column;
+    min-height: 100vh;
+    max-width: 800px;
+    margin: 0 auto;
+    padding: 0 var(--spacer-md);
+    > h1 {
+        font-size: clamp(1.75rem, 4.5vw, 3rem);
+        margin: var(--spacer-md) 0;
+    }
+
+    > p {
+
+    }
+}
+
+@media screen and (min-width: 800px) {
+    .container {
+        padding: 0 var(--spacer-lg);
+    }
+}

assets/styles/static.css

@@ -13,6 +13,9 @@ security:
         dev:
             pattern: ^/(_(profiler|wdt)|css|images|js)/
             security: false
+        api:
+          pattern: ^/api
+          stateless: true
         main:
             custom_authenticators:
                 - App\Security\AzureOIDCAuthenticator

config/packages/security.yaml

@@ -7,5 +7,5 @@ root_redirect:
   path: /
   controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController
   defaults:
-    route: 'qr_index'
+    route: 'admin'
     permanent: true

config/routes.yaml

@@ -10,7 +10,7 @@
 /**
  * Auto-generated Migration: Please modify to your needs!
  */
-final class Version20250826113021 extends AbstractMigration
+final class Version20250905124617 extends AbstractMigration
 {
     public function getDescription(): string
     {
@@ -20,12 +20,14 @@ public function getDescription(): string
     public function up(Schema $schema): void
     {
         // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE qr ADD alternative_url VARCHAR(255) DEFAULT NULL, ADD status VARCHAR(255) NOT NULL');
         $this->addSql('ALTER TABLE url CHANGE url url TEXT NOT NULL');
     }
 
     public function down(Schema $schema): void
     {
         // this down() migration is auto-generated, please modify it to your needs
         $this->addSql('ALTER TABLE url CHANGE url url VARCHAR(255) NOT NULL');
+        $this->addSql('ALTER TABLE qr DROP alternative_url, DROP status');
     }
 }

migrations/Version20250826113021.php renamed to migrations/Version20250905124617.php

@@ -5,11 +5,13 @@
 use App\Form\Type\BatchDownloadType;
 use App\Helper\DownloadHelper;
 use App\Repository\QrRepository;
+use GuzzleHttp\Utils;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
 
-final class BatchDownloadController extends DashboardController
+final class BatchDownloadController extends AbstractController
 {
     public function __construct(
         private readonly RequestStack $requestStack,
@@ -22,18 +24,24 @@ public function __construct(
      * @throws \Endroid\QrCode\Exception\ValidationException
      */
     #[Route('/admin/batch/download', name: 'admin_batch_download')]
-    public function index(): Response
+    public function batchDownload(string|array $selectedEntityIds): Response
     {
+        /*
+            If this method is called from the crud context menu and only regards a single item,
+            selectedEntityIds is a string. Convert to array to compatibilize.
+        */
+        if (!is_array($selectedEntityIds)) {
+            $selectedEntityIds = [$selectedEntityIds];
+        }
         $form = $this->createForm(BatchDownloadType::class);
-
         $request = $this->requestStack->getCurrentRequest();
 
         $form->handleRequest($request);
 
         if ($form->isSubmitted() && $form->isValid()) {
             $data = $form->getData();
 
-            $qrEntities = $this->qrRepository->findBy(['id' => $request->query->all()]);
+            $qrEntities = $this->qrRepository->findBy(['id' => $selectedEntityIds]);
 
             if (!$qrEntities) {
                 throw $this->createNotFoundException('No QR codes found');
@@ -44,8 +52,8 @@ public function index(): Response
 
         return $this->render('form/batchDownload.html.twig', [
             'form' => $form,
-            'selectedQrCodes' => json_encode($request->query->all()),
-            'count' => count($request->query->all()),
+            'selectedQrCodes' => Utils::jsonEncode($selectedEntityIds),
+            'count' => count($selectedEntityIds),
         ]);
     }
 }