Moved visitor stuff from 'hub'.
authorRoland Haeder <roland@mxchange.org>
Tue, 24 Mar 2015 20:27:47 +0000 (21:27 +0100)
committerRoland Haeder <roland@mxchange.org>
Tue, 24 Mar 2015 20:28:35 +0000 (21:28 +0100)
Signed-off-by: Roland H├Ąder <roland@mxchange.org>
13 files changed:
inc/classes/interfaces/visitor/.htaccess [new file with mode: 0644]
inc/classes/interfaces/visitor/class_Visitable.php [new file with mode: 0644]
inc/classes/interfaces/visitor/class_Visitor.php [new file with mode: 0644]
inc/classes/interfaces/visitor/tasks/.htaccess [new file with mode: 0644]
inc/classes/interfaces/visitor/tasks/class_TaskVisitor.php [new file with mode: 0644]
inc/classes/main/iterator/default/class_DefaultIterator.php
inc/classes/main/visitor/.htaccess [new file with mode: 0644]
inc/classes/main/visitor/class_ [new file with mode: 0644]
inc/classes/main/visitor/class_BaseVisitor.php [new file with mode: 0644]
inc/classes/main/visitor/tasks/.htaccess [new file with mode: 0644]
inc/classes/main/visitor/tasks/class_ActiveTaskVisitor.php [new file with mode: 0644]
inc/classes/main/visitor/tasks/class_ShutdownTaskVisitor.php [new file with mode: 0644]
inc/config.php

diff --git a/inc/classes/interfaces/visitor/.htaccess b/inc/classes/interfaces/visitor/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
diff --git a/inc/classes/interfaces/visitor/class_Visitable.php b/inc/classes/interfaces/visitor/class_Visitable.php
new file mode 100644 (file)
index 0000000..149b671
--- /dev/null
@@ -0,0 +1,35 @@
+<?php
+/**
+ * An interface for a visitable class that 'accepts' visitors
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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/>.
+ */
+interface Visitable extends FrameworkInterface {
+       /**
+        * Accepts the visitor to process the visit "request"
+        *
+        * @param       $visitorInstance        An instance of a Visitor class
+        * @return      void
+        */
+       function accept (Visitor $visitorInstance);
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/interfaces/visitor/class_Visitor.php b/inc/classes/interfaces/visitor/class_Visitor.php
new file mode 100644 (file)
index 0000000..96e9cee
--- /dev/null
@@ -0,0 +1,28 @@
+<?php
+/**
+ * An interface for the visitor implementation
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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/>.
+ */
+interface Visitor extends FrameworkInterface {
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/interfaces/visitor/tasks/.htaccess b/inc/classes/interfaces/visitor/tasks/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
diff --git a/inc/classes/interfaces/visitor/tasks/class_TaskVisitor.php b/inc/classes/interfaces/visitor/tasks/class_TaskVisitor.php
new file mode 100644 (file)
index 0000000..b729a42
--- /dev/null
@@ -0,0 +1,35 @@
+<?php
+/**
+ * An interface for the visitor implementation for tasks
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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/>.
+ */
+interface TaskVisitor extends Visitor {
+       /**
+        * Visits the given task instance
+        *
+        * @param       $taskInstance   A Taskable instance
+        * @return      void
+        */
+       function visitTask (Taskable $taskInstance);
+}
+
+// [EOF]
+?>
index eed6318..81050c5 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
diff --git a/inc/classes/main/visitor/.htaccess b/inc/classes/main/visitor/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
diff --git a/inc/classes/main/visitor/class_ b/inc/classes/main/visitor/class_
new file mode 100644 (file)
index 0000000..e1ccf27
--- /dev/null
@@ -0,0 +1,53 @@
+<?php
+/**
+ * A ??? visitor
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @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 ???Visitor extends BaseVisitor implements Visitor {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+
+               // Set visitor mode
+               $this->setVisitorMode('!!!');
+       }
+
+       /**
+        * Creates an instance of this class
+        *
+        * @return      $visitorInstance        An instance a Visitorable class
+        */
+       public final static function create???Visitor () {
+               // Get new instance
+               $visitorInstance = new ???Visitor();
+
+               // Return the prepared instance
+               return $visitorInstance;
+       }
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/main/visitor/class_BaseVisitor.php b/inc/classes/main/visitor/class_BaseVisitor.php
new file mode 100644 (file)
index 0000000..185588f
--- /dev/null
@@ -0,0 +1,62 @@
+<?php
+/**
+ * A general visitor class
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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 BaseVisitor extends BaseFrameworkSystem {
+       /**
+        * Mode of the visitor (the first word of the concrete class' name)
+        */
+       private $visitorMode = 'invalid';
+
+       /**
+        * Protected constructor
+        *
+        * @param       $className      Name of the class
+        * @return      void
+        */
+       protected function __construct ($className) {
+               // Call parent constructor
+               parent::__construct($className);
+       }
+
+       /**
+        * Setter for visitor mode
+        *
+        * @param       $visitorMode    New visitor mode to set
+        * @return      void
+        */
+       protected final function setVisitorMode ($visitorMode) {
+               $this->visitorMode = (string) $visitorMode;
+       }
+
+       /**
+        * Getter for visitor mode
+        *
+        * @return      $visitorMode    New visitor mode to set
+        */
+       public final function getVisitorMode () {
+               return $this->visitorMode;
+       }
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/main/visitor/tasks/.htaccess b/inc/classes/main/visitor/tasks/.htaccess
new file mode 100644 (file)
index 0000000..3a42882
--- /dev/null
@@ -0,0 +1 @@
+Deny from all
diff --git a/inc/classes/main/visitor/tasks/class_ActiveTaskVisitor.php b/inc/classes/main/visitor/tasks/class_ActiveTaskVisitor.php
new file mode 100644 (file)
index 0000000..ec34867
--- /dev/null
@@ -0,0 +1,104 @@
+<?php
+/**
+ * An ActiveTask visitor
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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 ActiveTaskVisitor extends BaseVisitor implements TaskVisitor, PoolVisitor, ListenerVisitor, DecoratorVisitor {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+
+               // Set visitor mode
+               $this->setVisitorMode('task');
+       }
+
+       /**
+        * Creates an instance of this class
+        *
+        * @return      $visitorInstance        An instance a Visitorable class
+        */
+       public static final function createActiveTaskVisitor () {
+               // Get new instance
+               $visitorInstance = new ActiveTaskVisitor();
+
+               // Return the prepared instance
+               return $visitorInstance;
+       }
+
+       /**
+        * Visits the given task instance
+        *
+        * @param       $taskInstance   A Taskable instance
+        * @return      void
+        */
+       public function visitTask (Taskable $taskInstance) {
+               // Execute the task from this visitor
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting task ' . $taskInstance->__toString() . ' - CALLED!');
+               $taskInstance->executeTask();
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting task ' . $taskInstance->__toString() . ' - EXIT!');
+       }
+
+       /**
+        * Pool visitor method for active tasks
+        *
+        * @param       $poolInstance   A Poolable instance
+        * @return      void
+        */
+       public function visitPool (Poolable $poolInstance) {
+               /**
+                * We don't need to visit a pool as an active task because a pool can
+                * never become a task. Instead e.g. by a listener pool we should visit
+                * all listeners one by one
+                */
+       }
+
+       /**
+        * Visits the given listener instance
+        *
+        * @param       $listenerInstance       A Listenable instance
+        * @return      void
+        */
+       public function visitListener (Listenable $listenerInstance) {
+               // Do "listen" here
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting ' . $listenerInstance->__toString() . ' - CALLED!');
+               $listenerInstance->doListen();
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting ' . $listenerInstance->__toString() . ' - FINISH');
+       }
+
+       /**
+        * Visits the given decorator instance
+        *
+        * @param       $decoratorInstance      A decorator instance
+        * @return      void
+        */
+       public function visitDecorator (BaseDecorator $decoratorInstance) {
+               // A decorator itself can never become an active task so this method
+               // remains empty.
+       }
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/main/visitor/tasks/class_ShutdownTaskVisitor.php b/inc/classes/main/visitor/tasks/class_ShutdownTaskVisitor.php
new file mode 100644 (file)
index 0000000..4fc037e
--- /dev/null
@@ -0,0 +1,97 @@
+<?php
+/**
+ * An ShutdownTask visitor
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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 ShutdownTaskVisitor extends BaseVisitor implements TaskVisitor, PoolVisitor, ListenerVisitor, DecoratorVisitor {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+
+               // Set visitor mode
+               $this->setVisitorMode('task');
+       }
+
+       /**
+        * Creates an instance of this class
+        *
+        * @return      $visitorInstance                An instance a Visitorable class
+        */
+       public static final function createShutdownTaskVisitor () {
+               // Get new instance
+               $visitorInstance = new ShutdownTaskVisitor();
+
+               // Return the prepared instance
+               return $visitorInstance;
+       }
+
+       /**
+        * Visits the given task instance
+        *
+        * @param       $taskInstance   A Taskable instance
+        * @return      void
+        */
+       public function visitTask (Taskable $taskInstance) {
+               // Shutdown the task instance
+               $taskInstance->doShutdown();
+       }
+
+       /**
+        * Pool visitor method for active tasks
+        *
+        * @param       $poolInstance   A Poolable instance
+        * @return      void
+        */
+       public function visitPool (Poolable $poolInstance) {
+               // Shutdown the pool instance
+               $poolInstance->doShutdown();
+       }
+
+       /**
+        * Visits the given listener instance
+        *
+        * @param       $listenerInstance       A Listenable instance
+        * @return      void
+        */
+       public function visitListener (Listenable $listenerInstance) {
+               // Shutdown the listener instance
+               $listenerInstance->doShutdown();
+       }
+
+       /**
+        * Visits the given decorator instance
+        *
+        * @param       $decoratorInstance      A decorator instance
+        * @return      void
+        */
+       public function visitDecorator (BaseDecorator $decoratorInstance) {
+               // Shutdown the decorator instance
+               $decoratorInstance->doShutdown();
+       }
+}
+
+// [EOF]
+?>
index 1bfdc40..6ad91b6 100644 (file)
@@ -416,5 +416,8 @@ $cfg->setConfigEntry('list_group_class', 'ListGroupList');
 // CFG: DEFAULT-ITERATOR-CLASS
 $cfg->setConfigEntry('default_iterator_class', 'DefaultIterator');
 
+// CFG: ACTIVE-TASK-VISITOR-CLASS
+$cfg->setConfigEntry('active_task_visitor_class', 'ActiveTaskVisitor');
+
 // [EOF]
 ?>