[英]JMS Groups Serialization and PagerFantaBundle
I'm working on a RESTFull API with Symfony and FOSRESTBundle. 我正在使用Symfony和FOSRESTBundle开发RESTFull API。 I use the JMS Serializer with groups to show differents fields depending on the context.
我将JMS序列化程序与组一起使用,以根据上下文显示不同的字段。
For listing my resources, I want implement PagerFantaBundle. 为了列出我的资源,我想实现PagerFantaBundle。 All work fine except that PagerFanta does not consider the serialization groups.
除PagerFanta不考虑序列化组外,其他所有方法都工作正常。
Below my code : 在我的代码下面:
Pagination function : 分页功能:
protected function paginate(QueryBuilder $qb, $limit = 20, $offset = 0) {
if($limit == 0 || $offset < 0) {
throw new \LogicException("$limit & $offset must be greater than 0");
}
$pager = new Pagerfanta(new DoctrineORMAdapter($qb));
$currentPage = ceil($offset + 1 / $limit);
$pager->setCurrentPage($currentPage);
$pager->setMaxPerPage((int) $limit);
return $pager;
}
List apartment function : 列出公寓功能:
public function listApartments(Location $location, $order = 'asc', $limit = 20, $offset = 0) {
$qb = $this->createQueryBuilder('a')
->select('a')
->orderBy('a.title', $order);
return $this->paginate($qb, $limit, $offset);
}
Controller : 控制器:
/**
* @Rest\Get(
* path = "/apartments",
* name = "apartments_get_all"
* )
* @Rest\QueryParam(
* name="order",
* requirements="asc|desc",
* nullable=true,
* description="Sort order (asc or desc)"
* )
* @Rest\QueryParam(
* name="limit",
* requirements="\d+",
* default="20",
* description="Max number of apartments per page"
* )
* @Rest\QueryParam(
* name="offset",
* requirements="\d+",
* default="0",
* description="Pagination offset"
* )
* @Rest\View(statusCode=200, serializerGroups={"listApartment"})
*/
public function getApartmentsAction(ParamFetcherInterface $paramFetcher)
{
$pager = $this->getDoctrine()->getRepository("HGBCoreBundle:Apartment")->listApartments(
new Location(),
$paramFetcher->get('order'),
$paramFetcher->get('limit'),
$paramFetcher->get('offset')
);
return new Apartments($pager);
}
Apartments representation : 公寓代表:
class Apartments
{
/**
* @Type("array<HGB\CoreBundle\Entity\Apartment>")
*/
public $data;
public $meta;
public function __construct(Pagerfanta $data)
{
$this->data = $data->getCurrentPageResults();
$this->addMeta('limit', $data->getMaxPerPage());
$this->addMeta('current_items', count($data->getCurrentPageResults()));
$this->addMeta('total_items', $data->getNbResults());
$this->addMeta('offset', $data->getCurrentPageOffsetStart());
}
public function addMeta($name, $value)
{
if (isset($this->meta[$name])) {
throw new \LogicException(sprintf('This meta already exists. You are trying to override this meta, use the setMeta method instead for the %s meta.', $name));
}
$this->setMeta($name, $value);
}
public function setMeta($name, $value)
{
$this->meta[$name] = $value;
}
}
Apartment Entity : 公寓实体:
/**
* Apartment
*
* @ORM\Table(name="apartment")
* @ORM\Entity(repositoryClass="HGB\CoreBundle\Repository\ApartmentRepository")
* @JMS\ExclusionPolicy("all")
*/
class Apartment
{
/**
* @var int
*
* @ORM\Column(name="id", type="integer")
* @ORM\Id
* @ORM\GeneratedValue(strategy="AUTO")
* @JMS\Groups({"listApartment"})
* @JMS\Expose()
*/
private $id;
/**
* @var string
*
* @ORM\Column(name="title", type="string", length=200)
* @JMS\Groups({"listApartment"})
* @JMS\Expose()
* @Assert\NotBlank()
*/
private $title;
...
So, how can I use group serialization with PagerFanta, or what pagination system could I use with groups serialization ? 因此,如何将组序列化与PagerFanta一起使用,或者可以将哪些分页系统用于组序列化?
Thanks 谢谢
I've found the solution. 我找到了解决方案。 Just need to configure the serialization groups for the Apartments representation like this :
只需为Apartments表示形式配置序列化组,如下所示:
<?php
namespace HGB\CoreBundle\Representation;
use JMS\Serializer\Annotation as Serializer;
use Pagerfanta\Pagerfanta;
/**
* Class Apartments
* @package HGB\CoreBundle\Representation
* @Serializer\ExclusionPolicy("all")
*/
class Apartments
{
/**
* @Serializer\Type("array<HGB\CoreBundle\Entity\Apartment>")
* @Serializer\Groups("listApartment")
* @Serializer\Expose()
*/
public $data;
/**
* @Serializer\Groups("listApartment")
* @Serializer\Expose()
*/
public $meta;
public function __construct(Pagerfanta $data)
{
$this->data = $data;
$this->addMeta('limit', $data->getMaxPerPage());
$this->addMeta('current_items', count($data->getCurrentPageResults()));
$this->addMeta('total_items', $data->getNbResults());
$this->addMeta('offset', $data->getCurrentPageOffsetStart());
}
public function addMeta($name, $value)
{
if (isset($this->meta[$name])) {
throw new \LogicException(sprintf('This meta already exists. You are trying to override this meta, use the setMeta method instead for the %s meta.', $name));
}
$this->setMeta($name, $value);
}
public function setMeta($name, $value)
{
$this->meta[$name] = $value;
}
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.