Unify the deprecation messages (see #6736)

Description ----------- Commits ------- 81cb454 Unify the deprecation messages
contao · Jan 18, 2024 · 4e273f0 · 4e273f0
1 parent c2def7e
commit 4e273f0
Show file tree

Hide file tree

Showing 17 changed files with 72 additions and 72 deletions.
diff --git a/comments-bundle/contao/classes/Comments.php b/comments-bundle/contao/classes/Comments.php
@@ -505,8 +505,8 @@ public function convertLineFeeds($strComment)
 	/**
 	 * Purge subscriptions that have not been activated within 24 hours
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
-	 *             Use CommentsNotifyModel::findExpiredSubscriptions() instead.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6;
+	 *             use CommentsNotifyModel::findExpiredSubscriptions() instead.
 	 */
 	public function purgeSubscriptions()
 	{

diff --git a/core-bundle/contao/classes/BackendUser.php b/core-bundle/contao/classes/BackendUser.php
@@ -154,8 +154,8 @@ public function __get($strKey)
 	 *
 	 * @return boolean
 	 *
-	 * @deprecated Deprecated since Contao 5.2, to be removed in Contao 6.0.
-	 *             Use the "ContaoCorePermissions::USER_CAN_ACCESS_*" permissions instead.
+	 * @deprecated Deprecated since Contao 5.2, to be removed in Contao 6;
+	 *             use the "ContaoCorePermissions::USER_CAN_ACCESS_*" permissions instead.
 	 */
 	public function hasAccess($field, $array)
 	{

diff --git a/core-bundle/contao/classes/DataContainer.php b/core-bundle/contao/classes/DataContainer.php
@@ -249,7 +249,8 @@ abstract class DataContainer extends Backend
 	/**
 	 * Active record
 	 * @var Model|object|null
-	 * @deprecated Deprecated since Contao 5.0 to be removed in Contao 6. Use $dc->getCurrentRecord() instead.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6;
+	 *             use $dc->getCurrentRecord() instead.
 	 */
 	protected $objActiveRecord;
 

diff --git a/core-bundle/contao/drivers/DC_Table.php b/core-bundle/contao/drivers/DC_Table.php
@@ -1100,7 +1100,7 @@ public function copy($blnDoNotRedirect=false)
 	}
 
 	/**
-	 * @deprecated Deprecated in Contao 5.3, to be removed in Contao 6;
+	 * @deprecated Deprecated since Contao 5.3, to be removed in Contao 6;
 	 *             use copyChildren() instead.
 	 */
 	protected function copyChilds($table, $insertID, $id, $parentId)
@@ -1804,7 +1804,7 @@ public function deleteAll()
 	}
 
 	/**
-	 * @deprecated Deprecated in Contao 5.3, to be removed in Contao 6;
+	 * @deprecated Deprecated since Contao 5.3, to be removed in Contao 6;
 	 *             use deleteChildren() instead.
 	 */
 	protected function deleteChilds($table, $id, &$delete)

diff --git a/core-bundle/contao/library/Contao/Automator.php b/core-bundle/contao/library/Contao/Automator.php
@@ -226,8 +226,8 @@ public function purgeTempFolder()
 	/**
 	 * Purge registrations that have not been activated within 24 hours
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
-	 *             Use MemberModel::findExpiredRegistrations() instead.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6;
+	 *             use MemberModel::findExpiredRegistrations() instead.
 	 */
 	public function purgeRegistrations()
 	{
@@ -251,8 +251,8 @@ public function purgeRegistrations()
 	/**
 	 * Purge opt-in tokens
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
-	 *             Use the "contao.opt_in" service instead.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6;
+	 *             use the "contao.opt_in" service instead.
 	 */
 	public function purgeOptInTokens()
 	{

diff --git a/core-bundle/contao/library/Contao/Config.php b/core-bundle/contao/library/Contao/Config.php
@@ -306,7 +306,7 @@ public function save()
 	/**
 	 * Return true if the installation is complete
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
 	 *
 	 * @return boolean True if the installation is complete
 	 */

diff --git a/core-bundle/contao/library/Contao/Controller.php b/core-bundle/contao/library/Contao/Controller.php
@@ -1222,8 +1222,8 @@ public static function resetControllerCache()
 	 *
 	 * @return string The URL of the target page
 	 *
-	 * @deprecated Deprecated since Contao 5.3, to be removed in Contao 6.0.
-	 *             Use the contao_backend_preview route instead.
+	 * @deprecated Deprecated since Contao 5.3, to be removed in Contao 6;
+	 *             use the contao_backend_preview route instead.
 	 */
 	protected function redirectToFrontendPage($intPage, $strArticle=null, $blnReturn=false)
 	{

diff --git a/core-bundle/contao/library/Contao/Input.php b/core-bundle/contao/library/Contao/Input.php
@@ -494,7 +494,7 @@ public static function getUnusedRouteParameters(): array
 	 *
 	 * @return mixed The clean name or array of names
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
 	 */
 	public static function cleanKey($varValue)
 	{
@@ -809,7 +809,7 @@ private static function getAttributesFromTag($strAttributes)
 	 *
 	 * @return mixed The cleaned string or array
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
 	 */
 	public static function xssClean($varValue, $blnStrictMode=false)
 	{
@@ -928,7 +928,7 @@ public static function xssClean($varValue, $blnStrictMode=false)
 	 *
 	 * @return mixed The decoded string or array
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
 	 */
 	public static function decodeEntities($varValue)
 	{
@@ -964,7 +964,7 @@ public static function decodeEntities($varValue)
 	 *
 	 * @return mixed The string or array with the converted entities
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
 	 */
 	public static function preserveBasicEntities($varValue)
 	{
@@ -1003,7 +1003,7 @@ public static function preserveBasicEntities($varValue)
 	 *
 	 * @return mixed The encoded string or array
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
 	 */
 	public static function encodeSpecialChars($varValue)
 	{

diff --git a/core-bundle/contao/library/Contao/Template.php b/core-bundle/contao/library/Contao/Template.php
@@ -60,7 +60,7 @@
  * @property array        $trustedDevices
  * @property string       $currentDevice
  *
- * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0;
+ * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6;
  *             use Twig templates instead
  */
 abstract class Template extends Controller

diff --git a/core-bundle/src/InsertTag/InsertTagParser.php b/core-bundle/src/InsertTag/InsertTagParser.php
@@ -166,7 +166,8 @@ public function replaceInlineChunked(string $input): ChunkedText
     }
 
     /**
-     * @deprecated Deprecated since Contao 5.1 to be removed in Contao 6. Use renderTag() instead.
+     * @deprecated Deprecated since Contao 5.1, to be removed in Contao 6;
+     *             use renderTag() instead.
      */
     public function render(string $input): string
     {

diff --git a/core-bundle/src/Security/ContaoCorePermissions.php b/core-bundle/src/Security/ContaoCorePermissions.php
@@ -184,7 +184,8 @@ final class ContaoCorePermissions
     public const USER_CAN_ACCESS_IMAGE_SIZE = 'contao_user.imageSizes';
 
     /**
-     * @deprecated use USER_CAN_EDIT_FORM instead
+     * @deprecated Deprecated since Contao 5.3, to be removed in Contao 6;
+     *             use USER_CAN_EDIT_FORM instead
      */
     public const USER_CAN_ACCESS_FORM = 'contao_user.forms';
 

diff --git a/core-bundle/src/Twig/Runtime/FigureRuntime.php b/core-bundle/src/Twig/Runtime/FigureRuntime.php
@@ -41,7 +41,7 @@ public function __construct(private readonly FigureRenderer $figureRenderer)
      * @param int|string|array|PictureConfiguration|null $size          A picture size configuration or reference
      * @param array<string, mixed>                       $configuration Configuration for the FigureBuilder
      *
-     * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
+     * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.
      */
     public function renderFigure(FilesModel|ImageInterface|int|string $from, PictureConfiguration|array|int|string|null $size, array $configuration = [], string $template = '@ContaoCore/Image/Studio/figure.html.twig'): string|null
     {

diff --git a/core-bundle/tests/EventListener/RobotsTxtListenerTest.php b/core-bundle/tests/EventListener/RobotsTxtListenerTest.php
@@ -86,8 +86,7 @@ public function disallowProvider(): \Generator
             <<<'EOF'
                 user-agent:*
                 allow:/
-                EOF
-            ,
+                EOF,
             null,
             <<<'EOF'
                 user-agent:*
@@ -103,8 +102,7 @@ public function disallowProvider(): \Generator
             <<<'EOF'
                 user-agent:googlebot
                 allow:/
-                EOF
-            ,
+                EOF,
             null,
             <<<'EOF'
                 user-agent:googlebot
@@ -138,8 +136,7 @@ public function disallowProvider(): \Generator
             <<<'EOF'
                 user-agent:googlebot
                 allow:/
-                EOF
-            ,
+                EOF,
             true,
             <<<'EOF'
                 user-agent:googlebot

diff --git a/newsletter-bundle/contao/classes/Newsletter.php b/newsletter-bundle/contao/classes/Newsletter.php
@@ -981,8 +981,8 @@ public function updateAccount()
 	/**
 	 * Purge subscriptions that have not been activated within 24 hours
 	 *
-	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6.0.
-	 *             Use NewsletterRecipientsModel::findExpiredSubscriptions() instead.
+	 * @deprecated Deprecated since Contao 5.0, to be removed in Contao 6;
+	 *             use NewsletterRecipientsModel::findExpiredSubscriptions() instead.
 	 */
 	public function purgeSubscriptions()
 	{

diff --git a/tools/ecs/composer.lock b/tools/ecs/composer.lock
diff --git a/tools/phpstan/composer.lock b/tools/phpstan/composer.lock