FOSRestBundle: częściowa odpowiedź w zależności od atrybutów zapytał żądania

Question

kontekście

Znalazłem wiele pytań o częściowej odpowiedzi API z FOSRest i wszystkie odpowiedzi są oparte na opcjach JMS serializer (exlude, obejmują grupy, itp). Działa dobrze, ale staram się osiągnąć coś mniej "statycznego".

Powiedzmy mam użytkownikowi następujące atrybuty: idusernamefirstnamelastnameagesex

odzyskać to użytkownikowi końcowym GET /users/{id} i następujący sposób:

/** 
* @View 
* 
* GET /users/{id} 
* @param integer $user (uses ParamConverter) 
*/ 
public function getUserAction(User $user) { 
    return $user; 
} 

metoda zwraca użytkownik ze wszystkimi swoimi atrybutami.

Teraz chcę, aby umożliwić coś takiego: GET /users/{id}?attributes=id,username,sex

Pytanie

ja brakowało funkcjonalności FOSRestBUndle, JMSserializer lub SensioFrameworkExtraBundle osiągnąć to automatycznie? Adnotacja, metoda, słowo kluczowe w żądaniu lub coś innego?

W przeciwnym razie, jaki jest najlepszy sposób, aby to osiągnąć?

Kod

myślałem zrobić coś takiego:

/** 
* @View 
* @QueryParam(name="attributes") 
* 
* GET /users/{id} 
* 
* @param integer $user (uses ParamConverter) 
*/ 
public function getUserAction(User $user, $attributes) { 
    $groups = $attributes ? explode(",", $attributes) : array("Default"); 

    $view = $this->view($user, 200) 
     ->setSerializationContext(SerializationContext::create()->setGroups($groups)); 

    return $this->handleView($view); 
} 

i utworzyć grupę dla każdego atrybutu:

use JMS\Serializer\Annotation\Groups; 

class User { 

    /** @Groups({"id"}) */ 
    protected $id; 

    /** @Groups({"username"}) */ 
    protected $username; 

    /** @Groups({"firstname"}) */ 
    protected $firstname; 

    //etc 
} 

Answer 1

można to zrobić tak przez grupy, jak ty "pokazano. Być może nieco bardziej eleganckim rozwiązaniem byłoby zaimplementowanie własnego ExclusionStrategy. @Groups i inne są również implementacjami ExclusionStrategyInterface.

Załóżmy, że nazwałaś swoją strategię: SelectFieldsStrategy. Kiedy wdrożyć go, możesz dodać go do swojej kontekście serializacji bardzo proste:

$context = new SerializationContext(); 
$context->addExclusionStrategy(new SelectFieldsStrategy(['id', 'name', 'someotherfield'])); 

Answer 2

Moje wykonanie na podstawie Igor's answer:

ExlusionStrategy:

use JMS\Serializer\Exclusion\ExclusionStrategyInterface; 
use JMS\Serializer\Metadata\ClassMetadata; 
use JMS\Serializer\Metadata\PropertyMetadata; 
use JMS\Serializer\Context; 

class FieldsExclusionStrategy implements ExclusionStrategyInterface { 
    private $fields = array(); 

    public function __construct(array $fields) { 
     $this->fields = $fields; 
    } 

    public function shouldSkipClass(ClassMetadata $metadata, Context $navigatorContext) { 
     return false; 
    } 

    public function shouldSkipProperty(PropertyMetadata $property, Context $navigatorContext) { 
     if (empty($this->fields)) { 
      return false; 
     } 

     if (in_array($property->name, $this->fields)) { 
      return false; 
     } 

     return true; 
    } 
} 

Kontroler:

/** 
* @View 
* @QueryParam(name="fields") 
* 
* GET /users/{id} 
* 
* @param integer $user (uses ParamConverter) 
*/ 
public function getUserAction(User $user, $fields) { 
    $context = new SerializationContext(); 
    $context->addExclusionStrategy(new FieldsExclusionStrategy($fields ? explode(',', $fields) : array())); 

    return $this->handleView($this->view($user)->setSerializationContext($context)); 
} 

Endpoint:

GET /users/{id}?fields=id,username,sex