Make sites chippable

craftcms · Nov 20, 2024 · 2b4b857 · 2b4b857
1 parent c8ecf6e
commit 2b4b857
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 5 deletions.
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -21,3 +21,4 @@
 - Added `craft\base\conditions\BaseElementSelectConditionRule::setElementIds()`.
 - Added `craft\fields\data\LinkData::$urlSuffix`.
 - Added `craft\fields\data\LinkData::getUrl()`.
+- `craft\models\Site` now implements `craft\base\Chippable`.
diff --git a/src/elements/conditions/SiteConditionRule.php b/src/elements/conditions/SiteConditionRule.php
@@ -6,7 +6,7 @@
 use craft\base\conditions\BaseMultiSelectConditionRule;
 use craft\base\ElementInterface;
 use craft\elements\db\ElementQueryInterface;
-use craft\helpers\ArrayHelper;
+use craft\models\Site;
 
 /**
  * Site condition rule.
@@ -37,8 +37,10 @@ public function getExclusiveQueryParams(): array
      */
     protected function options(): array
     {
-        $sites = Craft::$app->getSites()->getEditableSites();
-        return ArrayHelper::map($sites, 'uid', 'name');
+        return array_map(fn(Site $site) => [
+            'label' => $site->getUiLabel(),
+            'value' => $site->uid,
+        ], Craft::$app->getSites()->getEditableSites());
     }
 
     /**

diff --git a/src/models/Site.php b/src/models/Site.php
@@ -8,6 +8,7 @@
 namespace craft\models;
 
 use Craft;
+use craft\base\Chippable;
 use craft\base\Model;
 use craft\helpers\App;
 use craft\i18n\Locale;
@@ -29,8 +30,14 @@
  * @author Pixel & Tonic, Inc. <[email protected]>
  * @since 3.0.0
  */
-class Site extends Model
+class Site extends Model implements Chippable
 {
+    public static function get(int|string $id): ?static
+    {
+        /** @phpstan-ignore-next-line */
+        return Craft::$app->getSites()->getSiteById($id);
+    }
+
     /**
      * @var int|null ID
      */
@@ -104,6 +111,22 @@ class Site extends Model
      */
     private ?string $_language = null;
 
+    /**
+     * @inheritdoc
+     */
+    public function getId(): string|int|null
+    {
+        return $this->id;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getUiLabel(): string
+    {
+        return Craft::t('site', $this->getName());
+    }
+
     /**
      * Returns the site’s name.
      *
@@ -264,7 +287,7 @@ public function attributes(): array
      */
     public function __toString(): string
     {
-        return Craft::t('site', $this->getName()) ?: static::class;
+        return $this->getUiLabel() ?: static::class;
     }
 
     /**