Skip to content

Commit 145f89e

Browse files
westonruterwestonruter
committed
Rename post_id to url_metrics_id in OD_URL_Metric_Store_Request_Context
1 parent dd4e1ff commit 145f89e

File tree

4 files changed

+32
-11
lines changed

4 files changed

+32
-11
lines changed

‎plugins/optimization-detective/class-od-tag-visitor-context.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* @property-read OD_URL_Metric_Group_Collection $url_metric_group_collection URL Metric group collection.
2222
* @property-read OD_Link_Collection $link_collection Link collection.
2323
* @property-read positive-int|null $url_metrics_id ID for the od_url_metrics post which provided the URL Metrics in the collection.
24-
* @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection Deprecated alias for the url_metric_group_collection property.
24+
* @property-read OD_URL_Metric_Group_Collection $url_metrics_group_collection Deprecated alias for the $url_metric_group_collection property.
2525
*/
2626
final class OD_Tag_Visitor_Context {
2727

@@ -123,10 +123,10 @@ public function __get( string $name ) {
123123
case 'url_metrics_group_collection':
124124
// TODO: Remove this when no plugins are possibly referring to the url_metrics_group_collection property anymore.
125125
_doing_it_wrong(
126-
__CLASS__ . '::$url_metrics_group_collection',
126+
esc_html( __CLASS__ . '::$' . $name ),
127127
esc_html(
128128
sprintf(
129-
/* translators: %s is class member variable name */
129+
/* translators: %s is class member variable name */
130130
__( 'Use %s instead.', 'optimization-detective' ),
131131
__CLASS__ . '::$url_metric_group_collection'
132132
)

‎plugins/optimization-detective/storage/class-od-url-metric-store-request-context.php

+24-8
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@
1818
* @since 0.7.0
1919
*
2020
* @property-read WP_REST_Request<array<string, mixed>> $request Request.
21-
* @property-read positive-int $post_id ID for the od_url_metrics post.
21+
* @property-read positive-int $url_metrics_id ID for the od_url_metrics post.
2222
* @property-read OD_URL_Metric_Group_Collection $url_metric_group_collection URL Metric group collection.
2323
* @property-read OD_URL_Metric_Group $url_metric_group URL Metric group.
2424
* @property-read OD_URL_Metric $url_metric URL Metric.
25+
* @property-read positive-int $post_id Deprecated alias for the $url_metrics_id property.
2526
*/
2627
final class OD_URL_Metric_Store_Request_Context {
2728

@@ -36,10 +37,12 @@ final class OD_URL_Metric_Store_Request_Context {
3637
/**
3738
* ID for the od_url_metrics post.
3839
*
39-
* @since 0.7.0
40+
* This was originally $post_id which was introduced in 0.7.0.
41+
*
42+
* @since n.e.x.t
4043
* @var positive-int
4144
*/
42-
private $post_id;
45+
private $url_metrics_id;
4346

4447
/**
4548
* URL Metric group collection.
@@ -73,14 +76,14 @@ final class OD_URL_Metric_Store_Request_Context {
7376
* @phpstan-param WP_REST_Request<array<string, mixed>> $request
7477
*
7578
* @param WP_REST_Request $request REST API request.
76-
* @param positive-int $post_id ID for the URL Metric post.
79+
* @param positive-int $url_metrics_id ID for the URL Metric post.
7780
* @param OD_URL_Metric_Group_Collection $url_metric_group_collection URL Metric group collection.
7881
* @param OD_URL_Metric_Group $url_metric_group URL Metric group.
7982
* @param OD_URL_Metric $url_metric URL Metric.
8083
*/
81-
public function __construct( WP_REST_Request $request, int $post_id, OD_URL_Metric_Group_Collection $url_metric_group_collection, OD_URL_Metric_Group $url_metric_group, OD_URL_Metric $url_metric ) {
84+
public function __construct( WP_REST_Request $request, int $url_metrics_id, OD_URL_Metric_Group_Collection $url_metric_group_collection, OD_URL_Metric_Group $url_metric_group, OD_URL_Metric $url_metric ) {
8285
$this->request = $request;
83-
$this->post_id = $post_id;
86+
$this->url_metrics_id = $url_metrics_id;
8487
$this->url_metric_group_collection = $url_metric_group_collection;
8588
$this->url_metric_group = $url_metric_group;
8689
$this->url_metric = $url_metric;
@@ -100,14 +103,27 @@ public function __get( string $name ) {
100103
switch ( $name ) {
101104
case 'request':
102105
return $this->request;
103-
case 'post_id':
104-
return $this->post_id;
106+
case 'url_metrics_id':
107+
return $this->url_metrics_id;
105108
case 'url_metric_group_collection':
106109
return $this->url_metric_group_collection;
107110
case 'url_metric_group':
108111
return $this->url_metric_group;
109112
case 'url_metric':
110113
return $this->url_metric;
114+
case 'post_id':
115+
_doing_it_wrong(
116+
esc_html( __CLASS__ . '::$' . $name ),
117+
esc_html(
118+
sprintf(
119+
/* translators: %s is class member variable name */
120+
__( 'Use %s instead.', 'optimization-detective' ),
121+
__CLASS__ . '::$url_metrics_id'
122+
)
123+
),
124+
'optimization-detective n.e.x.t'
125+
);
126+
return $this->url_metrics_id;
111127
default:
112128
throw new Error(
113129
esc_html(

‎plugins/optimization-detective/tests/storage/test-rest-api.php

+4
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,11 @@ function ( OD_URL_Metric_Store_Request_Context $context ) use ( &$stored_context
8888
$this->assertInstanceOf( OD_URL_Metric_Group::class, $context->url_metric_group );
8989
$this->assertInstanceOf( OD_URL_Metric::class, $context->url_metric );
9090
$this->assertInstanceOf( WP_REST_Request::class, $context->request );
91+
$this->assertIsInt( $context->url_metrics_id );
92+
$this->setExpectedIncorrectUsage( 'OD_URL_Metric_Store_Request_Context::$post_id' );
9193
$this->assertIsInt( $context->post_id );
94+
$this->assertSame( $context->url_metrics_id, $context->post_id );
95+
9296
$error = null;
9397
$value = '';
9498
try {

‎plugins/optimization-detective/tests/test-optimization.php

+1
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,7 @@ function ( OD_Tag_Visitor_Context $context ): bool {
378378
$this->assertInstanceOf( OD_URL_Metric_Group_Collection::class, $context->url_metric_group_collection );
379379
$this->setExpectedIncorrectUsage( 'OD_Tag_Visitor_Context::$url_metrics_group_collection' );
380380
$this->assertInstanceOf( OD_URL_Metric_Group_Collection::class, $context->url_metrics_group_collection );
381+
$this->assertSame( $context->url_metric_group_collection, $context->url_metrics_group_collection );
381382
$this->assertInstanceOf( OD_HTML_Tag_Processor::class, $context->processor );
382383
$this->assertInstanceOf( OD_Link_Collection::class, $context->link_collection );
383384
$this->assertTrue( null === $context->url_metrics_id || $context->url_metrics_id > 0 );

0 commit comments

Comments
 (0)