Rename get_all_elements to get_xpath_elements_map

westonruter · westonruter · commit 98d3fd8a6d26 · 2024-10-17T12:49:24.000-07:00
diff --git a/plugins/embed-optimizer/class-embed-optimizer-tag-visitor.php b/plugins/embed-optimizer/class-embed-optimizer-tag-visitor.php
@@ -216,7 +216,7 @@ private function reduce_layout_shifts( OD_Tag_Visitor_Context $context ): void {
 		 */
 		$minimums = array();
 
-		$elements = $context->url_metric_group_collection->get_all_elements()[ $embed_wrapper_xpath ] ?? array();
+		$elements = $context->url_metric_group_collection->get_xpath_elements_map()[ $embed_wrapper_xpath ] ?? array();
 		foreach ( $elements as $element ) {
 			/**
 			 * Resized bounding client rect.
diff --git a/plugins/optimization-detective/class-od-url-metric-group-collection.php b/plugins/optimization-detective/class-od-url-metric-group-collection.php
@@ -79,7 +79,7 @@ final class OD_URL_Metric_Group_Collection implements Countable, IteratorAggrega
 	 *          get_groups_by_lcp_element?: array<string, OD_URL_Metric_Group[]>,
 	 *          get_common_lcp_element?: OD_Element|null,
 	 *          get_all_element_max_intersection_ratios?: array<string, float>,
-	 *          get_all_elements?: array<string, non-empty-array<int, OD_Element>>,
+	 *          get_xpath_elements_map?: array<string, non-empty-array<int, OD_Element>>,
 	 *      }
 	 */
 	private $result_cache = array();
@@ -419,7 +419,7 @@ public function get_common_lcp_element(): ?OD_Element {
 	 *
 	 * @return array<string, non-empty-array<int, OD_Element>> Keys are XPaths and values are the element instances.
 	 */
-	public function get_all_elements(): array {
+	public function get_xpath_elements_map(): array {
 		if ( array_key_exists( __FUNCTION__, $this->result_cache ) ) {
 			return $this->result_cache[ __FUNCTION__ ];
 		}
@@ -454,7 +454,7 @@ public function get_all_element_max_intersection_ratios(): array {
 
 		$result = ( function () {
 			$elements_max_intersection_ratios = array();
-			foreach ( $this->get_all_elements() as $xpath => $elements ) {
+			foreach ( $this->get_xpath_elements_map() as $xpath => $elements ) {
 				$element_intersection_ratios = array();
 				foreach ( $elements as $element ) {
 					$element_intersection_ratios[] = $element->get_intersection_ratio();
diff --git a/plugins/optimization-detective/tests/test-class-od-url-metrics-group-collection.php b/plugins/optimization-detective/tests/test-class-od-url-metrics-group-collection.php
@@ -710,7 +710,7 @@ public function data_provider_element_max_intersection_ratios(): array {
 	 *
 	 * @covers ::get_all_element_max_intersection_ratios
 	 * @covers ::get_element_max_intersection_ratio
-	 * @covers ::get_all_elements
+	 * @covers ::get_xpath_elements_map
 	 *
 	 * @dataProvider data_provider_element_max_intersection_ratios
 	 *
@@ -729,7 +729,7 @@ public function test_get_all_element_max_intersection_ratios( array $url_metrics
 		}
 
 		// Check get_all_denormalized_elements.
-		$all_elements = $group_collection->get_all_elements();
+		$all_elements = $group_collection->get_xpath_elements_map();
 		$xpath_counts = array();
 		foreach ( $url_metrics as $url_metric ) {
 			foreach ( $url_metric->get_elements() as $element ) {

Original file line number	Diff line number	Diff line change
`@@ -710,7 +710,7 @@ public function data_provider_element_max_intersection_ratios(): array {`
`710`	`710`	`*`
`711`	`711`	`* @covers ::get_all_element_max_intersection_ratios`
`712`	`712`	`* @covers ::get_element_max_intersection_ratio`
`713`		`- * @covers ::get_all_elements`
	`713`	`+ * @covers ::get_xpath_elements_map`
`714`	`714`	`*`
`715`	`715`	`* @dataProvider data_provider_element_max_intersection_ratios`
`716`	`716`	`*`
`@@ -729,7 +729,7 @@ public function test_get_all_element_max_intersection_ratios( array $url_metrics`
`729`	`729`	`}`
`730`	`730`
`731`	`731`	`// Check get_all_denormalized_elements.`
`732`		`- $all_elements = $group_collection->get_all_elements();`
	`732`	`+ $all_elements = $group_collection->get_xpath_elements_map();`
`733`	`733`	`$xpath_counts = array();`
`734`	`734`	`foreach ( $url_metrics as $url_metric ) {`
`735`	`735`	`foreach ( $url_metric->get_elements() as $element ) {`