<?php
/**
 * An ActiveTask visitor
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 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.
	}

}