feature #3776 Updated event_listener.rst (bfgasparin)

weaverryan · weaverryan · commit e8511cb4e5ab · 2014-05-27T13:57:01.000-05:00
This PR was merged into the 2.4 branch. Discussion ---------- Updated event_listener.rst Updated event_listener.rst to use the new KernelEvent::isMasterRequest method | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.4+ | Fixed tickets | none Commits ------- 4fc3b6a Fixed internals.rst syntax a6b17a0 Added KernelEvent::isMasterRequest method reference 8e8b8a0 Added Versionadded directive to event_listener.rst 0127bd2 Updated event_listener.rst
diff --git a/book/internals.rst b/book/internals.rst
@@ -208,6 +208,10 @@ processing must only occur on the master request).
 Events
 ~~~~~~
 
+.. versionadded:: 2.4
+    The ``isMasterRequest()`` method was introduced in Symfony 2.4.
+    Prior, the ``getRequestType()`` method must be used.
+
 Each event thrown by the Kernel is a subclass of
 :class:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent`. This means that
 each event has access to the same basic information:
@@ -216,22 +220,25 @@ each event has access to the same basic information:
   - returns the *type* of the request (``HttpKernelInterface::MASTER_REQUEST``
   or ``HttpKernelInterface::SUB_REQUEST``);
 
+* :method:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent::isMasterRequest`
+  - checks if it is a master request;
+
 * :method:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent::getKernel`
   - returns the Kernel handling the request;
 
 * :method:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent::getRequest`
   - returns the current ``Request`` being handled.
 
-``getRequestType()``
-....................
+``isMasterRequest()``
+.....................
 
-The ``getRequestType()`` method allows listeners to know the type of the
+The ``isMasterRequest()`` method allows listeners to check the type of the
 request. For instance, if a listener must only be active for master requests,
 add the following code at the beginning of your listener method::
 
     use Symfony\Component\HttpKernel\HttpKernelInterface;
 
-    if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
+    if (!$event->isMasterRequest()) {
         // return immediately
         return;
     }
diff --git a/components/http_kernel/introduction.rst b/components/http_kernel/introduction.rst
@@ -665,12 +665,16 @@ argument as follows::
     $response = $kernel->handle($request, HttpKernelInterface::SUB_REQUEST);
     // do something with this response
 
+.. versionadded:: 2.4
+    The ``isMasterRequest()`` method was introduced in Symfony 2.4.
+    Prior, the ``getRequestType()`` method must be used.
+
 This creates another full request-response cycle where this new ``Request`` is
 transformed into a ``Response``. The only difference internally is that some
 listeners (e.g. security) may only act upon the master request. Each listener
 is passed some sub-class of :class:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent`,
-whose :method:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent::getRequestType`
-can be used to figure out if the current request is a "master" or "sub" request.
+whose :method:`Symfony\\Component\\HttpKernel\\Event\\KernelEvent::isMasterRequest`
+can be used to check if the current request is a "master" or "sub" request.
 
 For example, a listener that only needs to act on the master request may
 look like this::
@@ -680,7 +684,7 @@ look like this::
 
     public function onKernelRequest(GetResponseEvent $event)
     {
-        if (HttpKernelInterface::MASTER_REQUEST !== $event->getRequestType()) {
+        if (!$event->isMasterRequest()) {
             return;
         }
 
diff --git a/cookbook/service_container/event_listener.rst b/cookbook/service_container/event_listener.rst
@@ -100,6 +100,10 @@ using a special "tag":
 Request events, checking types
 ------------------------------
 
+.. versionadded:: 2.4
+    The ``isMasterRequest()`` method was introduced in Symfony 2.4.
+    Prior, the ``getRequestType()`` method must be used.
+
 A single page can make several requests (one master request, and then multiple
 sub-requests), which is why when working with the ``KernelEvents::REQUEST``
 event, you might need to check the type of the request. This can be easily
@@ -115,7 +119,7 @@ done as follow::
     {
         public function onKernelRequest(GetResponseEvent $event)
         {
-            if (HttpKernel::MASTER_REQUEST != $event->getRequestType()) {
+            if (!$event->isMasterRequest()) {
                 // don't do anything if it's not the master request
                 return;
             }

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,10 @@ using a special "tag":`
`100`	`100`	`Request events, checking types`
`101`	`101`	`------------------------------`
`102`	`102`
	`103`	`+.. versionadded:: 2.4`
	`104`	+ The ``isMasterRequest()`` method was introduced in Symfony 2.4.
	`105`	+ Prior, the ``getRequestType()`` method must be used.
	`106`	`+`
`103`	`107`	`A single page can make several requests (one master request, and then multiple`
`104`	`108`	sub-requests), which is why when working with the ``KernelEvents::REQUEST``
`105`	`109`	`event, you might need to check the type of the request. This can be easily`
`@@ -115,7 +119,7 @@ done as follow::`
`115`	`119`	`{`
`116`	`120`	`public function onKernelRequest(GetResponseEvent $event)`
`117`	`121`	`{`
`118`		`- if (HttpKernel::MASTER_REQUEST != $event->getRequestType()) {`
	`122`	`+ if (!$event->isMasterRequest()) {`
`119`	`123`	`// don't do anything if it's not the master request`
`120`	`124`	`return;`
`121`	`125`	`}`