vendor/lexik/form-filter-bundle/Event/Subscriber/DoctrineORMSubscriber.php line 67

Open in your IDE?
  1. <?php
  3. namespace Lexik\Bundle\FormFilterBundle\Event\Subscriber;
  5. use Doctrine\Common\Collections\Collection;
  6. use Doctrine\DBAL\Connection;
  7. use Doctrine\DBAL\Types\Types;
  8. use Doctrine\ORM\EntityManagerInterface;
  9. use Doctrine\ORM\QueryBuilder;
  10. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  11. use Lexik\Bundle\FormFilterBundle\Event\GetFilterConditionEvent;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. /**
  15. * Register listeners to compute conditions to be applied on a Doctrine ORM query builder.
  16. *
  17. * @author Cédric Girard <[email protected]>
  18. */
  19. class DoctrineORMSubscriber extends AbstractDoctrineSubscriber implements EventSubscriberInterface
  20. {
  21. /**
  22. * @return array
  23. */
  24. public static function getSubscribedEvents()
  25. {
  26. return array(
  27. // Lexik form filter types
  28. 'lexik_form_filter.apply.orm.filter_boolean' => array('filterBoolean'),
  29. 'lexik_form_filter.apply.orm.filter_checkbox' => array('filterCheckbox'),
  30. 'lexik_form_filter.apply.orm.filter_choice' => array('filterValue'),
  31. 'lexik_form_filter.apply.orm.filter_date' => array('filterDate'),
  32. 'lexik_form_filter.apply.orm.filter_date_range' => array('filterDateRange'),
  33. 'lexik_form_filter.apply.orm.filter_datetime' => array('filterDateTime'),
  34. 'lexik_form_filter.apply.orm.filter_datetime_range' => array('filterDateTimeRange'),
  35. 'lexik_form_filter.apply.orm.filter_entity' => array('filterEntity'),
  36. 'lexik_form_filter.apply.orm.filter_number' => array('filterNumber'),
  37. 'lexik_form_filter.apply.orm.filter_number_range' => array('filterNumberRange'),
  38. 'lexik_form_filter.apply.orm.filter_text' => array('filterText'),
  40. // Symfony types
  41. 'lexik_form_filter.apply.orm.text' => array('filterText'),
  42. 'lexik_form_filter.apply.orm.email' => array('filterValue'),
  43. 'lexik_form_filter.apply.orm.integer' => array('filterValue'),
  44. 'lexik_form_filter.apply.orm.money' => array('filterValue'),
  45. 'lexik_form_filter.apply.orm.number' => array('filterValue'),
  46. 'lexik_form_filter.apply.orm.percent' => array('filterValue'),
  47. 'lexik_form_filter.apply.orm.search' => array('filterValue'),
  48. 'lexik_form_filter.apply.orm.url' => array('filterValue'),
  49. 'lexik_form_filter.apply.orm.choice' => array('filterValue'),
  50. 'lexik_form_filter.apply.orm.entity' => array('filterEntity'),
  51. 'lexik_form_filter.apply.orm.country' => array('filterValue'),
  52. 'lexik_form_filter.apply.orm.language' => array('filterValue'),
  53. 'lexik_form_filter.apply.orm.locale' => array('filterValue'),
  54. 'lexik_form_filter.apply.orm.timezone' => array('filterValue'),
  55. 'lexik_form_filter.apply.orm.date' => array('filterDate'),
  56. 'lexik_form_filter.apply.orm.datetime' => array('filterDate'),
  57. 'lexik_form_filter.apply.orm.birthday' => array('filterDate'),
  58. 'lexik_form_filter.apply.orm.checkbox' => array('filterValue'),
  59. 'lexik_form_filter.apply.orm.radio' => array('filterValue'),
  60. );
  61. }
  63. /**
  64. * @param GetFilterConditionEvent $event
  65. * @throws \Exception
  66. */
  67. public function filterEntity(GetFilterConditionEvent $event)
  68. {
  69. $expr = $event->getFilterQuery()->getExpr();
  70. $values = $event->getValues();
  72. if (is_object($values['value'])) {
  73. $paramName = $this->generateParameterName($event->getField());
  74. $filterField = $event->getField();
  76. /** @var QueryBuilder $queryBuilder */
  77. $queryBuilder = $event->getQueryBuilder();
  79. if ($dqlFrom = $event->getQueryBuilder()->getDQLPart('from')) {
  80. $rootPart = reset($dqlFrom);
  81. $fieldName = ltrim($event->getField(), $rootPart->getAlias() . '.');
  82. $metadata = $queryBuilder->getEntityManager()->getClassMetadata($rootPart->getFrom());
  84. if (isset($metadata->associationMappings[$fieldName]) && (!$metadata->associationMappings[$fieldName]['isOwningSide'] || $metadata->associationMappings[$fieldName]['type'] === ClassMetadataInfo::MANY_TO_MANY)) {
  85. if (!$event->getFilterQuery()->hasJoinAlias($fieldName)) {
  86. $queryBuilder->leftJoin($event->getField(), $fieldName);
  87. }
  89. $filterField = $fieldName;
  90. }
  91. }
  93. if ($values['value'] instanceof Collection) {
  94. $ids = array();
  96. foreach ($values['value'] as $value) {
  97. $ids[] = $this->getEntityIdentifier($value, $queryBuilder->getEntityManager());
  98. }
  100. if (count($ids) > 0) {
  101. $event->setCondition(
  102. $expr->in($filterField, ':'.$paramName),
  103. array($paramName => array($ids, Connection::PARAM_INT_ARRAY))
  104. );
  105. }
  106. } else {
  107. $event->setCondition(
  108. $expr->eq($filterField, ':'.$paramName),
  109. array($paramName => array(
  110. $this->getEntityIdentifier($values['value'], $queryBuilder->getEntityManager()),
  111. Types::INTEGER
  112. ))
  113. );
  114. }
  115. }
  116. }
  118. /**
  119. * @param object $value
  120. * @return integer
  121. * @throws \RuntimeException
  122. */
  123. protected function getEntityIdentifier($value, EntityManagerInterface $em)
  124. {
  125. $class = get_class($value);
  126. $metadata = $em->getClassMetadata($class);
  128. if ($metadata->isIdentifierComposite) {
  129. throw new \RuntimeException(sprintf('Composite identifier is not supported by FilterEntityType.', $class));
  130. }
  132. $identifierValues = $metadata->getIdentifierValues($value);
  134. if (empty($identifierValues)) {
  135. throw new \RuntimeException(sprintf('Can\'t get identifier value for class "%s".', $class));
  136. }
  138. return array_shift($identifierValues);
  139. }
  140. }