PHP Class AbstractFileSet, symfony-1.4

TODO: - merge this with patternsets: FileSet extends PatternSet !!! requires additional mods to the parsing algo [HL] .... not sure if that really makes so much sense. I think that perhaps they should use common utility class if there really is that much shared functionality
See also: ProjectComponent
Author: Andreas Aderhold ([email protected])
Author: Hans Lellelid ([email protected])
Inheritance: extends DataType, implements SelectorContainer
Afficher le fichier Open project: vjousse/symfony-1.4 Class Usage Examples

Méthodes publiques

Свойство Type Description
$additionalPatterns
$defaultPatterns PatternSet
$dir
$isCaseSensitive
$selectors
$useDefaultExcludes boolean

Méthodes publiques

Méthode Description
__construct ( $fileset = null )
appendSelector ( FileSelector $selector ) Add a new selector into this container.
createAnd ( ) add an "And" selector entry on the selector list
createContains ( ) add a contains selector entry on the selector list
createContainsRegexp ( ) add a contains selector entry on the selector list
createCustom ( ) add an extended selector entry on the selector list
createDate ( ) add a selector date entry on the selector list
createDepend ( ) add a depends selector entry on the selector list
createDepth ( ) add a depth selector entry on the selector list
createExclude ( ) add a name entry on the exclude list
createExcludesFile ( ) add a name entry on the include files list
createFilename ( ) add a selector filename entry on the selector list
createInclude ( ) add a name entry on the include list
createIncludesFile ( ) add a name entry on the include files list
createMajority ( ) add a majority selector entry on the selector list
createNone ( ) add a "None" selector entry on the selector list
createNot ( ) add a "Not" selector entry on the selector list
createOr ( ) add an "Or" selector entry on the selector list
createPatternSet ( )
createPresent ( ) add a present selector entry on the selector list
createSelector ( ) add a "Select" selector entry on the selector list
createSize ( ) add a selector size entry on the selector list
createType ( ) add a type selector entry on the selector list
getDir ( Project $p )
getDirectoryScanner ( Project $p ) returns a reference to the dirscanner object belonging to this fileset
getRef ( Project $p ) Performs the check for circular references and returns the referenced FileSet.
getSelectors ( Project $p ) : an Returns the set of selectors as an array.
hasPatterns ( ) : boolean Indicates whether there are any patterns here.
hasSelectors ( ) : boolean Indicates whether there are any selectors here.
selectorCount ( ) : integer Gives the count of the number of selectors in this container
selectorElements ( ) : array Returns an array for accessing the set of selectors.
setCaseSensitive ( $isCaseSensitive ) Sets case sensitivity of the file system
setDefaultexcludes ( $useDefaultExcludes ) Sets whether default exclusions should be used or not.
setDir ( $dir )
setExcludes ( $excludes ) Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
setExcludesfile ( $excl ) Sets the name of the file containing the includes patterns.
setIncludes ( $includes ) Sets the set of include patterns. Patterns may be separated by a comma or a space.
setIncludesfile ( $incl ) Sets the name of the file containing the includes patterns.
setRefid ( Reference $r ) Makes this instance in effect a reference to another PatternSet instance.

Méthodes protégées

Méthode Description
setupDirectoryScanner ( DirectoryScanner $ds, Project $p ) feed dirscanner with infos defined by this fileset

Method Details

__construct() public méthode

public __construct ( $fileset = null )

appendSelector() public méthode

Add a new selector into this container.
public appendSelector ( FileSelector $selector )
$selector FileSelector

createAnd() public méthode

add an "And" selector entry on the selector list
public createAnd ( )

createContains() public méthode

add a contains selector entry on the selector list
public createContains ( )

createContainsRegexp() public méthode

add a contains selector entry on the selector list
public createContainsRegexp ( )

createCustom() public méthode

add an extended selector entry on the selector list
public createCustom ( )

createDate() public méthode

add a selector date entry on the selector list
public createDate ( )

createDepend() public méthode

add a depends selector entry on the selector list
public createDepend ( )

createDepth() public méthode

add a depth selector entry on the selector list
public createDepth ( )

createExclude() public méthode

add a name entry on the exclude list
public createExclude ( )

createExcludesFile() public méthode

add a name entry on the include files list
public createExcludesFile ( )

createFilename() public méthode

add a selector filename entry on the selector list
public createFilename ( )

createInclude() public méthode

add a name entry on the include list
public createInclude ( )

createIncludesFile() public méthode

add a name entry on the include files list
public createIncludesFile ( )

createMajority() public méthode

add a majority selector entry on the selector list
public createMajority ( )

createNone() public méthode

add a "None" selector entry on the selector list
public createNone ( )

createNot() public méthode

add a "Not" selector entry on the selector list
public createNot ( )

createOr() public méthode

add an "Or" selector entry on the selector list
public createOr ( )

createPatternSet() public méthode

public createPatternSet ( )

createPresent() public méthode

add a present selector entry on the selector list
public createPresent ( )

createSelector() public méthode

add a "Select" selector entry on the selector list
public createSelector ( )

createSize() public méthode

add a selector size entry on the selector list
public createSize ( )

createType() public méthode

add a type selector entry on the selector list
public createType ( )

getDir() public méthode

public getDir ( Project $p )
$p Project

getDirectoryScanner() public méthode

returns a reference to the dirscanner object belonging to this fileset
public getDirectoryScanner ( Project $p )
$p Project

getRef() public méthode

Performs the check for circular references and returns the referenced FileSet.
public getRef ( Project $p )
$p Project

getSelectors() public méthode

Returns the set of selectors as an array.
public getSelectors ( Project $p ) : an
$p Project
Résultat an array of selectors in this container

hasPatterns() public méthode

Indicates whether there are any patterns here.
public hasPatterns ( ) : boolean
Résultat boolean Whether any patterns are in this container.

hasSelectors() public méthode

Indicates whether there are any selectors here.
public hasSelectors ( ) : boolean
Résultat boolean Whether any selectors are in this container

selectorCount() public méthode

Gives the count of the number of selectors in this container
public selectorCount ( ) : integer
Résultat integer The number of selectors in this container

selectorElements() public méthode

Returns an array for accessing the set of selectors.
public selectorElements ( ) : array
Résultat array The array of selectors

setCaseSensitive() public méthode

Sets case sensitivity of the file system
public setCaseSensitive ( $isCaseSensitive )

setDefaultexcludes() public méthode

Sets whether default exclusions should be used or not.
public setDefaultexcludes ( $useDefaultExcludes )
$useDefaultExcludes "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

setDir() public méthode

public setDir ( $dir )

setExcludes() public méthode

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
public setExcludes ( $excludes )

setExcludesfile() public méthode

Sets the name of the file containing the includes patterns.
public setExcludesfile ( $excl )
$excl The file to fetch the exclude patterns from.

setIncludes() public méthode

Sets the set of include patterns. Patterns may be separated by a comma or a space.
public setIncludes ( $includes )

setIncludesfile() public méthode

Sets the name of the file containing the includes patterns.
public setIncludesfile ( $incl )
$incl The file to fetch the include patterns from.

setRefid() public méthode

You must not set another attribute or nest elements inside this element if you make it a reference.
public setRefid ( Reference $r )
$r Reference

setupDirectoryScanner() protected méthode

feed dirscanner with infos defined by this fileset
protected setupDirectoryScanner ( DirectoryScanner $ds, Project $p )
$ds DirectoryScanner
$p Project

Property Details

$additionalPatterns public_oe property

public $additionalPatterns

$defaultPatterns public_oe property

public PatternSet $defaultPatterns
Résultat PatternSet

$dir public_oe property

public $dir

$isCaseSensitive public_oe property

public $isCaseSensitive

$selectors public_oe property

public $selectors

$useDefaultExcludes public_oe property

public bool $useDefaultExcludes
Résultat boolean