[C0-3455] Добавил сущности, репозитории, маппинг для файлов и каталогов

Author: Andrey Erdikov

src/Domain/Entity/MediaCatalog.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Entity;
+
+use Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject\Id;
+
+class MediaCatalog
+{
+    /**
+     * @var Id
+     */
+    private $id;
+
+    /**
+     * @var string
+     */
+    private $name;
+
+    public function __construct(Id $id, string $name)
+    {
+        $this->id = $id;
+        $this->name = $name;
+    }
+
+    public function getId(): Id
+    {
+        return $this->id;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}

src/Domain/Entity/MediaFile.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Entity;
+
+use Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject\Id;
+use Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject\MediaFileStorage;
+use Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject\MediaFileType;
+
+class MediaFile
+{
+    /**
+     * @var Id
+     */
+    private $id;
+
+    /**
+     * @var MediaCatalog
+     */
+    private $catalog;
+
+    /**
+     * @var string
+     */
+    private $title;
+
+    /**
+     * @var MediaFileType
+     */
+    private $type;
+
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var MediaFileStorage
+     */
+    private $storage;
+
+    public function __construct(Id $id, MediaCatalog $catalog, string $title, MediaFileType $type, string $name, MediaFileStorage $storage)
+    {
+        $this->id = $id;
+        $this->catalog = $catalog;
+        $this->title = $title;
+        $this->type = $type;
+        $this->name = $name;
+        $this->storage = $storage;
+    }
+
+    public function getId(): Id
+    {
+        return $this->id;
+    }
+
+    public function getCatalog(): MediaCatalog
+    {
+        return $this->catalog;
+    }
+
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    public function getType(): MediaFileType
+    {
+        return $this->type;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getStorage(): MediaFileStorage
+    {
+        return $this->storage;
+    }
+}

src/Domain/Entity/ValueObject/MediaFileStorage.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject;
+
+use Skyeng\MarketingCmsBundle\Domain\Traits\Exception\IncorrectValueObjectException;
+use Skyeng\MarketingCmsBundle\Domain\Traits\ValueObjectTrait;
+
+class MediaFileStorage
+{
+    public const S3_STORAGE = 's3';
+    public const LOCAL_STORAGE = 'local';
+
+    public const AVAILABLE_STORAGES = [
+        self::S3_STORAGE => self::S3_STORAGE,
+        self::LOCAL_STORAGE => self::LOCAL_STORAGE,
+    ];
+
+    use ValueObjectTrait;
+
+    protected function checkValue(string $value): void
+    {
+        if (!in_array($value, self::AVAILABLE_STORAGES)) {
+            throw new IncorrectValueObjectException('This media file storage is not supported');
+        }
+    }
+
+    public function isS3(): bool
+    {
+        return $this->value === self::S3_STORAGE;
+    }
+
+    public function isLocal(): bool
+    {
+        return $this->value === self::LOCAL_STORAGE;
+    }
+}

src/Domain/Entity/ValueObject/MediaFileType.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject;
+
+use Skyeng\MarketingCmsBundle\Domain\Traits\Exception\IncorrectValueObjectException;
+use Skyeng\MarketingCmsBundle\Domain\Traits\ValueObjectTrait;
+
+class MediaFileType
+{
+    public const IMAGE_TYPE = 'image';
+    public const PDF_TYPE = 'pdf';
+    public const VIDEO_TYPE = 'video';
+
+    public const AVAILABLE_TYPES = [
+        self::IMAGE_TYPE => self::IMAGE_TYPE,
+        self::PDF_TYPE => self::PDF_TYPE,
+        self::VIDEO_TYPE => self::VIDEO_TYPE,
+    ];
+
+    use ValueObjectTrait;
+
+    protected function checkValue(string $value): void
+    {
+        if (!in_array($value, self::AVAILABLE_TYPES)) {
+            throw new IncorrectValueObjectException('This media file type is not supported');
+        }
+    }
+
+    public function isPdf(): bool
+    {
+        return $this->value === self::PDF_TYPE;
+    }
+
+    public function isImage(): bool
+    {
+        return $this->value === self::IMAGE_TYPE;
+    }
+
+    public function isVideo(): bool
+    {
+        return $this->value === self::VIDEO_TYPE;
+    }
+}

src/Domain/Repository/MediaCatalogRepository/Exception/MediaCatalogNotFoundException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Repository\MediaCatalogRepository\Exception;
+
+use Skyeng\MarketingCmsBundle\Domain\Exception\NotFoundException;
+
+class MediaCatalogNotFoundException extends NotFoundException
+{
+}

src/Domain/Repository/MediaCatalogRepository/Exception/MediaCatalogRepositoryException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Repository\MediaCatalogRepository\Exception;
+
+use Skyeng\MarketingCmsBundle\Domain\Exception\ServiceException;
+
+class MediaCatalogRepositoryException extends ServiceException
+{
+}

src/Domain/Repository/MediaCatalogRepository/MediaCatalogRepositoryInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Repository\MediaCatalogRepository;
+
+use Skyeng\MarketingCmsBundle\Domain\Entity\MediaCatalog;
+use Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject\Id;
+use Skyeng\MarketingCmsBundle\Domain\Repository\MediaCatalogRepository\Exception\MediaFileRepositoryException;
+
+interface MediaCatalogRepositoryInterface
+{
+    public function getNextIdentity(): Id;
+
+    /**
+     * @return MediaCatalog[]
+     * @throws MediaFileRepositoryException
+     */
+    public function getAll(): array;
+}

src/Domain/Repository/MediaFileRepository/Exception/MediaFileNotFoundException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Repository\MediaFileRepository\Exception;
+
+use Skyeng\MarketingCmsBundle\Domain\Exception\NotFoundException;
+
+class MediaFileNotFoundException extends NotFoundException
+{
+}

src/Domain/Repository/MediaFileRepository/Exception/MediaFileRepositoryException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Repository\MediaFileRepository\Exception;
+
+use Skyeng\MarketingCmsBundle\Domain\Exception\ServiceException;
+
+class MediaFileRepositoryException extends ServiceException
+{
+}

src/Domain/Repository/MediaFileRepository/MediaFileRepositoryInterface.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Skyeng\MarketingCmsBundle\Domain\Repository\MediaFileRepository;
+
+use Skyeng\MarketingCmsBundle\Domain\Entity\MediaCatalog;
+use Skyeng\MarketingCmsBundle\Domain\Entity\MediaFile;
+use Skyeng\MarketingCmsBundle\Domain\Entity\ValueObject\Id;
+use Skyeng\MarketingCmsBundle\Domain\Repository\MediaFileRepository\Exception\MediaFileRepositoryException;
+
+interface MediaFileRepositoryInterface
+{
+    public function getNextIdentity(): Id;
+
+    /**
+     * @return MediaFile[]
+     * @throws MediaFileRepositoryException
+     */
+    public function getByCatalog(MediaCatalog $catalog): array;
+}