wucdbm/doctrine-behaviors

Doctrine2 行为特性

维护者

详细信息

github.com/wucdbm/DoctrineBehaviors

主页

源代码

安装次数: 5,665

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 290

v2.0.0 2020-01-05 23:22 UTC

Requires

Requires (Dev)

Suggests

MIT e79fb4227ab4a0012dfff6e7489718627ff76582

treebehaviorsdoctrine2translatabletimestampableBlameablefilterablesoftdeletable

This package is auto-updated.

Last update: 2024-09-06 09:14:15 UTC

README

Build Status

这是一个PHP >=5.4 库，它包含了一系列特性和接口，可以将行为添加到Doctrine2实体和仓库。

目前它支持以下功能：

注意

一些行为（translatable, timestampable, softDeletable, blameable, geocodable）需要Doctrine订阅者才能工作。请确保通过阅读订阅者部分来激活它们。

## 安装 composer require knplabs/doctrine-behaviors:~1.1

配置

默认情况下，当与Symfony集成时，所有订阅者都会被启用（如果你没有为该包指定任何配置）。但你也可以通过白名单的方式启用所需的行为

knp_doctrine_behaviors:
    blameable:      false
    geocodable:     ~     # Here null is converted to false
    loggable:       ~
    sluggable:      true
    soft_deletable: true
    # All others behaviors are disabled

订阅者

如果你使用symfony2，你可以轻松地在以下位置注册它们：

  • 推荐方法

添加到AppKernel

class AppKernel
{
    function registerBundles()
    {
        $bundles = array(
            //...
            new Knp\DoctrineBehaviors\Bundle\DoctrineBehaviorsBundle(),
            //...
        );

        //...

        return $bundles;
    }
}
  • 已弃用方法：导入服务定义文件
    # app/config/config.yml
    imports:
        - { resource: ../../vendor/knplabs/doctrine-behaviors/config/orm-services.yml }

你也可以使用doctrine2 api来注册它们

<?php

$em->getEventManager()->addEventSubscriber(new \Knp\DoctrineBehaviors\ORM\Translatable\TranslatableSubscriber);
// register more if needed

使用方法

你所要做的就是定义一个Doctrine2实体并使用特性

<?php

use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Model as ORMBehaviors;

/**
 * @ORM\Entity(repositoryClass="CategoryRepository")
 */
class Category implements ORMBehaviors\Tree\NodeInterface, \ArrayAccess
{
    use ORMBehaviors\Blameable\Blameable,
        ORMBehaviors\Geocodable\Geocodable,
        ORMBehaviors\Loggable\Loggable,
        ORMBehaviors\Sluggable\Sluggable,
        ORMBehaviors\SoftDeletable\SoftDeletable,
        ORMBehaviors\Sortable\Sortable,
        ORMBehaviors\Timestampable\Timestampable,
        ORMBehaviors\Translatable\Translatable,
        ORMBehaviors\Tree\Node
    ;

    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="NONE")
     */
    protected $id;
}

对于像tree这样的某些行为，你可以使用仓库特性

<?php

use Doctrine\ORM\EntityRepository;
use Knp\DoctrineBehaviors\ORM as ORMBehaviors;

class CategoryRepository extends EntityRepository
{
    use ORMBehaviors\Tree\Tree,
}

就这样！

你现在有一个工作的Category，它表现得像

tree

<?php

    $category = new Category;
    $category->setId(1); // tree nodes need an id to construct path.
    $child = new Category;
    $child->setId(2);

    $child->setChildNodeOf($category);

    $em->persist($child);
    $em->persist($category);
    $em->flush();

    $root = $em->getRepository('Category')->getTree();

    $root->getParentNode(); // null
    $root->getChildNodes(); // ArrayCollection
    $root[0][1]; // node or null
    $root->isLeafNode(); // boolean
    $root->isRootNode(); // boolean

你可以使用除了id以外的其他标识符，只需重写getNodeId并返回你的自定义标识符（与Sluggable结合使用效果极佳）

translatable

如果你正在处理Category实体，Translatable行为默认期望在Category实体相同的文件夹中有一个名为CategoryTranslation的实体。

默认的命名约定（或通过特性方法进行自定义）可以避免你手动处理实体关联。这由TranslationSubscriber自动处理。

为了使用Translatable特性，你必须创建这个CategoryTranslation实体。

<?php

use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Model as ORMBehaviors;

/**
 * @ORM\Entity
 */
class CategoryTranslation
{
    use ORMBehaviors\Translatable\Translation;

    /**
     * @ORM\Column(type="string", length=255)
     */
    protected $name;

    /**
     * @ORM\Column(type="string", length=255)
     */
    protected $description;

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param  string
     * @return null
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param  string
     * @return null
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }
}

相应的Category实体需要使用use ORMBehaviors\Translatable\Translatable;，并且应该只包含不需要翻译的字段。

<?php

use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Model as ORMBehaviors;

/**
 * @ORM\Entity
 */
class Category
{
    use ORMBehaviors\Translatable\Translatable;

    /**
     * @ORM\Column(type="string", length=255)
     */
    protected $someFieldYouDoNotNeedToTranslate;
}

更新数据库后，例如使用./console doctrine:schema:update --force，你现在可以使用translate或getTranslations方法进行翻译工作。

<?php

    $category = new Category;
    $category->translate('fr')->setName('Chaussures');
    $category->translate('en')->setName('Shoes');
    $em->persist($category);

    // In order to persist new translations, call mergeNewTranslations method, before flush
    $category->mergeNewTranslations();

    $category->translate('en')->getName();

重写

如果你更愿意使用不同的翻译实体类名，或者想要使用单独的命名空间，你有两种方法

如果你想全局定义一个自定义翻译实体类名
重写翻译实体中的Translatable特性及其方法getTranslationEntityClass以及Translation特性及其方法getTranslatableEntityClass。如果你重写了一个，你也必须重写另一个以返回逆类。

示例：假设你想要创建一个子命名空间AppBundle\Entity\Translation来存储翻译类，然后在该文件夹中放置重写的特性。

<?php
namespace AppBundle\Entity\Translation;

use Knp\DoctrineBehaviors\Model\Translatable\Translatable;
use Symfony\Component\PropertyAccess\PropertyAccess;

trait TranslatableTrait
{
    use Translatable;

    /**
     * @inheritdoc
     */
    public static function getTranslationEntityClass()
    {
        $explodedNamespace = explode('\\', __CLASS__);
        $entityClass = array_pop($explodedNamespace);
        return '\\'.implode('\\', $explodedNamespace).'\\Translation\\'.$entityClass.'Translation';
    }
}
<?php
namespace AppBundle\Entity\Translation;

use Knp\DoctrineBehaviors\Model\Translatable\Translation;

trait TranslationTrait
{
    use Translation;

    /**
     * @inheritdoc
     */
    public static function getTranslatableEntityClass()
    {
        $explodedNamespace = explode('\\', __CLASS__);
        $entityClass = array_pop($explodedNamespace);
        // Remove Translation namespace
        array_pop($explodedNamespace);
        return '\\'.implode('\\', $explodedNamespace).'\\'.substr($entityClass, 0, -11);
    }
}

如果你使用这种方法，请确保覆盖DoctrineBehaviors的特性参数

parameters:
    knp.doctrine_behaviors.translatable_subscriber.translatable_trait: AppBundle\Entity\Translation\TranslatableTrait
    knp.doctrine_behaviors.translatable_subscriber.translation_trait: AppBundle\Entity\Translation\TranslationTrait

如果你想只为单个可翻译类定义一个自定义翻译实体类名
重写可翻译实体中的getTranslationEntityClass方法和翻译实体中的getTranslatableEntityClass方法。如果你重写了一个，你也必须重写另一个以返回逆类。

猜测当前区域

您可以通过传递一个可调用的参数作为第一个参数来配置订阅者猜测当前区域的方式。这个库提供了一个可调用的对象（Knp\DoctrineBehaviors\ORM\Translatable\CurrentLocaleCallable），它使用Symfony2返回当前的区域。

代理翻译

一个额外功能允许您代理可翻译实体的翻译字段。

您可以在您可翻译实体的魔术方法__call中使用它，以便当您尝试调用getName（例如）时，它将返回当前区域的名称的翻译值。

<?php

    public function __call($method, $arguments)
    {
        return $this->proxyCurrentLocaleTranslation($method, $arguments);
    }
    
    // or do it with PropertyAccessor that ships with Symfony SE
    // if your methods don't take any required arguments
    public function __call($method, $arguments)
    {
        return \Symfony\Component\PropertyAccess\PropertyAccess::createPropertyAccessor()->getValue($this->translate(), $method);
    }

软删除

<?php

    $category = new Category;
    $em->persist($category);
    $em->flush();

    // get id
    $id = $category->getId();

    // now remove it
    $em->remove($category);
    $em->flush();

    // hey, I'm still here:
    $category = $em->getRepository('Category')->findOneById($id);

    // but I'm "deleted"
    $category->isDeleted(); // === true

    // restore me
    $category->restore();

    //look ma, I am back
    $category->isDeleted(); // === false

    //do not forget to call flush method to apply the change
    $em->flush();
<?php

    $category = new Category;
    $em->persist($category);
    $em->flush();

    // I'll delete you tomorrow
    $category->setDeletedAt((new \DateTime())->modify('+1 day'));

    // OK, I'm here
    $category->isDeleted(); // === false

    /*
     *  24 hours later...
     */

    // OK, I'm deleted
    $category->isDeleted(); // === true

timestampable

<?php

    $category = new Category;
    $em->persist($category);
    $em->flush();

    $id = $category->getId();
    $category = $em->getRepository('Category')->findOneById($id);

    $category->getCreatedAt();
    $category->getUpdatedAt();

如果您想更改将用于时间戳模型创建的数据库字段的doctrine类型，可以设置以下参数，如下所示：

parameters:
    knp.doctrine_behaviors.timestampable_subscriber.db_field_type: datetimetz

datetimetz 如果您正在使用Postgres数据库，这是一个非常有用的选项，否则您可能会遇到一些时区问题。有关更多信息，请参阅：[http://doctrine-dbal.readthedocs.org/en/latest/reference/known-vendor-issues.html#datetime-datetimetz-and-time-types](http://doctrine-dbal.readthedocs.org/en/latest/reference/known-vendor-issues.html#datetime-datetimetz-and-time-types)

默认类型是datetime。

blameable

Blameable能够跟踪给定实体的创建者和更新者。Blameable 可调用用于从您的应用程序中获取当前用户。

如果您使用Doctrine实体来表示您的用户，您可以为订阅者配置自动管理此用户实体与您的实体之间的关联。

在symfony2中，您只需配置DI参数%knp.doctrine_behaviors.blameable_subscriber.user_entity%即可，例如

# app/config/config.yml
parameters:
    knp.doctrine_behaviors.blameable_subscriber.user_entity: AppBundle\Entity\User

然后，您可以像这样使用它：

<?php

    $category = new Category;
    $em->persist($category);

    // instances of %knp.doctrine_behaviors.blameable_subscriber.user_entity%
    $creator = $category->getCreatedBy();
    $updater = $category->getUpdatedBy();

loggable

Loggable能够跟踪生命周期修改并将它们记录到任何第三方日志系统中。一个loggable 可调用用于从任何地方获取日志记录器。

<?php

/**
 * @ORM\Entity
 */
class Category
{
    use ORMBehaviors\Loggable\Loggable;

    // you can override the default log messages defined in trait:
    public function getUpdateLogMessage(array $changeSets = [])
    {
        return 'Changed: '.print_r($changeSets, true);
    }

    public function getRemoveLogMessage()
    {
        return 'removed!';
    }
}

然后，将这些消息传递到配置的可调用对象。您可以通过向LoggableSubscriber传递另一个可调用对象来自定义。

<?php

$em->getEventManager()->addEventSubscriber(
    new \Knp\DoctrineBehaviors\ORM\Loggable\LoggableSubscriber(
        new ClassAnalyzer,
        function($message) {
            // do stuff with message
        }
    )
);

如果您使用symfony，您也可以配置要使用的可调用对象。

// app/config/config.yml
parameters:
    knp.doctrine_behaviors.loggable_subscriber.logger_callable.class: Your\InvokableClass

geocodable

Geocodable为PostgreSQL平台提供扩展，以便与cube和earthdistance扩展一起工作。

它允许您根据地理坐标查询实体。它还提供了一个简单的入口点来使用第三方库（如优秀的geocoder），将地址转换为纬度和经度。

<?php

    $geocoder = new \Geocoder\Geocoder;
    // register geocoder providers

    // $subscriber instanceof GeocodableSubscriber (add "knp.doctrine_behaviors.geocodable_subscriber" into your services.yml)
    $subscriber->setGeolocationCallable(function($entity) use($geocoder) {
        $location = $geocoder->geocode($entity->getAddress());
        return new Point(
            $location->getLatitude(),
            $location->getLongitude()
        ));
    });

    $category = new Category;
    $em->persist($category);

    $location = $category->getLocation(); // instanceof Point

    // find cities in a circle of 500 km around point 47 lon., 7 lat.
    $nearCities = $repository->findByDistance(new Point(47, 7), 500);

sluggable

Sluggable为实体生成slug（唯一性不保证）。将在更新/持久化时自动生成（您可以通过重写getRegenerateSlugOnUpdate并返回false来禁用更新生成。您还可以通过重写getSlugDelimiter来覆盖默认的连字符作为slug分隔符。可以通过重写generateSlugValue来更改slug生成算法。用例包括SEO（例如，像http://example.com/post/3/introduction-to-php这样的URL）。

<?php

use Doctrine\ORM\Mapping as ORM;
use Knp\DoctrineBehaviors\Model as ORMBehaviors;

/**
 * @ORM\Entity
 */
class BlogPost
{
    use ORMBehaviors\Sluggable\Sluggable;

    /**
     * @ORM\Column(type="string")
     */
    protected $title;

    public function getSluggableFields()
    {
        return [ 'title' ];
    }

    public function generateSlugValue($values)
    {
        return implode('-', $values);
    }
}

filterable

Filterable可以在Repository级别使用

它允许简单过滤结果

联合过滤器示例

<?php

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity(repositoryClass="ProductRepository")
 */
class ProductEntity
{

    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\Column(type="string", nullable=true)
     */
    private $name;

    /**
     * @ORM\Column(type="integer")
     */
    private $code;

    /**
     * @ORM\OneToMany(targetEntity="Order", mappedBy="product")
     */
    protected $orders;
}

和仓库

<?php

use Knp\DoctrineBehaviors\ORM\Filterable;
use Doctrine\ORM\EntityRepository;

class ProductRepository extends EntityRepository
{
    use Filterable\FilterableRepository;

    public function getLikeFilterColumns()
    {
        return ['e:name', 'o:code'];
    }

    public function getEqualFilterColumns()
    {
        return [];
    }

    protected function createFilterQueryBuilder()
    {
        return $this
            ->createQueryBuilder('e')
            ->leftJoin('e.orders', 'o');
    }
}

现在我们可以使用以下内容进行过滤：

    $products = $em->getRepository('Product')->filterBy(['o:code' => '21']);

可调用对象

可调用对象由一些订阅者（如blameable和geocodable）使用，以根据第三方系统填充信息。

例如，blameable可调用可以是任何实现__invoke方法的symfony2服务或任何匿名函数，只要它们返回当前登录用户表示（这意味着一切，一个User实体，一个字符串，一个用户名，...）。关于被调用的DI服务的示例，请参阅Knp\DoctrineBehaviors\ORM\Blameable\UserCallable类。

在可地理编码的情况下，您可以将其设置为任何实现 __invoke 或返回 Knp\DoctrineBehaviors\ORM\Geocodable\Type\Point 对象的匿名函数的服务。

测试

阅读测试文档