Corrected method desriptions in Dataset class.

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index 8560f7495b25b8445c0b2faa0218505b8d195508..2adc60c688902baa68c5d4f155701fe0aeb5465f 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -1,6 +1,7 @@
 <?php
 require_once("Exception.php");
 require_once("openmediavault/util.inc");
+require_once("Snapshot.php");
 
 /**
  * XXX detailed description
@@ -35,6 +36,14 @@ class OMVModuleZFSDataset {
      */
     private $properties;
 
+       /**
+        * Array with Snapshots associated to the Dataset
+        *
+        * @var         array $snapshots
+        * @access private
+        */
+       private $snapshots;
+
        // Associations
        // Operations
 
@@ -58,6 +67,14 @@ class OMVModuleZFSDataset {
                                continue;
                        }
                }
+               $qname = preg_quote($name . "@", '/');
+               $cmd = "zfs list -H -t snapshot";
+               $this->exec($cmd, $out, $res);
+               foreach ($out as $line) {
+                       if (preg_match('/^(' . $qname . '[^\s]+)\t.*$/', $line, $res)) {
+                               $this->snapshots[$res[1]] = new OMVModuleZFSSnapshot($res[1]);
+                       }
+               }
        }
 
        /**
@@ -81,10 +98,21 @@ class OMVModuleZFSDataset {
        }
 
        /**
-        * Get a single property value associated with the Dataset
+        * Get all Snapshots associated with the Dataset
         *
+        * @return array $snapshots
+        * @access public
+        */
+       public function getSnapshots() {
+               return $this->snapshots;
+       }
+
+       /**
+        * Get a single property value associated with the Dataset
+        * 
         * @param string $property Name of the property to fetch
-        * @return array The returned array key 0=property value and key 1=property source.
+        * @return array The returned array with the property. The property is an associative array with
+        * two elements, <value> and <source>.
         * @access public
         */
        public function getProperty($property) {
@@ -92,11 +120,10 @@ class OMVModuleZFSDataset {
        }
 
        /**
-        * Get an associative array of all properties associated with the Dataset.
-        *
-        * @return array $properties Each entry is an array where key 0=property value and key
-        * 1=property source.
-        *
+        * Get an associative array of all properties associated with the Snapshot
+        * 
+        * @return array $properties Each entry is an associative array with two elements
+        * <value> and <source>
         * @access public
         */
        public function getProperties() {
@@ -163,7 +190,6 @@ class OMVModuleZFSDataset {
                $this->mountPoint = $this->properties["mountpoint"]["value"];
        }
 
-
        /**
         * Destroy the Dataset.
         *
@@ -237,6 +263,32 @@ class OMVModuleZFSDataset {
                $this->updateProperty("mounted");
        }
 
+       /**
+        * Creates a Snapshot and adds it to the existing list of snapshots associated
+        * with the Dataset.
+        *
+        * @param string $snap_name Name of the Snapshot to create.
+        * @param array $properties Optional array of properties to set on Snapshot
+        * @return void
+        * @access public
+        */
+       public function addSnapshot($snap_name, array $properties = null) {
+               $snap = new OMVModuleZFSSnapshot($snap_name);
+               $snap->create($properties);
+               $this->snapshots[$snap_name] = $snap;
+       }
+
+       /**
+        * Destroys a Snapshot on commandline and removes it from the Dataset.
+        *
+        * @param string $snap_name Name of the Snapshot to delete.
+        * @return void
+        * @access public
+        */
+       public function deleteSnapshot($snap_name) {
+               $this->snapshots[$snap_name]->destroy();
+               unset($this->snapshots[$snap_name]);
+       }
 
        /**
         * Helper function to execute a command and throw an exception on error