Add more in-depth support for object lifecycle management #1318

dwsupplee · 2018-09-24T21:15:13Z

With this change set Google\Cloud\Storage\StorageClient::createBucket() and Google\Cloud\Storage\Bucket::update() can now both accept an instance of Google\Cloud\Storage\Lifecycle as opposed to a raw array.

Sample usage:

use Google\Cloud\Storage\Bucket;
use Google\Cloud\Storage\StorageClient;

$storage = new StorageClient;
$bucket = $storage->createBucket('myBeautifulBucket', [
    'lifecycle' => Bucket::lifecycle()
        ->addDeleteRule([
            'age' => 50
        ])
]);

/cc @frankyn

jdpedrie

just one documentation suggestion. looks really nice!

Storage/src/Lifecycle.php

+     *        providing a callable you may define a custom route for how you
+     *        would like to remove rules. The provided callable will be run
+     *        through
+     *        [array_filter](http://php.net/manual/en/function.array-filter.php).


Storage/src/Bucket.php

@@ -779,7 +779,7 @@ public function delete(array $options = [])
     *           configuration.
     *     @type array $defaultObjectAcl Default access controls to apply to new
     *           objects when no ACL is provided.
-     *     @type array $lifecycle The bucket's lifecycle configuration.
+     *     @type array|Lifecycle $lifecycle The bucket's lifecycle configuration.


Storage/src/Bucket.php

@@ -779,7 +779,7 @@ public function delete(array $options = [])
     *           configuration.
     *     @type array $defaultObjectAcl Default access controls to apply to new
     *           objects when no ACL is provided.
-     *     @type array $lifecycle The bucket's lifecycle configuration.
+     *     @type array|Lifecycle $lifecycle The bucket's lifecycle configuration.


Storage/src/Lifecycle.php

+    }
+
+    /**
+     * @access private


Storage/src/Bucket.php

+     *     ->addDeleteRule([
+     *         'age' => 50,
+     *         'isLive' => true
+     *     ]);


Storage/src/Lifecycle.php

+     * @throws \InvalidArgumentException If a type other than a string or
+     *         callabe is provided.
+     */
+    public function clearRules($condition = null)


Storage/src/Lifecycle.php

+    }
+
+    /**
+     * Adds a delete rule.


Storage/src/Lifecycle.php

+     * @throws \InvalidArgumentException If a type other than a string or
+     *         callabe is provided.
+     */
+    public function clearRules($condition = null)


Storage/src/Lifecycle.php

+    }
+
+    /**
+     * Adds a set storage class rule.


Storage/src/Lifecycle.php

+    }
+
+    /**
+     * Clears out rules based on the provided condition.


Storage/src/Lifecycle.php

+ *
+ * @see https://cloud.google.com/storage/docs/lifecycle Object Lifecycle Management API Documentation
+ */
+class Lifecycle


dwsupplee · 2018-09-25T21:08:56Z

Thank you for the review @frankyn. I touched on your feedback, PTAL.

tmatsuo

LG, with some minor comments

Storage/src/Lifecycle.php

+     * @param string $offset
+     * @param mixed $value
+     */
+    public function offsetSet($offset, $value)


Storage/src/Lifecycle.php

+     * @param string $offset
+     * @return mixed
+     */
+    public function offsetGet($offset)


frankyn

I like the update, pending follow-up discussions in comments and some minor nits.

Storage/src/Bucket.php

+     * @param array $options [optional] Configuration options.
+     * @return Lifecycle
+     */
+    public function currentLifecycle(array $options = [])


Storage/src/Lifecycle.php

+ *
+ * $storage = new StorageClient();
+ * $bucket = $storage->bucket('my-bucket');
+ * $lifecycle = $bucket->currentLifecycle();


frankyn

LGTM

Add more in-depth support for object lifecycle management

c85200d

dwsupplee added the api: storage Issues related to the Cloud Storage API. label Sep 24, 2018

dwsupplee requested review from tmatsuo and jdpedrie September 24, 2018 21:15

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 24, 2018

jdpedrie approved these changes Sep 25, 2018

View reviewed changes

tmatsuo reviewed Sep 25, 2018

View reviewed changes

clarify documentation for using a callable in clearRules

e2921f2

frankyn suggested changes Sep 25, 2018

View reviewed changes

dwsupplee added 3 commits September 25, 2018 16:36

code review updates

816efde

implement ArrayAccess and IteratorAggregate

7aeb2f8

Add example of iterating over existing rules

429b1c5

tmatsuo approved these changes Sep 25, 2018

View reviewed changes

frankyn suggested changes Sep 26, 2018

View reviewed changes

frankyn approved these changes Sep 27, 2018

View reviewed changes

dwsupplee merged commit 81c4a94 into googleapis:master Sep 27, 2018

tmatsuo mentioned this pull request Sep 27, 2018

Prepare v0.80.0 #1321

Merged

Add more in-depth support for object lifecycle management #1318

Add more in-depth support for object lifecycle management #1318

Conversation

dwsupplee commented Sep 24, 2018

jdpedrie left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

dwsupplee commented Sep 25, 2018

tmatsuo left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

frankyn left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

frankyn left a comment

Choose a reason for hiding this comment