Merge pull request #18054 from craftcms/feature/entry-query

[6.x] Entry queries

Author: brandonkelly

database/Factories/DraftFactory.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Database\Factories;
+
+use craft\elements\Entry;
+use CraftCms\Cms\Element\Models\Draft;
+use CraftCms\Cms\Element\Models\Element;
+use CraftCms\Cms\User\Models\User;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+final class DraftFactory extends Factory
+{
+    protected $model = Draft::class;
+
+    #[\Override]
+    public function definition(): array
+    {
+        return [
+            'canonicalId' => Element::factory(),
+            'creatorId' => User::factory(),
+            'provisional' => fake()->boolean(),
+            'name' => fake()->words(asText: true),
+            'trackChanges' => fake()->boolean(),
+            'dateLastMerged' => now(),
+            'saved' => fake()->boolean(),
+        ];
+    }
+
+    #[\Override]
+    public function configure(): self
+    {
+        return $this->afterCreating(function (Draft $draft) {
+            $element = Element::create([
+                'type' => Entry::class,
+                'canonicalId' => $draft->canonicalId,
+            ]);
+
+            $draft->update(['id' => $element->id]);
+        });
+    }
+}

database/Factories/ElementFactory.php

@@ -11,12 +11,13 @@
 use CraftCms\Cms\Support\Str;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Support\Facades\DB;
+use Override;
 
 final class ElementFactory extends Factory
 {
     protected $model = Element::class;
 
-    #[\Override]
+    #[Override]
     public function definition(): array
     {
         return [
@@ -27,13 +28,16 @@ public function definition(): array
         ];
     }
 
-    #[\Override]
+    #[Override]
     public function configure(): self
     {
         return $this->afterCreating(function (Element $element) {
             DB::table(Table::ELEMENTS_SITES)
                 ->insert([
                     'elementId' => $element->id,
+                    'title' => fake()->words(asText: true),
+                    'slug' => fake()->slug(),
+                    'uri' => fake()->slug(),
                     'enabled' => true,
                     'siteId' => Site::first()->id,
                     'dateCreated' => $element->dateCreated,

database/Factories/EntryFactory.php

@@ -9,12 +9,13 @@
 use CraftCms\Cms\Entry\Models\EntryType;
 use CraftCms\Cms\Section\Models\Section;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Override;
 
 final class EntryFactory extends Factory
 {
     protected $model = Entry::class;
 
-    #[\Override]
+    #[Override]
     public function definition(): array
     {
         return [
@@ -27,4 +28,63 @@ public function definition(): array
             'dateUpdated' => $created,
         ];
     }
+
+    #[Override]
+    public function configure(): self
+    {
+        $this->afterCreating(function (Entry $entry) {
+            $entry->element->update([
+                'dateCreated' => $entry->postDate,
+                'dateUpdated' => $entry->postDate,
+            ]);
+        });
+
+        return $this;
+    }
+
+    public function trashed(bool $trashed = true): self
+    {
+        return $this->state(fn (array $attributes) => [
+            'id' => $attributes['id']->trashed($trashed),
+        ]);
+    }
+
+    public function archived(bool $archived = true): self
+    {
+        return $this->state(fn (array $attributes) => [
+            'id' => $attributes['id']->set('archived', $archived),
+        ]);
+    }
+
+    public function enabled(bool $enabled = true): self
+    {
+        return $this->state(fn (array $attributes) => [
+            'id' => $attributes['id']->set('enabled', $enabled),
+        ]);
+    }
+
+    public function disabled(bool $disabled = true): self
+    {
+        return $this->state(fn (array $attributes) => [
+            'id' => $attributes['id']->set('enabled', ! $disabled),
+        ]);
+    }
+
+    public function pending(bool $pending = true): self
+    {
+        return $this->state(fn (array $attributes) => [
+            'postDate' => $pending
+                ? fake()->dateTimeBetween('+1 day', '+1 year')
+                : fake()->dateTime(),
+        ]);
+    }
+
+    public function expired(bool $expired = true): self
+    {
+        return $this->state(fn (array $attributes) => [
+            'expiryDate' => $expired
+                ? fake()->dateTime()
+                : fake()->dateTimeBetween('+1 day', '+1 year'),
+        ]);
+    }
 }

database/Factories/UserGroupFactory.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Database\Factories;
+
+use CraftCms\Cms\User\Models\UserGroup;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Override;
+
+final class UserGroupFactory extends Factory
+{
+    protected $model = UserGroup::class;
+
+    #[Override]
+    public function definition(): array
+    {
+        return [
+            'name' => fake()->words(asText: true),
+            'handle' => fake()->slug(),
+            'description' => fake()->paragraph(),
+            'dateCreated' => $date = fake()->dateTime(),
+            'dateUpdated' => $date,
+        ];
+    }
+}

src/Dashboard/Widgets/MyDrafts.php

@@ -4,11 +4,12 @@
 
 namespace CraftCms\Cms\Dashboard\Widgets;
 
-use Craft;
-use craft\elements\Entry;
 use craft\helpers\Cp;
+use CraftCms\Cms\Element\Elements\Entry;
 use CraftCms\Cms\Support\Html;
+use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\Session;
+use Override;
 
 use function CraftCms\Cms\t;
 
@@ -17,7 +18,7 @@ final class MyDrafts extends Widget
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function displayName(): string
     {
         return t('My Drafts');
@@ -26,7 +27,7 @@ public static function displayName(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     protected static function allowMultipleInstances(): bool
     {
         return false;
@@ -40,13 +41,13 @@ protected static function allowMultipleInstances(): bool
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function icon(): string
     {
         return 'scribble';
     }
 
-    #[\Override]
+    #[Override]
     public static function getRules(): array
     {
         return [
@@ -57,7 +58,7 @@ public static function getRules(): array
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getSettingsHtml(): string
     {
         return Cp::textFieldHtml([
@@ -73,22 +74,22 @@ public function getSettingsHtml(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getBodyHtml(): string
     {
-        /** @var Entry[] $drafts */
+        /** @var \craft\elements\ElementCollection<Entry> $drafts */
         $drafts = Entry::find()
             ->drafts()
             ->status(null)
-            ->draftCreator(Craft::$app->getUser()->getId())
+            ->draftCreator(Auth::user()->id)
             ->section('*')
             ->site('*')
             ->unique()
-            ->orderBy(['dateUpdated' => SORT_DESC])
+            ->orderByDesc('dateUpdated')
             ->limit($this->limit)
-            ->all();
+            ->get();
 
-        if (empty($drafts)) {
+        if ($drafts->isEmpty()) {
             return Html::tag('div', t('You don’t have any active drafts.'), [
                 'class' => ['zilch', 'small'],
             ]);

src/Dashboard/Widgets/RecentEntries.php

@@ -5,13 +5,14 @@
 namespace CraftCms\Cms\Dashboard\Widgets;
 
 use Craft;
-use craft\elements\Entry;
-use craft\models\Section;
+use craft\elements\ElementCollection;
 use craft\web\assets\recententries\RecentEntriesAsset;
+use CraftCms\Cms\Element\Elements\Entry;
 use CraftCms\Cms\Section\Enums\SectionType;
 use CraftCms\Cms\Support\Facades\Sections;
 use CraftCms\Cms\Support\Facades\Sites;
 use CraftCms\Cms\Support\Json;
+use Override;
 
 use function CraftCms\Cms\t;
 
@@ -20,7 +21,7 @@ final class RecentEntries extends Widget
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function displayName(): string
     {
         return t('Recent Entries');
@@ -29,7 +30,7 @@ public static function displayName(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function icon(): string
     {
         return 'clock';
@@ -57,7 +58,7 @@ public function __construct(array $config = [])
         $this->siteId ??= Sites::getCurrentSite()->id;
     }
 
-    #[\Override]
+    #[Override]
     public static function getRules(): array
     {
         return [
@@ -69,7 +70,7 @@ public static function getRules(): array
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getSettingsHtml(): string
     {
         return Craft::$app->getView()->renderTemplate('_components/widgets/RecentEntries/settings.twig',
@@ -81,7 +82,7 @@ public function getSettingsHtml(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getTitle(): string
     {
         if (is_numeric($this->section) && $section = Sections::getSectionById((int) $this->section)) {
@@ -98,7 +99,7 @@ public function getTitle(): string
         // See if they are pulling entries from a different site
         $targetSiteId = $this->getTargetSiteId();
 
-        if ($targetSiteId !== null && $targetSiteId != Sites::getCurrentSite()->id) {
+        if ($targetSiteId !== null && $targetSiteId !== Sites::getCurrentSite()->id) {
             $site = Sites::getSiteById($targetSiteId);
 
             if ($site) {
@@ -115,7 +116,7 @@ public function getTitle(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getBodyHtml(): string
     {
         $params = [];
@@ -134,22 +135,20 @@ public function getBodyHtml(): string
 
         return $view->renderTemplate('_components/widgets/RecentEntries/body.twig',
             [
-                'entries' => $entries,
+                'entries' => $entries->all(),
             ]);
     }
 
     /**
      * Returns the recent entries, based on the widget settings and user permissions.
-     *
-     * @return Entry[]
      */
-    private function getEntries(): array
+    private function getEntries(): ElementCollection
     {
         $targetSiteId = $this->getTargetSiteId();
 
         if ($targetSiteId === null) {
             // Hopeless
-            return [];
+            return new ElementCollection;
         }
 
         // Normalize the target section ID value.
@@ -161,7 +160,7 @@ private function getEntries(): array
         }
 
         if (! $targetSectionId) {
-            return [];
+            return new ElementCollection;
         }
 
         return Entry::find()
@@ -171,8 +170,8 @@ private function getEntries(): array
             ->siteId($targetSiteId)
             ->limit($this->limit ?: 100)
             ->with(['author'])
-            ->orderBy(['dateCreated' => SORT_DESC])
-            ->all();
+            ->orderByDesc('dateCreated')
+            ->get();
     }
 
     /**