Use Symfony's deprecation function to trigger runtime deprecations with additional package information

Author: mbabker

composer.json

@@ -6,7 +6,8 @@
     "homepage": "https://github.com/joomla-framework/string",
     "license": "GPL-2.0-or-later",
     "require": {
-        "php": "^7.2.5"
+        "php": "^7.2.5",
+        "symfony/deprecation-contracts": "^2.1"
     },
     "require-dev": {
         "doctrine/inflector": "^1.2",

src/Inflector.php

@@ -111,13 +111,12 @@ public function addCountableRule($data)
 	 */
 	public function addWord($singular, $plural = '')
 	{
-		@trigger_error(
-			sprintf(
-				'%1$s() is deprecated and will be removed in 3.0, use %2$s::rules() instead.',
-				__METHOD__,
-				DoctrineInflector::class
-			),
-			E_USER_DEPRECATED
+		trigger_deprecation(
+			'joomla/string',
+			'2.0.0',
+			'%s() is deprecated and will be removed in 3.0, use %s::rules() instead.',
+			__METHOD__,
+			DoctrineInflector::class
 		);
 
 		if ($plural !== '')
@@ -168,13 +167,12 @@ public function addWord($singular, $plural = '')
 	 */
 	public function addPluraliseRule($data)
 	{
-		@trigger_error(
-			sprintf(
-				'%1$s() is deprecated and will be removed in 3.0, use %2$s::rules() instead.',
-				__METHOD__,
-				DoctrineInflector::class
-			),
-			E_USER_DEPRECATED
+		trigger_deprecation(
+			'joomla/string',
+			'2.0.0',
+			'%s() is deprecated and will be removed in 3.0, use %s::rules() instead.',
+			__METHOD__,
+			DoctrineInflector::class
 		);
 
 		$this->addRule($data, 'plural');
@@ -194,13 +192,12 @@ public function addPluraliseRule($data)
 	 */
 	public function addSingulariseRule($data)
 	{
-		@trigger_error(
-			sprintf(
-				'%1$s() is deprecated and will be removed in 3.0, use %2$s::rules() instead.',
-				__METHOD__,
-				DoctrineInflector::class
-			),
-			E_USER_DEPRECATED
+		trigger_deprecation(
+			'joomla/string',
+			'2.0.0',
+			'%s() is deprecated and will be removed in 3.0, use %s::rules() instead.',
+			__METHOD__,
+			DoctrineInflector::class
 		);
 
 		$this->addRule($data, 'singular');
@@ -220,12 +217,11 @@ public function addSingulariseRule($data)
 	 */
 	public static function getInstance($new = false)
 	{
-		@trigger_error(
-			sprintf(
-				'%1$s() is deprecated and will be removed in 3.0.',
-				__METHOD__
-			),
-			E_USER_DEPRECATED
+		trigger_deprecation(
+			'joomla/string',
+			'2.0.0',
+			'%s() is deprecated and will be removed in 3.0.',
+			__METHOD__
 		);
 
 		if ($new)
@@ -295,13 +291,12 @@ public function isSingular($word)
 	 */
 	public function toPlural($word)
 	{
-		@trigger_error(
-			sprintf(
-				'%1$s() is deprecated and will be removed in 3.0, use %2$s::pluralize() instead.',
-				__METHOD__,
-				DoctrineInflector::class
-			),
-			E_USER_DEPRECATED
+		trigger_deprecation(
+			'joomla/string',
+			'2.0.0',
+			'%s() is deprecated and will be removed in 3.0, use %s::pluralize() instead.',
+			__METHOD__,
+			DoctrineInflector::class
 		);
 
 		return static::pluralize($word);
@@ -319,13 +314,12 @@ public function toPlural($word)
 	 */
 	public function toSingular($word)
 	{
-		@trigger_error(
-			sprintf(
-				'%1$s() is deprecated and will be removed in 3.0, use %2$s::singularize() instead.',
-				__METHOD__,
-				DoctrineInflector::class
-			),
-			E_USER_DEPRECATED
+		trigger_deprecation(
+			'joomla/string',
+			'2.0.0',
+			'%s() is deprecated and will be removed in 3.0, use %s::singularize() instead.',
+			__METHOD__,
+			DoctrineInflector::class
 		);
 
 		return static::singularize($word);