ck-developer/doctrine-behaviors

此包已被弃用且不再维护。未建议替代包。

Doctrine2行为特性

维护者

详细信息

github.com/ck-developer/DoctrineBehaviors

主页

源代码

安装: 18

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 246

v1.0.3 2015-02-06 12:50 UTC

Requires

Requires (Dev)

MIT d7ced932fe89ee9fd812a923373c0237792d8846

treebehaviorsdoctrine2translatabletimestampableBlameablefilterablesoftdeletable

This package is auto-updated.

Last update: 2022-02-01 12:45:37 UTC

README

Latest Stable Version Latest Stable Version Latest Stable Version Build Status

此php 5.4+库是特质的集合，为Doctrine2实体和仓库添加行为。

它目前处理

注意

一些行为（可翻译、时间戳、软删除、责任归属、地理编码）需要Doctrine订阅者才能工作。请确保通过阅读订阅者部分来激活它们。

订阅者

如果您使用symfony2，可以通过导入服务定义文件轻松注册它们

    # 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\Tree\Node,
        ORMBehaviors\Translatable\Translatable,
        ORMBehaviors\Timestampable\Timestampable,
        ORMBehaviors\SoftDeletable\SoftDeletable,
        ORMBehaviors\Blameable\Blameable,
        ORMBehaviors\Geocodable\Geocodable,
        ORMBehaviors\Loggable\Loggable,
        ORMBehaviors\Sluggable\Sluggable
    ;

    /**
     * @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，其行为像

树形结构

<?php

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

    $child->setChildOf($category);

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

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

    $root->getParent(); // null
    $root->getChildNodes(); // ArrayCollection
    $root[0][1]; // node or null
    $root->isLeaf(); // boolean
    $root->isRoot(); // boolean

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

可翻译

如果您正在处理Category实体，则Translatable行为默认期望一个CategoryTranslation实体。如果您希望为翻译实体使用不同的类名，则应在可翻译实体中覆盖特质方法getTranslationEntityClass，并在翻译实体中覆盖getTranslatableEntityClass。如果您覆盖了一个，则需要覆盖另一个以返回逆类。

默认命名约定（或通过特质方法的定制）可避免您手动处理实体关联。它由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();

猜测当前区域设置

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

代理翻译

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

您可以在可翻译实体的魔法__call方法中使用它，这样当您尝试调用getName（例如）时，它将返回当前区域设置下name的翻译值

<?php

    public function __call($method, $arguments)
    {
        return $this->proxyCurrentLocaleTranslation($method, $arguments);
    }

软删除

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

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

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

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

    /*
     *  24 hours later...
     */

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

可记录时间戳

<?php

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

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

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

可追究责任

可追究责任可以跟踪特定实体的创建者和更新者。一个可追究责任的可调用对象用于从您的应用程序中获取当前用户。

如果您使用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();

可记录日志

可记录日志可以跟踪生命周期修改并将它们记录在任何第三方日志系统中。一个可记录日志的可调用对象用于从任何位置获取记录器。

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

可地理编码

可地理编码为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 cricle of 500 km around point 47 lon., 7 lat.
    $nearCities = $repository->findByDistance(new Point(47, 7), 500);

可生成缩略名

可生成缩略名为实体生成缩略名（不保证唯一性）。将在更新/持久化时自动生成（您可以通过重写getRegenerateSlugOnUpdate并返回false来禁用更新生成。您还可以通过重写getSlugDelimiter来覆盖默认的连字符作为分隔符。可以通过重写generateSlugValue来更改缩略名生成算法。用例包括SEO（例如，像http://mysite.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);
    }
}

可生成令牌

可生成令牌为实体生成令牌（不保证唯一性）。将在更新/持久化时自动生成（您可以通过重写getRegenerateTokenOnUpdate并返回true来启用更新生成。您还可以通过重写getTokenBase来覆盖默认的连字符作为基础。可以通过重写generateTokenValue来更改令牌生成算法。

<?php

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

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

    public function getRegenerateTokenOnUpdate()
    {
        return true;
    }
}

可筛选

可筛选可以在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']);

可调用对象

可调用对象被一些订阅者如可追究责任和可地理编码使用，以基于第三方系统填充信息。

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

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

测试

阅读测试文档