Indicate deprecated nature of url_metrics_group_collection property

westonruter · westonruter · commit 5960ff3c561c · 2024-10-03T09:01:22.000-07:00
diff --git a/plugins/optimization-detective/class-od-tag-visitor-context.php b/plugins/optimization-detective/class-od-tag-visitor-context.php
@@ -17,7 +17,7 @@
  * @since 0.4.0
  * @access private
  *
- * @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection
+ * @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection Deprecated property accessed via magic getter. Use the url_metric_group_collection property instead.
  */
 final class OD_Tag_Visitor_Context {
 
@@ -59,7 +59,10 @@ public function __construct( OD_HTML_Tag_Processor $processor, OD_URL_Metric_Gro
 	}
 
 	/**
-	 * Gets magic properties.
+	 * Gets deprecated property.
+	 *
+	 * @since n.e.x.t
+	 * @todo Remove this when no plugins are possibly referring to the url_metrics_group_collection property anymore.
 	 *
 	 * @param string $name Property name.
 	 * @return OD_URL_Metric_Group_Collection URL metric group collection.

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`* @since 0.4.0`
`18`	`18`	`* @access private`
`19`	`19`	`*`
`20`		`- * @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection`
	`20`	`+ * @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection Deprecated property accessed via magic getter. Use the url_metric_group_collection property instead.`
`21`	`21`	`*/`
`22`	`22`	`final class OD_Tag_Visitor_Context {`
`23`	`23`
`@@ -59,7 +59,10 @@ public function __construct( OD_HTML_Tag_Processor $processor, OD_URL_Metric_Gro`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`/**`
`62`		`- * Gets magic properties.`
	`62`	`+ * Gets deprecated property.`
	`63`	`+ *`
	`64`	`+ * @since n.e.x.t`
	`65`	`+ * @todo Remove this when no plugins are possibly referring to the url_metrics_group_collection property anymore.`
`63`	`66`	`*`
`64`	`67`	`* @param string $name Property name.`
`65`	`68`	`* @return OD_URL_Metric_Group_Collection URL metric group collection.`