1. <?php
3. namespace Aqarmap\Bundle\ListingBundle\Entity;
5. use App\Entity\Location\LocationTier;
6. use Aqarmap\Bundle\DiscussionBundle\Entity\Discussion;
7. use Aqarmap\Bundle\ExchangeBundle\Entity\ExchangeRequest;
8. use Aqarmap\Bundle\ListingBundle\Constant\LocationTypes;
9. use Aqarmap\Bundle\ListingBundle\Constant\PhotoTypes;
10. use Aqarmap\Bundle\ListingBundle\Repository\LocationRepository;
11. use Aqarmap\Bundle\NeighborhoodBundle\Entity\LocationCompound;
12. use Aqarmap\Bundle\NeighborhoodBundle\Entity\LocationStatistics;
13. use Aqarmap\Bundle\NotifierBundle\Entity\Notifier;
14. use Aqarmap\Bundle\UserBundle\Constant\UserInterestStatus;
15. use Aqarmap\Bundle\UserBundle\Entity\UserInterest;
16. use Doctrine\Common\Collections\ArrayCollection;
17. use Doctrine\Common\Collections\Collection;
18. use Doctrine\Common\Collections\Criteria;
19. use Doctrine\ORM\Mapping as ORM;
20. use Gedmo\Mapping\Annotation as Gedmo;
21. use Gedmo\Sluggable\Handler\TreeSlugHandler;
22. use Gedmo\Translatable\Translatable;
23. use JMS\Serializer\Annotation as Serializer;
24. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
25. use Symfony\Component\Serializer\Annotation\Groups;
27. /**
28. * Location.
29. */
30. #[UniqueEntity('slug')]
31. #[ORM\Table(name: 'locations')]
32. #[ORM\Index(columns: ['disabled'])]
33. #[ORM\Index(columns: ['listings_counter'])]
34. #[ORM\Index(columns: ['searchable'])]
35. #[ORM\Index(columns: ['lat'])]
36. #[ORM\Index(columns: ['lon'])]
37. #[ORM\Index(columns: ['root'])]
38. #[ORM\Index(columns: ['root', '_left', '_right'])]
39. #[ORM\Index(columns: ['home_filter', 'is_compound_location', 'listing_id'])]
40. #[ORM\Entity(repositoryClass: LocationRepository::class)]
41. #[ORM\Cache(usage: 'NONSTRICT_READ_WRITE', region: 'write_rare')]
42. #[Gedmo\TranslationEntity(class: LocationTranslation::class)]
43. #[Gedmo\Tree(type: 'nested')]
44. #[Serializer\ExclusionPolicy('all')]
45. class Location implements Translatable, \Stringable
46. {
47. /**
48. * @var int
49. */
50. #[ORM\Column(name: 'id', type: 'integer')]
51. #[ORM\Id]
52. #[ORM\GeneratedValue(strategy: 'AUTO')]
53. #[Serializer\Groups(['Default', 'listingDetails', 'List', 'MiniList', 'Data', 'Autocomplete', 'Details', 'Neighborhood', 'NeighborhoodStatistics', 'Discussion', 'Exchange', 'LocationFlat', 'Search', 'AutocompleteV3', 'DefaultV4', 'SearchV4', 'ProjectDetailsV4', 'Translation', 'SlugResolver', 'RelatedListingsV2', 'locationListingV2', 'leadsBank', 'UserFavoriteListings'])]
54. #[Groups(['valuation:read'])]
55. #[Serializer\Expose]
56. private $id;
58. #[ORM\Column(name: 'title', type: 'string', length: 50)]
59. #[Gedmo\Translatable]
60. #[Serializer\Groups(['Default', 'listingDetails', 'List', 'MiniList', 'Data', 'Details', 'Neighborhood', 'NeighborhoodStatistics', 'Discussion', 'Exchange', 'LocationFlat', 'Search', 'Translation', 'SlugResolver', 'Autocomplete', 'MyLeads', 'leadsBank', 'LocationStatistics', 'topAreasV2'])]
61. #[Serializer\Expose]
62. private string $title;
64. /**
65. * @var string
66. */
67. #[ORM\Column(name: 'alias', type: 'string', length: 512, nullable: true)]
68. #[Gedmo\Translatable]
69. #[Serializer\Groups(['SlugResolver'])]
70. #[Serializer\Expose]
71. private $alias;
73. /**
74. * @var string
75. */
76. #[ORM\Column(name: 'description', type: 'text', length: 512, nullable: true)]
77. #[Gedmo\Translatable]
78. #[Serializer\Groups(['Neighborhood'])]
79. #[Serializer\Expose]
80. private $description;
82. #[ORM\Column(length: 128, unique: true)]
83. #[Gedmo\Slug(fields: ['title'])]
84. #[Gedmo\SlugHandler(class: TreeSlugHandler::class, options: [
85. 'parentRelationField' => 'parent',
86. 'separator' => '/',
87. ])]
88. #[Serializer\Groups(['Default', 'listingDetails', 'List', 'MiniList', 'Data', 'Details', 'Neighborhood', 'LocationFlat', 'Autocomplete', 'AutocompleteV3', 'DefaultV4', 'SearchV4', 'SlugResolver', 'RelatedListingsV2', 'UserFavoriteListings', 'topAreasV2'])]
89. #[Groups(['valuation:read'])]
90. #[Serializer\Expose]
91. private string $slug = '';
93. #[ORM\Column(name: 'lat', type: 'float', nullable: true)]
94. #[Serializer\Groups(['DataJS', 'SSRData'])]
95. #[Serializer\Since('v2.14')]
96. #[Serializer\Expose]
97. private ?float $lat = null;
99. #[ORM\Column(name: 'lon', type: 'float', nullable: true)]
100. #[Serializer\Groups(['DataJS', 'SSRData'])]
101. #[Serializer\Since('v2.14')]
102. #[Serializer\Expose]
103. private ?float $lon = null;
105. #[ORM\Column(name: 'zoom', type: 'smallint', nullable: true)]
106. #[Serializer\Groups(['DataJS', 'SSRData'])]
107. #[Serializer\Since('v2.14')]
108. #[Serializer\Expose]
109. private ?int $zoom = null;
111. /**
112. * @var array
113. */
114. #[ORM\Column(name: 'coordinates', type: 'array', nullable: true)]
115. private $coordinates;
117. #[ORM\Column(type: 'boolean')]
118. #[Serializer\Expose]
119. #[Serializer\Groups(['List', 'Data', 'Details', 'LocationFlat'])]
120. private $searchable;
122. #[ORM\Column(name: 'home_filter', type: 'boolean')]
123. #[Serializer\Expose]
124. #[Serializer\Groups(['Neighborhood'])]
125. private $homeFilter = false;
127. #[ORM\Column(name: 'statistics_filter', type: 'boolean')]
128. #[Serializer\Expose]
129. #[Serializer\Groups(['Neighborhood'])]
130. private $statisticsFilter = false;
132. #[ORM\Column(name: 'neighborhood_filter', type: 'boolean')]
133. #[Serializer\Expose]
134. #[Serializer\Groups(['Neighborhood'])]
135. private $neighborhoodFilter = false;
137. #[ORM\Column(name: 'compound_filter', type: 'boolean')]
138. private $compoundFilter = false;
140. #[ORM\Column(type: 'boolean')]
141. #[Serializer\Expose]
142. #[Serializer\Groups(['List', 'Data', 'Details', 'LocationFlat'])]
143. private $estimate = false;
145. #[ORM\Column(type: 'boolean')]
146. #[Serializer\Expose]
147. #[Serializer\Groups(['DefaultV4'])]
148. private $disabled = false;
150. #[ORM\Column(name: 'level', type: 'integer')]
151. #[Gedmo\TreeLevel]
152. #[Serializer\Expose]
153. #[Serializer\Groups(['List', 'Data', 'LocationFlat', 'DefaultV4', 'SlugResolver'])]
154. private $level;
156. #[ORM\Column(name: '_left', type: 'integer')]
157. #[Gedmo\TreeLeft]
158. private $left;
160. #[ORM\Column(name: '_right', type: 'integer')]
161. #[Gedmo\TreeRight]
162. private $right;
164. #[ORM\Column(name: 'root', type: 'integer', nullable: true)]
165. #[Gedmo\TreeRoot]
166. private $root;
168. #[ORM\Column(name: 'show_primary_only', type: 'boolean', options: ['default' => false])]
169. #[Serializer\Expose]
170. #[Serializer\Groups(['Autocomplete', 'List', 'Data', 'Details', 'LocationFlat', 'AutocompleteV3', 'Compound', 'SlugResolver'])]
171. private $showPrimaryOnly = false;
173. #[ORM\ManyToOne(targetEntity: Location::class, inversedBy: 'children')]
174. #[ORM\JoinColumn(name: 'parent_id', referencedColumnName: 'id', onDelete: 'CASCADE')]
175. #[Gedmo\TreeParent]
176. #[Serializer\Expose]
177. #[Serializer\Groups(['DefaultV4', 'SearchV4', 'SlugResolver', 'RelatedListingsV2', 'listingDetails'])]
178. #[Serializer\MaxDepth(1)]
179. private $parent;
181. #[ORM\OneToMany(targetEntity: Location::class, mappedBy: 'parent')]
182. #[ORM\OrderBy(['left' => 'ASC'])]
183. #[Serializer\Expose]
184. #[Serializer\Groups(['List'])]
185. #[Serializer\MaxDepth(2)]
186. #[Serializer\Accessor(getter: 'getChildren')]
187. private $children;
189. #[ORM\ManyToMany(targetEntity: Location::class, cascade: ['persist'])]
190. #[ORM\JoinTable(name: 'locations_nearestby', joinColumns: [new ORM\JoinColumn(name: 'nearest_location_id', referencedColumnName: 'id')], inverseJoinColumns: [new ORM\JoinColumn(name: 'location_id', referencedColumnName: 'id')])]
191. protected $nearestLocations;
193. #[ORM\OneToMany(targetEntity: LocationTranslation::class, mappedBy: 'object', cascade: ['persist', 'remove'])]
194. private $translations;
196. #[ORM\OneToMany(targetEntity: Listing::class, mappedBy: 'location')]
197. protected $listings;
199. #[ORM\ManyToMany(targetEntity: PropertyType::class)]
200. protected $propertyTypes;
202. #[ORM\OneToMany(targetEntity: \Aqarmap\Bundle\CRMBundle\Entity\Company::class, mappedBy: 'location')]
203. protected $companies;
205. #[ORM\OneToMany(targetEntity: LocationSupplyDemand::class, mappedBy: 'location')]
206. protected $locationSupplyDemand;
208. #[ORM\OneToMany(targetEntity: Notifier::class, mappedBy: 'location')]
209. protected $notifiers;
211. #[ORM\OneToMany(targetEntity: UserInterest::class, mappedBy: 'location', fetch: 'EXTRA_LAZY')]
212. protected $interests;
214. #[ORM\OneToMany(targetEntity: Rule::class, mappedBy: 'location')]
215. protected $rules;
217. #[ORM\OneToMany(targetEntity: LocationPhoto::class, mappedBy: 'location', cascade: ['persist', 'remove'])]
218. #[Serializer\Expose]
219. #[Serializer\Groups(['Neighborhood', 'topAreasV2'])]
220. protected $photos;
222. #[ORM\OneToMany(targetEntity: LocationStatistics::class, mappedBy: 'location', fetch: 'EXTRA_LAZY')]
223. #[Serializer\Expose]
224. #[Serializer\Groups(['Neighborhood'])]
225. protected $locationStatistics;
227. #[ORM\OneToOne(targetEntity: LocationCompound::class, cascade: ['persist', 'remove'], mappedBy: 'location')]
228. #[ORM\JoinColumn(name: 'location_compound_id', referencedColumnName: 'id')]
229. protected $locationCompound;
231. #[ORM\OneToMany(targetEntity: Discussion::class, mappedBy: 'location', fetch: 'EXTRA_LAZY')]
232. protected $discussions;
234. #[ORM\OneToMany(targetEntity: ExchangeRequest::class, mappedBy: 'location', fetch: 'EXTRA_LAZY')]
235. protected $exchangeRequests;
237. #[ORM\OneToOne(targetEntity: LocationRating::class, cascade: ['persist', 'remove'])]
238. #[Serializer\Expose]
239. #[Serializer\Groups(['Neighborhood'])]
240. protected $rating;
242. #[ORM\ManyToOne(targetEntity: Listing::class, cascade: ['persist', 'remove'])]
243. #[ORM\JoinColumn(name: 'listing_id', referencedColumnName: 'id', nullable: true)]
244. #[Serializer\Expose]
245. #[Serializer\Groups(['Autocomplete'])]
246. protected $listing;
248. #[ORM\OneToMany(targetEntity: SearchTerm::class, mappedBy: 'location')]
249. protected $searchTerms;
251. #[ORM\ManyToMany(targetEntity: LocationTier::class, mappedBy: 'locations')]
252. private Collection $tiers;
254. #[Gedmo\Locale] // Used locale to override Translation listener`s locale
255. private $locale;
257. /**
258. * @var int
259. * Count number of leads for live listings
260. */
261. #[ORM\Column(name: 'leads_counter', type: 'integer', options: ['default' => 0])]
262. #[Serializer\Groups(['Api'])]
263. #[Serializer\Expose]
264. private $leadsCounter = 0;
266. /**
267. * @var int
268. * Count number of live listings
269. */
270. #[ORM\Column(name: 'listings_counter', type: 'integer', options: ['default' => 0])]
271. #[Serializer\Groups(['Api', 'RelatedResults', 'MiniList'])]
272. #[Serializer\Expose]
273. private $listingsCounter = 0;
275. /**
276. * Project File.
277. */
278. protected $file;
280. #[ORM\Column(name: 'synonyms', type: 'text', nullable: true)]
281. private $synonyms;
283. private $location;
285. /**
286. * @var string
287. */
288. #[ORM\Column(name: 'full_path', type: 'text', nullable: true)]
289. private $fullPath;
291. #[ORM\Column(name: 'reference_id', type: 'integer', nullable: true)]
292. private $referenceId;
294. /**
295. * @var string
296. */
297. #[ORM\Column(name: 'type', type: 'string', length: 50)]
298. #[Serializer\Groups(['listingDetails', 'listingDetailsWithLocationCompound'])]
299. #[Serializer\Expose]
300. private $type;
302. /**
303. * @var array
304. */
305. private $locationTranslations = [];
307. /**
308. * @var array
309. */
310. private $v4Translations = [];
312. #[ORM\Column(name: 'eligible_for_mortgage', type: 'boolean')]
313. #[Serializer\Groups(['listingDetails', 'listingDetailsWithLocationCompound'])]
314. #[Serializer\Expose]
315. protected $eligibleForMortgage = false;
317. #[ORM\Column(name: 'is_compound_location', type: 'boolean')]
318. #[Serializer\Expose]
319. #[Serializer\Groups(['Autocomplete', 'List', 'Data', 'Details', 'LocationFlat', 'AutocompleteV3', 'Compound', 'SlugResolver'])]
320. private $isCompoundLocation = false;
322. #[ORM\OneToMany(targetEntity: Location::class, mappedBy: 'parent')]
323. #[ORM\OrderBy(['id' => 'ASC'])]
324. #[Serializer\Expose]
325. #[Serializer\Groups(['Data'])]
326. #[Serializer\MaxDepth(2)]
327. #[Serializer\Accessor(getter: 'getChildrenSortedById')]
328. #[Serializer\SerializedName('children')]
329. private $childrenSortedById;
331. #[Serializer\VirtualProperty]
332. public function getLocation()
333. {
334. return $this->location;
335. }
337. public function getSynonyms()
338. {
339. return $this->synonyms;
340. }
342. /**
343. * @param mixed $synonym
344. */
345. public function addSynonym(string $synonym): self
346. {
347. $synonyms = $this->getSynonyms() ? explode(',', (string) $this->getSynonyms()) : [];
349. if (!empty($synonym) && !in_array($synonym, $synonyms, true)) {
350. $synonyms[] = $synonym;
351. }
353. $this->synonyms = implode(',', $synonyms) ?: null;
355. return $this;
356. }
358. public function removeSynonym(string $synonym): self
359. {
360. $newSynonyms = array_diff(explode(',', (string) $this->getSynonyms()), [$synonym]);
361. $this->synonyms = implode(',', $newSynonyms) ?: null;
363. return $this;
364. }
366. public function getFile()
367. {
368. return $this->file;
369. }
371. public function setFile($file): void
372. {
373. $this->file = $file;
374. }
376. /**
377. * Constructor.
378. */
379. public function __construct()
380. {
381. $this->children = new ArrayCollection();
382. $this->translations = new ArrayCollection();
383. $this->listings = new ArrayCollection();
384. $this->notifiers = new ArrayCollection();
385. $this->rules = new ArrayCollection();
386. $this->locationStatistics = new ArrayCollection();
387. $this->photos = new ArrayCollection();
388. $this->discussions = new ArrayCollection();
389. $this->propertyTypes = new ArrayCollection();
390. $this->nearestLocations = new ArrayCollection();
391. $this->interests = new ArrayCollection();
392. $this->exchangeRequests = new ArrayCollection();
393. $this->tiers = new ArrayCollection();
394. }
396. // ---------------------------------------------------------------------
398. /**
399. * Get id.
400. *
401. * @return int
402. */
403. public function getId()
404. {
405. return $this->id;
406. }
408. // ---------------------------------------------------------------------
410. /**
411. * Set title.
412. *
413. * @param string $title
414. *
415. * @return Location
416. */
417. public function setTitle($title)
418. {
419. $this->title = $title;
421. return $this;
422. }
424. /**
425. * Get title.
426. *
427. * @return string
428. */
429. public function getTitle()
430. {
431. return $this->title;
432. }
434. /**
435. * Get a short path title (ie: New Cairo - 90th Street).
436. */
437. #[Groups(['valuation:list', 'valuation:read'])]
438. public function getTitleShortPath(): string
439. {
440. $neighbourhood = $this->getParentByType(LocationTypes::NEIGHBORHOOD, true);
442. if ($neighbourhood) {
443. return $this->getTitle().' - '.$neighbourhood->getTitle();
444. }
446. return $this->getTitle();
447. }
449. /**
450. * @return string
451. */
452. public function getIndentedTitle()
453. {
454. return str_repeat('--', $this->getLevel()).' '.$this->getTitle();
455. }
457. // ---------------------------------------------------------------------
459. /**
460. * Set description.
461. *
462. * @param string $description
463. *
464. * @return Location
465. */
466. public function setDescription($description)
467. {
468. $this->description = $description;
470. return $this;
471. }
473. /**
474. * Get description.
475. *
476. * @return string
477. */
478. public function getDescription()
479. {
480. return $this->description;
481. }
483. // ---------------------------------------------------------------------
485. /**
486. * Set slug.
487. *
488. * @param string $slug
489. *
490. * @return Location
491. */
492. public function setSlug($slug)
493. {
494. $this->slug = $slug;
496. return $this;
497. }
499. /**
500. * Get slug.
501. */
502. public function getSlug(): string
503. {
504. return $this->slug;
505. }
507. // ---------------------------------------------------------------------
509. /**
510. * Set centerLat.
511. *
512. * @param float $centerLat
513. *
514. * @return Location
515. */
516. public function setCenterLat($centerLat)
517. {
518. return $this->setLat($centerLat);
519. }
521. /**
522. * @return float
523. */
524. #[Serializer\VirtualProperty]
525. #[Serializer\Groups(['Map', 'Details', 'Neighborhood', 'LocationFlat', 'Autocomplete'])]
526. #[Serializer\SerializedName('center_lat')]
527. #[Serializer\Until('v2.13')]
528. #[Serializer\Expose]
529. public function getCenterLat()
530. {
531. return $this->getLat();
532. }
534. /**
535. * @param float $latitude
536. *
537. * @return Location
538. */
539. public function setLat($latitude)
540. {
541. $this->lat = $latitude;
543. return $this;
544. }
546. /**
547. * @return float|null
548. */
549. public function getLat()
550. {
551. if (!$this->lat) {
552. return null;
553. }
555. return (float) $this->lat;
556. }
558. // ---------------------------------------------------------------------
560. /**
561. * Set lon.
562. *
563. * @deprecated
564. *
565. * @param float $lon
566. *
567. * @return Location
568. */
569. public function setCenterLng($lon)
570. {
571. return $this->setLon($lon);
572. }
574. /**
575. * @deprecated
576. *
577. * @return float|null
578. */
579. #[Serializer\VirtualProperty]
580. #[Serializer\Groups(['Map', 'Details', 'Neighborhood', 'LocationFlat', 'Autocomplete'])]
581. #[Serializer\SerializedName('center_lng')]
582. #[Serializer\Until('v2.13')]
583. #[Serializer\Expose]
584. public function getCenterLng()
585. {
586. return $this->getLon();
587. }
589. /**
590. * @param float $longitude
591. *
592. * @return Location
593. */
594. public function setLon($longitude)
595. {
596. $this->lon = $longitude;
598. return $this;
599. }
601. /**
602. * @return float|null
603. */
604. public function getLon()
605. {
606. if (!$this->lon) {
607. return null;
608. }
610. return (float) $this->lon;
611. }
613. // ---------------------------------------------------------------------
615. /**
616. * Set zoom.
617. *
618. * @deprecated
619. *
620. * @param int $zoom
621. *
622. * @return Location
623. */
624. public function setZoomLevel($zoom)
625. {
626. return $this->setZoom($zoom);
627. }
629. /**
630. * @deprecated
631. *
632. * @return int
633. */
634. #[Serializer\VirtualProperty]
635. #[Serializer\Groups(['Map', 'Details', 'Neighborhood', 'LocationFlat', 'Autocomplete', 'AutocompleteV3', 'DefaultV4'])]
636. #[Serializer\SerializedName('zoom_level')]
637. #[Serializer\Until('v2.13')]
638. #[Serializer\Expose]
639. public function getZoomLevel()
640. {
641. return $this->getZoom();
642. }
644. public function setZoom(?int $level): self
645. {
646. $this->zoom = $level;
648. return $this;
649. }
651. /**
652. * @return int|null
653. */
654. #[Serializer\VirtualProperty]
655. #[Serializer\SerializedName('zoom')]
656. #[Serializer\Groups(['DataJS'])]
657. public function getZoom()
658. {
659. return $this->zoom;
660. }
662. // ---------------------------------------------------------------------
664. /**
665. * Set coordinates.
666. *
667. * @param array $coordinates
668. *
669. * @return Location
670. */
671. public function setCoordinates($coordinates)
672. {
673. $this->coordinates = $coordinates;
675. return $this;
676. }
678. /**
679. * Get coordinates.
680. *
681. * @return array
682. */
683. public function getCoordinates()
684. {
685. return $this->coordinates;
686. }
688. // ---------------------------------------------------------------------
690. /**
691. * Set searchable.
692. *
693. * @param bool $searchable
694. *
695. * @return Location
696. */
697. public function setSearchable($searchable)
698. {
699. $this->searchable = $searchable;
701. return $this;
702. }
704. /**
705. * Get searchable.
706. *
707. * @return bool
708. */
709. public function getSearchable()
710. {
711. return $this->searchable;
712. }
714. // ---------------------------------------------------------------------
716. /**
717. * Set homeFilter.
718. *
719. * @param bool $homeFilter
720. *
721. * @return Location
722. */
723. public function setHomeFilter($homeFilter)
724. {
725. $this->homeFilter = $homeFilter;
727. return $this;
728. }
730. /**
731. * Get homeFilter.
732. *
733. * @return bool
734. */
735. public function getHomeFilter()
736. {
737. return $this->homeFilter;
738. }
740. // ---------------------------------------------------------------------
742. /**
743. * Set estimate.
744. *
745. * @param bool $estimate
746. *
747. * @return Location
748. */
749. public function setEstimate($estimate)
750. {
751. $this->estimate = $estimate;
753. return $this;
754. }
756. /**
757. * Get estimate.
758. *
759. * @return bool
760. */
761. public function getEstimate()
762. {
763. return $this->estimate;
764. }
766. // ---------------------------------------------------------------------
768. /**
769. * Set disabled.
770. *
771. * @param bool $disabled
772. *
773. * @return Location
774. */
775. public function setDisabled($disabled)
776. {
777. $this->disabled = $disabled;
779. return $this;
780. }
782. /**
783. * Get disabled.
784. *
785. * @return bool
786. */
787. public function getDisabled()
788. {
789. return $this->disabled;
790. }
792. // ---------------------------------------------------------------------
794. /**
795. * Set parent.
796. *
797. * @return Location
798. */
799. public function setParent(?self $parent = null)
800. {
801. $this->parent = $parent;
803. return $this;
804. }
806. /**
807. * Get parent.
808. *
809. * @return Location
810. */
811. public function getParent()
812. {
813. return $this->parent;
814. }
816. // ---------------------------------------------------------------------
818. /**
819. * Add children.
820. *
821. * @return Location
822. */
823. public function addChild(self $children)
824. {
825. $this->children[] = $children;
827. return $this;
828. }
830. /**
831. * Remove children.
832. */
833. public function removeChild(self $children): void
834. {
835. $this->children->removeElement($children);
836. }
838. /**
839. * Get children.
840. *
841. * @return Collection
842. */
843. public function getChildren()
844. {
845. $criteria = Criteria::create()
846. ->where(Criteria::expr()->eq('disabled', false));
848. return $this->children->matching($criteria);
849. }
851. /**
852. * Get children sorted by id.
853. *
854. * @return Collection
855. */
856. public function getChildrenSortedById($filters = [])
857. {
858. $criteria = Criteria::create()
859. ->where(Criteria::expr()->eq('disabled', false));
861. if (isset($filters['neighborhoodFilter'])) {
862. $criteria->andWhere(Criteria::expr()->eq('neighborhoodFilter', $filters['neighborhoodFilter']));
863. }
865. return $this->childrenSortedById->matching($criteria);
866. }
868. /**
869. * Get children.
870. *
871. * @return Collection
872. */
873. public function getChildrenArray()
874. {
875. $criteria = Criteria::create()
876. ->where(Criteria::expr()->eq('disabled', false));
878. return $this->children->matching($criteria)->toArray();
879. }
881. /**
882. * Get neighborhoodchildren.
883. *
884. * @return Collection
885. */
886. public function getNeighborhoodChildren()
887. {
888. $criteria = Criteria::create()
889. ->andWhere(Criteria::expr()->eq('disabled', false))
890. ->andWhere(Criteria::expr()->eq('neighborhoodFilter', true));
892. return $this->children->matching($criteria);
893. }
895. /**
896. * Get leveled children.
897. *
898. * @return Collection
899. */
900. public function getLeveledChildren()
901. {
902. $criteria = Criteria::create()
903. ->where(Criteria::expr()->eq('disabled', false))
904. ->where(Criteria::expr()->lte('level', 2));
906. return $this->children->matching($criteria);
907. }
909. /**
910. * Set type.
911. *
912. * @param string $type
913. *
914. * @return Location
915. */
916. public function setType($type)
917. {
918. $this->type = $type;
920. return $this;
921. }
923. /**
924. * Get type.
925. *
926. * @return string
927. */
928. public function getType()
929. {
930. return $this->type;
931. }
933. public function getTypeLabel(): ?string
934. {
935. return LocationTypes::getLabel($this->getType());
936. }
938. // ---------------------------------------------------------------------
940. /**
941. * Get translations.
942. *
943. * @return ArrayCollection
944. */
945. public function getTranslations()
946. {
947. return $this->translations;
948. }
950. /**
951. * Add translation.
952. *
953. * @return Location
954. */
955. public function addTranslation(LocationTranslation $translation)
956. {
957. if (!$this->translations->contains($translation)) {
958. $this->translations->add($translation);
959. $translation->setObject($this);
960. }
962. return $this;
963. }
965. /**
966. * Remove translation.
967. *
968. * @return Location
969. */
970. public function removeTranslation(LocationTranslation $translation)
971. {
972. if ($this->translations->contains($translation)) {
973. $this->translations->removeElement($translation);
974. }
976. return $this;
977. }
979. // ---------------------------------------------------------------------
981. /**
982. * Add listings.
983. *
984. * @return Location
985. */
986. public function addListing(Listing $listings)
987. {
988. $this->listings[] = $listings;
990. return $this;
991. }
993. /**
994. * Remove listings.
995. */
996. public function removeListing(Listing $listings): void
997. {
998. $this->listings->removeElement($listings);
999. }
1001. /**
1002. * Get listings.
1003. *
1004. * @return Collection
1005. */
1006. public function getListings()
1007. {
1008. return $this->listings;
1009. }
1011. // ---------------------------------------------------------------------
1013. /**
1014. * Add notifiers.
1015. *
1016. * @return Location
1017. */
1018. public function addNotifier(Notifier $notifiers)
1019. {
1020. $this->notifiers[] = $notifiers;
1022. return $this;
1023. }
1025. /**
1026. * Remove notifiers.
1027. */
1028. public function removeNotifier(Notifier $notifiers): void
1029. {
1030. $this->notifiers->removeElement($notifiers);
1031. }
1033. /**
1034. * Get notifiers.
1035. *
1036. * @return Collection
1037. */
1038. public function getNotifiers()
1039. {
1040. return $this->notifiers;
1041. }
1043. // ---------------------------------------------------------------------
1045. /**
1046. * Add rules.
1047. *
1048. * @return Location
1049. */
1050. public function addRule(Rule $rules)
1051. {
1052. $this->rules[] = $rules;
1054. return $this;
1055. }
1057. /**
1058. * Remove rules.
1059. */
1060. public function removeRule(Rule $rules): void
1061. {
1062. $this->rules->removeElement($rules);
1063. }
1065. /**
1066. * Get rules.
1067. *
1068. * @return Collection
1069. */
1070. public function getRules()
1071. {
1072. return $this->rules;
1073. }
1075. // ---------------------------------------------------------------------
1077. /**
1078. * Get Nearest Searchable Location.
1079. */
1080. public function getNearestSearchable()
1081. {
1082. $location = $this;
1083. while ($location && !$location->getSearchable()) {
1084. $location = $location->getParent();
1085. }
1086. if (!$location) {
1087. return $this;
1088. }
1090. return $location;
1091. }
1093. // -----------------------------------------------------------------------------
1095. /**
1096. * Get Nearest Neighborhood Parent.
1097. */
1098. public function getNearestNeighborhood()
1099. {
1100. $location = $this;
1102. while (
1103. !$location->getNeighborhoodFilter()
1104. && $location->getParent()
1105. && 0 != $location->getParent()->getLevel()
1106. ) {
1107. $location = $location->getParent();
1108. }
1110. if (!$location->getNeighborhoodFilter() || 0 == $location->getLevel()) {
1111. return;
1112. }
1114. return $location;
1115. }
1117. /**
1118. * Get Nearest Location Custom Level .
1119. *
1120. * @param int $level
1121. *
1122. * @return Location
1123. */
1124. public function getNearestLeveledLocation($level = 1)
1125. {
1126. $location = $this;
1128. if (\in_array($location->getLevel(), [0, $level])) {
1129. return $location;
1130. }
1132. while ($location->getParent() && 0 != $location->getParent()->getLevel()) {
1133. $location = $location->getParent();
1134. }
1136. return $location;
1137. }
1139. /**
1140. * Get the nearest parent with the provided location type.
1141. */
1142. public function getParentByType(string $locationType, bool $rootFallback = false): ?self
1143. {
1144. $location = $this->getParent();
1145. $root = null;
1147. while ($location) {
1148. if ($location->getType() === $locationType) {
1149. return $location;
1150. }
1152. $root = $location;
1153. $location = $location->getParent();
1154. }
1156. return $rootFallback ? $root : null;
1157. }
1159. #[Serializer\VirtualProperty]
1160. #[Serializer\SerializedName('parent')]
1161. #[Serializer\Expose]
1162. #[Serializer\Groups(['LocationFlat'])]
1163. public function getVirtualParent()
1164. {
1165. $parent = $this->getParent();
1166. if ($parent) {
1167. return [
1168. 'id' => $parent->getId(),
1169. 'title' => $parent->getTitle(),
1170. ];
1171. }
1173. return null;
1174. }
1176. /**
1177. * Gets parent by level.
1178. *
1179. * @param int $level
1180. *
1181. * @return Location|null
1182. */
1183. public function getLeveledParent($level = 1)
1184. {
1185. $location = $this;
1187. while ($location = $location->getParent()) {
1188. if ($location->getLevel() == $level) {
1189. return $location;
1190. }
1191. }
1193. return null;
1194. }
1196. /**
1197. * Get Nearest Location Custom Level .
1198. *
1199. * @return Location
1200. */
1201. public function getFirstParent()
1202. {
1203. $location = $this;
1205. if (0 == $location->getLevel()) {
1206. return $location;
1207. }
1209. while ($location = $location->getParent()) {
1210. if (0 == $location->getLevel()) {
1211. return $location;
1212. }
1213. }
1215. return $location;
1216. }
1218. /**
1219. * Set level.
1220. *
1221. * @param int $level
1222. *
1223. * @return Location
1224. */
1225. public function setLevel($level)
1226. {
1227. $this->level = $level;
1229. return $this;
1230. }
1232. /**
1233. * Get level.
1234. *
1235. * @return int
1236. */
1237. public function getLevel()
1238. {
1239. return $this->level;
1240. }
1242. /**
1243. * Set left.
1244. *
1245. * @param int $left
1246. *
1247. * @return Location
1248. */
1249. public function setLeft($left)
1250. {
1251. $this->left = $left;
1253. return $this;
1254. }
1256. /**
1257. * Get left.
1258. *
1259. * @return int
1260. */
1261. public function getLeft()
1262. {
1263. return $this->left;
1264. }
1266. /**
1267. * Set right.
1268. *
1269. * @param int $right
1270. *
1271. * @return Location
1272. */
1273. public function setRight($right)
1274. {
1275. $this->right = $right;
1277. return $this;
1278. }
1280. /**
1281. * Get right.
1282. *
1283. * @return int
1284. */
1285. public function getRight()
1286. {
1287. return $this->right;
1288. }
1290. /**
1291. * Set root.
1292. *
1293. * @param int $root
1294. *
1295. * @return Location
1296. */
1297. public function setRoot($root)
1298. {
1299. $this->root = $root;
1301. return $this;
1302. }
1304. /**
1305. * Get root.
1306. *
1307. * @return int
1308. */
1309. public function getRoot()
1310. {
1311. return $this->root;
1312. }
1314. /**
1315. * Add locationSupplyDemand.
1316. *
1317. * @return Location
1318. */
1319. public function addLocationSupplyDemand(LocationSupplyDemand $locationSupplyDemand)
1320. {
1321. $this->locationSupplyDemand[] = $locationSupplyDemand;
1323. return $this;
1324. }
1326. /**
1327. * Remove locationSupplyDemand.
1328. */
1329. public function removeLocationSupplyDemand(LocationSupplyDemand $locationSupplyDemand): void
1330. {
1331. $this->locationSupplyDemand->removeElement($locationSupplyDemand);
1332. }
1334. /**
1335. * Get locationSupplyDemand.
1336. *
1337. * @return Collection
1338. */
1339. public function getLocationSupplyDemand()
1340. {
1341. return $this->locationSupplyDemand;
1342. }
1344. // ---------------------------------------------------------------------
1346. /**
1347. * Add photos.
1348. *
1349. * @return Location
1350. */
1351. public function addPhoto(LocationPhoto $photo)
1352. {
1353. $photo->setLocation($this);
1355. $this->photos[] = $photo;
1357. return $this;
1358. }
1360. /**
1361. * Set photos.
1362. *
1363. * @return Location
1364. */
1365. public function setPhotos($photos)
1366. {
1367. foreach ($photos as $photo) {
1368. $this->addPhoto($photo);
1369. }
1371. return $this;
1372. }
1374. /**
1375. * Remove photos.
1376. */
1377. public function removePhoto(LocationPhoto $photo): void
1378. {
1379. $this->photos->removeElement($photo);
1380. }
1382. /**
1383. * @return ArrayCollection
1384. */
1385. public function getPhotos()
1386. {
1387. return $this->photos;
1388. }
1390. #[Serializer\VirtualProperty]
1391. #[Serializer\Groups(['topAreasV2'])]
1392. #[Serializer\SerializedName('avg_price_per_meter')]
1393. public function getAvgPricePerMeter(): ?float
1394. {
1395. $statistics = $this->getSingleStatistics();
1397. return $statistics ? (float) $statistics->getAvgPrice() : null;
1398. }
1400. #[Serializer\VirtualProperty]
1401. #[Serializer\Groups(['Default', 'LocationFlat', 'topAreasV2'])]
1402. public function getMainPhoto(): ?LocationPhoto
1403. {
1404. // Important for API
1405. if ($this->getPhotos()->count() <= 0) {
1406. return null;
1407. }
1409. /* @var LocationPhoto $photo */
1410. $mainPhoto = $this->photos->filter(fn ($photo) => PhotoTypes::MAIN_PHOTO == $photo->getType());
1412. return $mainPhoto->first() ?: $this->getPhotos()->first();
1413. }
1415. // ---------------------------------------------------------------------
1416. public function __clone()
1417. {
1418. $this->id = null;
1419. }
1421. public function __toString(): string
1422. {
1423. return $this->title;
1424. }
1426. /**
1427. * Set rating.
1428. *
1429. * @return Location
1430. */
1431. public function setRating(?LocationRating $rating = null)
1432. {
1433. $this->rating = $rating;
1435. $this->rating->setLocation($this);
1437. return $this;
1438. }
1440. /**
1441. * Get rating.
1442. *
1443. * @return LocationRating
1444. */
1445. public function getRating()
1446. {
1447. return $this->rating;
1448. }
1450. /**
1451. * Get rating of the nearest parent location that has one.
1452. */
1453. public function getNearestRating()
1454. {
1455. $location = $this;
1457. while ($location) {
1458. $rating = $location->getRating();
1460. if (
1461. $rating
1462. && null !== $rating->getOverall()
1463. && LocationTypes::CITY !== $location->getType()
1464. ) {
1465. return $rating;
1466. }
1468. $location = $location->getParent();
1469. }
1471. return null;
1472. }
1474. /**
1475. * Set neighborhoodFilter.
1476. *
1477. * @param bool $neighborhoodFilter
1478. *
1479. * @return Location
1480. */
1481. public function setNeighborhoodFilter($neighborhoodFilter)
1482. {
1483. $this->neighborhoodFilter = $neighborhoodFilter;
1485. return $this;
1486. }
1488. /**
1489. * Get neighborhoodFilter.
1490. *
1491. * @return bool
1492. */
1493. public function getNeighborhoodFilter()
1494. {
1495. return $this->neighborhoodFilter;
1496. }
1498. /**
1499. * Add locationStatistic.
1500. *
1501. * @return Location
1502. */
1503. public function addLocationStatistic(LocationStatistics $locationStatistic)
1504. {
1505. $this->locationStatistics[] = $locationStatistic;
1507. return $this;
1508. }
1510. /**
1511. * Remove locationStatistic.
1512. */
1513. public function removeLocationStatistic(LocationStatistics $locationStatistic): void
1514. {
1515. $this->locationStatistics->removeElement($locationStatistic);
1516. }
1518. /**
1519. * Get locationStatistics.
1520. *
1521. * @return Collection
1522. */
1523. public function getLocationStatistics()
1524. {
1525. return $this->locationStatistics;
1526. }
1528. /**
1529. * Get lowest Average Price.
1530. *
1531. * @return LocationStatistics $locationStatistic
1532. */
1533. public function getSingleStatistics(?PropertyType $propertyType = null)
1534. {
1535. $criteria = Criteria::create()
1536. ->andWhere(Criteria::expr()->neq('avgPrice', null))
1537. ->andWhere(Criteria::expr()->gt('avgPrice', 0))
1538. ->orderBy(['avgPrice' => Criteria::ASC]);
1539. if ($propertyType) {
1540. $criteria
1541. ->andWhere(Criteria::expr()->eq('propertyType', $propertyType));
1542. }
1544. return $this->locationStatistics->matching($criteria)->first();
1545. }
1547. /**
1548. * Set statisticsFilter.
1549. *
1550. * @param bool $statisticsFilter
1551. *
1552. * @return Location
1553. */
1554. public function setStatisticsFilter($statisticsFilter)
1555. {
1556. $this->statisticsFilter = $statisticsFilter;
1558. return $this;
1559. }
1561. /**
1562. * Get statisticsFilter.
1563. *
1564. * @return bool
1565. */
1566. public function getStatisticsFilter()
1567. {
1568. return $this->statisticsFilter;
1569. }
1571. /**
1572. * Add company.
1573. *
1574. * @return Location
1575. */
1576. public function addCompany(\Aqarmap\Bundle\CRMBundle\Entity\Company $company)
1577. {
1578. $this->companies[] = $company;
1580. return $this;
1581. }
1583. /**
1584. * Remove company.
1585. */
1586. public function removeCompany(\Aqarmap\Bundle\CRMBundle\Entity\Company $company): void
1587. {
1588. $this->companies->removeElement($company);
1589. }
1591. /**
1592. * Get companies.
1593. *
1594. * @return Collection
1595. */
1596. public function getCompanies()
1597. {
1598. return $this->companies;
1599. }
1601. /**
1602. * Add discussion.
1603. *
1604. * @return Location
1605. */
1606. public function addDiscussion(Discussion $discussion)
1607. {
1608. $this->discussions[] = $discussion;
1610. return $this;
1611. }
1613. /**
1614. * Remove discussion.
1615. */
1616. public function removeDiscussion(Discussion $discussion): void
1617. {
1618. $this->discussions->removeElement($discussion);
1619. }
1621. /**
1622. * Get discussions.
1623. *
1624. * @return Collection
1625. */
1626. public function getDiscussions()
1627. {
1628. return $this->discussions;
1629. }
1631. /**
1632. * Set compoundFilter.
1633. *
1634. * @param bool $compoundFilter
1635. *
1636. * @return Location
1637. */
1638. public function setCompoundFilter($compoundFilter)
1639. {
1640. $this->compoundFilter = $compoundFilter;
1642. return $this;
1643. }
1645. /**
1646. * Get compoundFilter.
1647. *
1648. * @return bool
1649. */
1650. public function getCompoundFilter()
1651. {
1652. return $this->compoundFilter;
1653. }
1655. /**
1656. * Add propertyType.
1657. *
1658. * @return Location
1659. */
1660. public function addPropertyType(PropertyType $propertyType)
1661. {
1662. $this->propertyTypes[] = $propertyType;
1664. return $this;
1665. }
1667. /**
1668. * Remove propertyType.
1669. */
1670. public function removePropertyType(PropertyType $propertyType): void
1671. {
1672. $this->propertyTypes->removeElement($propertyType);
1673. }
1675. /**
1676. * Get propertyTypes.
1677. *
1678. * @return Collection
1679. */
1680. public function getPropertyTypes()
1681. {
1682. return $this->propertyTypes;
1683. }
1685. /**
1686. * Set listing.
1687. *
1688. * @return Location
1689. */
1690. public function setListing(?Listing $listing = null)
1691. {
1692. $this->listing = $listing;
1694. return $this;
1695. }
1697. /**
1698. * Set listing.
1699. *
1700. * @return Location
1701. */
1702. public function setListings(array $listings = [])
1703. {
1704. $this->listings = $listings;
1706. return $this;
1707. }
1709. /**
1710. * Get listing.
1711. *
1712. * @return Listing
1713. */
1714. public function getListing()
1715. {
1716. return $this->listing;
1717. }
1719. /**
1720. * Set locationCompound.
1721. *
1722. * @return Location
1723. */
1724. public function setLocationCompound(?LocationCompound $locationCompound = null)
1725. {
1726. $this->locationCompound = $locationCompound;
1727. $this->locationCompound->setLocation($this);
1729. return $this;
1730. }
1732. /**
1733. * Get locationCompound.
1734. *
1735. * @return LocationCompound
1736. */
1737. public function getLocationCompound()
1738. {
1739. return $this->locationCompound;
1740. }
1742. /**
1743. * Add nearestLocation.
1744. *
1745. * @return Location
1746. */
1747. public function addNearestLocation(self $nearestLocation)
1748. {
1749. if (!$this->nearestLocations->contains($nearestLocation)) {
1750. $this->nearestLocations->add($nearestLocation);
1751. }
1753. return $this;
1754. }
1756. /**
1757. * Remove nearestLocation.
1758. *
1759. * @return Location
1760. */
1761. public function removeNearestLocation(self $nearestLocation)
1762. {
1763. if ($this->nearestLocations->contains($nearestLocation)) {
1764. $this->nearestLocations->removeElement($nearestLocation);
1765. }
1767. return $this;
1768. }
1770. /**
1771. * Get nearestLocations.
1772. *
1773. * @return Collection
1774. */
1775. public function getNearestLocations()
1776. {
1777. return $this->nearestLocations;
1778. }
1780. /**
1781. * Add interest.
1782. *
1783. * @return Location
1784. */
1785. public function addInterest(UserInterest $interest)
1786. {
1787. $this->interests[] = $interest;
1789. return $this;
1790. }
1792. /**
1793. * Remove interest.
1794. */
1795. public function removeInterest(UserInterest $interest): void
1796. {
1797. $this->interests->removeElement($interest);
1798. }
1800. /**
1801. * Get interests.
1802. *
1803. * @return Collection
1804. */
1805. public function getInterests()
1806. {
1807. return $this->interests;
1808. }
1810. /**
1811. * Get interests.
1812. *
1813. * @return UserInterest
1814. */
1815. public function getLiveInterests()
1816. {
1817. $criteria = Criteria::create()
1818. ->andwhere(Criteria::expr()->eq('status', UserInterestStatus::LIVE));
1820. return $this->interests->matching($criteria);
1821. }
1823. public function setTranslatableLocale($locale): void
1824. {
1825. $this->locale = $locale;
1826. }
1828. /**
1829. * Add exchangeRequest.
1830. *
1831. * @return Location
1832. */
1833. public function addExchangeRequest(ExchangeRequest $exchangeRequest)
1834. {
1835. $this->exchangeRequests[] = $exchangeRequest;
1837. return $this;
1838. }
1840. /**
1841. * Remove exchangeRequest.
1842. */
1843. public function removeExchangeRequest(ExchangeRequest $exchangeRequest): void
1844. {
1845. $this->exchangeRequests->removeElement($exchangeRequest);
1846. }
1848. /**
1849. * Get exchangeRequests.
1850. *
1851. * @return Collection
1852. */
1853. public function getExchangeRequests()
1854. {
1855. return $this->exchangeRequests;
1856. }
1858. public function setSearchTerms($searchTerms): void
1859. {
1860. $this->searchTerms = $searchTerms;
1861. }
1863. public function getSearchTerms()
1864. {
1865. return $this->searchTerms;
1866. }
1868. /**
1869. * @return int
1870. */
1871. public function getLeadsCounter()
1872. {
1873. return $this->leadsCounter;
1874. }
1876. /**
1877. * @param int $leadsCounter
1878. */
1879. public function setLeadsCounter($leadsCounter): void
1880. {
1881. $this->leadsCounter = $leadsCounter;
1882. }
1884. /**
1885. * @return int
1886. */
1887. public function getListingsCounter()
1888. {
1889. return $this->listingsCounter;
1890. }
1892. /**
1893. * @param int $listingsCounter
1894. *
1895. * @return Location
1896. */
1897. public function setListingsCounter($listingsCounter)
1898. {
1899. $this->listingsCounter = $listingsCounter;
1901. return $this;
1902. }
1904. /**
1905. * @return int
1906. */
1907. public function getLocationParentLabel()
1908. {
1909. $parent = $this->getParent() ? $this->getParent()->getTitle().' / ' : null;
1911. return $parent.$this->getTitle();
1912. }
1914. /**
1915. * @return int
1916. */
1917. public function getLastSlug()
1918. {
1919. $segments = explode('/', $this->slug);
1921. return end($segments);
1922. }
1924. /**
1925. * @return bool
1926. */
1927. #[Serializer\VirtualProperty]
1928. #[Serializer\SerializedName('has_children')]
1929. #[Serializer\Expose]
1930. #[Serializer\Groups(['LocationFlat', 'AutocompleteV3', 'DefaultV4'])]
1931. public function getHasChildren()
1932. {
1933. return $this->getChildren()->isEmpty() ? false : true;
1934. }
1936. /**
1937. * @return string
1938. */
1939. #[Serializer\VirtualProperty]
1940. #[Serializer\SerializedName('text')]
1941. #[Serializer\Groups(['Autocomplete'])]
1942. #[Serializer\Expose]
1943. public function getText()
1944. {
1945. return $this->getTitle();
1946. }
1948. /**
1949. * Get Title FullPath
1950. * e.g. takes 90th street and returns Greater Cairo / New Cairo / 90th Street.
1951. */
1952. #[Serializer\VirtualProperty]
1953. #[Serializer\SerializedName('title_full_path')]
1954. #[Serializer\Groups(['Autocomplete', 'listingDetails', 'AutocompleteV3', 'DefaultV4', 'SearchV4', 'ProjectDetailsV4', 'SlugResolver', 'RelatedListingsV2', 'topAreasV2'])]
1955. #[Serializer\Expose]
1956. public function getTitleFullPath(): string
1957. {
1958. $location = $this;
1959. $titlesFullPath[] = $this->getTitle();
1961. while ($location = $location->getParent()) {
1962. $titlesFullPath[] = $location->getTitle();
1963. }
1965. return implode(' / ', array_reverse($titlesFullPath ?? []));
1966. }
1968. /**
1969. * Get searchable title keywords
1970. * e.g. takes 90th street and returns Greater Cairo / New Cairo / 90th Street.
1971. */
1972. public function getSearchableTitle(): string
1973. {
1974. $location = $this;
1975. $titlesFullPath = [];
1976. $this->handleTitle($location, $titlesFullPath);
1978. while ($location = $location->getParent()) {
1979. $this->handleTitle($location, $titlesFullPath);
1980. }
1982. return implode(' / ', array_reverse($titlesFullPath ?? []));
1983. }
1985. /**
1986. * Get Title FullPath started from children
1987. * e.g. takes 90th street and returns Greater 90th Street - New Cairo - Cairo.
1988. */
1989. public function getTitleFullPathStartedFromChildren(): string
1990. {
1991. $location = $this;
1992. $titlesFullPath[] = $this->getTitle();
1994. while ($location = $location->getParent()) {
1995. $titlesFullPath[] = $location->getTitle();
1996. }
1998. return implode(' - ', $titlesFullPath);
1999. }
2001. #[Serializer\VirtualProperty]
2002. #[Serializer\Groups(['Autocomplete'])]
2003. #[Serializer\Expose]
2004. public function getTranslation(): array
2005. {
2006. $translations = [];
2008. foreach ($this->getTranslations()->toArray() as $trans) {
2009. $translations[$trans->getLocale()] = $trans->getContent();
2010. }
2012. return $translations;
2013. }
2015. /**
2016. * @return string|null
2017. */
2018. public function getFullPath()
2019. {
2020. return $this->fullPath;
2021. }
2023. public function setFullPath(?string $fullPath = null): self
2024. {
2025. $this->fullPath = $fullPath;
2027. return $this;
2028. }
2030. /**
2031. * @return string
2032. */
2033. #[Serializer\VirtualProperty]
2034. #[Serializer\SerializedName('name')]
2035. #[Serializer\Groups(['AutocompleteV3', 'DefaultV4', 'SearchV4', 'UserFavoriteListings'])]
2036. #[Serializer\Expose]
2037. public function getName()
2038. {
2039. return $this->getTitle();
2040. }
2042. /**
2043. * @return string
2044. */
2045. #[Serializer\VirtualProperty]
2046. #[Serializer\SerializedName('latitude')]
2047. #[Serializer\Groups(['AutocompleteV3', 'DefaultV4', 'ProjectDetailsV4'])]
2048. #[Serializer\Expose]
2049. public function getLatitude()
2050. {
2051. return $this->getLat();
2052. }
2054. /**
2055. * @return string
2056. */
2057. #[Serializer\VirtualProperty]
2058. #[Serializer\SerializedName('longitude')]
2059. #[Serializer\Groups(['AutocompleteV3', 'DefaultV4', 'ProjectDetailsV4'])]
2060. #[Serializer\Expose]
2061. public function getLongitude()
2062. {
2063. return $this->getLon();
2064. }
2066. #[Serializer\VirtualProperty]
2067. #[Serializer\Groups(['AutocompleteV3'])]
2068. #[Serializer\SerializedName('translations')]
2069. #[Serializer\Expose]
2070. public function getLocationTranslations(): array
2071. {
2072. return $this->locationTranslations;
2073. }
2075. public function setLocationTranslations(array $translation): self
2076. {
2077. $this->locationTranslations = $translation;
2079. return $this;
2080. }
2082. /**
2083. * @return int|null
2084. */
2085. public function getReferenceId()
2086. {
2087. return $this->id;
2088. }
2090. /**
2091. * @return self
2092. */
2093. public function setReferenceId(?int $referenceId)
2094. {
2095. $this->referenceId = $referenceId;
2097. return $this;
2098. }
2100. /**
2101. * @return int
2102. */
2103. #[Serializer\VirtualProperty]
2104. #[Serializer\Groups(['DefaultV4'])]
2105. #[Serializer\SerializedName('listingsCount')]
2106. #[Serializer\Expose]
2107. public function getListingsCount()
2108. {
2109. return $this->listingsCounter;
2110. }
2112. /**
2113. * @return $this
2114. */
2115. public function setListingsCount(int $listingsCount): self
2116. {
2117. $this->listingsCounter = $listingsCount;
2119. return $this;
2120. }
2122. #[Serializer\VirtualProperty]
2123. #[Serializer\SerializedName('referenceId')]
2124. #[Serializer\Expose]
2125. #[Serializer\Groups(['DefaultV4', 'AutocompleteV3', 'SearchV4'])]
2126. public function getReferencedV4Id()
2127. {
2128. return $this->getId();
2129. }
2131. /**
2132. * @param array $translations
2133. *
2134. * @return self
2135. */
2136. public function setV4Translations($translations = [])
2137. {
2138. $this->v4Translations = $translations;
2140. return $this;
2141. }
2143. /**
2144. * Get translations.
2145. *
2146. * @return array
2147. */
2148. #[Serializer\VirtualProperty]
2149. #[Serializer\Groups(['DefaultV4', 'MyListing', 'SearchV4'])]
2150. #[Serializer\SerializedName('translations')]
2151. #[Serializer\Expose]
2152. public function getV4Translations()
2153. {
2154. return $this->v4Translations;
2155. }
2157. /**
2158. * @return Location
2159. */
2160. public function setEligibleForMortgage(bool $eligibleForMortgage)
2161. {
2162. $this->eligibleForMortgage = $eligibleForMortgage;
2164. return $this;
2165. }
2167. /**
2168. * Get Eligible For Mortgage.
2169. *
2170. * @return bool
2171. */
2172. public function getEligibleForMortgage()
2173. {
2174. return $this->eligibleForMortgage;
2175. }
2177. /**
2178. * Set isCompoundLocation.
2179. *
2180. * @param bool $isCompoundLocation
2181. *
2182. * @return Location
2183. */
2184. public function setIsCompoundLocation($isCompoundLocation)
2185. {
2186. $this->isCompoundLocation = $isCompoundLocation;
2188. return $this;
2189. }
2191. /**
2192. * Get isCompoundLocation.
2193. *
2194. * @return bool
2195. */
2196. public function getIsCompoundLocation()
2197. {
2198. return $this->isCompoundLocation;
2199. }
2201. /**
2202. * Set showPrimaryOnly.
2203. */
2204. public function setShowPrimaryOnly(bool $showPrimaryOnly): self
2205. {
2206. $this->showPrimaryOnly = $showPrimaryOnly;
2208. return $this;
2209. }
2211. /**
2212. * Get showPrimaryOnly.
2213. */
2214. public function getShowPrimaryOnly(): bool
2215. {
2216. return $this->showPrimaryOnly;
2217. }
2219. /**
2220. * @param self $location
2221. * @param array &$titlesFullPath
2222. */
2223. private function handleTitle($location, &$titlesFullPath): void
2224. {
2225. $translations = $location->getTranslations() ? $location->getTranslations()->toArray() : [];
2227. foreach ($translations as $trans) {
2228. if ('en' == $trans->getLocale() && 'title' == $trans->getField()) {
2229. $titlesFullPath[] = ucfirst((string) $trans->getContent());
2230. }
2231. }
2232. $titlesFullPath[] = $location->getTitle();
2233. }
2235. private $listingOrNull;
2237. #[Serializer\VirtualProperty]
2238. #[Serializer\Groups(['SlugResolver', 'Compound', 'locationListingV2', 'homeCompoundV2', 'listingDetailsWithLocationCompound'])]
2239. #[Serializer\SerializedName('compound_listing')]
2240. #[Serializer\Expose]
2241. public function getListingOrNull(): ?Listing
2242. {
2243. return $this->listingOrNull;
2244. }
2246. public function setListingOrNull(?Listing $listingOrNull): void
2247. {
2248. $this->listingOrNull = $listingOrNull;
2249. }
2251. public function getAlias(): string
2252. {
2253. return $this->alias;
2254. }
2256. public function setAlias(string $alias): void
2257. {
2258. $this->alias = $alias;
2259. }
2261. /**
2262. * @return Collection|LocationTier[]
2263. */
2264. public function getLocationTiers(): Collection
2265. {
2266. return $this->tiers;
2267. }
2269. public function addLocationTier(LocationTier $tier): self
2270. {
2271. if (!$this->tiers->contains($tier)) {
2272. $this->tiers[] = $tier;
2273. }
2275. return $this;
2276. }
2278. public function removeLocationTier(LocationTier $tier): self
2279. {
2280. $this->tiers->removeElement($tier);
2282. return $this;
2283. }
2284. }