Wie Format des Parameters in Nelmio eingeben ApiDocBundle

Question

Ich verwende input Eigenschaft @ApiDoc Annotation für die Angabe von Parametern meiner API, die Form Felder sind.

data_class des Formulars ist eine Entität, die eine Einschränkungsüberprüfung für Eigenschaften aufweist.

Ich erwarte, dass nelmio api doc das Parameterformat als Validierungsbedingungen der Entität angibt, aber das Format leer ist.

Wie kann ich Parameter Formate in nelmio ApiDocBundle angeben?

---

EDIT: vielleicht schreibe ich eine schlechte Frage.

wir Parser für input & output angeben können, wenn wir keine Parser für diese angeben, rufen sie alle Parser für input & output, dann werden alle Parser für UserType genannt werden.

nelmio hat einen Parser ValidationParser benannt, die ein Verfahren parseConstraint genannt haben, die format für die Eingabe & Ausgang gesetzt, aber diese Methode ist nicht für mein Dokument genannt, warum?

Answer 1

Ich reiche eine Pull-Anfrage ein, die Validierungsmetadaten für format Property verwendet.

Sie können sehen, diese PRhere

Answer 2

Wie Sie sehen können here können Sie Filter in Annotation wie es Dokumentation Beispiel getan.

Hier Teil dieses Beispiels:

/** 
* This is the documentation description of your method, it will appear 
* on a specific pane. It will read all the text until the first 
* annotation. 
* 
* @ApiDoc(
* resource=true, 
* description="This is a description of your API method", 
* filters={ 
*  {"name"="a-filter", "dataType"="integer"}, 
*  {"name"="another-filter", "dataType"="string", "pattern"="(foo|bar) ASC|DESC"} 
* } 
*) 
*/ 
public function getAction() 
{ 
} 

Answer 3

Format Spalte ist nur für datetime, date und choice Typen.

Für datetime und date es repräsentiert das Datumsformat wie Y-m-d H:i:s und die Reihe von Entscheidungen für choice.

Ich habe keine Dokumentation darüber gefunden, also musste ich den Quellcode durchsehen. Dies ist FormTypeParser Klasse, der Ort, wo FormType tatsächlich geparst ist und und Sie können sehen, wie Formatfeld festgelegt ist.

In FormTypeParserTest Klasse können Sie sehen, wie man es benutzt. Übergeben Sie einfach den String-Parameter mit format Namen für einen der verfügbaren Typen und der Parser wird damit umgehen.

UPDATE: Sie sind Ihre Einschränkungen innerhalb Ihrer FormType Klasse zu definieren.

Zum Beispiel:

class TestType extends AbstractType 
{ 
    /** 
    * @Assert\Type("string") 
    * @Assert\Length(min="10", max="255") 
    * @Assert\Regex("/^[^<>]+$/i") 
    */ 
    private $title; 

    /** 
    * @Assert\Type("string") 
    * @Assert\Length(min="10", max="255") 
    * @Assert\Regex("/^[^<>]+$/i") 
    */ 
    private $content; 

    /** 
    * @Assert\Date() 
    */ 
    private $created; 

    public function getName() 
    { 
     return 'test'; 
    } 
} 

wird in analysiert werden:

ValidationParser in doParse() Methode findet alle in Ihrer FormType Klasse definiert Constraints und führt dann parseConstraint() Verfahren für jeden von ihnen .

Sie können auch FormTypeParser wie oben beschrieben verwenden. Zum Beispiel:

public function buildForm(FormBuilderInterface $builder, array $options) 
{ 
    $builder->add('created', 'date', array('label' => 'Created', 'format' => 'yyyy-MM-dd')) 
     ->add('color', 'choice', array('label' => 'Color', 'choices' => array('grey' => '#CCCCCC', 'red' => '#FF0000'))) 
     ->add('save', 'submit'); 
} 

wird analysiert, wie:

Hoffe, dass es jetzt hilft!