<?php

/**
 * Page DocBlock definition
 * @package org.zadara.marius.pax
 */

/**
 * Pattern interface.
 * 
 * @author Marius Zadara <hide@address.com>
 * @category Interfaces
 * @copyright (C) 2008-2009 Marius Zadara
 * @license Free for non-comercial use
 * @package org.zadara.marius.pax
 * @see IPAXObject
 * @since 5.0 
 */
interface IPattern extends IPAXObject  
{
	/**
	 * Method to make the instructions search pattern.
	 *
	 * @access public
	 * @param string $startDelimiter The pattern's start delimiter
	 * @param string $endDelimiter The pattern's end delimiter
	 * @return string
	 */
	public function makeInstructionSearchPattern($startDelimiter, $endDelimiter);
	
	/**
	 * Method to create the instruction replacement pattern.
	 *
	 * @access public
	 * @param string $instruction The instruction search for
	 * @param string $startDelimiter The pattern's start delimiter 
	 * @param string $endDelimiter The pattern's end delimiter
	 * @return string
	 */
	public function makeInstructionReplacePattern($instruction, $startDelimiter, $endDelimiter);	
}

?>