# mappers/FileNameMapper.php

Interface for filename mapper classes.

Author
  Andreas Aderhold, andi@binarycloud.com
Author
  Hans Lellelid
Package
  phing.mappers
Version
  $Revision: 526 $

## \FileNameMapper
jump to top

Package: phing\mappers

Interface for filename mapper classes.

Author
  Andreas Aderhold, andi@binarycloud.com
Author
  Hans Lellelid
Version
  $Revision: 526 $

### Methods

`main( mixed $sourceFileName ) : array`

The mapper implementation.

Parameters

Name | Type | Description
--- | --- | ---
$sourceFileName | mixed | The data the mapper works on.

Returns

Type | Description
--- | ---
array | The data after the mapper has been applied; must be in array format (for some reason).

`setFrom( string $from ) : void`

Accessor. Sets the from property. What this mapper should recognize. The actual implementation is dependent upon the child class

Parameters

Name | Type | Description
--- | --- | ---
$from | string | On what this mapper should work

`setTo( string $to ) : void`

Accessor. Sets the to property. The actual implementation depends on the child class.

Parameters

Name | Type | Description
--- | --- | ---
$to | string | To what this mapper should convert the from string

Documentation was generated by DocBlox 0.17.1.