{"id":196,"date":"2014-08-05T13:06:19","date_gmt":"2014-08-05T16:06:19","guid":{"rendered":"http:\/\/arielnavarrete.wordpress.com\/?p=196"},"modified":"2014-08-05T13:06:19","modified_gmt":"2014-08-05T16:06:19","slug":"knp_paginator-con-consulta-sql-personalizada-createnativequery","status":"publish","type":"post","link":"https:\/\/arielnavarrete.cl\/blog\/2014\/08\/05\/knp_paginator-con-consulta-sql-personalizada-createnativequery\/","title":{"rendered":"knp_paginator con consulta SQL personalizada (createNativeQuery)"},"content":{"rendered":"

El Bundle\u00a0KnpPaginator<\/a> es una excelente ayuda que nos permite paginar de una forma bastante amigable y facil, normalmente su uso se refiera a pasarle una query que formamos mediante createQuery y este la procesa y nos entrega el resultado paginado segun los parametros que definamos pero… \u00bfQue sucede cuando deseamos pasarle una consulta personalizada? la respuesta es tajante, no lo soporta, pero nos entrega herramientas para hacerlo.<\/p>\n

<\/p>\n

En su documentaci\u00f3n hace referencia a Creating custom subscriber<\/a>, esto especificamente nos permite personalizar la funcion que recibe los item de nuestra paginacion, siguiendo los mismos pasos dados en la documentaci\u00f3n tenemos<\/p>\n

1) Creamos el archivo PaginateDirectorySubscriber<\/strong> en la misma ruta indicada pero dentro de tu Bundle<\/p>\n

&lt;?php\n\n\/\/Ruta donde esta el archivo dentro de nuestro Bundle\nnamespace AN\\PruebaBundle\\Subscriber;\n\nuse Symfony\\Component\\EventDispatcher\\EventSubscriberInterface;\nuse Knp\\Component\\Pager\\Event\\ItemsEvent;\nuse Doctrine\\ORM\\EntityManager;\nuse Doctrine\\ORM\\NativeQuery;\n\nclass PaginateDirectorySubscriber implements EventSubscriberInterface\n{\n\u00a0\u00a0 \u00a0protected $em;\n\n\u00a0\u00a0\u00a0 public function __construct(EntityManager $entityManager)\n\u00a0\u00a0\u00a0 {\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$this-&gt;em = $entityManager;\n\u00a0\u00a0\u00a0 }\n\n\u00a0\u00a0\u00a0 public function items(ItemsEvent $event)\n\u00a0\u00a0\u00a0 {\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/Aqui ira nuestra logica a procesar\n\u00a0\u00a0\u00a0 }\n\n\u00a0\u00a0\u00a0 public static function getSubscribedEvents()\n\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return array(\n             \/*increased priority to override any internal*\/\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 'knp_pager.items' =&gt; array('items', 1)\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 );\n\u00a0\u00a0\u00a0 }\n}\n\n<\/pre>\n
Obviamente la documentaci\u00f3n nos indica que debemos agregar Finder<\/strong>, pero para el uso que deseamos darle no lo ocuparemos, asi que lo omitimos.<\/p>\n
Adem\u00e1s si te das cuenta agregue EntityManager<\/strong>, principalmente por si requieres hacer una consulta interna u otra cosa, para este ejemplo no lo ocuparemos, pero lo dejaremos incluido por si lo requieren.<\/p>\n
Por ultimo, agregue NativeQuery<\/strong> el cual nos ayudara a determinar si es una query normal o no.<\/p>\n
2) Creamos nuestro archivo paginate.xml<\/strong> como yo personalmente ocupo YAML, creare el archivo paginate.yml<\/strong>, la ruta donde ira sera similar a la que nos indican<\/p>\n
\n\n\/* Ruta donde esta este archivo :\n\nsymfony\\src\\AN\\PruebaBundle\\Resources\\config\\paginate.yml\n\n*\/\n\nservices:\n\u00a0\u00a0\u00a0 an_knp_paginator.subscriber:\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 class: AN\\PruebaBundle\\Subscriber\\PaginateDirectorySubscriber\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 scope: request\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 tags:\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 - { name: knp_paginator.subscriber }\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 arguments: [@doctrine.orm.entity_manager]\n\n<\/pre>\n
Como dije anteriormente, le pasamos como arguments el @doctrine.orm.entity_manager<\/strong>, asi podremos ocupar nuestra EntityManager<\/strong> de requerirla.<\/p>\n
3) Agregamos a la configuraci\u00f3n nuestro archivo generado en el paso 2<\/p>\n
\n\n&lt;?php\n\/\/Ruta donde esta\nnamespace AN\\PruebaBundle\\DependencyInjection;\n\nuse Symfony\\Component\\DependencyInjection\\ContainerBuilder;\nuse Symfony\\Component\\Config\\FileLocator;\nuse Symfony\\Component\\HttpKernel\\DependencyInjection\\Extension;\nuse Symfony\\Component\\DependencyInjection\\Loader;\n\n\/**\n\u00a0* This is the class that loads and manages your bundle configuration\n\u00a0*\n\u00a0* To learn more see {@link http:\/\/symfony.com\/doc\/current\/cookbook\/bundles\/extension.html}\n\u00a0*\/\nclass ANPruebaExtension extends Extension\n{\n\u00a0\u00a0\u00a0 \/**\n\u00a0\u00a0\u00a0\u00a0 * {@inheritDoc}\n\u00a0\u00a0\u00a0\u00a0 *\/\n\u00a0\u00a0\u00a0 public function load(array $configs, ContainerBuilder $container)\n\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $configuration = new Configuration();\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $config = $this-&gt;processConfiguration($configuration, $configs);\n\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $loader = new Loader\\YamlFileLoader($container, new FileLocator(__DIR__.'\/..\/Resources\/config'));\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $loader-&gt;load('services.yml');\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ Aqui agregamos nuestro archivo creado en el paso 2 para que lo cargue\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$loader-&gt;load('paginate.yml');\n\u00a0\u00a0\u00a0 }\n}\n\n<\/pre>\n
4) Antes de ocuparlo, nos falta lo mas importante, agregar la logica que necesitamos en nuestro PaginateDirectorySubscriber<\/strong>, dentro de la funcion items agregamos lo siguiente, quedando asi<\/p>\n
\n\n\u00a0\u00a0\u00a0 public function items(ItemsEvent $event)\n\u00a0\u00a0\u00a0 {\n\u00a0\u00a0 \u00a0\u00a0\u00a0\u00a0 \/\/Si es una instancia de &quot;NativeQuery&quot;\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 if ($event-&gt;target instanceof NativeQuery)\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0{\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/Seteamos y asignamos\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$query = $event-&gt;target;\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $event-&gt;count = count($query-&gt;getArrayResult());\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $event-&gt;items = array_slice(\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $query-&gt;getArrayResult(),\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $event-&gt;getOffset(),\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 $event-&gt;getLimit()\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 );\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$event-&gt;stopPropagation();\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\n\u00a0\u00a0\u00a0 }\n\n<\/pre>\n
Revisemos:<\/p>\n
if ($event-&gt;target instanceof NativeQuery)<\/pre>\n
Aqui preguntamos si es una instancia de NativeQuery<\/strong> o no, esto nos dira si fue creada con createNativeQuery o createQuery, lo cual nos permite distinguir entre una consulta creada normalmente con DQL (createQuery) y una personalizada (createNativeQuery), ya que si no agregamos esto, todas nuestra consultas normales pasaran por aqui y se producira un error<\/strong> ya que estas requieren otro tratamiento.<\/p>\n
5) Por \u00faltimo, lo llamamos desde nuestro Controller, aqu\u00ed asumimos que estamos creando una consulta SQL donde llamamos a Usuarios, esto obviamente lo puedes hacer con DQL pero es solo un ejemplo. Adem\u00e1s debemos guiarnos por la documentaci\u00f3n que nos entrega Doctrine sobre Native SQL<\/a><\/p>\n
\n\/* Consulta SQL pura, fijandonos bien en los nombres de los\ncampos que estan en nuestra Base de Datos *\/\n$sql = &quot;SELECT u.id,u.nombre FROM Usuario u&quot;;\n<\/pre>\n
Ya tenemos nuestra consulta SQL, ahora debemos agregar ResultSetMapping<\/strong> que es requerido para generar nuestra consulta personalizada, agregamos la libreria primero<\/p>\n
use Doctrine\\ORM\\Query\\ResultSetMapping;<\/pre>\n
Y ahora el codigo referente a esto<\/p>\n
\n\/\/Esto es requerido y debe ser coherente con nuestra consulta SQL\n\/\/ O no veremos los campos en el resultado\n$rsm = new ResultSetMapping;\n$rsm-&gt;addEntityResult('ANPruebaBundle:Usuario', 'u');\n$rsm-&gt;addScalarResult('id', 'id');\n$rsm-&gt;addScalarResult('nombre', 'nombre');\n<\/pre>\n
En la documentaci\u00f3n nos indica que podemos ocupar addFieldResult<\/strong> en vez de addScalarResult<\/strong>, personalmente esto me generaba internamente otro array es decir el resultado que entregaba nuestro paginador era<\/p>\n
Con addFieldResult<\/strong>:<\/p>\n
\narray (\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 array (\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 array (\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 [&quot;id&quot;] =&gt; 123\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 [&quot;nombre&quot;] =&gt; Ariel\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 )\u00a0\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 )\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 )\u00a0\n<\/pre>\n
Con addScalarResult<\/strong>:<\/p>\n
\narray (\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 array (\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 [&quot;id&quot;] =&gt; 123\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 [&quot;nombre&quot;] =&gt; Ariel\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 )\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 )\u00a0\u00a0 <\/pre>\n
Ademas esta ultima nos permite ocupar campos alias, pero de esto hablaremos en otro POST o nos extenderemos mucho mas.<\/p>\n
Volviendo a nuestra consulta original, ya tenemos la consulta en SQL y agregamos ResultSetMapping, pues bien, ahora podemos generarla<\/p>\n
\n\/\/Doctrine\n$em = $this-&gt;getDoctrine()-&gt;getManager();\n\n$query = $em-&gt;createNativeQuery($sql, $rsm);<\/pre>\n
Por ultimo, lo agregamos a nuestro paginador<\/p>\n
$paginator\u00a0 = $this-&gt;get('knp_paginator');\n\n$pagination = $paginator-&gt;paginate(\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$query,\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0$this-&gt;get('request')-&gt;query-&gt;get('page', 1)\/*page number*\/,\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0\u00a0 10 \/*limit per page*\/\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0);<\/pre>\n
Y listo, ahora podriamos probarla, si tienes el Bundle\u00a0LadyBug<\/a> para depurar puedes ocupar esto<\/p>\n
ladybug_dump_die($pagination-&gt;getItems());<\/pre>\n
Si no, pues de la forma tradicional<\/p>\n
var_dump($pagination-&gt;getItems());\nexit();<\/pre>\n
En resumen, lo mas complicado es generar la consulta con createNativeQuery, ya que si no se genera bien con su respectivo ResultSetMapping los campos no apareceran, antes de pasarsela a nuestro paginador te recomiendo probar los resultados que entrega<\/p>\n
ladybug_dump(count($query-&gt;getArrayResult()));<\/pre>\n
Fijate que ocupe getArrayResult<\/strong>, si ocupas otro como getResult no<\/strong> te entregara ningun resultado.<\/p>\n
Saludos<\/p>\n","protected":false},"excerpt":{"rendered":"
El Bundle\u00a0KnpPaginator es una excelente ayuda que nos permite paginar de una forma bastante amigable y facil, normalmente su uso se refiera a pasarle una query que formamos mediante createQuery y este la procesa y nos entrega el resultado paginado segun los parametros que definamos pero… \u00bfQue sucede cuando deseamos pasarle una consulta personalizada? la […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4,7,12],"tags":[25],"class_list":["post-196","post","type-post","status-publish","format-standard","hentry","category-doctrine","category-knppaginator","category-symfony2-2","tag-symfony2"],"_links":{"self":[{"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/posts\/196","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/comments?post=196"}],"version-history":[{"count":0,"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/posts\/196\/revisions"}],"wp:attachment":[{"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/media?parent=196"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/categories?post=196"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/arielnavarrete.cl\/blog\/wp-json\/wp\/v2\/tags?post=196"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}