首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >使用api平台为Symfony5中的用户角色获取子资源

使用api平台为Symfony5中的用户角色获取子资源
EN

Stack Overflow用户
提问于 2022-09-02 13:43:31
回答 1查看 120关注 0票数 0

Symfony5中,安全角色是普通字符串。因此,User实体通常有一个存储角色名称字符串的$roles数组,例如:

代码语言:javascript
复制
class User {
  /** @ORM\Column(type="json") */
  protected array $roles = ['ROLE_USER'];
  // ...
}

但是,在我的环境中,我想用描述和其他元数据来充实角色,所以我有一个Role类,并且我希望能够使用框架为(一个用户)获取一个角色列表(注意:获取一个角色集合不是问题,可以从框中取出)。

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2022-09-02 13:43:31

这可以通过在Api平台中定义自定义子资源DataProvider来实现。漂亮的部分是所有的过滤器和分页将自然工作(然而,过滤器不会出现在API文档中,我不知道如何解决这个问题)。

  1. 在用户::$ @ApiSubresource属性上定义:
代码语言:javascript
复制
/**
 * @ApiSubresource(maxDepth=1)
 * @ORM\Column(type="json")
 */
protected array $roles = [];
  1. 创建您的DataProvider。这是我所使用的,但可以使用一些改进,使之更通用。
代码语言:javascript
复制
<?php

namespace App\DataProvider;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use ApiPlatform\Core\DataProvider\SubresourceDataProviderInterface;
use ApiPlatform\Core\Exception\InvalidResourceException;
use ApiPlatform\Core\Exception\RuntimeException;
use App\Entity\Role;
use App\Entity\User;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;

/**
 * Converts the User::$roles plain array into a collection of Role entities.
 */
class UserRoleDataProvider implements SubresourceDataProviderInterface, RestrictedDataProviderInterface
{
    private iterable        $collectionExtensions;
    private ManagerRegistry $managerRegistry;

    public function __construct(ManagerRegistry $managerRegistry, iterable $collectionExtensions = [])
    {
        $this->managerRegistry = $managerRegistry;
        $this->collectionExtensions = $collectionExtensions;
    }

    public function getSubresource(string $resourceClass, array $identifiers, array $context, string $operationName = null)
    {
        $manager = $this->managerRegistry->getManagerForClass(Role::class);
        $repository = $manager->getRepository(Role::class);
        if (!method_exists($repository, 'createQueryBuilder')) {
            throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
        }

        /** @var User $user */
        $user = $this->managerRegistry->getManagerForClass(User::class)->getRepository(User::class)->find($identifiers['id']['id']);
        if (!$user) {
            throw new InvalidResourceException('Resource not found');
        }

        /** @var QueryBuilder $queryBuilder */
        $queryBuilder = $repository->createQueryBuilder('o');
        $queryNameGenerator = new QueryNameGenerator();

        $param = $queryNameGenerator->generateParameterName('roleNames');
        $queryBuilder->where(sprintf('o.name IN (:%s)', $param))->setParameter($param, $user->getRoles());

        foreach ($this->collectionExtensions as $extension) {
            $extension->applyToCollection($queryBuilder, $queryNameGenerator, Role::class, $operationName, $context);

            if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult(Role::class, $operationName, $context)) {
                return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context);
            }
        }

        return $queryBuilder;
    }

    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
    {
        return User::class === $resourceClass
            && $context['property'] === 'roles'
            && $this->managerRegistry->getManagerForClass($resourceClass) instanceof EntityManagerInterface;
    }
}
  1. 配置服务
代码语言:javascript
复制
App\DataProvider\UserRoleDataProvider:
    arguments:
        $collectionExtensions: !tagged api_platform.doctrine.orm.query_extension.collection
  1. 现在您可以调用您的路由:path('api_users_roles_get_subresource', {id: user.id})

我花了一点时间才弄明白这件事,所以我希望这能帮到别人。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/73583513

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档