src/Aqarmap/Bundle/SearchBundle/Controller/Api/V4/ListingSearchController.php line 592

  1. #[Rest\QueryParam(name: 'minRoom', requirements: '\d+', default: null, description: 'Minimum Room')]
  2. #[Rest\QueryParam(name: 'floor', requirements: '\d+', default: null, description: 'Floor Number')]
  3. #[Rest\QueryParam(name: 'room', requirements: '\d+', default: null, description: 'Number of Rooms')]
  4. #[Rest\QueryParam(name: 'baths', requirements: '\d+', default: null, description: 'Number of Baths')]
  5. #[Rest\QueryParam(name: 'finishType', default: null, description: 'finish Type')]
  6. #[Rest\QueryParam(name: 'sellerRole', requirements: '\d+', default: null, description: 'sellerRole')]
  7. #[Rest\QueryParam(name: 'paymentMethod', requirements: '\d+', default: null, description: 'paymentMethod')]
  8. #[Rest\QueryParam(name: 'deliveryYear', requirements: '\d+', default: null, description: 'deliveryYear')]
  9. #[Rest\QueryParam(name: 'bath', default: null, description: 'Number of Baths')]
  10. #[Rest\QueryParam(name: 'photos', requirements: '(1)|(0)', default: '0', description: 'Get only listings with photos', strict: true, nullable: true)]
  11. #[Rest\QueryParam(name: 'isMortgage', requirements: '(1)|(0)', default: '0', description: 'Get only listings that support mortgage', strict: true, nullable: true)]
  12. #[Rest\QueryParam(name: 'eligibleForMortgage', description: 'Get listings that has mortgage Percentage', strict: true, nullable: true)]
  13. #[Rest\QueryParam(name: 'page', requirements: '\d+', default: 1, description: 'Page number, starting from 1.', nullable: true)]
  14. #[Rest\QueryParam(name: 'limit', requirements: '\d+', default: 10, description: 'Number of items per page.', nullable: true)]
  15. #[Rest\QueryParam(name: 'sort', requirements: 'price|area', default: null, description: 'Sort search results by price or area.', nullable: true)]
  16. #[Rest\QueryParam(name: 'direction', requirements: 'asc|desc', default: 'asc', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', nullable: true)]
  17. #[Rest\QueryParam(name: 'keywordSearch', description: "Search by keyword in listing's title, description and address")]
  18. #[Rest\QueryParam(name: 'unitOnly', requirements: '(1)|(0)', description: 'Get compound units only', nullable: true)]
  19. #[Rest\View]
  20. #[Cache(expires: '+2 hours', maxage: '+2 hours', smaxage: '+2 hours', public: true, vary: ['Accept-Language', 'X-Accept-Version', 'Accept'])]
  21. #[OA\Parameter(name: 'propertyType', description: 'Property Type ID', in: 'query', required: false)]
  22. #[OA\Parameter(name: 'location', description: 'Location ID comma spereted', in: 'query', required: false)]
  23. #[OA\Parameter(name: 'section', description: 'Section ID', in: 'query', required: false)]
  24. #[OA\Parameter(name: 'bounds', description: 'Map bounds (example: 24.6275450,46.6363017,24.6977461,46.817232)', in: 'query', required: false)]
  25. #[OA\Parameter(name: 'minPrice', description: 'Minimum Prices', in: 'query', required: false)]
  26. #[OA\Parameter(name: 'maxPrice', description: 'Maximum Prices', in: 'query', required: false)]
  27. #[OA\Parameter(name: 'minArea', description: 'Minimum Area', in: 'query', required: false)]
  28. #[OA\Parameter(name: 'maxArea', description: 'Maximum Area', in: 'query', required: false)]
  29. #[OA\Parameter(name: 'minFloor', description: 'Minimum Floor', in: 'query', required: false)]
  30. #[OA\Parameter(name: 'minRoom', description: 'Minimum Room', in: 'query', required: false)]
  31. #[OA\Parameter(name: 'floor', description: 'Floor Number', in: 'query', required: false)]
  32. #[OA\Parameter(name: 'room', description: 'Number of Rooms', in: 'query', required: false)]
  33. #[OA\Parameter(name: 'baths', description: 'Number of Baths', in: 'query', required: false)]
  34. #[OA\Parameter(name: 'finishType', description: 'finish Type', in: 'query', required: false)]
  35. #[OA\Parameter(name: 'sellerRole', description: 'sellerRole', in: 'query', required: false)]
  36. #[OA\Parameter(name: 'paymentMethod', description: 'paymentMethod', in: 'query', required: false)]
  37. #[OA\Parameter(name: 'deliveryYear', description: 'deliveryYear', in: 'query', required: false)]
  38. #[OA\Parameter(name: 'bath', description: 'Number of Baths', in: 'query', required: false)]
  39. #[OA\Parameter(name: 'photos', description: 'Get only listings with photos', in: 'query', required: false)]
  40. #[OA\Parameter(name: 'isMortgage', description: 'Get only listings that support mortgage', in: 'query', required: false)]
  41. #[OA\Parameter(name: 'eligibleForMortgage', description: 'Get listings that has mortgage Percentage', in: 'query', required: false)]
  42. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  43. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  44. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  45. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  46. #[OA\Parameter(name: 'keywordSearch', description: "Search by keyword in listing's title, description and address", in: 'query', required: false)]
  47. #[OA\Parameter(name: 'unitOnly', description: 'Get compound units only', in: 'query', required: false)]
  48. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  49. public function getSearchListings(Request $request, CacheInterface $cache): Response
  50. {
  51. $criteria = $this->builderDirector->build($request)->getResult();
  52. $locations = explode(',', $request->query->get('location', ''));
  53. $request->query->set('locations', $locations);
  55. if (!empty($criteria['keywordSearch'])) {
  56. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  57. }
  59. if ($this->getUser() instanceof User) {
  60. $this->messageBus->dispatch(new Search($request->query, $this->getUser()));
  61. }
  63. $criteria['status'] = ListingStatus::LIVE;
  64. $cacheKey = sprintf('api_v4_listings_search_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  66. $cachedSerialize = $cache->getItem($cacheKey);
  67. if (!$cachedSerialize->isHit() || empty($cachedSerialize->get())) {
  68. $result = $this->mediator->start($criteria)->getResults();
  69. $mapped = new ListingDataMapper();
  70. $mapped->setMapListingAttributes(true);
  71. $mapped->setMapListingMainPhoto(true);
  72. $mapped->setMapListingPhotos(true);
  74. $data = [
  75. 'default' => $this->makeMappedPaginatedBody($result['searchResults'], $mapped),
  76. 'related' => [],
  77. ];
  79. $data = $this->serializer->serialize(
  80. $data,
  81. 'json',
  82. SerializationContext::create()
  83. ->setGroups('SearchV4')
  84. ->enableMaxDepthChecks()
  85. );
  87. $cachedSerialize->set($data);
  88. $cachedSerialize->expiresAfter(3600 * 3);
  89. $cache->save($cachedSerialize);
  90. }
  92. return new Response($cachedSerialize->get());
  93. }
  95. /**
  96. * Related Listings Search V4.
  97. */
  98. #[Rest\Get('/api/v4/listings/search/related', name: 'aqarmap_api_get_related_results_v4', options: ['i18n' => false])]
  99. #[Rest\QueryParam(name: 'propertyType', requirements: '\d+', default: null, description: 'Property Type ID')]
  100. #[Rest\QueryParam(name: 'location', requirements: '\d+', default: null, description: 'Location ID comma spereted')]
  101. #[Rest\QueryParam(name: 'section', requirements: '\d+', default: null, description: 'Section ID')]
  102. #[Rest\QueryParam(name: 'page', requirements: '\d+', default: 1, description: 'Page number, starting from 1.', nullable: true)]
  103. #[Rest\QueryParam(name: 'limit', requirements: '\d+', default: 10, description: 'Number of items per page.', nullable: true)]
  104. #[Rest\QueryParam(name: 'sort', requirements: 'price|area', default: null, description: 'Sort search results by price or area.', nullable: true)]
  105. #[Rest\QueryParam(name: 'direction', requirements: 'asc|desc', default: 'asc', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', nullable: true)]
  106. #[Rest\View(serializerGroups: ['DefaultV4', 'SearchV4'])]
  107. #[OA\Parameter(name: 'propertyType', description: 'Property Type ID', in: 'query', required: false)]
  108. #[OA\Parameter(name: 'location', description: 'Location ID comma seperated', in: 'query', required: false)]
  109. #[OA\Parameter(name: 'section', description: 'Section ID', in: 'query', required: false)]
  110. #[OA\Parameter(name: 'page', description: 'Page number, starting from 1.', in: 'query', required: false)]
  111. #[OA\Parameter(name: 'limit', description: 'Number of items per page.', in: 'query', required: false)]
  112. #[OA\Parameter(name: 'sort', description: 'Sort search results by price or area.', in: 'query', required: false)]
  113. #[OA\Parameter(name: 'direction', description: 'Ascending (A to Z, 0 to 9), Descending (Z to A, 9 to 0)', in: 'query', required: false)]
  114. #[OA\Response(response: 500, description: 'Returned when something went wrong, for example if you entered non existing propertyType ID')]
  115. public function getRelatedSearchListings(Request $request, HttpClientInterface $searchClient, SerializerInterface $jmsSerializer, ListingRepository $listingRepository): JsonResponse
  116. {
  117. $response = $searchClient->request('GET', '/api/listing/nearest', [
  118. 'query' => $request->query->all(),
  119. 'headers' => [
  120. 'Accept-Language' => $request->getPreferredLanguage(),
  121. ],
  122. ]);
  124. if (200 === $response->getStatusCode()) {
  125. $data = $response->toArray();
  127. if (isset($data['data']) && is_array($data['data'])) {
  128. foreach ($data['data'] as &$item) {
  129. if (isset($item['listings']) && is_array($item['listings'])) {
  130. $listings = $listingRepository->getListingsByIds(array_column($item['listings'], 'id'))->getQuery()->getResult();
  131. $context = SerializationContext::create()
  132. ->setGroups(['DefaultV4', 'SearchV4']);
  134. $item['listings'] = json_decode(
  135. $jmsSerializer->serialize($listings, 'json', $context),
  136. true
  137. );
  138. }
  139. }
  140. }
  142. return $this->json($data);
  143. }
  145. return $this->json([
  146. 'error' => 'Failed to fetch nearest search listings',
  147. ], $response->getStatusCode());
  148. }
  150. #[Rest\Get('/api/v4/listings', name: 'aqarmap_api_get_listings', options: ['i18n' => false])]
  151. #[Rest\Get('/api/v4/listings/search', name: 'aqarmap_api_listings_search_v4', options: ['i18n' => false])]
  152. #[OA\Get(summary: 'Search listings', description: 'Returns listing search results for the provided filters and pagination settings.', tags: ['ListingsSearch'])]
  153. #[OA\Parameter(name: 'minPrice', description: 'Minimum listing price.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  154. #[OA\Parameter(name: 'maxPrice', description: 'Maximum listing price.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  155. #[OA\Parameter(name: 'minArea', description: 'Minimum listing area.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  156. #[OA\Parameter(name: 'maxArea', description: 'Maximum listing area.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  157. #[OA\Parameter(name: 'room', description: 'Exact number of rooms.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  158. #[OA\Parameter(name: 'minRoom', description: 'Minimum number of rooms.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  159. #[OA\Parameter(name: 'bounds', description: 'Map bounds in south-west/north-east latitude-longitude format.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  160. #[OA\Parameter(name: 'marketPropertyType', description: 'Market-specific property type filter.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  161. #[OA\Parameter(name: 'excludedCategory', description: 'Category identifier to exclude from results.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  162. #[OA\Parameter(name: 'trackTotalHits', description: 'Whether to request exact total hit tracking from the search backend.', in: 'query', required: false, schema: new OA\Schema(type: 'boolean'))]
  163. #[OA\Parameter(name: 'scoredebug', description: 'Include search scoring debug details when permitted.', in: 'query', required: false, schema: new OA\Schema(type: 'boolean'))]
  164. #[OA\Parameter(name: 'esdebug', description: 'Include Elasticsearch debug details when permitted.', in: 'query', required: false, schema: new OA\Schema(type: 'boolean'))]
  165. #[OA\Parameter(name: 'limit', description: 'Maximum number of listings returned per page.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  166. #[OA\Parameter(name: 'sort', description: 'Sorting field for the result set.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  167. #[OA\Parameter(name: 'aggregatedField', description: 'Aggregation field requested from the search backend.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  168. #[OA\Parameter(name: 'creditExpiryDate', description: 'Credit expiry date filter.', in: 'query', required: false, schema: new OA\Schema(type: 'string', format: 'date'))]
  169. #[Rest\QueryParam(name: 'personalizedSearch', requirements: '(1)|(0)', default: '0', description: 'Enable personalized search', strict: true, nullable: true)]
  170. #[OA\Parameter(name: 'personalizedSearch', description: 'Enable personalized search (requires an authenticated user with an active subscription).', in: 'query', required: false, schema: new OA\Schema(type: 'string', enum: ['0', '1']))]
  171. #[OA\Parameter(name: 'personalizedForUser', description: 'Internal user identifier used to scope personalized results.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  172. #[OA\Parameter(name: 'status', description: 'Listing status filter.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  173. #[OA\Parameter(name: 'location', description: 'Comma-separated location identifiers.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  174. #[OA\Parameter(name: 'propertyType', description: 'Property type identifier.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  175. #[OA\Parameter(name: 'section', description: 'Section identifier.', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  176. #[OA\Parameter(name: 'excludedListingsIds', description: 'Comma-separated listing identifiers to exclude from results.', in: 'query', required: false, schema: new OA\Schema(type: 'string'))]
  177. #[Rest\QueryParam(name: 'amenities', description: 'A list of amenities to filter by.', map: true, nullable: true)]
  178. #[OA\Parameter(name: 'amenities', description: 'Filter by a list of amenities. Can be provided as an array.', in: 'query', required: false, schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string', enum: Amenities::ALL)))]
  179. #[Rest\QueryParam(name: 'downPayment', requirements: '\d+', default: null, description: 'Filter by maximum down payment amount', nullable: true)]
  180. #[OA\Parameter(name: 'downPayment', description: 'Filter by maximum down payment amount', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  181. #[Rest\QueryParam(name: 'duration', requirements: '\d+', default: null, description: 'Filter by minimum installment duration (in days)', nullable: true)]
  182. #[OA\Parameter(name: 'duration', description: 'Filter by minimum installment duration (in days)', in: 'query', required: false, schema: new OA\Schema(type: 'integer'))]
  183. #[OA\Response(response: 200, description: 'Paginated listing search results.')]
  184. #[OA\Response(response: 400, description: 'Invalid search request, such as a page number above the supported limit.')]
  185. #[OA\Response(response: 401, description: 'Returned when personalized search is requested without an authenticated user.')]
  186. #[OA\Response(response: 403, description: 'Returned when personalized search is requested without an active subscription.')]
  187. public function getListings(Request $request, ListingRepository $listingRepository, ListingManager $listingManager, CacheInterface $cache, MessageBusInterface $messageBus)
  188. {
  189. // This to prevent the "result window is too large" exception in ElasticSearch.
  190. if ($request->get('page', 1) > 500) {
  191. throw new BadRequestHttpException('Page number must be less than or equal to 500');
  192. }
  194. /** @var UserInterface $user */
  195. $user = $this->getUser();
  196. $hasSearchScoringRole = $user && $user->hasRole('ROLE_SEARCH_SCORING');
  197. if (!$hasSearchScoringRole && ($request->get('esdebug') || $request->get('scoredebug'))) {
  198. $request->query->remove('esdebug');
  199. $request->query->remove('scoredebug');
  200. }
  202. if ($request->get('location')) {
  203. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  204. }
  206. $personalizedSearch = $request->query->getBoolean('personalizedSearch', false);
  207. if ($personalizedSearch) {
  208. if (!$user instanceof User) {
  209. throw new UnauthorizedHttpException('Personalized search requires an active session. Please log in.');
  210. }
  212. if (!$user->hasSubscriptionPlan()) {
  213. throw new AccessDeniedHttpException('Active subscription required for personalized search.');
  214. }
  216. $request->query->set('personalizedSearch', true);
  217. $request->query->set('personalizedForUser', $user->getId());
  218. }
  220. if ($personalizedSearch) {
  221. $data = $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  222. } else {
  223. $cacheKey = sprintf('api_listings_search_v4_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  224. $data = $cache->get(
  225. $cacheKey,
  226. function(ItemInterface $item) use ($request, $listingRepository, $listingManager) {
  227. $item->expiresAfter(3600 * 3);
  229. return $this->getSerializedListingSearchResults($request, $listingRepository, $listingManager);
  230. }
  231. );
  232. }
  234. return new Response($data);
  235. }
  237. private function getSerializedListingSearchResults(Request $request, ListingRepository $listingRepository, ListingManager $listingManager): string
  238. {
  239. $listingsElasticResponse = $listingManager->getListingsElasticResponse($request);
  240. $listingsQueryBuilder = $listingRepository->getListingsByIds(array_column($listingsElasticResponse['items'], 'id'));
  242. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  243. $listingsElasticResponse['pagination']['totalPages'] = (float) $listingsElasticResponse['pagination']['totalPages'];
  244. }
  246. $listings = $listingsQueryBuilder->getQuery()->getResult();
  248. $data = [
  249. 'default' => $this->mapPaginatedBody($listingsElasticResponse, $listings),
  250. 'related' => [],
  251. ];
  253. return $this->serializer->serialize(
  254. $data,
  255. 'json',
  256. SerializationContext::create()
  257. ->setGroups('SearchV4')
  258. ->enableMaxDepthChecks()
  259. );
  260. }
  262. #[Rest\Get('/api/v4/listings/debug', options: ['i18n' => false], name: 'aqarmap_api_get_listings_debug')]
  263. public function getListingsEsDebug(Request $request, ListingManager $listingManager)
  264. {
  265. /** @var UserInterface $user */
  266. $user = $this->getUser();
  268. if (!($user && $user->hasRole('ROLE_SEARCH_SCORING'))) {
  269. throw new UnauthorizedHttpException();
  270. }
  272. $request->query->set('esdebug', 1);
  274. if ($request->get('location')) {
  275. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  276. }
  278. $listingsDebugElasticResponse = $listingManager->getListingsDebugElasticResponse($request);
  280. if ('aqarmap_api_listings_search_v4' === $request->attributes->get('_route')) {
  281. $listingsDebugElasticResponse['pagination']['totalPages'] = (float) $listingsDebugElasticResponse['pagination']['totalPages'];
  282. }
  284. $data = [
  285. 'default' => $this->mapPaginatedBody($listingsDebugElasticResponse, $listingsDebugElasticResponse['items']),
  286. ];
  288. return new JsonResponse($data);
  289. }
  291. #[Rest\Get('/api/v4/listings/search/ssr-data', name: 'aqarmap_api_get_listings_search_ssr-data', options: ['i18n' => false])]
  292. #[OA\Get(
  293. summary: 'Get listing search SSR data',
  294. description: 'Provides the pre-rendered content required for the listing search SSR page such as location hierarchy, SEO metadata and UI chips.',
  295. tags: ['ListingsSearch']
  296. )]
  297. #[OA\Parameter(name: 'location', in: 'query', required: false, description: 'Slug of the primary location to load contextual data for.', schema: new OA\Schema(type: 'string'))]
  298. #[OA\Parameter(
  299. name: 'locations[]',
  300. in: 'query',
  301. required: false,
  302. description: 'Optional list of location slugs used to resolve additional data.',
  303. schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string'))
  304. )]
  305. #[OA\Parameter(name: 'section', in: 'query', required: false, description: 'Section slug to scope the returned data.', schema: new OA\Schema(type: 'string'))]
  306. #[OA\Parameter(name: 'propertyType', in: 'query', required: false, description: 'Property type slug to scope the returned data.', schema: new OA\Schema(type: 'string'))]
  307. #[OA\Parameter(name: 'byOwnerOnly', in: 'query', required: false, description: 'Whether to limit content to owner only listings.', schema: new OA\Schema(type: 'boolean'))]
  308. #[OA\Response(
  309. response: 200,
  310. description: 'Successful response containing SSR data required by the listing search page.',
  311. content: new OA\JsonContent(
  312. type: 'object',
  313. properties: [
  314. new OA\Property(
  315. property: 'locationChildren',
  316. description: 'Hierarchy of child locations related to the requested location.',
  317. type: 'array',
  318. items: new OA\Items(type: 'object')
  319. ),
  320. new OA\Property(
  321. property: 'longTail',
  322. description: 'SEO long-tail content blocks generated for the section, property type and location.',
  323. type: 'array',
  324. items: new OA\Items(type: 'object')
  325. ),
  326. new OA\Property(
  327. property: 'customParagraph',
  328. description: 'Custom paragraph content tailored to the current search context.',
  329. type: 'array',
  330. items: new OA\Items(type: 'object')
  331. ),
  332. new OA\Property(
  333. property: 'slugResolver',
  334. description: 'Resolved slugs mapping for the provided filters.',
  335. type: 'array',
  336. items: new OA\Items(type: 'object')
  337. ),
  338. new OA\Property(
  339. property: 'faqData',
  340. description: 'Frequently asked questions related to the current search.',
  341. type: 'array',
  342. items: new OA\Items(type: 'object')
  343. ),
  344. new OA\Property(
  345. property: 'locationParents',
  346. description: 'Ordered list of parent locations for breadcrumb generation.',
  347. type: 'array',
  348. items: new OA\Items(type: 'object')
  349. ),
  350. new OA\Property(
  351. property: 'sections',
  352. description: 'Available sections that can be displayed in the SSR page.',
  353. type: 'array',
  354. items: new OA\Items(type: 'object')
  355. ),
  356. new OA\Property(
  357. property: 'propertyTypeChips',
  358. description: 'Property type chips rendered in the search interface.',
  359. type: 'array',
  360. items: new OA\Items(type: 'object')
  361. ),
  362. ]
  363. )
  364. )]
  365. #[OA\Response(response: 500, description: 'Returned when SSR data could not be generated or cached.')]
  366. public function getListingsSearchSSRData(Request $request, ListingManager $listingManager, CacheInterface $cache, SectionService $sectionService)
  367. {
  368. $cacheKey = sprintf('api_listings_search_ssr_data_%s_%s', $request->getLocale(), md5(http_build_query($request->query->all())));
  369. $cachedResponse = $cache->getItem($cacheKey);
  371. if (!$cachedResponse->isHit() || empty($cachedResponse->get())) {
  372. $customParagraph = $locationChildren = $slugResolver = $faqData = $locationParents = $longTail = [];
  374. if ($request->get('location')) {
  375. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  376. }
  378. $location = $request->query->all('locations') ? $request->query->all('locations')[0] : null;
  379. $location = $this->locationRepository->findOneBy(['slug' => $location]);
  380. $section = $this->sectionRepository->findOneBy(['slug' => $request->query->get('section')]);
  381. $propertyType = $this->propertyTypeRepository->findOneBy(['slug' => $request->query->get('propertyType')]);
  383. if ($location) {
  384. $locationChildren = $listingManager->getSerializedLocationChildren($location);
  385. $locationParents = $listingManager->getLocationParents($location, $request->getLocale());
  386. }
  388. if ($section && $propertyType && $location) {
  389. $longTail = $this->seoListingSearchService->getSerializedLongTailData($section, $propertyType, $location) ?? [];
  390. }
  392. if ($section) {
  393. $slugResolver = $listingManager->getSerializedResolvedSlugs($section, $propertyType, $request->query->all('locations'));
  394. }
  396. if ($section && $propertyType) {
  397. $byOwnerOnly = filter_var($request->get('byOwnerOnly'), FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) ?? false;
  398. $customParagraph = $listingManager->getSerializedCustomParagraph($section, $propertyType, $location, $byOwnerOnly) ?? [];
  399. $faqData = $listingManager->getFaqs($section, $propertyType, $location, $request->getLocale());
  400. }
  402. $response = [
  403. 'locationChildren' => !empty($locationChildren) ? json_decode((string) $locationChildren, true) : [],
  404. 'longTail' => !empty($longTail) ? json_decode((string) $longTail, true) : [],
  405. 'customParagraph' => !empty($customParagraph) ? json_decode((string) $customParagraph, true) : [],
  406. 'slugResolver' => !empty($slugResolver) ? json_decode((string) $slugResolver, true) : [],
  407. 'faqData' => $faqData,
  408. 'locationParents' => $locationParents,
  409. 'sections' => json_decode((string) $sectionService->getSerializedSections(), true),
  410. 'propertyTypeChips' => $listingManager->getListingPropertyTypesChips($request, $location, $section, $propertyType),
  411. ];
  413. $cachedResponse->set(json_encode($response));
  414. $cachedResponse->expiresAfter(3600 * 3);
  415. $cache->save($cachedResponse);
  416. }
  418. return new JsonResponse(json_decode((string) $cachedResponse->get(), true));
  419. }
  421. #[Rest\Get('/api/v4/listings/trigger-search', options: ['i18n' => false], name: 'aqarmap_api_trigger_search_listings_v4')]
  422. #[OA\Get(summary: 'Trigger listings search tracking', description: 'Dispatches search tracking and background processing events for the current listing search request.', tags: ['ListingsSearch'])]
  423. #[OA\Parameter(name: 'location', in: 'query', required: false, description: 'Comma-separated location identifiers to normalize into the locations filter.', schema: new OA\Schema(type: 'string'))]
  424. #[OA\Parameter(name: 'keywordSearch', in: 'query', required: false, description: 'Keyword query that triggers the search event tracking flow.', schema: new OA\Schema(type: 'string'))]
  425. #[OA\Response(response: 200, description: 'Search trigger event dispatched successfully.')]
  426. public function triggerSearchListings(Request $request, MessageBusInterface $messageBus)
  427. {
  428. $user = $this->getUser();
  430. if ($request->get('location')) {
  431. $request->query->set('locations', explode(',', $request->query->get('location', '')));
  432. }
  434. if ($request->get('keywordSearch')) {
  435. $this->eventDispatcher->dispatch(new SearchTriggerEvent($request));
  436. }
  438. if ($user) {
  439. $messageBus->dispatch(new Search($request->query, $user));
  440. }
  442. return new JsonResponse([
  443. 'statusCode' => Response::HTTP_OK,
  444. 'statusMessage' => 'Search triggered successfully!',
  445. ]);
  446. }
  448. private function mapPaginatedBody(array $result, array $listings): array
  449. {
  450. if (!$result['pagination']) {
  451. return [
  452. 'statusCode' => $this->getStatusCode(),
  453. 'statusMessage' => $this->getStatusMessage(),
  454. 'paginate' => [],
  455. 'data' => [],
  456. 'errors' => $this->getErrors(),
  457. ];
  458. }
  460. return [
  461. 'statusCode' => $this->getStatusCode(),
  462. 'statusMessage' => $this->getStatusMessage(),
  463. 'paginate' => $result['pagination'],
  464. 'data' => $listings,
  465. 'errors' => $this->getErrors(),
  466. ];
  467. }
  468. }