fsi/doctrine-extensions-bundle

FSi Doctrine 扩展组件。

安装次数: 29,228

依赖项: 2

建议者: 0

安全性: 0

星标: 3

关注者: 10

分支: 8

开放问题: 1

类型:symfony-bundle

2.2.0 2021-07-23 13:15 UTC

README

此组件提供了与 FSi DoctrineExtensions 库的集成。

安装

这是主分支,处于开发状态。对于稳定版本,请使用版本 1.1

将组件添加到 composer.json 并运行 composer.phar update

{
    "require": {
        "fsi/doctrine-extensions-bundle": "2.0@dev",
    }
}

在 AppKernel.php 中注册组件

    // app/AppKernel.php

    public function registerBundles()
    {
        return [
            new Knp\Bundle\GaufretteBundle\KnpGaufretteBundle(),
            new FSi\Bundle\DoctrineExtensionsBundle\FSiDoctrineExtensionsBundle(),
        ];
    }

配置监听器

监听器默认未注册,您需要在 app/config/config.yml 文件中启用它们才能使用。

# app/config/config.yml

fsi_doctrine_extensions:
    orm:
        default:
            translatable: true
            uploadable: true

确保在 app/config/config.yml 中启用翻译,即使您不想使用组件的可翻译组件。

framework:
    translator:      { fallback: %locale% }

带有可上传字段的实体示例

<?php

namespace FSi\DemoBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use FSi\Bundle\DoctrineExtensionsBundle\Validator\Constraints as FSiAssert;
use FSi\DoctrineExtensions\Uploadable\Mapping\Annotation as FSi;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ORM\Entity()
 */
class Article
{
    /**
     * @var integer
     *
     * @ORM\Column(type="integer")
     * @ORM\Id
     */
    private $id;

    /**
     * It is important that this column is nullable, because the value is set
     * after the entity is persisted.
     *
     * @ORM\Column(nullable=true)
     * @FSi\Uploadable(targetField="photo")
     */
    private $photoKey;

    /**
     * Currently there is no common interface for uploaded files.
     *
     * @var mixed
     *
     * @FSiAssert\Image(
     *     maxWidth = 1000,
     *     maxHeight = 460
     * )
     */
    private $photo;

    public function getId(): int
    {
        return $this->id;
    }

    public function setPhoto($photo): void
    {
        $this->photo = $photo;
    }

    public function getPhoto()
    {
        return $this->photo;
    }

    public function setPhotoKey(?string $photoKey): void
    {
        $this->photoKey = $photoKey;
    }

    public function getPhotoKey(): ?string
    {
        return $this->photoKey;
    }
}

具有可翻译字段和翻译实体的实体示例

namespace Entity;

use Doctrine\ORM\Mapping as ORM;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use FSi\DoctrineExtensions\Translatable\Mapping\Annotation as Translatable;

/**
 * The entity's repository needs to implement the 
 * \FSi\DoctrineExtensions\Translatable\Model\TranslatableRepositoryInterface
 *
 * @ORM\Entity(repositoryClass="FSi\DoctrineExtensions\Translatable\Entity\Repository\TranslatableRepository")
 */
class Article
{
    /**
     * @var integer
     *
     * @ORM\Column(type="integer")
     * @ORM\Id
     */
    private $id;

    /**
     * @var string
     *
     * @Translatable\Locale
     */
    private $locale;

    /**
     * @var string
     *
     * @Translatable\Translatable(mappedBy="translations")
     */
    private $title;

    /**
     * @var string
     *
     * @Translatable\Translatable(mappedBy="translations")
     */
    private $contents;

    /**
     * @var Collection|ArticleTranslation[]
     *
     * @ORM\OneToMany(targetEntity="ArticleTranslation", mappedBy="article", indexBy="locale")
     */
    private $translations;

    public function __construct()
    {
        $this->translations = new ArrayCollection();
    }

    public function getId(): int
    {
        return $this->id;
    }

    public function setTitle(?string $title): void
    {
        $this->title = $title;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setContents(?string $contents): void
    {
        $this->contents = $contents;
    }

    public function getContents(): ?string
    {
        return $this->contents;
    }

    public function setLocale(?string $locale): void
    {
        $this->locale = $locale;
    }

    public function getLocale(): ?string
    {
        return $this->locale;
    }

    public function getTranslations(): Collection
    {
        return $this->translations;
    }
}
namespace Entity;

use Doctrine\ORM\Mapping as ORM;
use FSi\DoctrineExtensions\Translatable\Mapping\Annotation as Translatable;

/**
 * @ORM\Entity
 */
class ArticleTranslation
{
    /**
     * @var integer
     *
     * @ORM\Column(type="integer")
     * @ORM\Id
     */
    private $id;

    /**
     * @var string
     *
     * @Translatable\Locale
     *
     * @ORM\Column(length=2)
     */
    private $locale;

    /**
     * @ORM\Column
     * @var string
     */
    private $title;

    /**
     * @var string
     *
     * @ORM\Column
     */
    private $contents;

    /**
     * @var Article
     *
     * @ORM\ManyToOne(targetEntity="Article", inversedBy="translations")
     */
    private $article;

    public function setTitle(?string $title): void
    {
        $this->title = $title;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setContents(?string $contents): void
    {
        $this->contents = $contents;
    }

    public function getContents(): ?string
    {
        return $this->contents;
    }

    public function setLocale(?string $locale): void
    {
        $this->locale = $locale;
    }

    public function getLocale(): ?string
    {
        return $this->locale;
    }

    public function setArticle(?Article $article): void
    {
        $this->article = $article;
    }

    public function getArticle(): ?Article
    {
        return $this->article;
    }
}

其他文档

扩展验证器

有两个验证器可以与 FSi 可上传文件一起使用。

@FSiAssert\Image - 扩展 Symfony 的图像验证器
@FSiAssert\File - 扩展 Symfony 的文件验证器

这两个验证器具有与父类完全相同的选项。

FSi doctrine 扩展的详细文档