Merge pull request #6 from illegalstudio/cr-volume-delete-options

mirchaemanuel · web-flow · commit e6f429d19b23 · 2023-08-21T12:40:43.000+02:00
added cascade parameters to Volume parameters / revised deletable int…
diff --git a/src/BlockStorage/v2/Models/QuotaSet.php b/src/BlockStorage/v2/Models/QuotaSet.php
@@ -79,7 +79,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $response = $this->executeWithState($this->api->deleteQuotaSet());
         $this->populateFromResponse($response);
diff --git a/src/BlockStorage/v2/Models/Snapshot.php b/src/BlockStorage/v2/Models/Snapshot.php
@@ -98,7 +98,7 @@ public function update()
         $this->executeWithState($this->api->putSnapshot());
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteSnapshot());
     }
diff --git a/src/BlockStorage/v2/Models/Volume.php b/src/BlockStorage/v2/Models/Volume.php
@@ -125,7 +125,7 @@ public function update()
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteVolume());
     }
diff --git a/src/BlockStorage/v2/Models/VolumeType.php b/src/BlockStorage/v2/Models/VolumeType.php
@@ -39,7 +39,7 @@ public function update()
         $this->executeWithState($this->api->putType());
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteType());
     }
diff --git a/src/BlockStorage/v3/Api.php b/src/BlockStorage/v3/Api.php
@@ -92,7 +92,10 @@ public function deleteVolume(): array
         return [
             'method' => 'DELETE',
             'path'   => 'volumes/{id}',
-            'params' => ['id' => $this->params->idPath()],
+            'params' => [
+                'id'      => $this->params->idPath(),
+                'cascade' => $this->params->cascade()
+            ],
         ];
     }
 
diff --git a/src/BlockStorage/v3/Models/QuotaSet.php b/src/BlockStorage/v3/Models/QuotaSet.php
@@ -80,7 +80,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $response = $this->executeWithState($this->api->deleteQuotaSet());
         $this->populateFromResponse($response);
diff --git a/src/BlockStorage/v3/Models/Snapshot.php b/src/BlockStorage/v3/Models/Snapshot.php
@@ -99,7 +99,7 @@ public function update()
         $this->executeWithState($this->api->putSnapshot());
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteSnapshot());
     }
diff --git a/src/BlockStorage/v3/Models/Volume.php b/src/BlockStorage/v3/Models/Volume.php
@@ -126,9 +126,10 @@ public function update()
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
-        $this->executeWithState($this->api->deleteVolume());
+        $userOptions = array_merge($userOptions, ['id' => $this->id]);
+        $this->execute($this->api->deleteVolume(), $userOptions);
     }
 
     public function getMetadata(): array
diff --git a/src/BlockStorage/v3/Models/VolumeType.php b/src/BlockStorage/v3/Models/VolumeType.php
@@ -40,7 +40,7 @@ public function update()
         $this->executeWithState($this->api->putType());
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteType());
     }
diff --git a/src/BlockStorage/v3/Params.php b/src/BlockStorage/v3/Params.php
@@ -70,6 +70,15 @@ public function imageRef(): array
         ];
     }
 
+    public function cascade(): array
+    {
+        return [
+            'location'    => self::QUERY,
+            'type'        => self::BOOL_TYPE,
+            'description' => 'Indicates whether to force delete a volume even if the volume is in deleting or error_deleting.',
+        ];
+    }
+
     public function volumeType(): array
     {
         return [
diff --git a/src/Common/Api/OperatorTrait.php b/src/Common/Api/OperatorTrait.php
@@ -115,7 +115,6 @@ protected function sendRequest(Operation $operation, array $userValues = [], boo
         if (array_key_exists('requestOptions', $userValues)) {
             $options += $userValues['requestOptions'];
         }
-
         return $this->client->$method($operation->getMethod(), $uri, $options);
     }
 
diff --git a/src/Common/Resource/Deletable.php b/src/Common/Resource/Deletable.php
@@ -12,5 +12,5 @@ interface Deletable
     /**
      * Permanently delete this resource.
      */
-    public function delete();
+    public function delete(array $userOptions);
 }
diff --git a/src/Compute/v2/Models/Flavor.php b/src/Compute/v2/Models/Flavor.php
@@ -63,7 +63,7 @@ public function create(array $userOptions): Creatable
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteFlavor(), ['id' => (string) $this->id]);
     }
diff --git a/src/Compute/v2/Models/Image.php b/src/Compute/v2/Models/Image.php
@@ -76,7 +76,7 @@ public function retrieve()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteImage(), ['id' => (string) $this->id]);
     }
diff --git a/src/Compute/v2/Models/Keypair.php b/src/Compute/v2/Models/Keypair.php
@@ -93,7 +93,7 @@ public function populateFromArray(array $array): self
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteKeypair(), ['name' => (string) $this->name]);
     }
diff --git a/src/Compute/v2/Models/QuotaSet.php b/src/Compute/v2/Models/QuotaSet.php
@@ -159,7 +159,7 @@ public function retrieve()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $response = $this->executeWithState($this->api->deleteQuotaSet());
         $this->populateFromResponse($response);
diff --git a/src/Compute/v2/Models/Server.php b/src/Compute/v2/Models/Server.php
@@ -154,7 +154,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteServer(), $this->getAttrs(['id']));
     }
diff --git a/src/Identity/v3/Models/ApplicationCredential.php b/src/Identity/v3/Models/ApplicationCredential.php
@@ -72,7 +72,7 @@ public function retrieve()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteApplicationCredential(), $this->getAttrs(['id', 'userId']));
     }
diff --git a/src/Identity/v3/Models/Credential.php b/src/Identity/v3/Models/Credential.php
@@ -70,7 +70,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteCredential());
     }
diff --git a/src/Identity/v3/Models/Domain.php b/src/Identity/v3/Models/Domain.php
@@ -68,7 +68,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteDomain());
     }
diff --git a/src/Identity/v3/Models/Ec2Credential.php b/src/Identity/v3/Models/Ec2Credential.php
@@ -56,7 +56,7 @@ public function retrieve()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteEc2Credential(), $this->getAttrs(['access', 'userId']));
     }
diff --git a/src/Identity/v3/Models/Endpoint.php b/src/Identity/v3/Models/Endpoint.php
@@ -73,7 +73,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteEndpoint(), $this->getAttrs(['id']));
     }
diff --git a/src/Identity/v3/Models/Group.php b/src/Identity/v3/Models/Group.php
@@ -70,7 +70,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteGroup(), ['id' => $this->id]);
     }
diff --git a/src/Identity/v3/Models/Policy.php b/src/Identity/v3/Models/Policy.php
@@ -75,7 +75,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deletePolicy(), ['id' => $this->id]);
     }
diff --git a/src/Identity/v3/Models/Project.php b/src/Identity/v3/Models/Project.php
@@ -80,7 +80,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteProject());
     }
diff --git a/src/Identity/v3/Models/Role.php b/src/Identity/v3/Models/Role.php
@@ -41,7 +41,7 @@ public function create(array $data): Creatable
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteRole());
     }
diff --git a/src/Identity/v3/Models/Service.php b/src/Identity/v3/Models/Service.php
@@ -81,7 +81,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteService());
     }
diff --git a/src/Identity/v3/Models/User.php b/src/Identity/v3/Models/User.php
@@ -81,7 +81,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->execute($this->api->deleteUser(), ['id' => $this->id]);
     }
diff --git a/src/Images/v2/Models/Image.php b/src/Images/v2/Models/Image.php
@@ -181,7 +181,7 @@ function (Alias $a) {
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteImage());
     }
diff --git a/src/Images/v2/Models/Member.php b/src/Images/v2/Models/Member.php
@@ -67,7 +67,7 @@ public function retrieve()
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteImageMember());
     }
diff --git a/src/Networking/v2/Extensions/Layer3/Models/FloatingIp.php b/src/Networking/v2/Extensions/Layer3/Models/FloatingIp.php
@@ -64,7 +64,7 @@ public function update()
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteFloatingIp());
     }
diff --git a/src/Networking/v2/Extensions/Layer3/Models/Router.php b/src/Networking/v2/Extensions/Layer3/Models/Router.php
@@ -76,7 +76,7 @@ public function retrieve()
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteRouter());
     }
diff --git a/src/Networking/v2/Extensions/SecurityGroups/Models/SecurityGroup.php b/src/Networking/v2/Extensions/SecurityGroups/Models/SecurityGroup.php
@@ -75,7 +75,7 @@ public function create(array $userOptions): Creatable
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteSecurityGroup());
     }
diff --git a/src/Networking/v2/Extensions/SecurityGroups/Models/SecurityGroupRule.php b/src/Networking/v2/Extensions/SecurityGroups/Models/SecurityGroupRule.php
@@ -93,7 +93,7 @@ public function create(array $userOptions): Creatable
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteSecurityRule());
     }
diff --git a/src/Networking/v2/Models/LoadBalancer.php b/src/Networking/v2/Models/LoadBalancer.php
@@ -122,7 +122,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteLoadBalancer());
     }
diff --git a/src/Networking/v2/Models/LoadBalancerHealthMonitor.php b/src/Networking/v2/Models/LoadBalancerHealthMonitor.php
@@ -145,7 +145,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteLoadBalancerHealthMonitor());
     }
diff --git a/src/Networking/v2/Models/LoadBalancerListener.php b/src/Networking/v2/Models/LoadBalancerListener.php
@@ -145,7 +145,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteLoadBalancerListener());
     }
diff --git a/src/Networking/v2/Models/LoadBalancerMember.php b/src/Networking/v2/Models/LoadBalancerMember.php
@@ -113,7 +113,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteLoadBalancerMember(), ['poolId' => (string) $this->poolId, 'id' => (string) $this->id]);
     }
diff --git a/src/Networking/v2/Models/LoadBalancerPool.php b/src/Networking/v2/Models/LoadBalancerPool.php
@@ -146,7 +146,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteLoadBalancerPool());
     }
diff --git a/src/Networking/v2/Models/Network.php b/src/Networking/v2/Models/Network.php
@@ -100,7 +100,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteNetwork());
     }
diff --git a/src/Networking/v2/Models/Port.php b/src/Networking/v2/Models/Port.php
@@ -165,7 +165,7 @@ public function update()
         $this->populateFromResponse($response);
     }
 
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deletePort());
     }
diff --git a/src/Networking/v2/Models/Quota.php b/src/Networking/v2/Models/Quota.php
@@ -98,7 +98,7 @@ public function update()
     /**
      * {@inheritdoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteQuota());
     }
diff --git a/src/Networking/v2/Models/RbacPolicy.php b/src/Networking/v2/Models/RbacPolicy.php
@@ -105,7 +105,7 @@ public function retrieve()
     /**
      * {@inheritDoc}
      */
-    public function delete()
+    public function delete(array $userOptions = [])
     {
         $this->executeWithState($this->api->deleteRbacPolicy());
     }
diff --git a/src/Networking/v2/Models/Subnet.php b/src/Networking/v2/Models/Subnet.php
diff --git a/src/ObjectStore/v1/Models/Container.php b/src/ObjectStore/v1/Models/Container.php
diff --git a/src/ObjectStore/v1/Models/StorageObject.php b/src/ObjectStore/v1/Models/StorageObject.php

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function update()`
`79`	`79`	`/**`
`80`	`80`	`* {@inheritdoc}`
`81`	`81`	`*/`
`82`		`- public function delete()`
	`82`	`+ public function delete(array $userOptions = [])`
`83`	`83`	`{`
`84`	`84`	`$response = $this->executeWithState($this->api->deleteQuotaSet());`
`85`	`85`	`$this->populateFromResponse($response);`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public function update()`
`98`	`98`	`$this->executeWithState($this->api->putSnapshot());`
`99`	`99`	`}`
`100`	`100`
`101`		`- public function delete()`
	`101`	`+ public function delete(array $userOptions = [])`
`102`	`102`	`{`
`103`	`103`	`$this->executeWithState($this->api->deleteSnapshot());`
`104`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public function update()`
`125`	`125`	`$this->populateFromResponse($response);`
`126`	`126`	`}`
`127`	`127`
`128`		`- public function delete()`
	`128`	`+ public function delete(array $userOptions = [])`
`129`	`129`	`{`
`130`	`130`	`$this->executeWithState($this->api->deleteVolume());`
`131`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function update()`
`39`	`39`	`$this->executeWithState($this->api->putType());`
`40`	`40`	`}`
`41`	`41`
`42`		`- public function delete()`
	`42`	`+ public function delete(array $userOptions = [])`
`43`	`43`	`{`
`44`	`44`	`$this->executeWithState($this->api->deleteType());`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public function update()`
`80`	`80`	`/**`
`81`	`81`	`* {@inheritdoc}`
`82`	`82`	`*/`
`83`		`- public function delete()`
	`83`	`+ public function delete(array $userOptions = [])`
`84`	`84`	`{`
`85`	`85`	`$response = $this->executeWithState($this->api->deleteQuotaSet());`
`86`	`86`	`$this->populateFromResponse($response);`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public function update()`
`99`	`99`	`$this->executeWithState($this->api->putSnapshot());`
`100`	`100`	`}`
`101`	`101`
`102`		`- public function delete()`
	`102`	`+ public function delete(array $userOptions = [])`
`103`	`103`	`{`
`104`	`104`	`$this->executeWithState($this->api->deleteSnapshot());`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,9 +126,10 @@ public function update()`
`126`	`126`	`$this->populateFromResponse($response);`
`127`	`127`	`}`
`128`	`128`
`129`		`- public function delete()`
	`129`	`+ public function delete(array $userOptions = [])`
`130`	`130`	`{`
`131`		`- $this->executeWithState($this->api->deleteVolume());`
	`131`	`+ $userOptions = array_merge($userOptions, ['id' => $this->id]);`
	`132`	`+ $this->execute($this->api->deleteVolume(), $userOptions);`
`132`	`133`	`}`
`133`	`134`
`134`	`135`	`public function getMetadata(): array`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function update()`
`40`	`40`	`$this->executeWithState($this->api->putType());`
`41`	`41`	`}`
`42`	`42`
`43`		`- public function delete()`
	`43`	`+ public function delete(array $userOptions = [])`
`44`	`44`	`{`
`45`	`45`	`$this->executeWithState($this->api->deleteType());`
`46`	`46`	`}`