<?php
/**
 * A PhpRequirements filter for chat
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2012 Chat Developer Teama
 * @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 ChatPhpRequirementsFilter extends BaseChatFilter implements Filterable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this filter class
	 *
	 * @return	$filterInstance		An instance of this filter class
	 */
	public static final function createChatPhpRequirementsFilter () {
		// Get a new instance
		$filterInstance = new ChatPhpRequirementsFilter();

		// Return the instance
		return $filterInstance;
	}

	/**
	 * Executes the filter with given request and response objects
	 *
	 * @param	$requestInstance	An instance of a class with an Requestable interface
	 * @param	$responseInstance	An instance of a class with an Responseable interface
	 * @return	void
	 * @throws	FilterChainException	If a required PHP function is not available
	 * @todo	Add more test and try to add an extra message to the thrown exception
	 */
	public function execute (Requestable $requestInstance, Responseable $responseInstance) {
		// By default, the requirement check is passed and zero checks are failed
		$checkPassed = TRUE;
		$checksFailed = 0;

		// Socket support is essential...
		if (!function_exists('socket_create')) {
			// Test failed
			$checkPassed = FALSE;
			$checksFailed++;
		} // END -if

		// Are all tests passed?
		if ($checkPassed === FALSE) {
			// Throw an exception
			throw new FilterChainException($this, self::FILTER_CHAIN_INTERCEPTED);
		} // END - if
	}
}

// [EOF]
?>