RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #255 from adrienbrault/form-type-name

Browse Source 
Can now specifiy form name
This commit is contained in:
William Durand 2013-10-09 16:18:34 -07:00
commit 7317c7aa81
3 changed files with 55 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Parser/FormTypeParser.php
View File

@ -82,7 +82,7 @@ class FormTypeParser implements ParserInterface
$form = $this->formFactory->create($type); $form = $this->formFactory->create($type);
return $this->parseForm($form, $form->getName()); return $this->parseForm($form, array_key_exists('name', $item) ? $item['name'] : $form->getName());
} }
private function parseForm($form, $prefix = null) private function parseForm($form, $prefix = null)

14
README.md
View File

@ -209,6 +209,20 @@ you can specify which groups to use when generating the documentation by using t
If your `output` classes use [versioning capabilities of JMS Serializer](http://jmsyst.com/libs/serializer/master/cookbook/exclusion_strategies#versioning-objects), If your `output` classes use [versioning capabilities of JMS Serializer](http://jmsyst.com/libs/serializer/master/cookbook/exclusion_strategies#versioning-objects),
the versioning information will be automatically used when generating the documentation. the versioning information will be automatically used when generating the documentation.
#### Form Types features ####
If you use `FormFactoryInterface::createdNamed('', 'your_form_type'`, then by default the documentation will use
the form type name as the prefix (`your_form_type[param]` ... instead of just `param`).
You can specify which prefix to use with the `name` key:
```
input = {
"class" = "your_form_type",
"name" = ""
}
```
### Documentation on-the-fly ### ### Documentation on-the-fly ###
By calling an URL with the parameter `?_doc=1`, you will get the corresponding documentation if available. By calling an URL with the parameter `?_doc=1`, you will get the corresponding documentation if available.

40
Tests/Parser/FormTypeParserTest.php
View File

@ -72,6 +72,46 @@ class FormTypeParserTest extends \PHPUnit_Framework_TestCase
) )
) )
), ),
array(
array(
'class' => 'Nelmio\ApiDocBundle\Tests\Fixtures\Form\CollectionType',
'name' => '',
),
array(
'a' => array(
'dataType' => 'array of strings',
'required' => true,
'description' => '',
'readonly' => false
),
'b' => array(
'dataType' => 'string',
'required' => true,
'description' => '',
'readonly' => false
)
)
),
array(
array(
'class' => 'Nelmio\ApiDocBundle\Tests\Fixtures\Form\CollectionType',
'name' => null,
),
array(
'a' => array(
'dataType' => 'array of strings',
'required' => true,
'description' => '',
'readonly' => false
),
'b' => array(
'dataType' => 'string',
'required' => true,
'description' => '',
'readonly' => false
)
)
),
); );
} }
} }