74 lines
2.7 KiB
PHP
74 lines
2.7 KiB
PHP
<?php
|
|
/*
|
|
* $Id: RegexpEngine.php 905 2010-10-05 16:28:03Z mrook $
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the LGPL. For more information please see
|
|
* <http://phing.info>.
|
|
*/
|
|
|
|
/**
|
|
* Contains some shared attributes and methods -- and some abstract methods with
|
|
* engine-specific implementations that sub-classes must override.
|
|
*
|
|
* @author Hans Lellelid <hans@velum.net>
|
|
* @package phing.util.regex
|
|
* @version $Revision: 905 $
|
|
*/
|
|
interface RegexpEngine {
|
|
|
|
/**
|
|
* Sets whether or not regex operation should ingore case.
|
|
* @param boolean $bit
|
|
* @return void
|
|
*/
|
|
public function setIgnoreCase($bit);
|
|
|
|
/**
|
|
* Returns status of ignore case flag.
|
|
* @return boolean
|
|
*/
|
|
public function getIgnoreCase();
|
|
|
|
/**
|
|
* Matches pattern against source string and sets the matches array.
|
|
* @param string $pattern The regex pattern to match.
|
|
* @param string $source The source string.
|
|
* @param array $matches The array in which to store matches.
|
|
* @return boolean Success of matching operation.
|
|
*/
|
|
function match($pattern, $source, &$matches);
|
|
|
|
/**
|
|
* Matches all patterns in source string and sets the matches array.
|
|
* @param string $pattern The regex pattern to match.
|
|
* @param string $source The source string.
|
|
* @param array $matches The array in which to store matches.
|
|
* @return boolean Success of matching operation.
|
|
*/
|
|
function matchAll($pattern, $source, &$matches);
|
|
|
|
/**
|
|
* Replaces $pattern with $replace in $source string.
|
|
* @param string $pattern The regex pattern to match.
|
|
* @param string $replace The string with which to replace matches.
|
|
* @param string $source The source string.
|
|
* @return string The replaced source string.
|
|
*/
|
|
function replace($pattern, $replace, $source);
|
|
|
|
}
|
|
|