Add support for files upload

.gitignore

@@ -1,5 +1,6 @@
 /public/build/fonts/glyphicons-*
 /public/build/images/glyphicons-*
+/public/uploads/
 
 ###> symfony/framework-bundle ###
 /.env.local

assets/scss/app.scss

@@ -358,3 +358,9 @@ body#blog_search .post-metadata {
   font-size: 16px;
   margin-bottom: 8px;
 }
+
+/* Page: 'User edit'
+   ------------------------------------------------------------------------- */
+body#user_edit #main form .form-group .thumbnail {
+  max-width: 150px;
+}

config/services.yaml

@@ -5,6 +5,7 @@ parameters:
     # This parameter defines the codes of the locales (languages) enabled in the application
     app_locales: en|fr|de|es|cs|nl|ru|uk|ro|pt_BR|pl|it|ja|id|ca|sl|hr|zh_CN|bg|tr|lt
     app.notifications.email_sender: anonymous@example.com
+    app.uploader_directory: '%kernel.project_dir%/public/uploads'
 
 services:
     # default configuration for services in *this* file
@@ -32,3 +33,10 @@ services:
     # 'arguments' key and define the arguments just below the service class
     App\EventSubscriber\CommentNotificationSubscriber:
         $sender: '%app.notifications.email_sender%'
+
+    App\EventSubscriber\UploadSubscriber:
+        tags:
+            - { name: doctrine.event_subscriber, connection: default }
+
+    App\Utils\FileUploader:
+        $uploadPath: '%app.uploader_directory%'

public/build/entrypoints.json

@@ -50,4 +50,4 @@
     "/build/admin.css": "sha384-NMnc2b6jJOZO4QiUk4TgitF+ipl41B2+0TFmAwGqpQ6cinY6Q6mb1watPtAAWkAZ",
     "/build/search.js": "sha384-R/BW5h0YHjTYt/CVNZNOPDSuk0IQsvSSQZeP9hPpBtEkI4pBWMkBX4CAQnQQkFvt"
   }
-}
+}

public/build/manifest.json

@@ -37,4 +37,4 @@
   "build/images/fa-regular-400.svg": "/build/images/fa-regular-400.95f13e0b.svg",
   "build/images/fa-solid-900.svg": "/build/images/fa-solid-900.6ed5e3bc.svg",
   "build/images/glyphicons-halflings-regular.svg": "/build/images/glyphicons-halflings-regular.89889688.svg"
-}
+}

src/Annotation/Uploadable.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Annotation;
+
+use Doctrine\Common\Annotations\Annotation;
+
+/**
+ * This file defined an annotation to target a class.
+ *
+ * @Annotation
+ * @Target("CLASS")
+ *
+ * @author Romain Monteil <monteil.romain@gmail.com>
+ */
+class Uploadable
+{
+}

src/Annotation/UploadableField.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Annotation;
+
+use Doctrine\Common\Annotations\Annotation\Target;
+use Doctrine\Common\Annotations\AnnotationException;
+
+/**
+ * This file defined an annotation to target a property on a class.
+ *
+ * @Annotation
+ * @Target("PROPERTY")
+ *
+ * @author Romain Monteil <monteil.romain@gmail.com>
+ */
+class UploadableField
+{
+    private $filename;
+
+    private $path;
+
+    public function __construct(array $options)
+    {
+        if (!isset($options['filename'])) {
+            throw new AnnotationException('Attribute "filename" is required for UploadableField annotation.');
+        }
+
+        if (!isset($options['path'])) {
+            throw new AnnotationException('Attribute "path" is required for UploadableField annotation.');
+        }
+
+        $this->filename = $options['filename'];
+        $this->path = $options['path'];
+    }
+
+    public function getFilename(): string
+    {
+        return $this->filename;
+    }
+
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+}

src/Annotation/UploadableReader.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Annotation;
+
+use Doctrine\Common\Annotations\Reader;
+
+/**
+ * @author Romain Monteil <monteil.romain@gmail.com>
+ */
+class UploadableReader
+{
+    private $reader;
+
+    public function __construct(Reader $reader)
+    {
+        $this->reader = $reader;
+    }
+
+    public function isUploadable($entity): bool
+    {
+        $reflection = new \ReflectionClass(\get_class($entity));
+
+        return null !== $this->reader->getClassAnnotation($reflection, Uploadable::class);
+    }
+
+    public function getUploadableFields($entity): array
+    {
+        $reflection = new \ReflectionClass(\get_class($entity));
+
+        $properties = [];
+        if ($this->isUploadable($entity)) {
+            foreach ($reflection->getProperties() as $property) {
+                $propertyAnnotation = $this->reader->getPropertyAnnotation($property, UploadableField::class);
+                if (null !== $propertyAnnotation) {
+                    $properties[$property->getName()] = $propertyAnnotation;
+                }
+            }
+        }
+
+        return $properties;
+    }
+}

src/Entity/Interfaces/TimestampableEntityInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Entity\Interfaces;
+
+/**
+ * This interface allow us to mark an Entity as Timestampable.
+ *
+ * @author Romain Monteil <monteil.romain@gmail.com>
+ */
+interface TimestampableEntityInterface
+{
+    public function getCreatedAt(): ?\DateTimeInterface;
+
+    public function setCreatedAt();
+
+    public function getUpdatedAt(): ?\DateTimeInterface;
+
+    public function setUpdatedAt();
+}

src/Entity/Post.php

@@ -11,14 +11,21 @@
 
 namespace App\Entity;
 
+use App\Annotation\Uploadable;
+use App\Annotation\UploadableField;
+use App\Entity\Interfaces\TimestampableEntityInterface;
+use App\Entity\Traits\TimestampableEntityTrait;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * @ORM\Entity(repositoryClass="App\Repository\PostRepository")
  * @ORM\Table(name="symfony_demo_post")
+ * @ORM\HasLifecycleCallbacks()
+ * @Uploadable()
  *
  * Defines the properties of the Post entity to represent the blog posts.
  *
@@ -31,8 +38,10 @@
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  * @author Yonel Ceruto <yonelceruto@gmail.com>
  */
-class Post
+class Post implements TimestampableEntityInterface
 {
+    use TimestampableEntityTrait;
+
     /**
      * Use constants to define configuration options that rarely change instead
      * of specifying them under parameters section in config/services.yaml file.
@@ -90,6 +99,27 @@ class Post
      */
     private $publishedAt;
 
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="text")
+     */
+    private $thumbnail;
+
+    /**
+     * @Assert\Image(
+     *     mimeTypes={
+     *      "image/jpeg",
+     *      "image/png"
+     *     },
+     *     maxSize="1M",
+     *     maxWidth="1000",
+     *     maxHeight="500"
+     * )
+     * @UploadableField(filename="thumbnail", path="posts")
+     */
+    private $thumbnailFile;
+
     /**
      * @var User
      *
@@ -173,6 +203,32 @@ public function setPublishedAt(\DateTime $publishedAt): void
         $this->publishedAt = $publishedAt;
     }
 
+    public function getThumbnail(): ?string
+    {
+        return $this->thumbnail;
+    }
+
+    public function setThumbnail(string $thumbnail): void
+    {
+        $this->thumbnail = $thumbnail;
+    }
+
+    public function getThumbnailFile(): ?File
+    {
+        return $this->thumbnailFile;
+    }
+
+    public function setThumbnailFile(File $thumbnailFile): void
+    {
+        $this->thumbnailFile = $thumbnailFile;
+
+        // the thumbnailFile field not being mapped with ORM, we force the change of a property that is mapped
+        // so that the change of this field is taken into account when updating the entity.
+        if (null !== $thumbnailFile) {
+            $this->updatedAt = new \DateTime();
+        }
+    }
+
     public function getAuthor(): ?User
     {
         return $this->author;

src/Entity/Traits/TimestampableEntityTrait.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Entity\Traits;
+
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * This trait allow us to add methods needed by the TimestampableEntityInterface.
+ * By doing son we don't have to redefine the methods necessary for the
+ * TimestampableEntityInterface interface in each entity.
+ *
+ * @author Romain Monteil <monteil.romain@gmail.com>
+ */
+trait TimestampableEntityTrait
+{
+    /**
+     * @var \DateTimeInterface|null
+     *
+     * @ORM\Column(
+     *     name="created_at",
+     *     type="datetime",
+     *     nullable=true
+     * )
+     */
+    private $createdAt;
+
+    /**
+     * @var \DateTimeInterface|null
+     *
+     * @ORM\Column(
+     *     name="updated_at",
+     *     type="datetime",
+     *     nullable=true
+     * )
+     */
+    private $updatedAt;
+
+    public function getCreatedAt(): ?\DateTimeInterface
+    {
+        return $this->createdAt;
+    }
+
+    /**
+     * @ORM\PrePersist
+     */
+    public function setCreatedAt(): self
+    {
+        $this->createdAt = new \DateTime();
+
+        return $this;
+    }
+
+    public function getUpdatedAt(): ?\DateTimeInterface
+    {
+        return $this->updatedAt;
+    }
+
+    /**
+     * @ORM\PrePersist
+     * @ORM\PreUpdate
+     */
+    public function setUpdatedAt(): self
+    {
+        $this->updatedAt = new \DateTime();
+
+        return $this;
+    }
+}