phing-types-selectors

# Class: BaseExtendSelector Source Location: /types/selectors/BaseExtendSelector.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --BaseSelector
             |
             --BaseExtendSelector
Convenience base class for all selectors accessed through ExtendSelector. #### Author(s): Bruce Atherton, bruce@callenish.com (Ant) Hans Lellelid, hans@xmpl.org (Phing) #### Version: $Revision: 526 $ Implements interfaces: ExtendFileSelector | ### Variables $parameters | ### Methods getParameters setParameters
### Child classes: ContainsSelector Selector that filters files based on whether they contain a particular string. DateSelector Selector that chooses files based on their last modified date. Ant uses millisecond precision (thanks to Java); PHP is forced to use only seconds precision. DepthSelector Selector that filters files based on the how deep in the directory tree they are. TypeSelector Selector that selects a certain kind of file: directory or regular file. FilenameSelector Selector that filters files based on the filename. SizeSelector Selector that filters files based on their size. ContainsRegexpSelector Selector that filters files based on whether they contain a particular string using regexp. | ### Inherited Variables #### Class: DataType DataType::$checked DataType::$description DataType::$ref #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### 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 37] Convenience base class for all selectors accessed through ExtendSelector. It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected. #### Tags:
author: | Bruce Atherton, bruce@callenish.com (Ant)
author: | Hans Lellelid, hans@xmpl.org (Phing)
version: | $Revision: 526 $
abstract: |
[ Top ] ### Class Variables #### $parameters = null [line 40] The passed in parameter array. #### Tags:
access: | protected
Type: | mixed
[ Top ] ### Class Methods ### method getParameters [line 58]
`the getParameters( )`
Allows access to the parameters gathered and set within the &lt;custom&gt; tag. #### Tags:
return: | set of parameters defined for this selector
access: | protected
[ Top ] ### method setParameters [line 48]
`void setParameters( parameters $parameters)`
Set all the Parameters for this custom selector, collected by the ExtendSelector class. #### Tags:
access: | public
Overridden in child classes as: ContainsSelector::setParameters() When using this as a custom selector, this method will be called. DateSelector::setParameters() When using this as a custom selector, this method will be called. DepthSelector::setParameters() When using this as a custom selector, this method will be called. TypeSelector::setParameters() When using this as a custom selector, this method will be called. FilenameSelector::setParameters() When using this as a custom selector, this method will be called. SizeSelector::setParameters() When using this as a custom selector, this method will be called. ContainsRegexpSelector::setParameters() When using this as a custom selector, this method will be called. Implementation of: Parameterizable::setParameters() #### Parameters:
parameters | $parameters | the complete set of parameters for this selector
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:22 +0200 by phpDocumentor 1.4.3