Writing your own filename mapper classes will allow you to control how names are
transformed in tasks like CopyTask, MoveTask,
XSLTTask, etc. In some cases you may want to extend existing
mappers (e.g. creating a GlobMapper that also transforms to uppercase); in other cases,
you may simply want to create a very specific name transformation that isn't easily
accomplished with other mappers like GlobMapper or
RegexpMapper.
Writing filename mappers is simplified by interface support in PHP5. Essentially,
your custom filename mapper must implement
Phing\Mapper\FileNameMapper. Here's an example of a filename
mapper that creates DOS-style file names. For this example, the "to" and "from"
attributes are not needed because all files will be transformed. To see the "to" and
"from" attributes in action, look at Phing\Mapper\GlobMapper or
Phing\Mapper\RegexpMapper.
use Phing\Mapper\FileNameMapper;
/**
* A mapper that makes those ugly DOS filenames.
*/
class DOSMapper implements FileNameMapper {
/**
* The main() method actually performs the mapping.
*
* In this case we transform the $sourceFilename into
* a DOS-compatible name. E.g.
* ExtendingPhing.html -> EXTENDI~.DOC
*
* @param string $sourceFilename The name to be converted.
* @return array The matched filenames.
*/
public function main($sourceFilename) {
$info = pathinfo($sourceFilename);
$ext = $info['extension'];
// get basename w/o extension
$bname = preg_replace('/\.\w+\$/', '', $info['basename']);
if (strlen($bname) > 8) {
$bname = substr($bname,0,7) . '~';
}
if (strlen($ext) > 3) {
$ext = substr($bname,0,3);
}
if (!empty($ext)) {
$res = $bname . '.' . $ext;
} else {
$res = $bname;
}
return (array) strtoupper($res);
}
/**
* The "from" attribute is not needed here, but method must exist.
*/
public function setFrom($from) {}
/**
* The "from" attribute is not needed here, but method must exist.
*/
public function setTo($to) {}
}