mappers/FileNameMapper.php

Show: inherited
    Table of Contents

    Interface for filename mapper classes.

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

    \FileNameMapper

    Package: phing\mappers

    Interface for filename mapper classes.

    Children
    \IdentityMapper
    \RegexpMapper
    \GlobMapper
    \FlattenMapper
    \MergeMapper
    Author
    Andreas Aderhold, andi@binarycloud.com  
    Author
    Hans Lellelid  
    Version
    $Id$  

    Methods

    methodpublicmain( 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).
    methodpublicsetFrom( 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

    methodpublicsetTo( 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.18.1.