API Deprecations for template layer

silverstripe · Oct 10, 2024 · 044d44b · 044d44b
1 parent 483e944
commit 044d44b
Show file tree

Hide file tree

Showing 19 changed files with 277 additions and 105 deletions.
diff --git a/src/Control/Controller.php b/src/Control/Controller.php
@@ -4,6 +4,7 @@
 
 use SilverStripe\Core\ClassInfo;
 use SilverStripe\Dev\Debug;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Security;
@@ -455,7 +456,8 @@ protected function definingClassForAction($action)
         $class = static::class;
         while ($class != 'SilverStripe\\Control\\RequestHandler') {
             $templateName = strtok($class ?? '', '_') . '_' . $action;
-            if (SSViewer::hasTemplate($templateName)) {
+            $templateExists = Deprecation::withSuppressedNotice(fn() => SSViewer::hasTemplate($templateName));
+            if ($templateExists) {
                 return $class;
             }
 
@@ -487,7 +489,7 @@ public function hasActionTemplate($action)
             $parentClass = get_parent_class($parentClass ?? '');
         }
 
-        return SSViewer::hasTemplate($templates);
+        return Deprecation::withSuppressedNotice(fn() => SSViewer::hasTemplate($templates));
     }
 
     /**

diff --git a/src/Control/Email/Email.php b/src/Control/Email/Email.php
@@ -12,6 +12,7 @@
 use SilverStripe\Core\Extensible;
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\FieldType\DBField;
 use SilverStripe\View\ArrayData;
 use SilverStripe\View\Requirements;
@@ -402,9 +403,11 @@ public function getHTMLTemplate(): string
             return $this->HTMLTemplate;
         }
 
-        return ThemeResourceLoader::inst()->findTemplate(
-            SSViewer::get_templates_by_class(static::class, '', Email::class),
-            SSViewer::get_themes()
+        return Deprecation::withSuppressedNotice(
+            fn() => ThemeResourceLoader::inst()->findTemplate(
+                SSViewer::get_templates_by_class(static::class, '', Email::class),
+                SSViewer::get_themes()
+            )
         );
     }
 

diff --git a/src/Forms/GridField/GridFieldAddExistingAutocompleter.php b/src/Forms/GridField/GridFieldAddExistingAutocompleter.php
@@ -17,6 +17,7 @@
 use SilverStripe\View\SSViewer;
 use LogicException;
 use SilverStripe\Control\HTTPResponse_Exception;
+use SilverStripe\Dev\Deprecation;
 
 /**
  * This class is is responsible for adding objects to another object's has_many
@@ -283,7 +284,7 @@ public function doSearch($gridField, $request)
         $json = [];
         Config::nest();
         SSViewer::config()->set('source_file_comments', false);
-        $viewer = SSViewer::fromString($this->resultsFormat);
+        $viewer = Deprecation::withSuppressedNotice(fn() => SSViewer::fromString($this->resultsFormat));
         foreach ($results as $result) {
             if (!$result->canView()) {
                 continue;

diff --git a/src/Forms/GridField/GridFieldDataColumns.php b/src/Forms/GridField/GridFieldDataColumns.php
@@ -5,6 +5,7 @@
 use SilverStripe\Core\Convert;
 use InvalidArgumentException;
 use LogicException;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\View\ViewableData;
 
 /**
@@ -228,16 +229,18 @@ public function getColumnMetadata($gridField, $column)
      * @param ViewableData $record
      * @param string $columnName
      * @return string|null - returns null if it could not found a value
+     * @deprecated 5.4.0 Will be removed without equivalent functionality to replace it.
      */
     protected function getValueFromRelation($record, $columnName)
     {
+        Deprecation::notice('5.4.0', 'Will be removed without equivalent functionality to replace it.');
         $fieldNameParts = explode('.', $columnName ?? '');
         $tmpItem = clone($record);
         for ($idx = 0; $idx < sizeof($fieldNameParts ?? []); $idx++) {
             $methodName = $fieldNameParts[$idx];
             // Last mmethod call from $columnName return what that method is returning
             if ($idx == sizeof($fieldNameParts ?? []) - 1) {
-                return $tmpItem->XML_val($methodName);
+                return Deprecation::withSuppressedNotice(fn() => $tmpItem->XML_val($methodName));
             }
             // else get the object from this $methodName
             $tmpItem = $tmpItem->$methodName();

diff --git a/src/Forms/HTMLEditor/HTMLEditorField.php b/src/Forms/HTMLEditor/HTMLEditorField.php
@@ -8,6 +8,7 @@
 use SilverStripe\ORM\DataObject;
 use SilverStripe\ORM\DataObjectInterface;
 use Exception;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\View\Parsers\HTMLValue;
 
 /**
@@ -129,7 +130,9 @@ public function getAttributes()
      */
     public function saveInto(DataObjectInterface $record)
     {
-        if ($record->hasField($this->name) && $record->escapeTypeForField($this->name) != 'xml') {
+        if ($record->hasField($this->name)
+            && Deprecation::withSuppressedNotice(fn () => $record->escapeTypeForField($this->name)) != 'xml'
+        ) {
             throw new Exception(
                 'HTMLEditorField->saveInto(): This field should save into a HTMLText or HTMLVarchar field.'
             );

diff --git a/src/View/SSTemplateParser.peg b/src/View/SSTemplateParser.peg
@@ -948,7 +948,7 @@ class SSTemplateParser extends Parser implements TemplateParser
         $arguments = $res['arguments'];
 
         // Note: 'type' here is important to disable subTemplates in SSViewer::getSubtemplateFor()
-        $res['php'] = '$val .= \\SilverStripe\\View\\SSViewer::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getItem(), [' .
+        $res['php'] = '$val .= \\SilverStripe\\View\\SSViewer::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getCurrentItem(), [' .
             implode(',', $arguments)."], \$scope, true);\n";
 
         if ($this->includeDebuggingComments) { // Add include filename comments on dev sites

diff --git a/src/View/SSTemplateParser.php b/src/View/SSTemplateParser.php
@@ -3897,7 +3897,7 @@ function Include__finalise(&$res)
         $arguments = $res['arguments'];
 
         // Note: 'type' here is important to disable subTemplates in SSViewer::getSubtemplateFor()
-        $res['php'] = '$val .= \\SilverStripe\\View\\SSViewer::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getItem(), [' .
+        $res['php'] = '$val .= \\SilverStripe\\View\\SSViewer::execute_template([["type" => "Includes", '.$template.'], '.$template.'], $scope->getCurrentItem(), [' .
             implode(',', $arguments)."], \$scope, true);\n";
 
         if ($this->includeDebuggingComments) { // Add include filename comments on dev sites