commandbox.system.modules.globber.models

Class Globber

lucee.Component
    extended by commandbox.system.modules.globber.models.Globber

Copyright Since 2014 by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com I represent a single globbing pattern and provide a fluent API to access the matching files Unlike the PathPatternMatcher, which only handles comparisons of patterns, this model actually interacts with the file system to resolve a pattern to a list of real file system resources.

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • author : Brad Wood
    •  
    Property Summary
    type property default serializable required
    any baseDir
          Directory the list was pulled from.

    • access = public
    • returntype = any
    		 true false
    any excludePattern
          The file globbing pattern NOT to match.

    • access = public
    • returntype = any
    		 true false
    any format
          Return matches as a query instead of an array.

    • access = public
    • returntype = any
    		 array true false
    any loose
          Uses Gitignore rules that match pattern anywhere inside path, not requiring explicit * at the start or end of the pattern.

    • access = public
    • returntype = any
    		 false true false
    any matchQuery
          query of real file system resources that match the pattern.

    • access = public
    • returntype = any
    		 true false
    any matchQueryArray


    • access = public
    • returntype = any
    		 true false
    any notExcludePattern


    • access = public
    • returntype = any
    		 true false
    any pathPatternMatcher


    • access = public
    • returntype = any
    • inject = pathPatternMatcher@globber
    		 true false
    any pattern
          The file globbing pattern to match.

    • access = public
    • returntype = any
    		 true false
    any sort
          Sort to use.

    • access = public
    • returntype = any
    		 type, name true false
    Constructor Summary
    init()
    Method Summary
    any addExcludePattern(string excludePattern)
         Add additional excludePattern to process.
    any addNotExcludePattern(string notExcludePattern)
         Add not excludePattern to process.
    any addPattern(string pattern)
         Add additional pattern to process.
    any appendMatchQuery([any matchQuery])
    any apply(any udf)
         Pass a closure to this function to have it.
    any asArray()
         Return results as array.
    any asQuery()
         Return results as query.
    private any calculateBaseDir(string pattern)
    private any combineMatchQueries()
    any copyTo(string targetPath)
         Copy all matched paths to a new folder.
    any count()
         Get count of matched files.
    private any ensureMatches()
         Make sure the MatchQuery has been loaded.
    any findUnmatchedPattern([any thisPattern], [any currentBaseDir])
    string getBaseDir()
    any getCleanSort()
         The sort function in CFDirectory will simply ignore invalid sort columns so I'm mimicking that here, as much as I dislike it.
    any getExcludePattern()
         Always returns a string which is a list of excludePatterns.
    any getExcludePatternArray()
    string getFormat()
    string getLoose()
    string getMatchQuery()
    string getMatchQueryArray()
    string getNotExcludePattern()
    string getPathPatternMatcher()
    any getPattern()
         Always returns a string which is a list of patterns.
    any getPatternArray()
    string getSort()
    any inDirectory(string baseDirectory)
         Enable loose matching.
    any loose([boolean loose='true'])
         Enable loose matching.
    any matches()
         Get array of matched file system paths.
    any pathAppend([any base], [any path])
         Concatenate a folder or file to an existing base path, taking into account forward or backslashes.
    any pathMayNotBeExcluded([any pathToMatch], [any type], [any currentBaseDir])
    private any process()
         Load matching file from the file system.
    private any processPattern([string pattern], [any baseDir], [any skipExcludes='false'])
    any setBaseDir(any baseDir)
    any setExcludePattern(any thisExcludePattern)
         Can be list of excludePatterns or array of excludePatterns.
    any setFormat(any format)
    any setLoose(any loose)
    any setMatchQuery(any matchQuery)
    any setMatchQueryArray(any matchQueryArray)
    any setNotExcludePattern(any notExcludePattern)
    any setPathPatternMatcher(any pathPatternMatcher)
    any setPattern(any thisPattern)
         Override setter to ensure consistent slashes in pattern.
    any setSort(any sort)
    any withSort([any thisSort])
         Return results as array.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Property Detail

    baseDir

    property any baseDir

    Directory the list was pulled from

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    excludePattern

    property any excludePattern

    The file globbing pattern NOT to match.

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    format

    property any format = [array]

    Return matches as a query instead of an array

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    loose

    property any loose = [false]

    Uses Gitignore rules that match pattern anywhere inside path, not requiring explicit * at the start or end of the pattern

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    matchQuery

    property any matchQuery

    query of real file system resources that match the pattern

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    matchQueryArray

    property any matchQueryArray

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    notExcludePattern

    property any notExcludePattern

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    pathPatternMatcher

    property any pathPatternMatcher

    Attributes:
    access - public
    required - false
    returntype - any
    inject - pathPatternMatcher@globber
    serializable - true

    pattern

    property any pattern

    The file globbing pattern to match.

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    sort

    property any sort = [type, name]

    Sort to use

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    addExcludePattern

    public any addExcludePattern(string excludePattern)

    Add additional excludePattern to process

    Parameters:
    excludePattern

    addNotExcludePattern

    public any addNotExcludePattern(string notExcludePattern)

    Add not excludePattern to process

    Parameters:
    notExcludePattern

    addPattern

    public any addPattern(string pattern)

    Add additional pattern to process

    Parameters:
    pattern

    appendMatchQuery

    public any appendMatchQuery([any matchQuery])

    Parameters:
    matchQuery

    apply

    public any apply(any udf)

    Pass a closure to this function to have it applied to each paths matched by the pattern.

    Parameters:
    udf

    asArray

    public any asArray()

    Return results as array

    asQuery

    public any asQuery()

    Return results as query

    calculateBaseDir

    private any calculateBaseDir(string pattern)

    Parameters:
    pattern

    combineMatchQueries

    private any combineMatchQueries()

    copyTo

    public any copyTo(string targetPath)

    Copy all matched paths to a new folder

    Parameters:
    targetPath

    count

    public any count()

    Get count of matched files

    ensureMatches

    private any ensureMatches()

    Make sure the MatchQuery has been loaded.

    findUnmatchedPattern

    public any findUnmatchedPattern([any thisPattern], [any currentBaseDir])

    Parameters:
    thisPattern
    currentBaseDir

    getBaseDir

    public string getBaseDir()

    getCleanSort

    public any getCleanSort()

    The sort function in CFDirectory will simply ignore invalid sort columns so I'm mimicking that here, as much as I dislike it. The sort should be in the format of "col asc, col2 desc, col3, col4" like a SQL order by If any of the columns or sort directions don't look right, just bail and return the default sort.

    getExcludePattern

    public any getExcludePattern()

    Always returns a string which is a list of excludePatterns

    getExcludePatternArray

    public any getExcludePatternArray()

    getFormat

    public string getFormat()

    getLoose

    public string getLoose()

    getMatchQuery

    public string getMatchQuery()

    getMatchQueryArray

    public string getMatchQueryArray()

    getNotExcludePattern

    public string getNotExcludePattern()

    getPathPatternMatcher

    public string getPathPatternMatcher()

    getPattern

    public any getPattern()

    Always returns a string which is a list of patterns

    getPatternArray

    public any getPatternArray()

    getSort

    public string getSort()

    inDirectory

    public any inDirectory(string baseDirectory)

    Enable loose matching

    Parameters:
    baseDirectory

    loose

    public any loose([boolean loose='true'])

    Enable loose matching

    Parameters:
    loose

    matches

    public any matches()

    Get array of matched file system paths

    pathAppend

    public any pathAppend([any base], [any path])

    Concatenate a folder or file to an existing base path, taking into account forward or backslashes Won't remove leading slashes on *nix. If base is an empty string, path is returned untouched.

    Parameters:
    base - The base path to append to
    path - The path segment or segments to add on to the base

    pathMayNotBeExcluded

    public any pathMayNotBeExcluded([any pathToMatch], [any type], [any currentBaseDir])

    Parameters:
    pathToMatch
    type
    currentBaseDir

    process

    private any process()

    Load matching file from the file system

    processPattern

    private any processPattern([string pattern], [any baseDir], [any skipExcludes='false'])

    Parameters:
    pattern
    baseDir
    skipExcludes

    setBaseDir

    public any setBaseDir(any baseDir)

    Parameters:
    baseDir

    setExcludePattern

    public any setExcludePattern(any thisExcludePattern)

    Can be list of excludePatterns or array of excludePatterns. Empty excludePatterns will be ignored

    Parameters:
    thisExcludePattern

    setFormat

    public any setFormat(any format)

    Parameters:
    format

    setLoose

    public any setLoose(any loose)

    Parameters:
    loose

    setMatchQuery

    public any setMatchQuery(any matchQuery)

    Parameters:
    matchQuery

    setMatchQueryArray

    public any setMatchQueryArray(any matchQueryArray)

    Parameters:
    matchQueryArray

    setNotExcludePattern

    public any setNotExcludePattern(any notExcludePattern)

    Parameters:
    notExcludePattern

    setPathPatternMatcher

    public any setPathPatternMatcher(any pathPatternMatcher)

    Parameters:
    pathPatternMatcher

    setPattern

    public any setPattern(any thisPattern)

    Override setter to ensure consistent slashes in pattern Can be list of patterns or array of patterns. Empty patterns will be ignored

    Parameters:
    thisPattern

    setSort

    public any setSort(any sort)

    Parameters:
    sort

    withSort

    public any withSort([any thisSort])

    Return results as array

    Parameters:
    thisSort