Improving exercise links and generating migration.

Author: krulis-martin

app/model/entity/ExerciseFileLink.php

@@ -28,10 +28,16 @@ class ExerciseFileLink
 
     /**
      * The key (fixed ID) used to identify the file in exercise specification (for simple replacement).
-     * @ORM\Column(type="string")
+     * @ORM\Column(type="string", length=16)
      */
     protected $key;
 
+    /**
+     * New name under which the file is downloaded (null means the original name).
+     * @ORM\Column(type="string", nullable=true)
+     */
+    protected $saveName;
+
     /**
      * Minimal required user role to access the file (null means even non-logged-in users).
      * @ORM\Column(type="string", nullable=true)
@@ -56,36 +62,53 @@ class ExerciseFileLink
 
     /**
      * Link constructor
-     * @param string $key
+     * @param string $key used to identify the file in exercise specification (for simple replacement)
      * @param ExerciseFile $exerciseFile
-     * @param string|null $requiredRole
      * @param Exercise|null $exercise
      * @param Assignment|null $assignment
+     * @param string|null $requiredRole minimal required user role to access the file (null = non-logged-in users)
+     * @param string|null $saveName new name under which the file is downloaded (null means the original name)
      */
     private function __construct(
         string $key,
         ExerciseFile $exerciseFile,
-        ?string $requiredRole = null,
         ?Exercise $exercise = null,
         ?Assignment $assignment = null,
+        ?string $requiredRole = null,
+        ?string $saveName = null
     ) {
         $this->key = $key;
         $this->requiredRole = $requiredRole;
+        $this->saveName = $saveName;
         $this->exerciseFile = $exerciseFile;
         $this->exercise = $exercise;
         $this->assignment = $assignment;
         $this->createdAt = new DateTime();
     }
 
+    /**
+     * Create a link for exercise
+     * @param string $key
+     * @param ExerciseFile $exerciseFile
+     * @param Exercise $exercise
+     * @param string|null $requiredRole
+     * @param string|null $saveName
+     */
     public static function createForExercise(
         string $key,
         ExerciseFile $exerciseFile,
-        ?string $requiredRole,
-        Exercise $exercise
+        Exercise $exercise,
+        ?string $requiredRole = null,
+        ?string $saveName = null
     ): self {
-        return new self($key, $exerciseFile, $requiredRole, $exercise, null);
+        return new self($key, $exerciseFile, $exercise, null, $requiredRole, $saveName);
     }
 
+    /**
+     * Create a link for assignment by copying an existing link
+     * @param ExerciseFileLink $link to be copied when assignment is being created
+     * @param Assignment $assignment the assignment for which the link is being created
+     */
     public static function copyForAssignment(
         ExerciseFileLink $link,
         Assignment $assignment
@@ -95,7 +118,7 @@ public static function copyForAssignment(
                 'Can only copy links associated with an exercise of selected assignment.'
             );
         }
-        return new self($link->key, $link->exerciseFile, $link->requiredRole, null, $assignment);
+        return new self($link->key, $link->exerciseFile, null, $assignment, $link->requiredRole, $link->saveName);
     }
 
     /*
@@ -107,11 +130,31 @@ public function getKey(): string
         return $this->key;
     }
 
+    public function setKey(string $key): void
+    {
+        $this->key = $key;
+    }
+
     public function getRequiredRole(): ?string
     {
         return $this->requiredRole;
     }
 
+    public function setRequiredRole(?string $requiredRole): void
+    {
+        $this->requiredRole = $requiredRole;
+    }
+
+    public function getSaveName(): ?string
+    {
+        return $this->saveName;
+    }
+
+    public function setSaveName(?string $saveName): void
+    {
+        $this->saveName = $saveName;
+    }
+
     public function getExerciseFile(): ExerciseFile
     {
         return $this->exerciseFile;

migrations/Version20251114174621.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20251114174621 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('CREATE TABLE exercise_file_link (id CHAR(36) NOT NULL COMMENT \'(DC2Type:uuid)\', exercise_file_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', exercise_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', assignment_id CHAR(36) DEFAULT NULL COMMENT \'(DC2Type:uuid)\', `key` VARCHAR(16) NOT NULL, save_name VARCHAR(255) DEFAULT NULL, required_role VARCHAR(255) DEFAULT NULL, created_at DATETIME NOT NULL, INDEX IDX_1187F77549DE8E29 (exercise_file_id), INDEX IDX_1187F775E934951A (exercise_id), INDEX IDX_1187F775D19302F8 (assignment_id), UNIQUE INDEX UNIQ_1187F7758A90ABA9E934951A (`key`, exercise_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci` ENGINE = InnoDB');
+        $this->addSql('ALTER TABLE exercise_file_link ADD CONSTRAINT FK_1187F77549DE8E29 FOREIGN KEY (exercise_file_id) REFERENCES `uploaded_file` (id)');
+        $this->addSql('ALTER TABLE exercise_file_link ADD CONSTRAINT FK_1187F775E934951A FOREIGN KEY (exercise_id) REFERENCES exercise (id)');
+        $this->addSql('ALTER TABLE exercise_file_link ADD CONSTRAINT FK_1187F775D19302F8 FOREIGN KEY (assignment_id) REFERENCES assignment (id)');
+        $this->addSql('ALTER TABLE uploaded_file DROP is_public');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE exercise_file_link DROP FOREIGN KEY FK_1187F77549DE8E29');
+        $this->addSql('ALTER TABLE exercise_file_link DROP FOREIGN KEY FK_1187F775E934951A');
+        $this->addSql('ALTER TABLE exercise_file_link DROP FOREIGN KEY FK_1187F775D19302F8');
+        $this->addSql('DROP TABLE exercise_file_link');
+        $this->addSql('ALTER TABLE `uploaded_file` ADD is_public TINYINT(1) NOT NULL');
+    }
+}