Base updated from ship-simu code

[hub.git] / inc / classes / main / commands / class_BaseCommand.php

diff --git a/inc/classes/main/commands/class_BaseCommand.php b/inc/classes/main/commands/class_BaseCommand.php
new file mode 100644 (file)
index 0000000..825b2b0
--- /dev/null
+++ b/inc/classes/main/commands/class_BaseCommand.php
@@ -0,0 +1,85 @@
+<?php
+/**
+ * A general (base) command
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class BaseCommand extends BaseFrameworkSystem {
+       /**
+        * The controller we need for this command
+        */
+       private $controllerName = "";
+
+       /**
+        * Resolver instance
+        */
+       private $resolverInstance = null;
+
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct ($class) {
+               // Call parent constructor
+               parent::__construct($class);
+       }
+
+       /**
+        * Setter for controller name
+        *
+        * @param       $controllerName         Name of the controller assigned with this command
+        * @return      void
+        */
+       public final function setControllerName ($controllerName) {
+               $this->controllerName = (string) $controllerName;
+       }
+
+       /**
+        * Getter for controller name
+        *
+        * @return      $controllerName         Name of the controller assigned with this command
+        */
+       public final function getControllerName () {
+               return $this->controllerName;
+       }
+
+       /**
+        * Setter for resolver instance
+        *
+        * @param       $resolverInstance               Instance of a command resolver class
+        * @return      void
+        */
+       public final function setResolverInstance (CommandResolver $resolverInstance) {
+               $this->resolverInstance = $resolverInstance;
+       }
+
+       /**
+        * Getter for resolver instance
+        *
+        * @return      $resolverInstance               Instance of a command resolver class
+        */
+       public final function getResolverInstance () {
+               return $this->resolverInstance;
+       }
+}
+
+// [EOF]
+?>