Merge pull request #24 from wrav/v2

feat: Add scope to all sites or a selected site
wrav · Sep 15, 2023 · fd2d194 · fd2d194
2 parents 5f5456f + 55324b7
commit fd2d194
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Related Changelog
 
+## 2.1.1 - 2023-09-15
+
+### Updated
+- Add scope to all sites or a selected site, thanks @OscarBarrett for the issue #20 
+
 ## 2.1.0 - 2023-09-15
 
 ### Updated

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "wrav/related",
     "description": "A simple plugin that adds a widget within the Craft CP page sidebar, allowing you to quickly and easily access related entries.",
     "type": "craft-plugin",
-    "version": "2.1.0",
+    "version": "2.1.1",
     "keywords": [
         "craft",
         "cms",

diff --git a/src/Related.php b/src/Related.php
@@ -137,13 +137,26 @@ protected function createSettingsModel(): ?craft\base\Model
 
     protected function settingsHtml(): string
     {
+        // Fetch the available sites
+        $sites = Craft::$app->sites->getAllSites();
+
+        // Fetch other data you need (sections, categories, asset volumes)
         $sections = Craft::$app->getSections()->getAllSections();
         $categories = Craft::$app->getCategories()->getAllGroups();
         $assetVolumes = Craft::$app->getVolumes()->getAllVolumes();
 
+        // Prepare options arrays
         $optionsSections = [];
         $optionsCategories = [];
         $optionsAssetVolumes = [];
+        $siteOptions = [];
+
+        $siteOptions['*'] = 'All Sites';
+
+        foreach ($sites as $site) {
+            // Populate site options with site ID as the value and site name as the label
+            $siteOptions[$site->id] = $site->name;
+        }
 
         foreach ($sections as $id => $section) {
             $optionsSections[$section->handle] = $section->name;
@@ -167,6 +180,7 @@ protected function settingsHtml(): string
                 'optionsSections' => $optionsSections,
                 'optionsCategories' => $optionsCategories,
                 'optionsAssetVolumes' => $optionsAssetVolumes,
+                'siteOptions' => $siteOptions,
             ]
         );
     }

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -46,4 +46,9 @@ class Settings extends Model
      * @var string
      */
     public $allowedAssetVolumes;
+
+    /**
+     * @var string
+     */
+    public $selectedSite;
 }
diff --git a/src/services/RelatedService.php b/src/services/RelatedService.php
@@ -47,12 +47,18 @@ public function getRelated($elementId)
             return [];
         }
 
+        $selectedSite = Related::getInstance()->getSettings()->selectedSite ?? '*';
+
+        if ('*' !== $selectedSite) {
+            $selectedSite = Craft::$app->sites->getSiteById($selectedSite);
+        }
+
         /** @var Element $element */
         $element = Craft::$app->elements->getElementById($elementId);
         /** @var Element $elementType */
         $elementType = Craft::$app->elements->getElementTypeById($elementId);
 
-        $query = MatrixBlock::find();
+        $query = MatrixBlock::find()->site($selectedSite);
         $query->relatedTo = $element;
         $query->anyStatus();
         /** @var MatrixBlock[] $blocks */
@@ -67,28 +73,28 @@ public function getRelated($elementId)
         }
 
         /** @var Query $query */
-        $query = Entry::find();
+        $query = Entry::find()->site($selectedSite);
         $query->relatedTo = $element;
         $query->anyStatus();
         /** @var Element[] $entries */
         $entries = $query->all();
 
         /** @var Query $query */
-        $query = Category::find();
+        $query = Category::find()->site($selectedSite);
         $query->relatedTo = $element;
         $query->anyStatus();
         /** @var Element[] $categories */
         $categories = $query->all();
 
         /** @var Query $query */
-        $query = User::find();
+        $query = User::find()->site($selectedSite);
         $query->relatedTo = $element;
         $query->anyStatus();
         /** @var Element[] $users */
         $users = $query->all();
 
         /** @var Query $query */
-        $query = User::find();
+        $query = User::find()->site($selectedSite);
         $query->relatedTo = $element;
         $query->anyStatus();
         /** @var Element[] $users */
@@ -97,7 +103,7 @@ public function getRelated($elementId)
         $products = [];
         try {
             if (class_exists('craft\commerce\elements\Product')) {
-                $query = craft\commerce\elements\Product::find();
+                $query = craft\commerce\elements\Product::find()->site($selectedSite);
                 $query->relatedTo = $element;
                 $query->anyStatus();
                 $products = $query->all();

diff --git a/src/templates/settings.twig b/src/templates/settings.twig
@@ -15,6 +15,15 @@
 
 {% import "_includes/forms" as forms %}
 
+{{ forms.selectField({
+    label: "Select Site"|t,
+    instructions: "Choose a site"|t,
+    id: 'selectedSite',
+    name: 'selectedSite',
+    options: siteOptions,
+    value: settings['selectedSite'] ?? null,
+}) }}
+
 {{ forms.multiselectField({
     label: "Allowed Sections"|t,
     instructions: "Choose which sections the relation widget will show on. Leave blank for all sections"|t,