Add macros for deprecated/renamed functions

Author: riasvdv

src/Database/Queries/Concerns/OverridesResults.php

@@ -70,7 +70,7 @@ public function setResultOverride(array $elements): void
      * @see getResultOverride()
      * @see setResultOverride()
      */
-    public function clearOverride(): void
+    public function clearResultOverride(): void
     {
         $this->override = $this->overrideCriteria = null;
     }

src/Database/Queries/ElementQuery.php

@@ -480,18 +480,6 @@ public function all(array|string $columns = ['*']): ElementCollection|array
         return $this->get($columns);
     }
 
-    /**
-     * Execute the query as a "select" statement.
-     *
-     * @return \craft\elements\ElementCollection<int, TElement>
-     */
-    public function collect(array|string $columns = ['*']): ElementCollection
-    {
-        $this->asArray = false;
-
-        return $this->get($columns);
-    }
-
     public function one(array|string $columns = ['*']): ?ElementInterface
     {
         return $this->first($columns);

src/Field/BaseRelationField.php

@@ -982,7 +982,7 @@ public function getPreviewHtml(mixed $value, ElementInterface $element): string
     {
         /** @var ElementQueryInterface|ElementCollection $value */
         if ($value instanceof ElementQueryInterface) {
-            $value = $this->_all($value, $element)->collect();
+            $value = $this->_all($value, $element)->get();
         } else {
             // todo: come up with a way to get the normalized field value ignoring the eager-loaded value
             $rawValue = $element->getBehavior('customFields')->{$this->handle} ?? null;
@@ -1200,7 +1200,7 @@ public function getRelationTargetIds(ElementInterface $element): array
             // just running $this->_all()->ids() will cause the query to get adjusted
             // see https://github.com/craftcms/cms/issues/14674 for details
             $targetIds = $this->_all($value, $element)
-                ->collect()
+                ->get()
                 ->map(fn (ElementInterface $element) => $element->id)
                 ->all();
         }

yii2-adapter/legacy/controllers/ElementsController.php

@@ -791,7 +791,7 @@ private function _contextMenuItems(
                 ->status(null)
                 ->orderBy(['dateUpdated' => SORT_DESC])
                 ->with(['draftCreator'])
-                ->collect()
+                ->get()
                 ->filter(fn(ElementInterface $draft) => $elementsService->canView($draft, $user))
                 ->all();
         } else {

yii2-adapter/src/Yii2ServiceProvider.php

@@ -66,13 +66,15 @@
 use craft\services\Utilities;
 use craft\utilities\AssetIndexes;
 use craft\utilities\ClearCaches;
+use craft\web\Application;
 use craft\web\twig\GlobalsExtension;
 use craft\web\twig\variables\Cp as CpVariable;
 use craft\web\UrlManager;
 use craft\web\View;
 use CraftCms\Aliases\Aliases;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Config\BaseConfig;
+use CraftCms\Cms\Database\Queries\ElementQuery;
 use CraftCms\Cms\Database\Table;
 use CraftCms\Cms\Edition\Events\EditionChanged;
 use CraftCms\Cms\Field\Events\RegisterFieldTypes;
@@ -207,6 +209,33 @@ private function registerMacros(): void
 
             $this->dispatchComponentEvent($name, $event);
         });
+
+        ElementQuery::macro('getCachedResult', function() {
+            Deprecator::log('ElementQuery-getCachedResult', 'Calling ->getCachedResult on an ElementQuery is deprecated. Use ->getResultOverride() instead.');
+
+            /** @var ElementQuery $this */
+            return $this->getResultOverride();
+        });
+
+        ElementQuery::macro('setCachedResult', function(array $elements) {
+            Deprecator::log('ElementQuery-setCachedResult', 'Calling ->setCachedResult on an ElementQuery is deprecated. Use ->setResultOverride() instead.');
+
+            /** @var ElementQuery $this */
+            $this->setResultOverride($elements);
+        });
+
+        ElementQuery::macro('clearCachedResult', function() {
+            Deprecator::log('ElementQuery-clearCachedResult', 'Calling ->clearCachedResult on an ElementQuery is deprecated. Use ->clearResultOverride() instead.');
+
+            /** @var ElementQuery $this */
+            $this->clearResultOverride();
+        });
+
+        ElementQuery::macro('collect', function() {
+            Deprecator::log('ElementQuery-collect', 'Calling ->collect on an ElementQuery is deprecated. ElementQuery now returns a collection by default.');
+
+            return $this->get();
+        });
     }
 
     protected function registerLegacyApp(): void
@@ -246,7 +275,7 @@ protected function registerLegacyApp(): void
             $app->setTimeZone(app()->getTimezone());
             $app->language = app()->getLocale();
 
-            \Craft::$app = $app;
+            Craft::$app = $app;
 
             $this->bootEvents();
             self::bootYiiEvents();
@@ -468,11 +497,11 @@ private function bootEvents(): void
             $craft = app('Craft');
 
             // Fire an 'afterEditionChange' event
-            if (!$craft->hasEventHandlers(\craft\web\Application::EVENT_AFTER_EDITION_CHANGE)) {
+            if (!$craft->hasEventHandlers(Application::EVENT_AFTER_EDITION_CHANGE)) {
                 return;
             }
 
-            $craft->trigger(\craft\web\Application::EVENT_AFTER_EDITION_CHANGE, new EditionChangeEvent([
+            $craft->trigger(Application::EVENT_AFTER_EDITION_CHANGE, new EditionChangeEvent([
                 'oldEdition' => $event->oldEdition->value,
                 'newEdition' => $event->newEdition->value,
             ]));
@@ -1152,7 +1181,7 @@ private function ensureNewMigrationTable(): void
             Artisan::call('craft:migrate:migration-table', [
                 '--force' => true,
             ]);
-        } catch (\PDOException) {
+        } catch (PDOException) {
             // No database connection
         }
     }

yii2-adapter/tests/unit/elements/ElementCollectionTest.php

@@ -33,7 +33,7 @@ public function _fixtures(): array
 
     public function testFind(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $first = $collection->first();
         self::assertInstanceOf(Entry::class, $first);
@@ -47,7 +47,7 @@ public function testFind(): void
 
     public function testContains(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         self::assertTrue($collection->contains('title', 'Theories of life'));
         self::assertTrue($collection->contains(fn(Entry $entry) => $entry->title === 'Theories of life'));
@@ -63,7 +63,7 @@ public function testContains(): void
 
     public function testIds(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $ids = $collection->map(fn(Entry $entry) => $entry->id)->all();
         self::assertSame($ids, $collection->ids()->all());
@@ -72,7 +72,7 @@ public function testIds(): void
     public function testMerge(): void
     {
         /** @var ElementCollection<Entry|User> $collection */
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $first = $collection->first();
         self::assertInstanceOf(Entry::class, $first);
@@ -86,7 +86,7 @@ public function testMerge(): void
 
     public function testMap(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $mapped = $collection->map(fn(Entry $entry) => new Entry());
         self::assertInstanceOf(ElementCollection::class, $mapped);
@@ -96,7 +96,7 @@ public function testMap(): void
 
     public function testMapWithKeys(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $mapped = $collection->mapWithKeys(fn(Entry $entry, int|string $key) => [$entry->id => new Entry()]);
         self::assertInstanceOf(ElementCollection::class, $mapped);
@@ -107,7 +107,7 @@ public function testMapWithKeys(): void
 
     public function testFresh(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $collection->each(function(Entry $entry) {
             $entry->title .= 'edit';
@@ -120,10 +120,10 @@ public function testFresh(): void
 
     public function testDiff(): void
     {
-        $collection1 = Entry::find()->limit(4)->collect();
+        $collection1 = Entry::find()->limit(4)->get();
         self::assertInstanceOf(ElementCollection::class, $collection1);
         self::assertSame(4, $collection1->count());
-        $collection2 = Entry::find()->offset(3)->collect();
+        $collection2 = Entry::find()->offset(3)->get();
         self::assertInstanceOf(ElementCollection::class, $collection2);
         self::assertTrue($collection2->isNotEmpty());
         $diff = $collection1->diff($collection2->all());
@@ -132,10 +132,10 @@ public function testDiff(): void
 
     public function testIntersect(): void
     {
-        $collection1 = Entry::find()->limit(4)->collect();
+        $collection1 = Entry::find()->limit(4)->get();
         self::assertInstanceOf(ElementCollection::class, $collection1);
         self::assertSame(4, $collection1->count());
-        $collection2 = Entry::find()->offset(3)->collect();
+        $collection2 = Entry::find()->offset(3)->get();
         self::assertInstanceOf(ElementCollection::class, $collection2);
         self::assertTrue($collection2->isNotEmpty());
         $intersect = $collection1->intersect($collection2->all());
@@ -144,7 +144,7 @@ public function testIntersect(): void
 
     public function testUnique(): void
     {
-        $collection = Entry::find()->limit(4)->collect();
+        $collection = Entry::find()->limit(4)->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $count = $collection->count();
         $collection->push(...$collection->all());
@@ -155,7 +155,7 @@ public function testUnique(): void
 
     public function testOnly(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         self::assertNotEquals(1, $collection->count());
         $first = $collection->first();
@@ -166,7 +166,7 @@ public function testOnly(): void
 
     public function testExcept(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         $count = $collection->count();
         $first = $collection->first();
@@ -177,7 +177,7 @@ public function testExcept(): void
 
     public function testBaseMethods(): void
     {
-        $collection = Entry::find()->collect();
+        $collection = Entry::find()->get();
         self::assertInstanceOf(ElementCollection::class, $collection);
         self::assertSame(Collection::class, get_class($collection->countBy(fn(Entry $entry) => $entry->sectionId)));
         self::assertSame(Collection::class, get_class($collection->collapse()));