[TASK] Deprecate __toString() (#1012)

oliverklee · web-flow · commit d882635dc700 · 2025-03-03T13:28:56.000Z
Part of #998 This is the V8.x backport of #1006.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Deprecated
 
+- Deprecate `__toString()` (#1006)
 - Deprecate greedy calculation of selector specificity (#1018)
 - Deprecate the IE hack in `Rule` (#993, #1003)
 - `OutputFormat` properties for space around list separators as an array (#880)
diff --git a/src/CSSList/AtRuleBlockList.php b/src/CSSList/AtRuleBlockList.php
@@ -50,6 +50,8 @@ public function atRuleArgs()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/CSSList/CSSList.php b/src/CSSList/CSSList.php
@@ -416,6 +416,8 @@ public function removeDeclarationBlockBySelector($mSelector, $bRemoveAll = false
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/CSSList/KeyFrame.php b/src/CSSList/KeyFrame.php
@@ -61,6 +61,8 @@ public function getAnimationName()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Comment/Comment.php b/src/Comment/Comment.php
@@ -59,6 +59,8 @@ public function setComment($sComment)
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Property/CSSNamespace.php b/src/Property/CSSNamespace.php
@@ -55,6 +55,8 @@ public function getLineNo()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Property/Charset.php b/src/Property/Charset.php
@@ -75,6 +75,8 @@ public function getCharset()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Property/Import.php b/src/Property/Import.php
@@ -76,6 +76,8 @@ public function getLocation()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Property/Selector.php b/src/Property/Selector.php
@@ -121,6 +121,8 @@ public function setSelector($sSelector)
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Renderable.php b/src/Renderable.php
@@ -6,6 +6,8 @@ interface Renderable
 {
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString();
 
diff --git a/src/Rule/Rule.php b/src/Rule/Rule.php
@@ -359,6 +359,8 @@ public function getIsImportant()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/RuleSet/AtRuleSet.php b/src/RuleSet/AtRuleSet.php
@@ -53,6 +53,8 @@ public function atRuleArgs()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/RuleSet/DeclarationBlock.php b/src/RuleSet/DeclarationBlock.php
@@ -831,6 +831,8 @@ public function createFontShorthand()
      * @return string
      *
      * @throws OutputException
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/RuleSet/RuleSet.php b/src/RuleSet/RuleSet.php
@@ -268,6 +268,8 @@ public function removeRule($mRule)
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/CSSFunction.php b/src/Value/CSSFunction.php
@@ -88,6 +88,8 @@ public function getArguments()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/CSSString.php b/src/Value/CSSString.php
@@ -94,6 +94,8 @@ public function getString()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/Color.php b/src/Value/Color.php
@@ -155,6 +155,8 @@ public function getColorDescription()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/LineName.php b/src/Value/LineName.php
@@ -51,6 +51,8 @@ public static function parse(ParserState $oParserState)
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/Size.php b/src/Value/Size.php
@@ -222,6 +222,8 @@ public function isRelative()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/URL.php b/src/Value/URL.php
@@ -81,6 +81,8 @@ public function getURL()
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {
diff --git a/src/Value/ValueList.php b/src/Value/ValueList.php
@@ -90,6 +90,8 @@ public function setListSeparator($sSeparator)
 
     /**
      * @return string
+     *
+     * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
      */
     public function __toString()
     {

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,8 @@ public function atRuleArgs()`
`50`	`50`
`51`	`51`	`/**`
`52`	`52`	`* @return string`
	`53`	`+ *`
	`54`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`53`	`55`	`*/`
`54`	`56`	`public function __toString()`
`55`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -416,6 +416,8 @@ public function removeDeclarationBlockBySelector($mSelector, $bRemoveAll = false`
`416`	`416`
`417`	`417`	`/**`
`418`	`418`	`* @return string`
	`419`	`+ *`
	`420`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`419`	`421`	`*/`
`420`	`422`	`public function __toString()`
`421`	`423`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,8 @@ public function getAnimationName()`
`61`	`61`
`62`	`62`	`/**`
`63`	`63`	`* @return string`
	`64`	`+ *`
	`65`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`64`	`66`	`*/`
`65`	`67`	`public function __toString()`
`66`	`68`	`{`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,8 @@ public function setComment($sComment)`
`59`	`59`
`60`	`60`	`/**`
`61`	`61`	`* @return string`
	`62`	`+ *`
	`63`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`62`	`64`	`*/`
`63`	`65`	`public function __toString()`
`64`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,8 @@ public function getLineNo()`
`55`	`55`
`56`	`56`	`/**`
`57`	`57`	`* @return string`
	`58`	`+ *`
	`59`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`58`	`60`	`*/`
`59`	`61`	`public function __toString()`
`60`	`62`	`{`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,8 @@ public function getCharset()`
`75`	`75`
`76`	`76`	`/**`
`77`	`77`	`* @return string`
	`78`	`+ *`
	`79`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`78`	`80`	`*/`
`79`	`81`	`public function __toString()`
`80`	`82`	`{`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@ public function getLocation()`
`76`	`76`
`77`	`77`	`/**`
`78`	`78`	`* @return string`
	`79`	`+ *`
	`80`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`79`	`81`	`*/`
`80`	`82`	`public function __toString()`
`81`	`83`	`{`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,8 @@ public function setSelector($sSelector)`
`121`	`121`
`122`	`122`	`/**`
`123`	`123`	`* @return string`
	`124`	`+ *`
	`125`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`124`	`126`	`*/`
`125`	`127`	`public function __toString()`
`126`	`128`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ interface Renderable`
`6`	`6`	`{`
`7`	`7`	`/**`
`8`	`8`	`* @return string`
	`9`	`+ *`
	`10`	+ * @deprecated in V8.8.0, will be removed in V9.0.0. Use `render` instead.
`9`	`11`	`*/`
`10`	`12`	`public function __toString();`
`11`	`13`