phing-types-selectors
[ class tree: phing-types-selectors ] [ index: phing-types-selectors ] [ all elements ]

Element index for package phing-types-selectors

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ n ] [ o ] [ p ] [ s ] [ t ] [ u ] [ v ] [ w ] [ _ ]

_

__construct
in file DependSelector.php, method DependSelector::__construct()
top

a

addParam
in file ExtendSelector.php, method ExtendSelector::addParam()
    Create new parameters to pass to custom selector.
AndSelector
in file AndSelector.php, class AndSelector
    This selector has a collection of other selectors, all of which have to select a file in order for this selector to select it.
appendSelector
in file SelectorContainer.php, method SelectorContainer::appendSelector()
    Add a new selector into this container.
appendSelector
in file SelectSelector.php, method SelectSelector::appendSelector()
    Add a new selector into this container.
appendSelector
in file BaseSelectorContainer.php, method BaseSelectorContainer::appendSelector()
    Add a new selector into this container.
AndSelector.php
procedural page AndSelector.php
top

b

BaseExtendSelector
in file BaseExtendSelector.php, class BaseExtendSelector
    Convenience base class for all selectors accessed through ExtendSelector.
BaseSelector
in file BaseSelector.php, class BaseSelector
    A convenience base class that you can subclass Selectors from. It provides some helpful common behaviour. Note that there is no need for Selectors to inherit from this class, it is only necessary that they implement FileSelector.
BaseSelectorContainer
in file BaseSelectorContainer.php, class BaseSelectorContainer
    This is the base class for selectors that can contain other selectors.
BaseExtendSelector.php
procedural page BaseExtendSelector.php
BaseSelector.php
procedural page BaseSelector.php
BaseSelectorContainer.php
procedural page BaseSelectorContainer.php
top

c

CASE_KEY
in file ContainsSelector.php, class constant ContainsSelector::CASE_KEY
CASE_KEY
in file FilenameSelector.php, class constant FilenameSelector::CASE_KEY
CASE_KEY
in file ContainsRegexpSelector.php, class constant ContainsRegexpSelector::CASE_KEY
ContainsRegexpSelector
in file ContainsRegexpSelector.php, class ContainsRegexpSelector
    Selector that filters files based on whether they contain a particular string using regexp.
ContainsSelector
in file ContainsSelector.php, class ContainsSelector
    Selector that filters files based on whether they contain a particular string.
CONTAINS_KEY
in file ContainsSelector.php, class constant ContainsSelector::CONTAINS_KEY
createAnd
in file SelectorContainer.php, method SelectorContainer::createAnd()
    add an "And" selector entry on the selector list
createAnd
in file BaseSelectorContainer.php, method BaseSelectorContainer::createAnd()
    add an "And" selector entry on the selector list
createContains
in file BaseSelectorContainer.php, method BaseSelectorContainer::createContains()
    add a contains selector entry on the selector list
createContains
in file SelectorContainer.php, method SelectorContainer::createContains()
    add a contains selector entry on the selector list
createContainsRegexp
in file BaseSelectorContainer.php, method BaseSelectorContainer::createContainsRegexp()
    add a contains selector entry on the selector list
createCustom
in file BaseSelectorContainer.php, method BaseSelectorContainer::createCustom()
    add an extended selector entry on the selector list
createCustom
in file SelectorContainer.php, method SelectorContainer::createCustom()
    add an extended selector entry on the selector list
createDate
in file BaseSelectorContainer.php, method BaseSelectorContainer::createDate()
    add a selector date entry on the selector list
createDate
in file SelectorContainer.php, method SelectorContainer::createDate()
    add a selector date entry on the selector list
createDepend
in file SelectorContainer.php, method SelectorContainer::createDepend()
    add a depends selector entry on the selector list
createDepend
in file BaseSelectorContainer.php, method BaseSelectorContainer::createDepend()
    add a depends selector entry on the selector list
createDepth
in file BaseSelectorContainer.php, method BaseSelectorContainer::createDepth()
    add a depth selector entry on the selector list
createDepth
in file SelectorContainer.php, method SelectorContainer::createDepth()
    add a depth selector entry on the selector list
createFilename
in file SelectorContainer.php, method SelectorContainer::createFilename()
    add a selector filename entry on the selector list
createFilename
in file BaseSelectorContainer.php, method BaseSelectorContainer::createFilename()
    add a selector filename entry on the selector list
createMajority
in file BaseSelectorContainer.php, method BaseSelectorContainer::createMajority()
    add a majority selector entry on the selector list
createMajority
in file SelectorContainer.php, method SelectorContainer::createMajority()
    add a majority selector entry on the selector list
createMapper
in file PresentSelector.php, method PresentSelector::createMapper()
    Defines the FileNameMapper to use (nested mapper element).
createMapper
in file DependSelector.php, method DependSelector::createMapper()
    Defines the FileNameMapper to use (nested mapper element).
createNone
in file BaseSelectorContainer.php, method BaseSelectorContainer::createNone()
    add a "None" selector entry on the selector list
createNone
in file SelectorContainer.php, method SelectorContainer::createNone()
    add a "None" selector entry on the selector list
createNot
in file SelectorContainer.php, method SelectorContainer::createNot()
    add a "Not" selector entry on the selector list
createNot
in file BaseSelectorContainer.php, method BaseSelectorContainer::createNot()
    add a "Not" selector entry on the selector list
createOr
in file SelectorContainer.php, method SelectorContainer::createOr()
    add an "Or" selector entry on the selector list
createOr
in file BaseSelectorContainer.php, method BaseSelectorContainer::createOr()
    add an "Or" selector entry on the selector list
createPresent
in file SelectorContainer.php, method SelectorContainer::createPresent()
    add a present selector entry on the selector list
createPresent
in file BaseSelectorContainer.php, method BaseSelectorContainer::createPresent()
    add a present selector entry on the selector list
createSelector
in file SelectorContainer.php, method SelectorContainer::createSelector()
    add a "Select" selector entry on the selector list
createSelector
in file BaseSelectorContainer.php, method BaseSelectorContainer::createSelector()
    add a "Select" selector entry on the selector list
createSize
in file BaseSelectorContainer.php, method BaseSelectorContainer::createSize()
    add a selector size entry on the selector list
createSize
in file SelectorContainer.php, method SelectorContainer::createSize()
    add a selector size entry on the selector list
createType
in file BaseSelectorContainer.php, method BaseSelectorContainer::createType()
    add a type selector entry on the selector list
ContainsRegexpSelector.php
procedural page ContainsRegexpSelector.php
ContainsSelector.php
procedural page ContainsSelector.php
top

d

DependSelector
in file DependSelector.php, class DependSelector
    Selector that filters files based on whether they are newer than a matching file in another directory tree. It can contain a mapper element, so isn't available as an ExtendSelector (since those parameters can't hold other elements).
DepthSelector
in file DepthSelector.php, class DepthSelector
    Selector that filters files based on the how deep in the directory tree they are.
DependSelector.php
procedural page DependSelector.php
DepthSelector.php
procedural page DepthSelector.php
top

e

EXPRESSION_KEY
in file ContainsRegexpSelector.php, class constant ContainsRegexpSelector::EXPRESSION_KEY
ExtendFileSelector
in file ExtendFileSelector.php, class ExtendFileSelector
    This is the interface to be used by all custom selectors, those that are
ExtendSelector
in file ExtendSelector.php, class ExtendSelector
    Selector that selects files by forwarding the request on to other classes.
ExtendFileSelector.php
procedural page ExtendFileSelector.php
ExtendSelector.php
procedural page ExtendSelector.php
top

f

FilenameSelector
in file FilenameSelector.php, class FilenameSelector
    Selector that filters files based on the filename.
FileSelector
in file FileSelector.php, class FileSelector
    This is the interface to be used by all selectors.
FilenameSelector.php
procedural page FilenameSelector.php
FileSelector.php
procedural page FileSelector.php
top

g

getDeselectedDirectories
in file SelectorScanner.php, method SelectorScanner::getDeselectedDirectories()
    Directories which were selected out of a scan.
getDeselectedFiles
in file SelectorScanner.php, method SelectorScanner::getDeselectedFiles()
    Files which were selected out of a scan.
getError
in file BaseSelector.php, method BaseSelector::getError()
    Returns any error messages that have been set.
getInstance
in file SelectorUtils.php, method SelectorUtils::getInstance()
    Retrieves the instance of the Singleton.
getParameters
in file BaseExtendSelector.php, method BaseExtendSelector::getParameters()
    Allows access to the parameters gathered and set within the <custom> tag.
getSelectors
in file SelectSelector.php, method SelectSelector::getSelectors()
    Returns the set of selectors as an array.
getSelectors
in file SelectorContainer.php, method SelectorContainer::getSelectors()
    Returns a *copy* of the set of selectors as an array.
getSelectors
in file BaseSelectorContainer.php, method BaseSelectorContainer::getSelectors()
    Returns a copy of the selectors as an array.
top

h

hasSelectors
in file SelectSelector.php, method SelectSelector::hasSelectors()
    Indicates whether there are any selectors here.
hasSelectors
in file SelectorContainer.php, method SelectorContainer::hasSelectors()
    Indicates whether there are any selectors here.
hasSelectors
in file BaseSelectorContainer.php, method BaseSelectorContainer::hasSelectors()
    Indicates whether there are any selectors here.
top

i

isOutOfDate
in file SelectorUtils.php, method SelectorUtils::isOutOfDate()
    Returns dependency information on these two files. If src has been
isSelected
in file OrSelector.php, method OrSelector::isSelected()
    Returns true (the file is selected) if any of the other selectors agree that the file should be selected.
isSelected
in file NoneSelector.php, method NoneSelector::isSelected()
    Returns true (the file is selected) only if all other selectors agree that the file should not be selected.
isSelected
in file PresentSelector.php, method PresentSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.
isSelected
in file TypeSelector.php, method TypeSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.
isSelected
in file MajoritySelector.php, method MajoritySelector::isSelected()
    Returns true (the file is selected) if most of the other selectors agree. In case of a tie, go by the allowtie setting. That defaults to true, meaning in case of a tie, the file is selected.
isSelected
in file SizeSelector.php, method SizeSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.
isSelected
in file FileSelector.php, method FileSelector::isSelected()
    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.
isSelected
in file DependSelector.php, method DependSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.
isSelected
in file ContainsSelector.php, method ContainsSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.
isSelected
in file DepthSelector.php, method DepthSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide
isSelected
in file ExtendSelector.php, method ExtendSelector::isSelected()
    Allows the custom selector to choose whether to select a file. This is also where the Parameters are passed to the custom selector.
isSelected
in file FilenameSelector.php, method FilenameSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide
isSelected
in file AndSelector.php, method AndSelector::isSelected()
    Returns true (the file is selected) only if all other selectors agree that the file should be selected.
isSelected
in file ContainsRegexpSelector.php, method ContainsRegexpSelector::isSelected()
    The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.
top

m

$max
in file DepthSelector.php, variable DepthSelector::$max
$min
in file DepthSelector.php, variable DepthSelector::$min
MajoritySelector
in file MajoritySelector.php, class MajoritySelector
    This selector is here just to shake up your thinking a bit. Don't get
match
in file SelectorUtils.php, method SelectorUtils::match()
    Tests whether or not a string matches against a pattern.
matchPath
in file SelectorUtils.php, method SelectorUtils::matchPath()
    Tests whether or not a given path matches a given pattern.
matchPatternStart
in file SelectorUtils.php, method SelectorUtils::matchPatternStart()
    Tests whether or not a given path matches the start of a given pattern up to the first "**".
MAX_KEY
in file DepthSelector.php, class constant DepthSelector::MAX_KEY
MIN_KEY
in file DepthSelector.php, class constant DepthSelector::MIN_KEY
MajoritySelector.php
procedural page MajoritySelector.php
top

n

NAME_KEY
in file FilenameSelector.php, class constant FilenameSelector::NAME_KEY
NEGATE_KEY
in file FilenameSelector.php, class constant FilenameSelector::NEGATE_KEY
NoneSelector
in file NoneSelector.php, class 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.
NotSelector
in file NotSelector.php, class 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.
NoneSelector.php
procedural page NoneSelector.php
NotSelector.php
procedural page NotSelector.php
top

o

OrSelector
in file OrSelector.php, class OrSelector
    This selector has a collection of other selectors, any of which have to select a file in order for this selector to select it.
OrSelector.php
procedural page OrSelector.php
top

p

$parameters
in file BaseExtendSelector.php, variable BaseExtendSelector::$parameters
    The passed in parameter array.
PresentSelector
in file PresentSelector.php, class PresentSelector
    Selector that filters files based on whether they appear in another directory tree. It can contain a mapper element, so isn't available as an ExtendSelector (since those parameters can't hold other elements).
PresentSelector.php
procedural page PresentSelector.php
top

s

SelectorContainer
in file SelectorContainer.php, class SelectorContainer
    This is the interface for selectors that can contain other selectors.
selectorCount
in file SelectSelector.php, method SelectSelector::selectorCount()
    Gives the count of the number of selectors in this container
selectorCount
in file SelectorContainer.php, method SelectorContainer::selectorCount()
    Gives the count of the number of selectors in this container
selectorCount
in file BaseSelectorContainer.php, method BaseSelectorContainer::selectorCount()
    Gives the count of the number of selectors in this container
selectorCreate
in file ExtendSelector.php, method ExtendSelector::selectorCreate()
    Instantiates the identified custom selector class.
selectorElements
in file SelectSelector.php, method SelectSelector::selectorElements()
    Returns an enumerator for accessing the set of selectors.
selectorElements
in file SelectorContainer.php, method SelectorContainer::selectorElements()
    Returns an array for accessing the set of selectors.
selectorElements
in file BaseSelectorContainer.php, method BaseSelectorContainer::selectorElements()
    Returns an array for accessing the set of selectors (not a copy).
SelectorScanner
in file SelectorScanner.php, class SelectorScanner
    An interface used to describe the actions required by any type of directory scanner that supports Selecters.
SelectorUtils
in file SelectorUtils.php, class SelectorUtils
    <p>This is a utility class used by selectors and DirectoryScanner. The functionality more properly belongs just to selectors, but unfortunately DirectoryScanner exposed these as protected methods. Thus we have to support any subclasses of DirectoryScanner that may access these methods.
SelectSelector
in file SelectSelector.php, class SelectSelector
    This selector just holds one other selector and forwards all
setAllowtie
in file MajoritySelector.php, method MajoritySelector::setAllowtie()
setCasesensitive
in file FilenameSelector.php, method FilenameSelector::setCasesensitive()
    Whether to ignore case when checking filenames.
setCasesensitive
in file ContainsRegexpSelector.php, method ContainsRegexpSelector::setCasesensitive()
    Whether to ignore case in the regex match.
setCasesensitive
in file ContainsSelector.php, method ContainsSelector::setCasesensitive()
    Whether to ignore case in the string being searched.
setClassname
in file ExtendSelector.php, method ExtendSelector::setClassname()
    Sets the classname of the custom selector.
setError
in file BaseSelector.php, method BaseSelector::setError()
    Allows all selectors to indicate a setup error. Note that only the first error message is recorded.
setExpression
in file ContainsRegexpSelector.php, method ContainsRegexpSelector::setExpression()
    The expression to match on within a file.
setGranularity
in file DependSelector.php, method DependSelector::setGranularity()
    Sets the number of milliseconds leeway we will give before we consider a file out of date.
setMax
in file DepthSelector.php, method DepthSelector::setMax()
    The minimum depth below the basedir before a file is selected.
setMin
in file DepthSelector.php, method DepthSelector::setMin()
    The minimum depth below the basedir before a file is selected.
setName
in file FilenameSelector.php, method FilenameSelector::setName()
    The name of the file, or the pattern for the name, that should be used for selection.
setNegate
in file FilenameSelector.php, method FilenameSelector::setNegate()
    You can optionally reverse the selection of this selector, thereby emulating an &lt;exclude&gt; tag, by setting the attribute negate to true. This is identical to surrounding the selector with &lt;not&gt;&lt;/not&gt;.
setParameters
in file DepthSelector.php, method DepthSelector::setParameters()
    When using this as a custom selector, this method will be called.
setParameters
in file ContainsSelector.php, method ContainsSelector::setParameters()
    When using this as a custom selector, this method will be called.
setParameters
in file ContainsRegexpSelector.php, method ContainsRegexpSelector::setParameters()
    When using this as a custom selector, this method will be called.
setParameters
in file TypeSelector.php, method TypeSelector::setParameters()
    When using this as a custom selector, this method will be called.
setParameters
in file SizeSelector.php, method SizeSelector::setParameters()
    When using this as a custom selector, this method will be called.
setParameters
in file FilenameSelector.php, method FilenameSelector::setParameters()
    When using this as a custom selector, this method will be called.
setParameters
in file BaseExtendSelector.php, method BaseExtendSelector::setParameters()
    Set all the Parameters for this custom selector, collected by the ExtendSelector class.
setPresent
in file PresentSelector.php, method PresentSelector::setPresent()
    This sets whether to select a file if its dest file is present.
setSelectors
in file SelectorScanner.php, method SelectorScanner::setSelectors()
    Sets the selectors the scanner should use.
setTargetdir
in file PresentSelector.php, method PresentSelector::setTargetdir()
    The name of the file or directory which is checked for matching files.
setTargetdir
in file DependSelector.php, method DependSelector::setTargetdir()
    The name of the file or directory which is checked for out-of-date files.
setText
in file ContainsSelector.php, method ContainsSelector::setText()
    The string to search for within a file.
setType
in file TypeSelector.php, method TypeSelector::setType()
    Set the type of file to require.
setUnits
in file SizeSelector.php, method SizeSelector::setUnits()
    Sets the units to use for the comparison. This is a little
setValue
in file SizeSelector.php, method SizeSelector::setValue()
    A size selector needs to know what size to base its selecting on.
setWhen
in file SizeSelector.php, method SizeSelector::setWhen()
    This specifies when the file should be selected, whether it be when the file matches a particular size, when it is smaller, or whether it is larger.
SizeSelector
in file SizeSelector.php, class SizeSelector
    Selector that filters files based on their size.
SIZE_KEY
in file SizeSelector.php, class constant SizeSelector::SIZE_KEY
SelectorContainer.php
procedural page SelectorContainer.php
SelectorScanner.php
procedural page SelectorScanner.php
SelectorUtils.php
procedural page SelectorUtils.php
SelectSelector.php
procedural page SelectSelector.php
SizeSelector.php
procedural page SizeSelector.php
top

t

toString
in file OrSelector.php, method OrSelector::toString()
toString
in file NotSelector.php, method NotSelector::toString()
toString
in file PresentSelector.php, method PresentSelector::toString()
toString
in file SelectSelector.php, method SelectSelector::toString()
toString
in file TypeSelector.php, method TypeSelector::toString()
toString
in file SizeSelector.php, method SizeSelector::toString()
toString
in file AndSelector.php, method AndSelector::toString()
toString
in file NoneSelector.php, method NoneSelector::toString()
toString
in file ContainsRegexpSelector.php, method ContainsRegexpSelector::toString()
toString
in file BaseSelectorContainer.php, method 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.
toString
in file MajoritySelector.php, method MajoritySelector::toString()
toString
in file ContainsSelector.php, method ContainsSelector::toString()
toString
in file DependSelector.php, method DependSelector::toString()
toString
in file DepthSelector.php, method DepthSelector::toString()
toString
in file FilenameSelector.php, method FilenameSelector::toString()
TypeSelector.php
procedural page TypeSelector.php
TypeSelector
in file TypeSelector.php, class TypeSelector
    Selector that selects a certain kind of file: directory or regular file.
TYPE_KEY
in file TypeSelector.php, class constant TypeSelector::TYPE_KEY
    Key to used for parameterized custom selector
top

u

UNITS_KEY
in file SizeSelector.php, class constant SizeSelector::UNITS_KEY
top

v

validate
in file BaseSelector.php, method BaseSelector::validate()
    Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.
validate
in file BaseSelectorContainer.php, method 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.
verifySettings
in file NotSelector.php, method NotSelector::verifySettings()
    Makes sure that there is only one entry, sets an error message if not.
verifySettings
in file PresentSelector.php, method PresentSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the targetdir attribute has been set and we have a mapper.
verifySettings
in file SizeSelector.php, method SizeSelector::verifySettings()
    <p>Checks to make sure all settings are kosher. In this case, it
verifySettings
in file TypeSelector.php, method TypeSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set.
verifySettings
in file FilenameSelector.php, method FilenameSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the name attribute has been set.
verifySettings
in file SelectSelector.php, method SelectSelector::verifySettings()
    Makes sure that there is only one entry, sets an error message if not.
verifySettings
in file DepthSelector.php, method DepthSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the max depth is not lower than the min depth.
verifySettings
in file BaseSelector.php, method BaseSelector::verifySettings()
    <p>Subclasses can override this method to provide checking of their
verifySettings
in file ContainsRegexpSelector.php, method ContainsRegexpSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set.
verifySettings
in file ContainsSelector.php, method ContainsSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set.
verifySettings
in file DependSelector.php, method DependSelector::verifySettings()
    Checks to make sure all settings are kosher. In this case, it means that the dest attribute has been set and we have a mapper.
verifySettings
in file ExtendSelector.php, method ExtendSelector::verifySettings()
    These are errors specific to ExtendSelector only. If there are errors in the custom selector, it should throw a BuildException when isSelected() is called.
top

w

WHEN_KEY
in file SizeSelector.php, class constant SizeSelector::WHEN_KEY
top

Documentation generated on Mon, 19 Oct 2009 10:50:10 +0200 by phpDocumentor 1.4.3