Element::getSource() => ElementHelper::sourceElement()

cc #4754
craftcms · Aug 16, 2019 · efab623 · efab623
1 parent 43caabc
commit efab623
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 43 deletions.
diff --git a/CHANGELOG-v3.md b/CHANGELOG-v3.md
@@ -2,13 +2,18 @@
 
 ## Unreleased
 
+### Added
+- Added `craft\helpers\ElementHelper::sourceElement()`.
+
 ### Changed
 - Element arrays no longer include `hasDescendants` or `totalDescendants` keys by default.
 - Relational fields without a specific target site will now only return related elements from the same site as the source element by default, as they did before Craft 3.2. ([#4751](https://github.com/craftcms/cms/issues/4751))
-- `source` is now a reserved field handle. ([#4754](https://github.com/craftcms/cms/issues/4754))
 - Improved the performance of element duplication on multi-site installs.
 - Edit Entry pages now get updated preview target URLs after saving a draft, in case the URLs have changed.
 
+### Removed
+- Removed `craft\base\ElementInterface::getSource()`. ([#4754](https://github.com/craftcms/cms/issues/4754))
+
 ### Fixed
 - Fixed an error that could occur if garbage collection was run while Craft 3.2 migrations were pending. ([#4720](https://github.com/craftcms/cms/issues/4720))
 - Fixed a validation error that occurred when duplicating an entry, if the URI format was based on a custom field value. ([#4759](https://github.com/craftcms/cms/issues/4759))

diff --git a/src/base/Element.php b/src/base/Element.php
@@ -1277,23 +1277,6 @@ public function getSourceUid(): string
             ->scalar();
     }
 
-    /**
-     * @inheritdoc
-     */
-    public function getSource(): ElementInterface
-    {
-        $sourceId = $this->getSourceId();
-        if ($sourceId === $this->id) {
-            return $this;
-        }
-        return static::find()
-            ->id($sourceId)
-            ->siteId($this->siteId)
-            ->anyStatus()
-            ->ignorePlaceholders()
-            ->one();
-    }
-
     /**
      * @inheritdoc
      */
@@ -1580,7 +1563,7 @@ public function getAncestors(int $dist = null)
     {
         return static::find()
             ->structureId($this->structureId)
-            ->ancestorOf($this->getSource())
+            ->ancestorOf(ElementHelper::sourceElement($this))
             ->siteId($this->siteId)
             ->ancestorDist($dist);
     }
@@ -1597,7 +1580,7 @@ public function getDescendants(int $dist = null)
 
         return static::find()
             ->structureId($this->structureId)
-            ->descendantOf($this->getSource())
+            ->descendantOf(ElementHelper::sourceElement($this))
             ->siteId($this->siteId)
             ->descendantDist($dist);
     }
@@ -1622,7 +1605,7 @@ public function getSiblings()
     {
         return static::find()
             ->structureId($this->structureId)
-            ->siblingOf($this->getSource())
+            ->siblingOf(ElementHelper::sourceElement($this))
             ->siteId($this->siteId);
     }
 
@@ -1635,7 +1618,7 @@ public function getPrevSibling()
             /** @var ElementQuery $query */
             $query = $this->_prevSibling = static::find();
             $query->structureId = $this->structureId;
-            $query->prevSiblingOf = $this->getSource();
+            $query->prevSiblingOf = ElementHelper::sourceElement($this);
             $query->siteId = $this->siteId;
             $query->anyStatus();
             $this->_prevSibling = $query->one();
@@ -1657,7 +1640,7 @@ public function getNextSibling()
             /** @var ElementQuery $query */
             $query = $this->_nextSibling = static::find();
             $query->structureId = $this->structureId;
-            $query->nextSiblingOf = $this->getSource();
+            $query->nextSiblingOf = ElementHelper::sourceElement($this);
             $query->siteId = $this->siteId;
             $query->anyStatus();
             $this->_nextSibling = $query->one();
@@ -1700,7 +1683,7 @@ public function getTotalDescendants(): int
     public function isAncestorOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         return ($source->root == $element->root && $source->lft < $element->lft && $source->rgt > $element->rgt);
     }
@@ -1711,7 +1694,7 @@ public function isAncestorOf(ElementInterface $element): bool
     public function isDescendantOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         return ($source->root == $element->root && $source->lft > $element->lft && $source->rgt < $element->rgt);
     }
@@ -1722,7 +1705,7 @@ public function isDescendantOf(ElementInterface $element): bool
     public function isParentOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         return ($source->root == $element->root && $source->level == $element->level - 1 && $source->isAncestorOf($element));
     }
@@ -1733,7 +1716,7 @@ public function isParentOf(ElementInterface $element): bool
     public function isChildOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         return ($source->root == $element->root && $source->level == $element->level + 1 && $source->isDescendantOf($element));
     }
@@ -1744,7 +1727,7 @@ public function isChildOf(ElementInterface $element): bool
     public function isSiblingOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         if ($source->root == $element->root && $source->level !== null && $source->level == $element->level) {
             if ($source->level == 1 || $source->isPrevSiblingOf($element) || $source->isNextSiblingOf($element)) {
@@ -1767,7 +1750,7 @@ public function isSiblingOf(ElementInterface $element): bool
     public function isPrevSiblingOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         return ($source->root == $element->root && $source->level == $element->level && $source->rgt == $element->lft - 1);
     }
@@ -1778,7 +1761,7 @@ public function isPrevSiblingOf(ElementInterface $element): bool
     public function isNextSiblingOf(ElementInterface $element): bool
     {
         /** @var Element $source */
-        $source = $this->getSource();
+        $source = ElementHelper::sourceElement($this);
         /** @var Element $element */
         return ($source->root == $element->root && $source->level == $element->level && $source->lft == $element->rgt + 1);
     }

diff --git a/src/base/ElementInterface.php b/src/base/ElementInterface.php
@@ -417,14 +417,6 @@ public function getSourceId();
      */
     public function getSourceUid(): string;
 
-    /**
-     * Returns the element, or if it’s a draft/revision, the source element.
-     *
-     * @return ElementInterface
-     * @since 3.2.9
-     */
-    public function getSource(): ElementInterface;
-
     /**
      * Returns whether the element is an unsaved draft.
      *

diff --git a/src/base/Field.php b/src/base/Field.php
@@ -240,7 +240,6 @@ public function rules()
                 'site',
                 'slug',
                 'sortOrder',
-                'source',
                 'status',
                 'title',
                 'uid',

diff --git a/src/controllers/EntryRevisionsController.php b/src/controllers/EntryRevisionsController.php
@@ -335,7 +335,7 @@ public function actionPublishDraft()
 
         // Permission enforcement
         /** @var Entry|null $entry */
-        $entry = $draft->getSource();
+        $entry = ElementHelper::sourceElement($draft);
         $this->enforceEditEntryPermissions($entry);
         $section = ($entry)->getSection();
 
@@ -429,7 +429,7 @@ public function actionRevertEntryToVersion()
 
         // Permission enforcement
         /** @var Entry $entry */
-        $entry = $revision->getSource();
+        $entry = ElementHelper::sourceElement($revision);
 
         $this->enforceEditEntryPermissions($entry);
         $userId = Craft::$app->getUser()->getId();

diff --git a/src/helpers/ElementHelper.php b/src/helpers/ElementHelper.php
@@ -348,6 +348,29 @@ public static function isDraftOrRevision(ElementInterface $element): bool
         return $root->getIsDraft() || $root->getIsRevision();
     }
 
+    /**
+     * Returns the element, or if it’s a draft/revision, the source element.
+     *
+     * @param ElementInterface $element
+     * @return ElementInterface
+     * @since 3.2.11
+     */
+    public static function sourceElement(ElementInterface $element): ElementInterface
+    {
+        /** @var Element $element */
+        $sourceId = $element->getSourceId();
+        if ($sourceId === $element->id) {
+            return $element;
+        }
+
+        return $element::find()
+            ->id($sourceId)
+            ->siteId($element->siteId)
+            ->anyStatus()
+            ->ignorePlaceholders()
+            ->one();
+    }
+
     /**
      * Given an array of elements, will go through and set the appropriate "next"
      * and "prev" elements on them.

diff --git a/src/services/Drafts.php b/src/services/Drafts.php
@@ -18,6 +18,7 @@
 use craft\events\DraftEvent;
 use craft\helpers\DateTimeHelper;
 use craft\helpers\Db;
+use craft\helpers\ElementHelper;
 use yii\base\Component;
 use yii\base\InvalidArgumentException;
 use yii\db\Exception as DbException;
@@ -210,7 +211,7 @@ public function applyDraft(ElementInterface $draft): ElementInterface
         /** @var DraftBehavior $behavior */
         $behavior = $draft->getBehavior('draft');
         /** @var Element $source */
-        $source = $draft->getSource();
+        $source = ElementHelper::sourceElement($draft);
 
         // Fire a 'beforeApplyDraft' event
         if ($this->hasEventHandlers(self::EVENT_BEFORE_APPLY_DRAFT)) {

diff --git a/src/services/Revisions.php b/src/services/Revisions.php
@@ -17,6 +17,7 @@
 use craft\errors\InvalidElementException;
 use craft\events\RevisionEvent;
 use craft\helpers\ArrayHelper;
+use craft\helpers\ElementHelper;
 use craft\helpers\Json;
 use yii\base\Component;
 use yii\base\InvalidArgumentException;
@@ -219,7 +220,7 @@ public function revertToRevision(ElementInterface $revision, int $creatorId): El
     {
         /** @var Element|RevisionBehavior $revision */
         /** @var Element $source */
-        $source = $revision->getSource();
+        $source = ElementHelper::sourceElement($revision);
 
         // Fire a 'beforeRevertToRevision' event
         if ($this->hasEventHandlers(self::EVENT_BEFORE_REVERT_TO_REVISION)) {