Merge pull request DigitalOceanPHP#133 from yassirh/master

Updated the docs
caseyhen · Jul 14, 2016 · d945a30 · d945a30
2 parents 83aa153 + 5e29896
commit d945a30
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+2.1.1 (Not released yet)
+------------------
+
+- Added support for Volumes (Block Storage)
+
 2.1.0 (2015-12-22)
 ------------------
 

diff --git a/README.md b/README.md
@@ -436,6 +436,36 @@ $rateLimit = $digitalocean->rateLimit();
 $currentLimit = $rateLimit->getRateLimit();
 ```
 
+Volume
+---------
+
+```php
+// ..
+// return the volume api
+$volume = $digitalocean->volume();
+
+// returns the all volumes
+$volumes = $volume->getAll();
+
+// returns the all volumes by region
+$volumes = $volume->getAll('nyc1');
+
+// returns volumes by name and region
+$volumes = $volume->getByNameAndRegion('example', 'nyc1');
+
+// returns a volume by id
+$myvolume = $volume->getById('506f78a4-e098-11e5-ad9f-000f53306ae1');
+
+// creates a volume
+$myvolume = $volume->create('example', 'Block store for examples', 10, 'nyc1');
+
+// deletes a volume by id
+$volume->delete('506f78a4-e098-11e5-ad9f-000f53306ae1');
+
+// deletes a volume by name and region
+$volume->delete('example', 'nyc1');
+```
+
 Specification tests
 -------------------
 

diff --git a/src/DigitalOceanV2.php b/src/DigitalOceanV2.php
@@ -23,6 +23,7 @@
 use DigitalOceanV2\Api\RateLimit;
 use DigitalOceanV2\Api\Region;
 use DigitalOceanV2\Api\Size;
+use DigitalOceanV2\Api\Volume;
 
 /**
  * @author Antoine Corcy <contact@sbin.dk>
@@ -130,4 +131,12 @@ public function size()
     {
         return new Size($this->adapter);
     }
+
+    /**
+     * @return Volume
+     */
+    public function volume()
+    {
+        return new Volume($this->adapter);
+    }
 }