From: Michael Rasmussen <mir@datanom.net>
Date: Thu, 27 Feb 2014 01:19:25 +0000 (+0100)
Subject: added class templates
X-Git-Url: http://git.datanom.net/omvzfs.git/commitdiff_plain/f891182fc1ca2217dfab6d0a90cf30b22d03545b

added class templates
---

diff --git a/src/Dataset.php b/src/Dataset.php
new file mode 100644
index 0000000..210fc6e
--- /dev/null
+++ b/src/Dataset.php
@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ */
+class Dataset {
+    // Attributes
+    /**
+     * XXX
+     *
+     * @var    string $name
+     * @access private
+     */
+    private $_name;
+
+    /**
+     * XXX
+     *
+     * @var    int $size
+     * @access private
+     */
+    private $_size;
+
+    /**
+     * XXX
+     *
+     * @var    string $mountPoint
+     * @access private
+     */
+    private $_mountPoint;
+
+    /**
+     * XXX
+     *
+     * @var    array $features
+     * @access private
+     */
+    private $_features;
+
+    // Associations
+    // Operations
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getName() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return int XXX
+     * @access public
+     */
+    public function getSize() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getMountPoint() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return array XXX
+     * @access public
+     */
+    public function getFeatures() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  array XXX
+     * @return void XXX
+     * @access public
+     */
+    public function setFeatures($list<Feature>) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Mirror.php b/src/Mirror.php
new file mode 100644
index 0000000..d25edb4
--- /dev/null
+++ b/src/Mirror.php
@@ -0,0 +1,27 @@
+<?php
+require_once 'Vdev.php';
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ * @abstract
+ */
+class Mirror extends Vdev {
+
+    /**
+     * XXX
+     *
+     * @param  Disk $disk XXX
+     * @return void XXX
+     * @access public
+     */
+    public function removeDisk($disk) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Raidz1.php b/src/Raidz1.php
new file mode 100644
index 0000000..e352869
--- /dev/null
+++ b/src/Raidz1.php
@@ -0,0 +1,27 @@
+<?php
+require_once 'Vdev.php';
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ * @abstract
+ */
+class Raidz1 extends Vdev {
+
+    /**
+     * XXX
+     *
+     * @param  Disk $disk XXX
+     * @return void XXX
+     * @access public
+     */
+    public function removeDisk($disk) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Raidz2.php b/src/Raidz2.php
new file mode 100644
index 0000000..f09499b
--- /dev/null
+++ b/src/Raidz2.php
@@ -0,0 +1,27 @@
+<?php
+require_once 'Vdev.php';
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ * @abstract
+ */
+class Raidz2 extends Vdev {
+
+    /**
+     * XXX
+     *
+     * @param  Disk $disk XXX
+     * @return void XXX
+     * @access public
+     */
+    public function removeDisk($disk) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Raidz3.php b/src/Raidz3.php
new file mode 100644
index 0000000..38912b4
--- /dev/null
+++ b/src/Raidz3.php
@@ -0,0 +1,27 @@
+<?php
+require_once 'Vdev.php';
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ * @abstract
+ */
+class Raidz3 extends Vdev {
+
+    /**
+     * XXX
+     *
+     * @param  Disk $disk XXX
+     * @return void XXX
+     * @access public
+     */
+    public function removeDisk($disk) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Snapshot.php b/src/Snapshot.php
new file mode 100644
index 0000000..33a469a
--- /dev/null
+++ b/src/Snapshot.php
@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ */
+class Snapshot {
+    // Attributes
+    /**
+     * XXX
+     *
+     * @var    string $name
+     * @access private
+     */
+    private $_name;
+
+    /**
+     * XXX
+     *
+     * @var    int $size
+     * @access private
+     */
+    private $_size;
+
+    /**
+     * XXX
+     *
+     * @var    string $mountPoint
+     * @access private
+     */
+    private $_mountPoint;
+
+    /**
+     * XXX
+     *
+     * @var    list<Feature> $features
+     * @access private
+     */
+    private $_features;
+
+    // Associations
+    // Operations
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getName() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return int XXX
+     * @access public
+     */
+    public function getSize() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getMountPoint() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return list<Feature> XXX
+     * @access public
+     */
+    public function getFeatures() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param   $list<Feature> XXX
+     * @return void XXX
+     * @access public
+     */
+    public function setFeatures($list<Feature>) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Vdev.php b/src/Vdev.php
new file mode 100644
index 0000000..e740edf
--- /dev/null
+++ b/src/Vdev.php
@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ */
+class Vdev {
+    // Attributes
+    /**
+     * XXX
+     *
+     * @var    list<Disk> $disks
+     * @access private
+     */
+    protected $_disks;
+
+    // Associations
+    // Operations
+    /**
+     * XXX
+     *
+     * @param  Disk $disk XXX
+     * @return void XXX
+     * @access public
+     */
+    public function addDisk($disk) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Disk $disk XXX
+     * @return void XXX
+     * @access public
+     */
+    public abstract function removeDisk($disk) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return list<Disk> XXX
+     * @access public
+     */
+    public function getDisks() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>
diff --git a/src/Zpool.php b/src/Zpool.php
new file mode 100644
index 0000000..a2fee73
--- /dev/null
+++ b/src/Zpool.php
@@ -0,0 +1,377 @@
+<?php
+require_once 'Vdev.php';
+require_once 'Snapshot.php';
+require_once 'Dataset.php';
+require_once 'Zvol.php';
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ */
+class Zpool {
+    // Attributes
+    /**
+     * XXX
+     *
+     * @var    string $name
+     * @access private
+     */
+    private $_name;
+
+    /**
+     * XXX
+     *
+     * @var    list<Vdev> $vdevs
+     * @access private
+     */
+    private $_vdevs;
+
+    /**
+     * XXX
+     *
+     * @var    list<Disk> $spare
+     * @access private
+     */
+    private $_spare;
+
+    /**
+     * XXX
+     *
+     * @var    Log $log
+     * @access private
+     */
+    private $_log;
+
+    /**
+     * XXX
+     *
+     * @var    Cache $cache
+     * @access private
+     */
+    private $_cache;
+
+    /**
+     * XXX
+     *
+     * @var    int $size
+     * @access private
+     */
+    private $_size;
+
+    /**
+     * XXX
+     *
+     * @var    string $mountPoint
+     * @access private
+     */
+    private $_mountPoint;
+
+    /**
+     * XXX
+     *
+     * @var    list<Feature> $features
+     * @access private
+     */
+    private $_features;
+
+    // Associations
+    /**
+     * XXX
+     *
+     * @var    Snapshot $unnamed
+     * @access private
+     * @accociation Snapshot to unnamed
+     */
+    #var $unnamed;
+
+    /**
+     * XXX
+     *
+     * @var    Dataset $unnamed
+     * @access private
+     * @accociation Dataset to unnamed
+     */
+    #var $unnamed;
+
+    /**
+     * XXX
+     *
+     * @var    Zvol $unnamed
+     * @access private
+     * @accociation Zvol to unnamed
+     */
+    #var $unnamed;
+
+    /**
+     * XXX
+     *
+     * @var    Vdev $unnamed
+     * @access private
+     * @accociation Vdev to unnamed
+     */
+    #var $unnamed;
+
+    // Operations
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getName() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return list<Vdev> XXX
+     * @access public
+     */
+    public function getVdevs() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Vdev $vdev XXX
+     * @return void XXX
+     * @access public
+     */
+    public function addVdev($vdev) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Vdev $vdev XXX
+     * @return void XXX
+     * @access public
+     */
+    public function removeVdev($vdev) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Cache $cache XXX
+     * @return void XXX
+     * @access public
+     */
+    public function addCache($cache) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return void XXX
+     * @access public
+     */
+    public function removeCache() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return Cache XXX
+     * @access public
+     */
+    public function getCache() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Log $log XXX
+     * @return void XXX
+     * @access public
+     */
+    public function addLog($log) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return void XXX
+     * @access public
+     */
+    public function removeLog() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return Log XXX
+     * @access public
+     */
+    public function getLog() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Disk $spare XXX
+     * @return void XXX
+     * @access public
+     */
+    public function addSpare($spare) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  Disk $spare XXX
+     * @return void XXX
+     * @access public
+     */
+    public function removeSpare($spare) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return list<Disk> XXX
+     * @access public
+     */
+    public function getSpares() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return int XXX
+     * @access public
+     */
+    public function getSize() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getMountPoint() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  list<Feature> $features XXX
+     * @return void XXX
+     * @access public
+     */
+    public function setFeatures($features) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return list<Feature> XXX
+     * @access public
+     */
+    public function getFeatures() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return void XXX
+     * @access public
+     */
+    public function export() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param  string $name XXX
+     * @return void XXX
+     * @access public
+     */
+    public function import($name) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return void XXX
+     * @access public
+     */
+    public function scrub() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function status() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+	/**
+	 * XXX
+	 * org.openmediavault.module.service.<servicename>.start
+	 * org.openmediavault.module.service.<servicename>.stop
+	 * org.openmediavault.module.service.<servicename>.applyconfig
+	 *
+	 * @param string event
+	 * @access public
+	 */
+	public function onNotify($event) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+	}
+
+	/**
+	 * XXX
+	 *
+	 * @access public
+	 */
+	public function applyConfig() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+	}
+
+	/**
+	 * XXX
+	 *
+	 * @access public
+	 */
+	public function stopService() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+	}
+
+	/**
+	 * XXX
+	 *
+	 * @access public
+	 */
+	public function startService() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+	}
+}
+
+?>
diff --git a/src/Zvol.php b/src/Zvol.php
new file mode 100644
index 0000000..b5b5941
--- /dev/null
+++ b/src/Zvol.php
@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * XXX detailed description
+ *
+ * @author    XXX
+ * @version   XXX
+ * @copyright XXX
+ */
+class Zvol {
+    // Attributes
+    /**
+     * XXX
+     *
+     * @var    string $name
+     * @access private
+     */
+    private $_name;
+
+    /**
+     * XXX
+     *
+     * @var    int $size
+     * @access private
+     */
+    private $_size;
+
+    /**
+     * XXX
+     *
+     * @var    string $mountPoint
+     * @access private
+     */
+    private $_mountPoint;
+
+    /**
+     * XXX
+     *
+     * @var    list<Feature> $features
+     * @access private
+     */
+    private $_features;
+
+    // Associations
+    // Operations
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getName() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return int XXX
+     * @access public
+     */
+    public function getSize() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return string XXX
+     * @access public
+     */
+    public function getMountPoint() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @return list<Feature> XXX
+     * @access public
+     */
+    public function getFeatures() {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+    /**
+     * XXX
+     *
+     * @param   $list<Feature> XXX
+     * @return void XXX
+     * @access public
+     */
+    public function setFeatures($list<Feature>) {
+        trigger_error('Not Implemented!', E_USER_WARNING);
+    }
+
+}
+
+?>