[FrameworkBundle] Added configuration for additionnal request formats #9862
Next
Next commit
[FrameworkBundle] Added configuration for additionnal request formats
- Loading branch information
commit 10c2b06b37c10ced63af432d1af324af823fc226
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\FrameworkBundle\EventListener; | ||
|
|
||
| use Symfony\Component\EventDispatcher\EventSubscriberInterface; | ||
| use Symfony\Component\HttpKernel\KernelEvents; | ||
| use Symfony\Component\HttpKernel\Event\GetResponseEvent; | ||
|
|
||
| /** | ||
| * Set additional formats into the request | ||
| * | ||
| * @author Gildas Quemener <gildas.quemener@gmail.com> | ||
| */ | ||
| class AddRequestFormatsListener implements EventSubscriberInterface | ||
| { | ||
| /** | ||
| * @var array | ||
| */ | ||
| protected $formats; | ||
|
|
||
| /** | ||
| * @param array $formats | ||
| */ | ||
| public function __construct(array $formats) | ||
| { | ||
| $this->formats = $formats; | ||
| } | ||
|
|
||
| /** | ||
| * Set additionnal request formats | ||
| * | ||
| * @param GetResponseEvent $event | ||
| */ | ||
| public function onKernelRequest(GetResponseEvent $event) | ||
| { | ||
| foreach ($this->formats as $format => $mimeTypes) { | ||
| $event->getRequest()->setFormat($format, $mimeTypes); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public static function getSubscribedEvents() | ||
| { | ||
| return array( | ||
|
There was a problem hiding this comment. Everything should be on one line. |
||
| KernelEvents::REQUEST => 'onKernelRequest', | ||
| ); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <?xml version="1.0" ?> | ||
|
|
||
| <container xmlns="http://symfony.com/schema/dic/services" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> | ||
|
|
||
| <parameters> | ||
| <parameter key="request.add_request_formats_listener.class">Symfony\Bundle\FrameworkBundle\EventListener\AddRequestFormatsListener</parameter> | ||
| </parameters> | ||
|
|
||
| <services> | ||
| <service id="request.add_request_formats_listener" class="%request.add_request_formats_listener.class%"> | ||
| <tag name="kernel.event_subscriber" /> | ||
| <argument>%request.additional_formats%</argument> | ||
| </service> | ||
| </services> | ||
| </container> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <?php | ||
|
|
||
| $container->loadFromExtension('framework', array( | ||
| 'request' => array( | ||
| 'additional_formats' => array(), | ||
| ), | ||
| )); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <?xml version="1.0" ?> | ||
|
|
||
| <container xmlns="http://symfony.com/schema/dic/services" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xmlns:framework="http://symfony.com/schema/dic/symfony" | ||
| xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd | ||
| http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd"> | ||
| <framework:config> | ||
| <framework:request /> | ||
| </framework:config> | ||
| </container> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| framework: | ||
| request: | ||
| additional_formats: ~ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bundle\FrameworkBundle\Tests\EventListener; | ||
|
|
||
| use Symfony\Bundle\FrameworkBundle\EventListener\AddRequestFormatsListener; | ||
| use Symfony\Component\HttpFoundation\Request; | ||
| use Symfony\Component\HttpKernel\KernelEvents; | ||
|
|
||
| /** | ||
| * Test AddRequestFormatsListener class | ||
| * | ||
| * @author Gildas Quemener <gildas.quemener@gmail.com> | ||
| */ | ||
| class AddRequestFormatsListenerTest extends \PHPUnit_Framework_TestCase | ||
| { | ||
| /** | ||
| * @var AddRequestFormatsListener | ||
| */ | ||
| private $listener; | ||
|
|
||
| protected function setUp() | ||
| { | ||
| $this->listener = new AddRequestFormatsListener(array('csv' => array('text/csv', 'text/plain'))); | ||
| } | ||
|
|
||
| protected function tearDown() | ||
| { | ||
| $this->listener = null; | ||
| } | ||
|
|
||
| public function testIsAnEventSubscriber() | ||
| { | ||
| $this->assertInstanceOf('Symfony\Component\EventDispatcher\EventSubscriberInterface', $this->listener); | ||
| } | ||
|
|
||
| public function testRegisteredEvent() | ||
| { | ||
| $this->assertEquals( | ||
| array( | ||
|
There was a problem hiding this comment. you could put this into a single line |
||
| KernelEvents::REQUEST => 'onKernelRequest', | ||
| ), | ||
| AddRequestFormatsListener::getSubscribedEvents() | ||
| ); | ||
| } | ||
|
|
||
| public function testSetAdditionnalFormats() | ||
|
|
||
| { | ||
| $request = $this->getRequestMock(); | ||
| $event = $this->getGetResponseEventMock($request); | ||
|
|
||
| $request->expects($this->once()) | ||
| ->method('setFormat') | ||
| ->with('csv', array('text/csv', 'text/plain')); | ||
|
|
||
| $this->listener->onKernelRequest($event); | ||
| } | ||
|
|
||
| protected function getRequestMock() | ||
| { | ||
| return $this->getMock('Symfony\Component\HttpFoundation\Request'); | ||
| } | ||
|
|
||
| protected function getGetResponseEventMock(Request $request) | ||
|
There was a problem hiding this comment. wonder if in symfony/symfony these are straight private |
||
| { | ||
| $event = $this | ||
| ->getMockBuilder('Symfony\Component\HttpKernel\Event\GetResponseEvent') | ||
| ->disableOriginalConstructor() | ||
| ->getMock(); | ||
|
|
||
| $event->expects($this->any()) | ||
| ->method('getRequest') | ||
| ->will($this->returnValue($request)); | ||
|
|
||
| return $event; | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of creating a parameter, I'd inject the value directly into the listener service (like done everywhere else).