FileNameMapper.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. <?php
  2. /*
  3. * $Id: FileNameMapper.php 905 2010-10-05 16:28:03Z 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. * Interface for filename mapper classes.
  23. *
  24. * @author Andreas Aderhold, andi@binarycloud.com
  25. * @author Hans Lellelid <hans@xmpl.org>
  26. * @version $Revision: 905 $
  27. * @package phing.mappers
  28. */
  29. interface FileNameMapper {
  30. /**
  31. * The mapper implementation.
  32. *
  33. * @param mixed $sourceFileName The data the mapper works on.
  34. * @return array The data after the mapper has been applied; must be in array format (for some reason).
  35. */
  36. public function main($sourceFileName);
  37. /**
  38. * Accessor. Sets the to property. The actual implementation
  39. * depends on the child class.
  40. *
  41. * @param string $to To what this mapper should convert the from string
  42. * @return void
  43. */
  44. public function setTo($to);
  45. /**
  46. * Accessor. Sets the from property. What this mapper should
  47. * recognize. The actual implementation is dependent upon the
  48. * child class
  49. *
  50. * @param string $from On what this mapper should work
  51. * @return void
  52. */
  53. public function setFrom($from);
  54. }