<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2008 Patrick Broens (patrick@patrickbroens.nl)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project 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 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script 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.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * Regular expression filter
 *
 * @author Patrick Broens <patrick@patrickbroens.nl>
 * @package TYPO3
 * @subpackage form
 */
class tx_form_System_Filter_Regexp implements tx_form_System_Filter_Interface {

	/**
	 * Regular expression for filter
	 *
	 * @var boolean
	 */
	protected $regularExpression;

	/**
	 * Constructor
	 *
	 * @param array $arguments Filter configuration
	 */
	public function __construct(array $arguments = array()) {
		$this->setRegularExpression($arguments['expression']);
	}

	/**
	 * Set the regular expression
	 *
	 * @param string $expression The regular expression
	 * @return void
	 */
	public function setRegularExpression($expression) {
		$this->regularExpression = (string) $expression;
	}

	/**
	 * Return filtered value
	 * Remove all characters found in regular expression
	 *
	 * @param  string $value
	 * @return string
	 */
	public function filter($value) {
		return preg_replace($this->regularExpression, '', (string) $value);
	}
}
?>