| 1 |
lars |
1 |
<?php
|
|
|
2 |
/*
|
|
|
3 |
* $Id: FileNameMapper.php 123 2006-09-14 20:19:08Z mrook $
|
|
|
4 |
*
|
|
|
5 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
6 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
7 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
8 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
9 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
10 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
11 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
12 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
13 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
14 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
15 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
16 |
*
|
|
|
17 |
* This software consists of voluntary contributions made by many individuals
|
|
|
18 |
* and is licensed under the LGPL. For more information please see
|
|
|
19 |
* <http://phing.info>.
|
|
|
20 |
*/
|
|
|
21 |
|
|
|
22 |
/**
|
|
|
23 |
* Interface for filename mapper classes.
|
|
|
24 |
*
|
|
|
25 |
* @author Andreas Aderhold, andi@binarycloud.com
|
|
|
26 |
* @author Hans Lellelid <hans@xmpl.org>
|
|
|
27 |
* @version $Revision: 1.7 $
|
|
|
28 |
* @package phing.mappers
|
|
|
29 |
*/
|
|
|
30 |
interface FileNameMapper {
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* The mapper implementation.
|
|
|
34 |
*
|
|
|
35 |
* @param mixed $sourceFileName The data the mapper works on.
|
|
|
36 |
* @return array The data after the mapper has been applied; must be in array format (for some reason).
|
|
|
37 |
*/
|
|
|
38 |
public function main($sourceFileName);
|
|
|
39 |
|
|
|
40 |
/**
|
|
|
41 |
* Accessor. Sets the to property. The actual implementation
|
|
|
42 |
* depends on the child class.
|
|
|
43 |
*
|
|
|
44 |
* @param string $to To what this mapper should convert the from string
|
|
|
45 |
* @return void
|
|
|
46 |
*/
|
|
|
47 |
public function setTo($to);
|
|
|
48 |
|
|
|
49 |
/**
|
|
|
50 |
* Accessor. Sets the from property. What this mapper should
|
|
|
51 |
* recognize. The actual implementation is dependent upon the
|
|
|
52 |
* child class
|
|
|
53 |
*
|
|
|
54 |
* @param string $from On what this mapper should work
|
|
|
55 |
* @return void
|
|
|
56 |
*/
|
|
|
57 |
public function setFrom($from);
|
|
|
58 |
|
|
|
59 |
}
|