A couple of days ago, one of our developers mentioned wanting to log all the requests that hit a specific Symfony2 controller. Back in Symfony 1.2, you’d be able to easily accomplish this with a “preExecute” function in the specific controller that you want to log. We’d actually set something similar to this up and the code would end up looking like:
This file contains 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
| <?php | |
| public function preExecute(){ | |
| $this->jsonVariables = strlen($this->getRequest()->getContent()) | |
| ? json_decode( $this->getRequest()->getContent(), true ) : array(); | |
| if( strlen(trim($this->getRequest()->getContent())) && $this->getUser()->getUserId() ){ | |
| $uid = $this->getUser()->getUserId(); | |
| $log = new JsonApiLog(); | |
| $log->setUserId( $uid ); | |
| $log->setRequestBody( $this->getRequest()->getContent() ); | |
| $log->save(); | |
| } | |
| } |
by Symfony2 doesn’t have a “preExecute” hook in the same fashion as 1.2 but using the event system you can accomplish the same thing. What you’ll basically end up doing is configuring an event listener for the “kernel.controller” event, inject the EntityManager (or kernel) and then log the request.
The pertinent service configuration in YAML looks like:
This file contains 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
| ctbe.apirequest_listner: | |
| class: CT\BEBundle\Event\ApiControllerRequest | |
| arguments: [@kernel] | |
| tags: | |
| - { name: kernel.event_listener, event: kernel.controller, method: onControllerRequest } |
And then the corresponding class looks something like:
This file contains 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
| <?php | |
| namespace CT\BEBundle\Event; | |
| use CT\BEBundle\Entity\ApiRequest; | |
| use Symfony\Component\HttpKernel\HttpKernelInterface; | |
| use Symfony\Component\HttpKernel\Event\FilterControllerEvent; | |
| use Symfony\Component\HttpKernel\Kernel; | |
| class ApiControllerRequest { | |
| private $kernel; | |
| public function __construct(Kernel $kernel){ | |
| $this->kernel = $kernel; | |
| } | |
| public function onControllerRequest(FilterControllerEvent $event){ | |
| $controller = $event->getRequest()->attributes->get('_controller'); | |
| if( count(explode("::", $controller)) == 1 ){ | |
| return; | |
| } | |
| list($className, $methodName) = explode("::", $controller); | |
| $className = explode("\\", $className); | |
| $className = $className[count($className) - 1]; | |
| if( strpos($className, "Api") === false ){ | |
| return; | |
| } | |
| $user = $this->kernel->getContainer()->get('security.context')->getToken()->getUser(); | |
| $req = new ApiRequest(); | |
| $req->setUser($user); | |
| $req->setRequest( $event->getRequest()->getContent() ); | |
| $req->setUrl( $event->getRequest()->getRequestUri() ); | |
| $this->kernel->getContainer()->get("doctrine")->getEntityManager()->persist($req); | |
| $this->kernel->getContainer()->get("doctrine")->getEntityManager()->flush($req); | |
| } | |
| } |
And thats about it.