src/Aqarmap/Bundle/SearchBundle/Services/CompoundSearchService.php line 121

  1. <?php
  3. namespace Aqarmap\Bundle\SearchBundle\Services;
  5. use Aqarmap\Bundle\ListingBundle\Constant\CompoundFeedback;
  6. use Aqarmap\Bundle\ListingBundle\Constant\ListingCategories;
  7. use Aqarmap\Bundle\ListingBundle\Constant\ListingSections;
  8. use Aqarmap\Bundle\ListingBundle\Constant\ListingStatus;
  9. use Aqarmap\Bundle\ListingBundle\Entity\CompoundLocation;
  10. use Aqarmap\Bundle\MainBundle\Constant\CustomParagraphPlaceTypes;
  11. use Aqarmap\Bundle\MainBundle\Entity\CustomParagraph;
  12. use Aqarmap\Bundle\MainBundle\Repository\CustomParagraphRepository;
  13. use Aqarmap\Bundle\SearchBundle\Repositories\ListingSearchRepository;
  14. use Doctrine\ORM\NonUniqueResultException;
  15. use Elastica\Aggregation\Terms;
  16. use Elastica\Aggregation\ValueCount;
  17. use Symfony\Component\Form\FormInterface;
  18. use Symfony\Component\HttpFoundation\Request;
  20. class CompoundSearchService extends BaseSearchService
  21. {
  22. /** @var ListingSearchRepository */
  23. protected $repository;
  25. public const TOTAL_LISTINGS_PER_PAGE = 30;
  27. public const CUSTOM_PARAGRAPH_MAX_RESULTS = 1;
  29. public const CRITERIA_DATA_TYPE = [
  30. 'compoundLocations' => 'is_numeric',
  31. 'propertyTypes' => 'is_numeric',
  32. 'priceLevels' => 'is_numeric',
  33. 'compoundStatus' => 'is_numeric',
  34. 'paymentMethods' => 'is_numeric',
  35. 'keywords' => 'is_numeric',
  36. 'finishTypes' => 'is_string',
  37. 'deliveryYears' => 'is_numeric',
  38. 'developerExperience' => 'is_string',
  39. ];
  41. public const DELIVERY_YEAR_FIELD = 'childrenAttributesList.year-built.keyword';
  43. public function setSort($sortBy = '_score', $order = 'asc'): void
  44. {
  45. $this->repository->setSort($sortBy);
  46. $this->repository->setOrder($order);
  47. }
  49. /**
  50. * Deep Search, Search inside sub (Locations & Property Types).
  51. */
  52. public function enableDeepSearch(array &$criteria): void
  53. {
  54. try {
  55. $this->enableCompoundLocationDeepSearch($criteria);
  56. } catch (\Exception) {
  57. }
  58. }
  60. /**
  61. * Enable Compound Location Deep Search.
  62. */
  63. public function enableCompoundLocationDeepSearch(array &$criteria): void
  64. {
  65. if (isset($criteria['compoundLocations'])) {
  66. $criteria['compoundLocations'] = \is_array($criteria['compoundLocations']) ? $criteria['compoundLocations'] : [$criteria['compoundLocations']];
  68. $locations = [];
  69. foreach ($criteria['compoundLocations'] as $location) {
  70. if (!\is_object($location)) {
  71. $location = $this->entityManager->getReference(CompoundLocation::class, $location);
  72. }
  73. $locations = array_merge($locations, $this->entityManager->getRepository(CompoundLocation::class)->getCompoundLocationChildren($location));
  74. }
  75. array_walk($locations, function(&$location): void {
  76. $location = $location->getId();
  77. });
  79. $criteria['compoundLocations'] = array_unique($locations);
  80. }
  81. }
  83. /**
  84. * Enable property type Deep Search.
  85. */
  86. public function enablePropertytypeDeepSearch(array &$criteria): void
  87. {
  88. if (isset($criteria['propertyTypes'])) {
  89. $criteria['propertyTypes'] = \is_array($criteria['propertyTypes']) ? $criteria['propertyTypes'] : [$criteria['propertyTypes']];
  91. $propertyTypes = [];
  92. foreach ($criteria['propertyTypes'] as $propertyType) {
  93. if (!\is_object($propertyType)) {
  94. $propertyType = $this->entityManager->getReference(\Aqarmap\Bundle\ListingBundle\Entity\PropertyType::class, $propertyType);
  95. }
  96. $propertyTypes = array_merge($propertyTypes, $this->entityManager->getRepository(\Aqarmap\Bundle\ListingBundle\Entity\PropertyType::class)->getPropertyTypeChildren($propertyType));
  97. }
  98. array_walk($propertyTypes, function(&$propertyType): void {
  99. $propertyType = $propertyType->getId();
  100. });
  102. $criteria['propertyTypes'] = array_unique($propertyTypes);
  103. }
  104. }
  106. /**
  107. * Handles criteria & find compounds results.
  108. *
  109. * @return \Knp\Component\Pager\Pagination\PaginationInterface|mixed
  110. */
  111. public function getCompounds(array $criteria, $page)
  112. {
  113. $criteria = array_merge($criteria, [
  114. 'category' => ListingCategories::PROJECTS,
  115. 'nullParent' => null,
  116. 'status' => ListingStatus::LIVE,
  117. ]);
  119. $this->handleCriteriaToQuery($criteria);
  121. return $this->getResults($page, $criteria);
  122. }
  124. /**
  125. * Compounds query.
  126. *
  127. * @param int $page
  128. *
  129. * @return \Knp\Component\Pager\Pagination\PaginationInterface|mixed
  130. */
  131. public function getResults($page, array $criteria)
  132. {
  133. $limit = (int) ($criteria['limit'] ?? self::TOTAL_LISTINGS_PER_PAGE) ?: self::TOTAL_LISTINGS_PER_PAGE;
  134. $resultsQuery = $this->repository->getResultQuery();
  136. // Adding Default Sorting By Featuring
  137. $resultsQuery->addSort([$criteria['sort'][0] ?? 'featured' => ['order' => $criteria['direction'] ?? 'desc']]);
  139. $results = $this->finder->createPaginatorAdapter($resultsQuery);
  141. try {
  142. $pagination = $this->paginator->paginate($results, (int) $page ?: 1, $limit);
  143. } catch (\Exception) {
  144. $pagination = $this->paginator->paginate([], (int) $page ?: 1, $limit);
  145. }
  147. return $pagination;
  148. }
  150. /**
  151. * Handles criteria and find compounds count.
  152. *
  153. * @return array
  154. *
  155. * @throws \Exception
  156. */
  157. public function getResultsCount(Request $request)
  158. {
  159. $fields = explode(',', $request->query->get('aggregation'));
  160. $request->query->remove('aggregation');
  162. $criteria = $this->compoundService->stringCriteriaToInteger($request->query->all());
  163. $criteria = $this->handleCriteriaDataType($criteria);
  165. $criteria = array_merge($criteria, [
  166. 'category' => ListingCategories::PROJECTS,
  167. 'nullParent' => null,
  168. 'status' => ListingStatus::LIVE,
  169. ]);
  170. $compoundsCount = [];
  171. $oldCriteria = [];
  172. foreach ($fields as $field) {
  173. $clonedField = $field;
  175. $aggregationType = $this->getAggregationType($clonedField);
  177. $this->handleRelationField($field);
  179. $this->excludeAggregationFromCriteria($clonedField, $criteria, $oldCriteria);
  181. $counts = $this->findCompoundsCountByField($field, $criteria, $aggregationType);
  183. if (self::DELIVERY_YEAR_FIELD == $field) {
  184. $compoundsCount[$clonedField] = $this->handleCountResults($counts, $aggregationType, true);
  185. } else {
  186. $compoundsCount[$clonedField] = $this->handleCountResults($counts, $aggregationType);
  187. }
  188. $criteria = array_merge($criteria, $oldCriteria);
  189. }
  191. $compoundsCount['totalHits'] = $this->findCompoundsTotalCount($criteria);
  193. return $compoundsCount;
  194. }
  196. public function isNoIndexMetaTag(array $request): bool
  197. {
  198. return isset($request['priceLevels']) || isset($request['compoundStatus'])
  199. || isset($request['paymentMethods']) || isset($request['finishTypes'])
  200. || isset($request['compoundLocations']) || isset($request['propertyTypes'])
  201. || isset($request['keywords']) ? true : false;
  202. }
  204. /**
  205. * Compounds count query.
  206. *
  207. * @return array|mixed
  208. */
  209. protected function findCompoundsCountByField(string $field, array $criteria, $aggregationType = CompoundFeedback::AGGERGATION_BUCKET_COUNT_TYPE)
  210. {
  211. $this->handleCriteriaToQuery($criteria);
  213. $resultsQuery = $this->repository->getResultQuery();
  214. if (CompoundFeedback::AGGERGATION_SINGLE_COUNT_TYPE == $aggregationType) {
  215. $aggregation = new ValueCount('fields', $field);
  216. } else {
  217. $aggregation = new Terms('fields');
  218. $aggregation->setField($field);
  219. $aggregation->setSize(CompoundFeedback::AGGERGATION_SIZE);
  220. }
  222. $resultsQuery->addAggregation($aggregation);
  224. return $this
  225. ->finder
  226. ->createPaginatorAdapter($resultsQuery)
  227. ->getAggregations();
  228. }
  230. /**
  231. * Compounds total count query.
  232. *
  233. * @return int
  234. */
  235. protected function findCompoundsTotalCount(array $criteria)
  236. {
  237. $this->handleCriteriaToQuery($criteria);
  239. $resultsQuery = $this->repository->getResultQuery();
  241. return $this
  242. ->finder
  243. ->createPaginatorAdapter($resultsQuery)
  244. ->getTotalHits();
  245. }
  247. /**
  248. * Excludes aggregation field from criteria.
  249. */
  250. protected function excludeAggregationFromCriteria(string $field, array &$criteria, array &$oldCriteria): void
  251. {
  252. $aggregationField = $field.'s';
  254. if (\array_key_exists($field, $criteria)) {
  255. $oldCriteria[$field] = $criteria[$field];
  256. unset($criteria[$field]);
  257. } elseif (\array_key_exists($aggregationField, $criteria)) {
  258. $oldCriteria[$aggregationField] = $criteria[$aggregationField];
  259. unset($criteria[$aggregationField]);
  260. }
  261. }
  263. /**
  264. * Adds 'id' to relation field.
  265. */
  266. protected function handleRelationField(&$field): void
  267. {
  268. switch ($field) {
  269. case 'compoundLocation':
  270. $field .= '.id';
  271. break;
  273. case 'propertyType':
  274. $field = 'childrenPropertyType.id';
  275. break;
  277. case 'finishType':
  278. $field = 'childrenAttributesList.finish-type.keyword';
  279. break;
  281. case 'deliveryYears':
  282. $field = self::DELIVERY_YEAR_FIELD;
  283. break;
  285. case 'hasDelivered':
  286. $field = 'compoundField.numberOfProjectsDelivered';
  287. break;
  289. case 'hasInhabited':
  290. $field = 'compoundField.numberOfProjectsInhabited';
  291. break;
  293. default:
  294. break;
  295. }
  296. }
  298. /**
  299. * Handles criteria data types.
  300. */
  301. protected function handleCriteriaDataType(array $criteria)
  302. {
  303. // TODO implement better valiadtion
  304. $acceptedCriteria = self::CRITERIA_DATA_TYPE;
  305. foreach ($criteria as $key => $value) {
  306. if (\array_key_exists($key, $acceptedCriteria)) {
  307. $criteria[$key] = array_filter($value, $acceptedCriteria[$key]);
  309. if (empty($criteria[$key])) {
  310. unset($criteria[$key]);
  311. }
  312. }
  313. }
  315. return $criteria;
  316. }
  318. /**
  319. * Converts criteria value to string.
  320. */
  321. protected function handleStringCriteria(&$criteria): void
  322. {
  323. if (\array_key_exists('keywords', $criteria)) {
  324. $criteria['keywords'] = \is_array($criteria['keywords']) ? implode(',', $criteria['keywords']) : $criteria['keywords'];
  325. }
  326. }
  328. /**
  329. * handle count results.
  330. */
  331. protected function handleCountResults(array $aggregations, ?string $aggregationType = null, $isDeliveryYear = false)
  332. {
  333. if (CompoundFeedback::AGGERGATION_SINGLE_COUNT_TYPE == $aggregationType) {
  334. return $aggregations['fields']['value'];
  335. }
  337. return $this->handleAggregationResults($aggregations, $isDeliveryYear);
  338. }
  340. /**
  341. * Mapping aggregations results.
  342. *
  343. * @return array
  344. */
  345. protected function handleAggregationResults(array $aggregations, $isDeliveryYear = false)
  346. {
  347. $result = [];
  348. if (\array_key_exists('fields', $aggregations) && \array_key_exists('buckets', $aggregations['fields'])) {
  349. foreach ($aggregations['fields']['buckets'] as $aggregation) {
  350. if ($isDeliveryYear) {
  351. $result[(int) $aggregation['key'] - date('Y')] = $aggregation['doc_count'];
  352. } else {
  353. $result[$aggregation['key']] = $aggregation['doc_count'];
  354. }
  355. }
  356. }
  358. return $result;
  359. }
  361. /**
  362. * Sets Repository.
  363. *
  364. * @throws \Exception
  365. */
  366. protected function setRepository(): void
  367. {
  368. $this->repository = new ListingSearchRepository($this->clientService->getClient(), $this->setting);
  369. }
  371. /**
  372. * Add Location to checked Compound Locations.
  373. *
  374. * @param array $checkedLocations
  375. *
  376. * @return array
  377. */
  378. public function addCheckedLocations($checkedLocations, CompoundLocation $location)
  379. {
  380. if (!\in_array($location->getId(), $checkedLocations)) {
  381. array_unshift($checkedLocations, $location->getId());
  382. }
  384. return $checkedLocations;
  385. }
  387. /**
  388. * Add Location to Compound Locations criteria.
  389. *
  390. * @return array
  391. */
  392. public function addLocationsToCriteria(array $criteria, CompoundLocation $location)
  393. {
  394. $locationId = $location->getId();
  395. if (!isset($criteria['compoundLocations'])) {
  396. $criteria['compoundLocations'] = [$locationId];
  397. } elseif (!\in_array($locationId, $criteria['compoundLocations'])) {
  398. array_unshift($criteria['compoundLocations'], $locationId);
  399. }
  401. return $criteria;
  402. }
  404. /**
  405. * remove Current Location from Criteria.
  406. *
  407. * @return string
  408. */
  409. public function removeCurrentLocation(array $criteria)
  410. {
  411. $locationsIds = $criteria['compoundLocations'];
  412. array_shift($locationsIds);
  414. return implode(',', $locationsIds);
  415. }
  417. /**
  418. * Generate the Parameters of No Slug in Url of Compound Search for RedirectUrl.
  419. *
  420. * @return array
  421. */
  422. public function getRedirectUrlParams(array $criteria)
  423. {
  424. $location = $this->entityManager
  425. ->getRepository(CompoundLocation::class)
  426. ->findOneById($criteria['compoundLocations'][0]);
  427. if ($location) {
  428. $params['location'] = $location->getSlug();
  429. }
  430. $params['compoundLocations'] = null;
  431. if (\count($criteria['compoundLocations']) > 1) {
  432. $params['compoundLocations'] = $this->removeCurrentLocation($criteria);
  433. }
  435. return $params;
  436. }
  438. /**
  439. * Sets compound search data.
  440. */
  441. public function setCompoundSearchFormData(FormInterface $form, array $criteria)
  442. {
  443. $compoundService = $this->compoundService;
  445. $form->get('priceLevel')->setData($compoundService->getParameter($criteria, 'priceLevels'));
  446. $form->get('compoundStatus')->setData($compoundService->getParameter($criteria, 'compoundStatus'));
  447. $form->get('paymentMethod')->setData($compoundService->getParameter($criteria, 'paymentMethods'));
  448. $form->get('finishType')->setData($compoundService->getParameter($criteria, 'finishType'));
  449. $form->get('keyword')->setData($compoundService->getParameter($criteria, 'keywords'));
  450. $form->get('finishType')->setData($compoundService->getParameter($criteria, 'finishTypes'));
  451. $form->get('deliveryYears')->setData($compoundService->getParameter($criteria, 'deliveryYears'));
  453. return $form;
  454. }
  456. private function getAggregationType(string $field): string
  457. {
  458. if (\in_array($field, CompoundFeedback::SINGLE_AGGREGATION_FIELDS)) {
  459. return CompoundFeedback::AGGERGATION_SINGLE_COUNT_TYPE;
  460. }
  462. return CompoundFeedback::AGGERGATION_BUCKET_COUNT_TYPE;
  463. }
  465. /**
  466. * @throws \Exception
  467. */
  468. public function getCustomParagraph(array $criteria): ?CustomParagraph
  469. {
  470. $customParagraphs = null;
  471. $selectedCustomParagraphId = $criteria['selectedParagraphId'] ?? null;
  473. $criteria = $this->getCriteriaCustomParagraph($criteria);
  475. $customParagraphRepository = $this->getCustomParagraphRepository();
  477. $this->getTranslatableContainer()->setTranslationFallback(false);
  479. if ($selectedCustomParagraphId) {
  480. $criteria['id'] = $selectedCustomParagraphId;
  481. $customParagraphs = $this->getSelectedCustomParagraph($customParagraphRepository, $criteria);
  482. }
  484. if (!$customParagraphs) {
  485. $customParagraphs = $customParagraphRepository
  486. ->get(array_merge($criteria, ['published' => true]))
  487. ->getQuery()
  488. ->getResult();
  489. }
  491. if (!empty($customParagraphs)) {
  492. $customParagraphs = $customParagraphs[array_rand($customParagraphs)];
  493. } else {
  494. $customParagraphs = null;
  495. }
  497. return $customParagraphs;
  498. }
  500. private function getCriteriaCustomParagraph($criteria): array
  501. {
  502. return [
  503. 'place' => CustomParagraphPlaceTypes::COMPOUND_PLANNER,
  504. 'section' => ListingSections::PROJECTS,
  505. 'propertyType' => $criteria['propertyTypes'] ?? null,
  506. 'compoundLocations' => $criteria['selectedCompoundLocation'] ?? null,
  507. ];
  508. }
  510. private function getCustomParagraphRepository(): CustomParagraphRepository
  511. {
  512. /* @var CustomParagraphRepository $customParagraphRepository */
  513. return $this->entityManager->getRepository(CustomParagraph::class);
  514. }
  516. private function getSelectedCustomParagraph($customParagraphRepository, $criteria)
  517. {
  518. $result = null;
  519. try {
  520. $result = $customParagraphRepository
  521. ->get($criteria)
  522. ->getQuery()
  523. ->setMaxResults(self::CUSTOM_PARAGRAPH_MAX_RESULTS)
  524. ->getOneOrNullResult();
  525. } catch (NonUniqueResultException) {
  526. $result = null;
  527. }
  529. return $result;
  530. }
  532. /**
  533. * @return \Gedmo\Translatable\TranslatableListener|object|null
  534. *
  535. * @throws \Exception
  536. */
  537. private function getTranslatableContainer()
  538. {
  539. return $this->translatableListener;
  540. }
  541. }