phing-types-selectors

# Class: NoneSelector Source Location: /types/selectors/NoneSelector.php
### Class Overview
    ProjectComponent
       |
       --DataType
          |
          --BaseSelector
             |
             --BaseSelectorContainer
                |
                --NoneSelector
This selector has a collection of other selectors. All of those selectors must refuse to select a file before the file is considered selected by this selector. #### Author(s): Bruce Atherton <bruce@callenish.com> (Ant) Hans Lellelid <hans@xmpl.org> #### Version: $Revision: 526 $ | ### Methods isSelected toString
### Child classes: NotSelector This selector has one other selectors whose meaning it inverts. It actually relies on NoneSelector for its implementation of the isSelected() method, but it adds a check to ensure there is only one other selector contained within. | ### Inherited Variables #### Class: DataType DataType::$checked DataType::$description DataType::$ref #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: BaseSelectorContainer BaseSelectorContainer::appendSelector() Add a new selector into this container. BaseSelectorContainer::createAnd() add an "And" selector entry on the selector list BaseSelectorContainer::createContains() add a contains selector entry on the selector list BaseSelectorContainer::createContainsRegexp() add a contains selector entry on the selector list BaseSelectorContainer::createCustom() add an extended selector entry on the selector list BaseSelectorContainer::createDate() add a selector date entry on the selector list BaseSelectorContainer::createDepend() add a depends selector entry on the selector list BaseSelectorContainer::createDepth() add a depth selector entry on the selector list BaseSelectorContainer::createFilename() add a selector filename entry on the selector list BaseSelectorContainer::createMajority() add a majority selector entry on the selector list BaseSelectorContainer::createNone() add a "None" selector entry on the selector list BaseSelectorContainer::createNot() add a "Not" selector entry on the selector list BaseSelectorContainer::createOr() add an "Or" selector entry on the selector list BaseSelectorContainer::createPresent() add a present selector entry on the selector list BaseSelectorContainer::createSelector() add a "Select" selector entry on the selector list BaseSelectorContainer::createSize() add a selector size entry on the selector list BaseSelectorContainer::createType() add a type selector entry on the selector list BaseSelectorContainer::getSelectors() Returns a copy of the selectors as an array. BaseSelectorContainer::hasSelectors() Indicates whether there are any selectors here. BaseSelectorContainer::selectorCount() Gives the count of the number of selectors in this container BaseSelectorContainer::selectorElements() Returns an array for accessing the set of selectors (not a copy). BaseSelectorContainer::toString() Convert the Selectors within this container to a string. This will just be a helper class for the subclasses that put their own name around the contents listed here. BaseSelectorContainer::validate() <p>This implementation validates the container by calling verifySettings() and then validates each contained selector provided that the selector implements the validate interface. #### 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] This selector has a collection of other selectors. All of those selectors must refuse to select a file before the file is considered selected by this selector. #### Tags:
author: | Bruce Atherton <bruce@callenish.com> (Ant)
author: | Hans Lellelid <hans@xmpl.org>
version: | $Revision: 526 $
[ Top ] ### Class Methods ### method isSelected [line 55]
`whether isSelected( $basedir, filename $filename, $file)`
Returns true (the file is selected) only if all other selectors agree that the file should not be selected. #### Tags:
return: | the file should be selected or not
access: | public
#### Parameters:
basedir | $basedir | the base directory the scan is being done from
filename | $filename | is the name of the file to check
file | $file | is a java.io.File object for the filename that the selector can use
[ Top ] ### method toString [line 35]
`void toString( )`
#### Tags:
access: | public
Overridden in child classes as: NotSelector::toString() Overrides BaseSelectorContainer::toString() (Convert the Selectors within this container to a string. This will just be a helper class for the subclasses that put their own name around the contents listed here.) [ Top ] Documentation generated on Mon, 19 Oct 2009 10:51:19 +0200 by phpDocumentor 1.4.3