chore: cleanup dry_run conflicts

Author: jaredhendrickson13

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/Model.inc

@@ -441,6 +441,10 @@ class Model {
         $this->skip_init = $options['skip_init'] ?? false;
         unset($options['skip_init']);
 
+        # Obtain the dry_run flag if given. Ensure this defaults to false.
+        $this->dry_run = $options['dry_run'] ?? false;
+        unset($options['dry_run']);
+
         return $options;
     }
 

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/ModelSet.inc

@@ -152,12 +152,13 @@ class ModelSet {
 
     /**
      * Deletes all Model objects within this ModelSet.
+     * @param bool $dry_run Run through the delete request but don't actually delete anything
      * @return ModelSet The ModelSet object with all Model objects that were deleted.
      */
-    public function delete(): ModelSet {
+    public function delete(bool $dry_run = false): ModelSet {
         # Run the delete method for each model object in this ModelSet
         # Note: We have to do this in reverse order to avoid index issues when deleting objects.
-        $this->run_model_method(method_name: 'delete', reverse: true);
+        $this->run_model_method(method_name: 'delete', reverse: true, dry_run: $dry_run);
         return $this;
     }
 
@@ -166,17 +167,24 @@ class ModelSet {
      * @param string $method_name The name of the Model method to run for each model object in this model set.
      * @param bool $use_id_as_key Use each Model object's `id` property value as the return array keys.
      * @param bool $reverse Reverse the order of which the model objects are processed.
+     * @param bool $dry_run Sets the `dry_run` property of each Model object to true before running the method.
      * @return array The return value of method call for each model object. Results are stored in the same order as
      * the model objects were passed in during construction.
      */
-    private function run_model_method(string $method_name, bool $use_id_as_key = false, bool $reverse = false): array {
+    private function run_model_method(
+        string $method_name,
+        bool $use_id_as_key = false,
+        bool $reverse = false,
+        bool $dry_run = false,
+    ): array {
         # Variables
         $results = [];
         $model_objects = $reverse ? array_reverse($this->model_objects) : $this->model_objects;
 
         # Loop through each model object and call its to_representation() method
         foreach ($model_objects as $loop_count => $model_object) {
             $id = $use_id_as_key ? $model_object->id : $loop_count;
+            $model_object->dry_run = $dry_run;
             $results[$id] = $model_object->$method_name();
         }
 

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/SystemHalt.inc

@@ -10,20 +10,10 @@ use RESTAPI\Fields\BooleanField;
  * Defines a Model that performs a system halt operation.
  */
 class SystemHalt extends Model {
-    public BooleanField $dry_run;
-
     public function __construct(mixed $id = null, mixed $parent_id = null, mixed $data = [], ...$options) {
         # Set model attributes
         $this->many = false;
 
-        # Set model fields
-        $this->dry_run = new BooleanField(
-            default: false,
-            write_only: true,
-            verbose_name: 'Dry Run',
-            help_text: "Run through the call but don't actually initiate a shutdown.",
-        );
-
         parent::__construct($id, $parent_id, $data, ...$options);
     }
 
@@ -38,9 +28,6 @@ class SystemHalt extends Model {
      * Defines the steps necessary to initiate a shutdown.
      */
     public function _create(): void {
-        # Only initiate the shutdown if this is not a dry run
-        if (!$this->dry_run->value) {
-            (new SystemHaltDispatcher($this->async))->spawn_process();
-        }
+        (new SystemHaltDispatcher($this->async))->spawn_process();
     }
 }

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/SystemReboot.inc

@@ -10,20 +10,10 @@ use RESTAPI\Fields\BooleanField;
  * Defines a Model that performs a system reboot operation.
  */
 class SystemReboot extends Model {
-    public BooleanField $dry_run;
-
     public function __construct(mixed $id = null, mixed $parent_id = null, mixed $data = [], ...$options) {
         # Set model attributes
         $this->many = false;
 
-        # Set model fields
-        $this->dry_run = new BooleanField(
-            default: false,
-            write_only: true,
-            verbose_name: 'Dry Run',
-            help_text: "Run through the call but don't actually initiate a reboot.",
-        );
-
         parent::__construct($id, $parent_id, $data, ...$options);
     }
 
@@ -38,9 +28,6 @@ class SystemReboot extends Model {
      * Defines the steps necessary to initiate a reboot.
      */
     public function _create(): void {
-        # Only initiate the reboot if this is not a dry run
-        if (!$this->dry_run->value) {
-            (new SystemRebootDispatcher($this->async))->spawn_process();
-        }
+        (new SystemRebootDispatcher($this->async))->spawn_process();
     }
 }