| 1 |
<?php |
| 2 |
|
| 3 |
// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure. |
| 4 |
namespace Yoast\WP\SEO\Bulk_Editor\Domain\Updates; |
| 5 |
|
| 6 |
/** |
| 7 |
* This class describes a collection of update results. |
| 8 |
*/ |
| 9 |
class Update_Result_Collection { |
| 10 |
|
| 11 |
/** |
| 12 |
* The update results. |
| 13 |
* |
| 14 |
* @var array<Update_Result> |
| 15 |
*/ |
| 16 |
private $results = []; |
| 17 |
|
| 18 |
/** |
| 19 |
* Adds an update result to the collection. |
| 20 |
* |
| 21 |
* @param Update_Result $result The update result to add. |
| 22 |
* |
| 23 |
* @return void |
| 24 |
*/ |
| 25 |
public function add( Update_Result $result ): void { |
| 26 |
$this->results[] = $result; |
| 27 |
} |
| 28 |
|
| 29 |
/** |
| 30 |
* Returns the update results in the collection. |
| 31 |
* |
| 32 |
* @return array<Update_Result> The update results in the collection. |
| 33 |
*/ |
| 34 |
public function get(): array { |
| 35 |
return $this->results; |
| 36 |
} |
| 37 |
|
| 38 |
/** |
| 39 |
* Parses the collection to the expected key value representation. |
| 40 |
* |
| 41 |
* @return array<string, array<array<string, int|bool|string>>> The collection presented as the expected key value representation. |
| 42 |
*/ |
| 43 |
public function to_array(): array { |
| 44 |
$results = []; |
| 45 |
foreach ( $this->results as $result ) { |
| 46 |
$results[] = $result->to_array(); |
| 47 |
} |
| 48 |
|
| 49 |
return [ 'results' => $results ]; |
| 50 |
} |
| 51 |
} |
| 52 |
|
