types/selectors/FileSelector.php

Show: inherited
    Table of Contents

    This is the interface to be used by all selectors.

    Author
    Hans Lellelid, hans@xmpl.org (Phing)  
    Author
    Bruce Atherton, bruce@callenish.com (Ant)  
    Package
    phing.types.selectors  

    \FileSelector

    Package: phing\types\selectors

    This is the interface to be used by all selectors.

    Children
    \BaseSelector
    Author
    Hans Lellelid, hans@xmpl.org (Phing)  
    Author
    Bruce Atherton, bruce@callenish.com (Ant)  

    Methods

    methodpublicisSelected( \basedir $basedir, \filename $filename, \file $file ) : \whether

    Method that each selector will implement to create their selection behaviour. If there is a problem with the setup of a selector, it can throw a BuildException to indicate the problem.

    Parameters
    Name Type Description
    $basedir \basedir

    A PhingFile object for the base directory

    $filename \filename

    The name of the file to check

    $file \file

    A PhingFile object for this filename

    Returns
    Type Description
    \whether the file should be selected or not
    Throws
    Exception Description
    \BuildException if the selector was not configured correctly
    Documentation was generated by DocBlox 0.18.1.