gnugat / marshaller-bundle
Marshaller integration in Symfony
Installs: 285
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Type:symfony-bundle
Requires
- gnugat/marshaller: ~2.0
- symfony/config: ~2.3
- symfony/dependency-injection: ~2.3
- symfony/http-kernel: ~2.3
- symfony/yaml: ~2.3
Requires (Dev)
- phpunit/phpunit: >=3.7,<5.0
- symfony/framework-bundle: ~2.3
This package is auto-updated.
Last update: 2022-02-01 12:47:46 UTC
README
Marshaller integration in Symfony.
Installation
MarshallerBundle can be installed using Composer:
composer require "gnugat/marshaller-bundle:~2.0"
We then need to register it in our application:
<?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:
<?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:
array( 'title' => 'Nobody expects...', 'content' => '... The Spanish Inquisition!', );
Then we have first to create a MarshallerStrategy
:
<?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:
# File: app/config/services.yml
services:
app.article_marshaller:
class: AppBundle\Marshaller\ArticleMarshaller
tags:
- { name: gnugat_marshaller }
Note: Thanks to the
gnugat_marshaller
tag, theArticleMarshaller
will be registered in the maingnugat_marshaller.marshaller
service.
Finally we can actually convert the object:
<?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 theArticleMarshaller
onArticle
collections.
Partial conversions
If we need to convert Article
into the following format:
array('title' => 'Nobody expects...');
Then we first have to define a new MarshallStrategy
:
// 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):
# 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:
<?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:
- the
git tag
command - the releases page on Github
- the file listing the changes between versions
You can find more documentation at the following links: