slowhop/doctrine-behaviors

Doctrine2 行为特性 - slowhop 分支

维护者

详细信息

github.com/slowhop/DoctrineBehaviors

主页

源代码

安装数: 9,978

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 291

1.5.0 2017-09-27 18:53 UTC

Requires

Requires (Dev)

Suggests

MIT d27e25ff9bab8f6c0b88a2115e7fdd2d74b08fbb

treebehaviorsdoctrine2translatabletimestampableBlameablefilterablesoftdeletable

This package is auto-updated.

Last update: 2024-09-11 15:57:27 UTC

README

Build Status

这是一个PHP >=5.4库，它是一系列特性接口的集合，用于向Doctrine2实体和仓库添加行为。

目前它处理以下行为

该项目正在寻找维护者

我们意识到我们没有那么多时间去维护这个项目，因此我们正在寻找维护者。如果您想继续工作，请提交一个issue。

注意

某些行为（可翻译的、可记录时间的、软删除的、可追溯的、可地理编码的）需要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;
}

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

<?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

默认类型是 datetime。

blameable

可问责的（Blameable）能够跟踪给定实体的创建者和更新者。一个可问责的 可调用对象 用于从你的应用程序中获取当前用户。

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

使用 symfony2，你只需要配置名为 %knp.doctrine_behaviors.blameable_subscriber.user_entity% 的 DI 参数，例如：

# 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）能够跟踪生命周期修改并将它们记录到任何第三方日志系统中。一个可记录的 可调用对象 用于从任何地方获取记录器。

<?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）为实体生成短句（不保证唯一性）。将在更新/持久化时自动生成（你可以通过重写 getRegenerateSlugOnUpdate 并返回 false 来禁用更新生成。你也可以通过重写 getSlugDelimiter 从默认的破折号重写短句分隔符。可以通过重写 generateSlugValue 改变短句生成算法。用例包括 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）可以在仓库级别使用。

它允许简单过滤结果。

联合过滤示例

<?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）使用，以基于第三方系统填充信息。

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

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

测试

请阅读测试文档