Merge 25126267af into ba97de9458

Includes the following large-scale changes:
- Impoved barrier between model and view layers
- Improved casting of scalar to relevant DBField types
- Improved capabilities for rendering arbitrary data in templates

src/Control/HTTPResponse.php

@@ -8,11 +8,12 @@ use SilverStripe\Core\Convert;
 use SilverStripe\Core\Injector\Injectable;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\View\Requirements;
+use Stringable;
 
 /**
  * Represents a response returned by a controller.
  */
-class HTTPResponse
+class HTTPResponse implements Stringable
 {
     use Injectable;
 
@@ -445,7 +446,7 @@ EOT
     /**
      * The HTTP response represented as a raw string
      */
-    public function __toString()
+    public function __toString(): string
     {
         $headers = [];
         foreach ($this->getHeaders() as $header => $values) {

src/Core/Extensible.php

@@ -511,7 +511,7 @@ trait Extensible
         // Setup all extension instances for this instance
         $this->extension_instances = [];
         foreach (ClassInfo::ancestry(static::class) as $class) {
-            if (in_array($class, self::class::$unextendable_classes)) {
+            if (in_array($class, self::$unextendable_classes)) {
                 continue;
             }
             $extensions = Config::inst()->get($class, 'extensions', Config::UNINHERITED | Config::EXCLUDE_EXTRA_SOURCES);

src/Core/Manifest/ModuleResource.php

@@ -5,12 +5,13 @@ namespace SilverStripe\Core\Manifest;
 use InvalidArgumentException;
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Core\Path;
+use Stringable;
 
 /**
  * This object represents a single resource file attached to a module, and can be used
  * as a reference to this to be later turned into either a URL or file path.
  */
-class ModuleResource
+class ModuleResource implements Stringable
 {
     /**
      * @var Module
@@ -115,7 +116,7 @@ class ModuleResource
     /**
      * Get relative path
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getRelativePath();
     }

src/Dev/Deprecation.php

@@ -391,7 +391,7 @@ class Deprecation
                 }
 
                 // Getting a backtrace is slow, so we only do it if we need it
-                $backtrace = [];
+                $backtrace = null;
 
                 // Get the calling scope
                 if ($scope == Deprecation::SCOPE_METHOD) {

src/Forms/GridField/GridFieldDataColumns.php

@@ -6,7 +6,6 @@ use SilverStripe\Core\Convert;
 use InvalidArgumentException;
 use LogicException;
 use SilverStripe\Model\ModelData;
-use SilverStripe\Dev\Deprecation;
 
 /**
  * @see GridField

src/Forms/GridField/GridState.php

@@ -5,6 +5,7 @@ namespace SilverStripe\Forms\GridField;
 use SilverStripe\Core\Convert;
 use SilverStripe\Forms\HiddenField;
 use SilverStripe\ORM\DataList;
+use Stringable;
 
 /**
  * This class is a snapshot of the current status of a {@link GridField}.
@@ -14,7 +15,7 @@ use SilverStripe\ORM\DataList;
  *
  * @see GridField
  */
-class GridState extends HiddenField
+class GridState extends HiddenField implements Stringable
 {
 
     /**
@@ -129,7 +130,7 @@ class GridState extends HiddenField
         return Convert::raw2att($this->Value());
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->Value();
     }

src/Forms/GridField/GridState_Data.php

@@ -2,13 +2,15 @@
 
 namespace SilverStripe\Forms\GridField;
 
+use Stringable;
+
 /**
  * Simple set of data, similar to stdClass, but without the notice-level
  * errors.
  *
  * @see GridState
  */
-class GridState_Data
+class GridState_Data implements Stringable
 {
 
     /**
@@ -94,7 +96,7 @@ class GridState_Data
         unset($this->data[$name]);
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         if (!$this->data) {
             return "";

src/Model/ModelData.php

@@ -18,6 +18,7 @@ use SilverStripe\ORM\FieldType\DBHTMLText;
 use SilverStripe\Model\ArrayData;
 use SilverStripe\View\CastingService;
 use SilverStripe\View\SSViewer;
+use Stringable;
 use UnexpectedValueException;
 
 /**
@@ -27,7 +28,7 @@ use UnexpectedValueException;
  * is provided and automatically escaped by ModelData. Any class that needs to be available to a view (controllers,
  * {@link DataObject}s, page controls) should inherit from this class.
  */
-class ModelData
+class ModelData implements Stringable
 {
     use Extensible {
         defineMethods as extensibleDefineMethods;
@@ -305,12 +306,9 @@ class ModelData
         return true;
     }
 
-    /**
-     * Return the class name (though subclasses may return something else)
-     */
     public function __toString(): string
     {
-        return static::class;
+        return $this->forTemplate();
     }
 
     /**
@@ -550,9 +548,8 @@ class ModelData
      */
     private function objCacheName(string $fieldName, array $arguments = []): string
     {
-        $name = empty($arguments)
+        return empty($arguments)
             ? $fieldName
             : $fieldName . ":" . var_export($arguments, true);
-        return md5($name);
     }
 }

src/ORM/FieldType/DBField.php

@@ -521,11 +521,6 @@ abstract class DBField extends ModelData implements DBIndexable
 DBG;
     }
 
-    public function __toString(): string
-    {
-        return (string)$this->forTemplate();
-    }
-
     public function getArrayValue()
     {
         return $this->arrayValue;

src/ORM/Queries/SQLExpression.php

@@ -6,12 +6,13 @@ use SilverStripe\Core\Convert;
 use SilverStripe\ORM\Connect\Query;
 use SilverStripe\ORM\DB;
 use Exception;
+use Stringable;
 
 /**
  * Abstract base class for an object representing an SQL query.
  * The various parts of the SQL query can be manipulated individually.
  */
-abstract class SQLExpression
+abstract class SQLExpression implements Stringable
 {
 
     /**
@@ -45,7 +46,7 @@ abstract class SQLExpression
     /**
      * Return the generated SQL string for this query
      */
-    public function __toString()
+    public function __toString(): string
     {
         try {
             $sql = $this->sql($parameters);

src/View/CastingService.php

@@ -21,33 +21,33 @@ class CastingService
     /**
      * Cast a value to the relevant object (usually a DBField instance) for use in the view layer.
      *
-     * @param ModelData|array|null $source Where the data originates from. This is used both to check for casting helpers
+     * @param null|array|ModelData $source Where the data originates from. This is used both to check for casting helpers
      * and to help set the value in cast DBField instances.
      * @param bool $strict If true, an object will be returned even if $data is null.
      */
-    public function cast(mixed $data, ModelData|array|null $source = null, string $fieldName = '', bool $strict = false): ?object
+    public function cast(mixed $data, null|array|ModelData $source = null, string $fieldName = '', bool $strict = false): ?object
     {
-        // Assume anything that's an object is intentionally using whatever class it's using
-        // and don't cast it.
-        if (is_object($data)) {
-            return $data;
-        }
-
         // null is null - we shouldn't cast it to an object, because that makes it harder
         // for downstream checks to know there's "no value".
         if (!$strict && $data === null) {
             return null;
         }
 
-        $serviceKey = null;
+        // Assume anything that's an object is intentionally using whatever class it's using
+        // and don't cast it.
+        if (is_object($data)) {
+            return $data;
+        }
+
+        $service = null;
         if ($source instanceof ModelData) {
-            $serviceKey = $source->castingHelper($fieldName);
+            $service = $source->castingHelper($fieldName);
         }
 
         // Cast to object if there's an explicit casting for this field
         // Explicit casts take precedence over array casting
-        if ($serviceKey) {
-            $castObject = Injector::inst()->create($serviceKey, $fieldName);
+        if ($service) {
+            $castObject = Injector::inst()->create($service, $fieldName);
             if (!ClassInfo::hasMethod($castObject, 'setValue')) {
                 throw new LogicException('Explicit casting service must have a setValue method.');
             }
@@ -61,8 +61,8 @@ class CastingService
         }
 
         // Fall back to default casting
-        $serviceKey = $this->getDefaultServiceKey($data, $source, $fieldName);
-        $castObject = Injector::inst()->create($serviceKey, $fieldName);
+        $service = $this->defaultService($data, $source, $fieldName);
+        $castObject = Injector::inst()->create($service, $fieldName);
         if (!ClassInfo::hasMethod($castObject, 'setValue')) {
             throw new LogicException('Default service must have a setValue method.');
         }
@@ -73,7 +73,7 @@ class CastingService
     /**
      * Get the default service to use if no explicit service is declared for this field on the source model.
      */
-    private function getDefaultServiceKey(mixed $data, mixed $source = null, string $fieldName = ''): ?string
+    private function defaultService(mixed $data, mixed $source = null, string $fieldName = ''): ?string
     {
         $default = null;
         if ($source instanceof ModelData) {
@@ -81,7 +81,7 @@ class CastingService
             if ($default === null) {
                 $failover = $source->getFailover();
                 if ($failover) {
-                    $default = $this->getDefaultServiceKey($data, $failover, $fieldName);
+                    $default = $this->defaultService($data, $failover, $fieldName);
                 }
             }
         }

src/View/SSTemplateParser.php

@@ -1189,7 +1189,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     	$matchrule = "QuotedString"; $result = $this->construct($matchrule, $matchrule, null);
     	$_154 = NULL;
     	do {
-    		$stack[] = $result; $result = $this->construct( $matchrule, "q" );
+    		$stack[] = $result; $result = $this->construct( $matchrule, "q" ); 
     		if (( $subres = $this->rx( '/[\'"]/' ) ) !== FALSE) {
     			$result["text"] .= $subres;
     			$subres = $result; $result = array_pop($stack);
@@ -1199,7 +1199,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     			$result = array_pop($stack);
     			$_154 = FALSE; break;
     		}
-    		$stack[] = $result; $result = $this->construct( $matchrule, "String" );
+    		$stack[] = $result; $result = $this->construct( $matchrule, "String" ); 
     		if (( $subres = $this->rx( '/ (\\\\\\\\ | \\\\. | [^'.$this->expression($result, $stack, 'q').'\\\\])* /' ) ) !== FALSE) {
     			$result["text"] .= $subres;
     			$subres = $result; $result = array_pop($stack);
@@ -1842,7 +1842,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     		$pos_255 = $this->pos;
     		$_254 = NULL;
     		do {
-    			$stack[] = $result; $result = $this->construct( $matchrule, "Not" );
+    			$stack[] = $result; $result = $this->construct( $matchrule, "Not" ); 
     			if (( $subres = $this->literal( 'not' ) ) !== FALSE) {
     				$result["text"] .= $subres;
     				$subres = $result; $result = array_pop($stack);
@@ -2235,7 +2235,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     		else { $_330 = FALSE; break; }
     		if (( $subres = $this->whitespace(  ) ) !== FALSE) { $result["text"] .= $subres; }
     		else { $_330 = FALSE; break; }
-    		$stack[] = $result; $result = $this->construct( $matchrule, "Call" );
+    		$stack[] = $result; $result = $this->construct( $matchrule, "Call" ); 
     		$_326 = NULL;
     		do {
     			$matcher = 'match_'.'Word'; $key = $matcher; $pos = $this->pos;
@@ -2740,7 +2740,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     		$_423 = NULL;
     		do {
     			if (( $subres = $this->whitespace(  ) ) !== FALSE) { $result["text"] .= $subres; }
-    			$stack[] = $result; $result = $this->construct( $matchrule, "Conditional" );
+    			$stack[] = $result; $result = $this->construct( $matchrule, "Conditional" ); 
     			$_419 = NULL;
     			do {
     				$_417 = NULL;
@@ -3166,7 +3166,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     		if (( $subres = $this->literal( '<%' ) ) !== FALSE) { $result["text"] .= $subres; }
     		else { $_555 = FALSE; break; }
     		if (( $subres = $this->whitespace(  ) ) !== FALSE) { $result["text"] .= $subres; }
-    		$stack[] = $result; $result = $this->construct( $matchrule, "CacheTag" );
+    		$stack[] = $result; $result = $this->construct( $matchrule, "CacheTag" ); 
     		$_508 = NULL;
     		do {
     			$_506 = NULL;
@@ -3225,7 +3225,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     		$_524 = NULL;
     		do {
     			if (( $subres = $this->whitespace(  ) ) !== FALSE) { $result["text"] .= $subres; }
-    			$stack[] = $result; $result = $this->construct( $matchrule, "Conditional" );
+    			$stack[] = $result; $result = $this->construct( $matchrule, "Conditional" ); 
     			$_520 = NULL;
     			do {
     				$_518 = NULL;
@@ -4165,7 +4165,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     			unset( $pos_685 );
     		}
     		if (( $subres = $this->whitespace(  ) ) !== FALSE) { $result["text"] .= $subres; }
-    		$stack[] = $result; $result = $this->construct( $matchrule, "Zap" );
+    		$stack[] = $result; $result = $this->construct( $matchrule, "Zap" ); 
     		if (( $subres = $this->literal( '%>' ) ) !== FALSE) {
     			$result["text"] .= $subres;
     			$subres = $result; $result = array_pop($stack);
@@ -4556,7 +4556,7 @@ class SSTemplateParser extends Parser implements TemplateParser
     		if (( $subres = $this->literal( '<%' ) ) !== FALSE) { $result["text"] .= $subres; }
     		else { $_743 = FALSE; break; }
     		if (( $subres = $this->whitespace(  ) ) !== FALSE) { $result["text"] .= $subres; }
-    		$stack[] = $result; $result = $this->construct( $matchrule, "Tag" );
+    		$stack[] = $result; $result = $this->construct( $matchrule, "Tag" ); 
     		$_737 = NULL;
     		do {
     			if (( $subres = $this->literal( 'end_' ) ) !== FALSE) { $result["text"] .= $subres; }

src/View/SSViewer.php

@@ -372,8 +372,9 @@ PHP;
 
         if ($isXhtml) {
             return "<base href=\"$base\" />";
+        } else {
+            return "<base href=\"$base\">";
         }
-        return "<base href=\"$base\">";
     }
 
     /**

src/View/ThemeResourceLoader.php

@@ -9,7 +9,6 @@ use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Core\Manifest\ModuleLoader;
 use SilverStripe\Core\Manifest\ModuleResourceLoader;
 use SilverStripe\Core\Path;
-use SilverStripe\Dev\Deprecation;
 
 /**
  * Handles finding templates from a stack of template manifest objects.

src/i18n/Messages/Symfony/FlushInvalidatedResource.php

@@ -3,6 +3,7 @@
 namespace SilverStripe\i18n\Messages\Symfony;
 
 use SilverStripe\Core\Flushable;
+use Stringable;
 use Symfony\Component\Config\Resource\SelfCheckingResourceInterface;
 
 /**
@@ -12,9 +13,9 @@ use Symfony\Component\Config\Resource\SelfCheckingResourceInterface;
  * @link https://media.giphy.com/media/fRRD3T37DeY6Y/giphy.gif for use case
  * @see DirectoryResource
  */
-class FlushInvalidatedResource implements SelfCheckingResourceInterface, Flushable
+class FlushInvalidatedResource implements SelfCheckingResourceInterface, Flushable, Stringable
 {
-    public function __toString()
+    public function __toString(): string
     {
         return md5(__CLASS__);
     }

tests/php/Dev/DeprecationTest.php

@@ -111,8 +111,8 @@ class DeprecationTest extends SapphireTest
             'Will be removed without equivalent functionality to replace it.',
             'Called from SilverStripe\Dev\Tests\DeprecationTest->testNoticeNoReplacement.'
         ]);
-        $this->expectException(DeprecationTestException::class);
-        $this->expectExceptionMessage($message);
+        $this->expectDeprecation();
+        $this->expectDeprecationMessage($message);
         $this->enableDeprecationNotices(true);
         $ret = $this->myDeprecatedMethodNoReplacement();
         $this->assertSame('abc', $ret);