phing-types-selectors

# Class: TypeSelector Source Location: /types/selectors/TypeSelector.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --BaseSelector
             |
             --BaseExtendSelector
                |
                --TypeSelector
Selector that selects a certain kind of file: directory or regular file. #### Author(s): Jeff Turner <jefft@apache.org> (Ant) Hans Lellelid <hans@xmpl.org> (Phing) #### Version: $Revision: 526 $ | ### Constants TYPE_KEY | ### Methods isSelected setParameters setType toString verifySettings
### Inherited Variables #### Class: BaseExtendSelector BaseExtendSelector::$parameters #### Class: DataType DataType::$checked DataType::$description DataType::$ref #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: BaseExtendSelector BaseExtendSelector::getParameters() Allows access to the parameters gathered and set within the &lt;custom&gt; tag. BaseExtendSelector::setParameters() Set all the Parameters for this custom selector, collected by the ExtendSelector class. #### Class: BaseSelector BaseSelector::getError() Returns any error messages that have been set. BaseSelector::setError() Allows all selectors to indicate a setup error. Note that only the first error message is recorded. BaseSelector::validate() Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition. BaseSelector::verifySettings() <p>Subclasses can override this method to provide checking of their #### Class: DataType DataType::circularReference() Creates an exception that indicates the user has generated a loop of data types referencing each other. DataType::dieOnCircularReference() Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself). DataType::getCheckedRef() Performs the check for circular references and returns the referenced object. DataType::getDescription() Return the description for the current data type. DataType::isReference() Has the refid attribute of this element been set? DataType::noChildrenAllowed() Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set. DataType::parsingComplete() Template method being called when the data type has been parsed completely. DataType::setDescription() Sets a description of the current data type. It will be useful in commenting what we are doing. DataType::setRefid() Set the value of the refid attribute. DataType::tooManyAttributes() Creates an exception that indicates that refid has to be the only attribute if it is set. #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 33] Selector that selects a certain kind of file: directory or regular file. #### Tags:
author: | Jeff Turner <jefft@apache.org> (Ant)
author: | Hans Lellelid <hans@xmpl.org> (Phing)
version: | $Revision: 526 $
[ Top ] ### Class Methods ### method isSelected [line 101]
`boolean isSelected( $basedir, string $filename, $file)`
The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset. #### Tags:
return: | Whether the file should be selected or not
access: | public
#### Parameters:
PhingFile | $basedir | the base directory the scan is being done from
string | $filename | is the name of the file to check
PhingFile | $file | is a PhingFile object the selector can use
[ Top ] ### method setParameters [line 65]
`void setParameters( array $parameters)`
When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call. #### Tags:
access: | public
Overrides BaseExtendSelector::setParameters() (Set all the Parameters for this custom selector, collected by the ExtendSelector class.) #### Parameters:
array | $parameters | the complete set of parameters for this selector
[ Top ] ### method setType [line 55]
`void setType( string $type)`
Set the type of file to require. #### Tags:
access: | public
#### Parameters:
string | $type | The type of file - 'file' or 'dir'
[ Top ] ### method toString [line 46]
`string toString( )`
#### Tags:
return: | A string describing this object
access: | public
[ Top ] ### method verifySettings [line 84]
`void verifySettings( )`
Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set. #### Tags:
access: | public
Overrides BaseSelector::verifySettings() (<p>Subclasses can override this method to provide checking of their) [ Top ] ### Class Constants #### TYPE_KEY = "type" [line 38] Key to used for parameterized custom selector [ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:17 +0200 by phpDocumentor 1.4.3