Skip to content

Commit 344d6e1

Browse files
westonruterwestonruter
committed
Add getter/setter methods
1 parent a99208b commit 344d6e1

7 files changed

+71
-7
lines changed

‎plugins/embed-optimizer/class-embed-optimizer-tag-visitor.php

+4-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,10 @@ private function reduce_layout_shifts( OD_Tag_Visitor_Context $context ): void {
227227
if ( ! is_array( $resized_bounding_client_rect ) ) {
228228
continue;
229229
}
230-
$group = $element->url_metric->group;
230+
$group = $element->get_url_metric_group();
231+
if ( null === $group ) {
232+
continue; // Technically could be null but in practice it never will be.
233+
}
231234
$group_min_width = $group->get_minimum_viewport_width();
232235
if ( ! isset( $minimums[ $group_min_width ] ) ) {
233236
$minimums[ $group_min_width ] = array(

‎plugins/optimization-detective/class-od-element.php

+23-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class OD_Element implements ArrayAccess, JsonSerializable {
3939
* @var OD_URL_Metric
4040
* @readonly
4141
*/
42-
public $url_metric;
42+
protected $url_metric;
4343

4444
/**
4545
* Constructor.
@@ -56,6 +56,28 @@ public function __construct( array $data, OD_URL_Metric $url_metric ) {
5656
$this->url_metric = $url_metric;
5757
}
5858

59+
/**
60+
* Gets the URL metric that this element belongs to.
61+
*
62+
* @since n.e.x.t
63+
*
64+
* @return OD_URL_Metric URL Metric.
65+
*/
66+
public function get_url_metric(): OD_URL_Metric {
67+
return $this->url_metric;
68+
}
69+
70+
/**
71+
* Gets the group that this element's URL metric is a part of (which may not be any).
72+
*
73+
* @since n.e.x.t
74+
*
75+
* @return OD_URL_Metric_Group|null Group.
76+
*/
77+
public function get_url_metric_group(): ?OD_URL_Metric_Group {
78+
return $this->url_metric->get_group();
79+
}
80+
5981
/**
6082
* Gets property value for an arbitrary key.
6183
*

‎plugins/optimization-detective/class-od-url-metric-group.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ public function add_url_metric( OD_URL_Metric $url_metric ): void {
193193
$this->collection->clear_cache();
194194
}
195195

196-
$url_metric->group = $this;
196+
$url_metric->set_group( $this );
197197
$this->url_metrics[] = $url_metric;
198198

199199
// If we have too many URL metrics now, remove the oldest ones up to the sample size.

‎plugins/optimization-detective/class-od-url-metric.php

+29-2
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ class OD_URL_Metric implements JsonSerializable {
6767
* Group.
6868
*
6969
* @since n.e.x.t
70-
* @var OD_URL_Metric_Group
70+
* @var OD_URL_Metric_Group|null
7171
*/
72-
public $group;
72+
protected $group = null;
7373

7474
/**
7575
* Constructor.
@@ -123,6 +123,33 @@ private function prepare_data( array $data ): array {
123123
return rest_sanitize_value_from_schema( $data, $schema, self::class );
124124
}
125125

126+
/**
127+
* Gets the group that this URL metric is a part of (which may not be any).
128+
*
129+
* @since n.e.x.t
130+
*
131+
* @return OD_URL_Metric_Group|null Group.
132+
*/
133+
public function get_group(): ?OD_URL_Metric_Group {
134+
return $this->group;
135+
}
136+
137+
/**
138+
* Sets the group that this URL metric is a part of.
139+
*
140+
* @since n.e.x.t
141+
*
142+
* @param OD_URL_Metric_Group $group Group.
143+
*
144+
* @throws InvalidArgumentException When the supplied group has minimum/maximum viewport widths which are out of bounds with the viewport width for this URL Metric.
145+
*/
146+
public function set_group( OD_URL_Metric_Group $group ): void {
147+
if ( $this->get_viewport_width() < $group->get_minimum_viewport_width() || $this->get_viewport_width() > $group->get_maximum_viewport_width() ) {
148+
throw new InvalidArgumentException( 'Group does not have the correct minimum or maximum viewport widths for this URL Metric.' );
149+
}
150+
$this->group = $group;
151+
}
152+
126153
/**
127154
* Gets JSON schema for URL Metric.
128155
*

‎plugins/optimization-detective/tests/test-class-od-element.php

+7
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ class Test_OD_Element extends WP_UnitTestCase {
1313
* Tests construction.
1414
*
1515
* @covers ::get
16+
* @covers ::get_url_metric
17+
* @covers ::get_url_metric_group
1618
* @covers ::is_lcp
1719
* @covers ::is_lcp_candidate
1820
* @covers ::get_xpath
@@ -67,6 +69,11 @@ static function ( array $schema ): array {
6769

6870
$element = $url_metric->get_elements()[0];
6971
$this->assertInstanceOf( OD_Element::class, $element );
72+
$this->assertSame( $url_metric, $element->get_url_metric() );
73+
$this->assertNull( $element->get_url_metric_group() );
74+
$collection = new OD_URL_Metric_Group_Collection( array( $url_metric ), array(), 1, DAY_IN_SECONDS );
75+
$collection->add_url_metric( $url_metric );
76+
$this->assertSame( iterator_to_array( $collection )[0], $element->get_url_metric_group() );
7077

7178
$this->assertSame( $element_data['xpath'], $element->get_xpath() );
7279
$this->assertSame( $element_data['xpath'], $element['xpath'] );

‎plugins/optimization-detective/tests/test-class-od-url-metric.php

+6
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,8 @@ static function ( $value ) {
205205
* @covers ::jsonSerialize
206206
* @covers ::get
207207
* @covers ::get_json_schema
208+
* @covers ::set_group
209+
* @covers ::get_group
208210
*
209211
* @dataProvider data_provider_to_test_constructor
210212
*
@@ -217,6 +219,10 @@ public function test_constructor( array $data, string $error = '' ): void {
217219
$this->expectExceptionMessage( $error );
218220
}
219221
$url_metric = new OD_URL_Metric( $data );
222+
$this->assertNull( $url_metric->get_group() );
223+
$group = new OD_URL_Metric_Group( array( $url_metric ), 0, PHP_INT_MAX, 1, DAY_IN_SECONDS );
224+
$url_metric->set_group( $group );
225+
$this->assertSame( $group, $url_metric->get_group() );
220226

221227
$this->assertSame( array_map( 'intval', $data['viewport'] ), $url_metric->get_viewport() );
222228
$this->assertSame( array_map( 'intval', $data['viewport'] ), $url_metric->get( 'viewport' ) );

‎plugins/optimization-detective/tests/test-class-od-url-metrics-group-collection.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -742,8 +742,7 @@ public function test_get_all_element_max_intersection_ratios( array $url_metrics
742742
$this->assertCount( count( $xpath_counts ), $all_elements );
743743
foreach ( $all_elements as $xpath => $elements ) {
744744
foreach ( $elements as $element ) {
745-
$this->assertInstanceOf( OD_URL_Metric::class, $element->url_metric );
746-
$this->assertInstanceOf( OD_URL_Metric_Group::class, $element->url_metric->group );
745+
$this->assertSame( $element->get_url_metric()->get_group(), $element->get_url_metric_group() );
747746
$this->assertInstanceOf( OD_Element::class, $element );
748747
$this->assertSame( $xpath, $element['xpath'] );
749748
}

0 commit comments

Comments
 (0)