API Use new class_description configuration (#1272)

silverstripe · Nov 14, 2024 · d3cbca7 · d3cbca7
1 parent 5f8f754
commit d3cbca7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 7 deletions.
diff --git a/src/Models/BaseElement.php b/src/Models/BaseElement.php
@@ -66,9 +66,12 @@ class BaseElement extends DataObject implements CMSPreviewable
      *
      * @config
      * @var string
+     * @deprecated 5.4.0 use class_description instead.
      */
     private static $description = 'Base element class';
 
+    private static $class_description = 'Base element class';
+
     /**
      * List of fields to exclude from CMS SiteTree seatch
      * @see ElementSiteTreeFilterSearch::applyDefaultFilters()
@@ -1140,18 +1143,14 @@ public function getIcon()
     /**
      * Get a description for this content element, if available
      *
-     * @deprecated 5.3.0 Use the description configuration property and localisation API directly instead.
+     * @deprecated 5.3.0 Use i18n_classDescription() instead.
      *
      * @return string
      */
     public function getDescription()
     {
-        Deprecation::notice('5.3.0', 'Use getTypeNice() or the description configuration property directly instead.');
-        $description = $this->config()->uninherited('description');
-        if ($description) {
-            return _t(__CLASS__ . '.Description', $description);
-        }
-        return '';
+        Deprecation::notice('5.3.0', 'Use i18n_classDescription() instead.');
+        return $this->i18n_classDescription() ?? '';
     }
 
     /**

diff --git a/src/Models/ElementContent.php b/src/Models/ElementContent.php
@@ -23,8 +23,13 @@ class ElementContent extends BaseElement
 
     private static $plural_name = 'content blocks';
 
+    /**
+     * @deprecated 5.4.0 use class_description instead.
+     */
     private static $description = 'HTML text block';
 
+    private static $class_description = 'HTML text block';
+
     /**
      * Re-title the HTML field to Content
      *