IBX-8019: Added usage notice to LocationService::loadLocationChildren…

… method
ezsystems · May 29, 2024 · 99a6d34 · 99a6d34
1 parent 98b7b50
commit 99a6d34
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/eZ/Publish/API/Repository/LocationService.php b/eZ/Publish/API/Repository/LocationService.php
@@ -97,6 +97,10 @@ public function loadLocations(ContentInfo $contentInfo, ?Location $rootLocation
     /**
      * Loads children which are readable by the current user of a location object sorted by sortField and sortOrder.
      *
+     * Use this method with caution. It performs heavy queries on the database.
+     * Consider using {@see \eZ\Publish\API\Repository\SearchService::findLocations()} with
+     * {@see \eZ\Publish\Core\QueryType\BuiltIn\ChildrenQueryType} as an alternative.
+     *
      * @param \eZ\Publish\API\Repository\Values\Content\Location $location
      * @param int $offset the start offset for paging
      * @param int $limit the number of locations returned