Marshaller integration in Symfony., (*1)
Installation
MarshallerBundle can be installed using Composer:, (*2)
composer require "gnugat/marshaller-bundle:~2.0"
We then need to register it in our application:, (*3)
<?php
// File: app/AppKernel.php
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Config\Loader\LoaderInterface;
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new Gnugat\MarshallerBundle\GnugatMarshallerBundle(),
);
// ...
}
// ...
}
Simple conversion
Let's take the following object:, (*4)
<?php
// File: src/AppBundle/Entity/Article.php
namespace AppBundle\Entity;
class Article
{
public function __construct($title, $content)
{
$this->title = $title;
$this->content = $content;
}
public function getTitle()
{
return $this->title;
}
public function getContent()
{
return $this->content;
}
}
If we want to convert it to the following format:, (*5)
array(
'title' => 'Nobody expects...',
'content' => '... The Spanish Inquisition!',
);
Then we have first to create a MarshallerStrategy:, (*6)
<?php
// File: src/AppBundle/Marshaller/ArticleMarshaller.php
use AppBundle\Entity\Article;
use Gnugat\Marshaller\MarshallerStrategy;
class ArticleMarshaller implements MarshallerStrategy
{
public function supports($toMarshal, $category = null)
{
return $toMarshal instanceof Article;
}
public function marshal($toMarshal)
{
return array(
'title' => $toMarshal->getTitle(),
'content' => $toMarshal->getContent(),
);
}
}
The second step is to define it as a service:, (*7)
# File: app/config/services.yml
services:
app.article_marshaller:
class: AppBundle\Marshaller\ArticleMarshaller
tags:
- { name: gnugat_marshaller }
Note: Thanks to the gnugat_marshaller tag, the ArticleMarshaller will
be registered in the main gnugat_marshaller.marshaller service., (*8)
Finally we can actually convert the object:, (*9)
<?php
// File: src/AppBundle/Controller/ArticleController.php
namespace AppBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
class ArtcileController extends Controller
{
/**
* @Route("/api/v1/articles")
* @Method({"GET"})
*/
public function listAction()
{
$articles = $this->get('app.article_repository')->findAll();
return new JsonResponse($this->get('gnugat_marshaller.marshaller')->marshalCollection($articles), 200);
}
/**
* @Route("/api/v1/articles/{id}")
* @Method({"GET"})
*/
public function viewAction(Article $article)
{
return new JsonResponse($this->get('gnugat_marshaller.marshaller')->marshal($article), 200);
}
}
Note: gnugat_marshaller.marshaller can also call the ArticleMarshaller
on Article collections., (*10)
Partial conversions
If we need to convert Article into the following format:, (*11)
array('title' => 'Nobody expects...');
Then we first have to define a new MarshallStrategy:, (*12)
// File: src/AppBundle/Marshaller/ArticleMarshaller.php
use AppBundle\Entity\Article;
use Gnugat\Marshaller\MarshallStrategy;
class PartialArticleMarshaller implements MarshallStrategy
{
public function supports($toMarshal, $category = null)
{
return $toMarshal instanceof Article && 'partial' === $category;
}
public function marshal($toMarshal)
{
return array(
'title' => $toMarshal->getTitle(),
);
}
}
Since this MarshallerStrategy has a more restrictive support condition, we'd
like it to be checked before ArticleMarshaller. This can be done by registering
PartialArticleMarshaller with a higher priority than ArticleMarshaller
(in this case with a priority higher than 0):, (*13)
# File: app/config/services.yml
services:
app.article_marshaller:
class: AppBundle\Marshaller\PartialArticleMarshaller
tags:
- { name: gnugat_marshaller, priority: 1 }
Finally we can call Marshaller, for the partial category:, (*14)
<?php
// File: src/AppBundle/Controller/ArticleController.php
namespace AppBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
class ArtcileController extends Controller
{
/**
* @Route("/api/v1/articles")
* @Method({"GET"})
*/
public function listAction()
{
$articles = $this->get('app.article_repository')->findAll();
return new JsonResponse($this->get('gnugat_marshaller.marshaller')->marshalCollection($articles, 'partial'), 200);
}
/**
* @Route("/api/v1/articles/{id}")
* @Method({"GET"})
*/
public function viewAction(Article $article)
{
return new JsonResponse($this->get('gnugat_marshaller.marshaller')->marshal($article), 200);
}
}
Further documentation
You can see the current and past versions using one of the following:, (*15)
You can find more documentation at the following links:, (*16)
Wallogit.com
