FOSRestBundle: partielles Ansprechen in Abhängigkeit von Attributen in der Anfrage

Question

Kontext gefragt

ich eine Menge Fragen über Teil API-Antwort mit FOSRest gefunden und alle Antworten basieren auf den JMS-Serializer-Optionen (exlude, umfassen Gruppen, etc). Es funktioniert gut, aber ich versuche, etwas weniger "statisch" zu erreichen.

Sagen wir, ich habe einen Benutzer mit den folgenden Attributen: idusernamefirstnamelastnameagesex

ich abrufen diesen Benutzer mit dem Endpunkt GET /users/{id} und die folgende Methode:

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

Die Methode liefert der Benutzer mit all seinen Attributen.

Jetzt möchte ich, so etwas erlauben: GET /users/{id}?attributes=id,username,sex

Frage

Habe ich eine Funktionalität von FOSRestBUndle, JMSserializer oder SensioFrameworkExtraBundle verpassten es automatisch zu erreichen? Eine Annotation, eine Methode, ein Schlüsselwort in der Anfrage oder etwas anderes?

Oder, was ist der beste Weg, um es zu erreichen?

-Code

Ich dachte, so etwas zu tun:

/** 
* @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); 
} 

und eine Gruppe für jedes Attribut erstellen:

use JMS\Serializer\Annotation\Groups; 

class User { 

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

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

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

    //etc 
} 

Answer 1

Sie es so, dass durch Gruppen tun können, wie Sie habe gezeigt. Vielleicht wäre eine etwas elegantere Lösung, Ihre eigene ExclusionStrategy zu implementieren. @Groups und andere sind auch Implementierungen von ExclusionStrategyInterface.

Also, sagen Sie, Sie haben Ihre Strategie SelectFieldsStrategy aufgerufen. Sobald Sie es implementieren, können Sie es zu Ihrem Serialisierungskontext hinzufügen sehr einfach:

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

Answer 2

Meine Implementierung basiert auf 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; 
    } 
} 

Controller:

/** 
* @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)); 
} 

Endpunkt:

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