Changed properties attribute to an associative array to get cleaner code

[omvzfs.git] / src / Dataset.php

diff --git a/src/Dataset.php b/src/Dataset.php
index 210fc6ea2f54e57fcb82d2d458f881115fedf661..f053faec54e05ff33781b8dcf4efb2a7378a598c 100644 (file)
--- a/src/Dataset.php
+++ b/src/Dataset.php
@@ -1,4 +1,6 @@
 <?php
+require_once("Exception.php");
+require_once("openmediavault/util.inc");
 
 /**
  * XXX detailed description
@@ -7,92 +9,145 @@
  * @version   XXX
  * @copyright XXX
  */
-class Dataset {
+class OMVModuleZFSDataset {
     // Attributes
     /**
-     * XXX
+     * Name of Dataset
      *
      * @var    string $name
      * @access private
      */
-    private $_name;
-
+    private $name;
     /**
-     * XXX
-     *
-     * @var    int $size
-     * @access private
-     */
-    private $_size;
-
-    /**
-     * XXX
+     * Mountpoint of the Dataset
      *
      * @var    string $mountPoint
      * @access private
      */
-    private $_mountPoint;
+    private $mountPoint;
 
     /**
-     * XXX
+     * Array with properties assigned to the Dataset
      *
-     * @var    array $features
+     * @var    array $properties
      * @access private
      */
-    private $_features;
+    private $properties;
 
-    // Associations
-    // Operations
-    /**
-     * XXX
-     *
-     * @return string XXX
-     * @access public
-     */
-    public function getName() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
+       // Associations
+       // Operations
 
-    /**
-     * XXX
-     *
-     * @return int XXX
-     * @access public
-     */
-    public function getSize() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
+       /**
+        * Constructor
+        *
+        * @param string $name Name of the new Dataset
+        * @param array $properties An associative array with properties to set when creating the Dataset
+        * @throws OMVModuleZFSException
+        *
+        */
+       public function __construct($name, array $properties = null) {
+               $cmd = "zfs create " . $name . " 2>&1";
+               OMVUtil::exec($cmd,$out,$res);
+               if ($res) {
+                       throw new OMVModuleZFSException(implode("\n", $out));
+               }
+               $this->name = $name;
+               $this->setProperties($properties);
+               $this->mountPoint = $this->properties["mountpoint"];
+       }
 
-    /**
-     * XXX
-     *
-     * @return string XXX
-     * @access public
-     */
-    public function getMountPoint() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
+       /**
+        * Return name of the Dataset
+        *
+        * @return string $name
+        * @access public
+        */
+       public function getName() {
+               return $this->name;
+       }
 
-    /**
-     * XXX
-     *
-     * @return array XXX
-     * @access public
-     */
-    public function getFeatures() {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
+       /**
+        * Get the mountpoint of the Dataset
+        *
+        * @return string $mountPoint
+        * @access public
+        */
+       public function getMountPoint() {
+               return $this->mountPoint;
+       }
 
-    /**
-     * XXX
-     *
-     * @param  array XXX
-     * @return void XXX
-     * @access public
-     */
-    public function setFeatures($list<Feature>) {
-        trigger_error('Not Implemented!', E_USER_WARNING);
-    }
+       /**
+        * Get a single property value associated with the Dataset
+        *
+        * @param string $property Name of the property to fetch
+        * @return string
+        * @access public
+        */
+       public function getProperty($property) {
+               return $this->properties["$property"];
+       }
+
+       /**
+        * Get an array of all properties associated with the Dataset
+        *
+        * @return array $properties
+        * @access public
+        */
+       public function getProperties() {
+               return $this->properties;
+       }
+
+       /**
+        * Sets a number of Dataset properties. If a property is already set it will be updated with the new value.
+        *
+        * @param  array $properties An associative array with properties to set
+        * @return void
+        * @access public
+        */
+       public function setProperties($properties) {
+               foreach ($properties as $newpropertyk => $newpropertyv) {
+                       $cmd = "zfs set " . $newpropertyk . "=" . $newpropertyv . " " . $this->name;
+                       OMVUtil::exec($cmd,$out,$res);
+                       if ($res) {
+                               throw new OMVModuleZFSException(implode("\n", $out));
+                       }
+                       $this->properties["$newpropertyk"] = $newpropertyv;
+               }
+               $this->updateAllProperties();
+       }
+
+       /**
+        * Get all Dataset properties from commandline and update object properties attribute
+        *
+        * @throws OMVModuleZFSException
+        * @access private
+        */ 
+       private function updateAllProperties() {
+               $cmd = "zfs get -H all " . $this->name;
+               OMVUtil::exec($cmd,$out,$res);
+               if ($res) {
+                       throw new OMVModuleZFSException(implode("\n", $out));
+               }
+               unset($this->properties);
+               foreach ($out as $line) {
+                       $tmpary = preg_split('/\t+/', $line);
+                       $this->properties["$tmpary[1]"] = $tmpary[2];
+               }
+       }
+
+       /**
+        * Destroy the Dataset.
+        *
+        * @throws OMVModuleZFSException
+        * @access public
+        */
+       public function destroy() {
+               $cmd = "zfs destroy " . $this->name;
+               OMVUtil::exec($cmd,$out,$res);
+               if ($res) {
+                       throw new OMVModuleZFSException(implode("\n", $out));
+               }
+       }
 
 }