Futilities/human/lib/cFolderator
Human Futilities:
cFolderator class |
Flow
The flow typically starts with StartSpider()
, which retrieves the source-path from Options (GetSourcePath()
) and then passes control to OnWantedFolder
. (We assume that the folder in the source-path is wanted, even if it fails inclusion criteria that are applied to its sub-folders.)
This initiates a recursive loop guided in part by the app's Matcher object, which is an app-defined caMatch podling.
OnWantedFolder
OnWantedFolder(caPathPiece $op)
gets a directory listing for $op
, puts that list in an array, and then for each entry in the array sets that entry as the last piece in $opCurr
and passes it to OnPath($opCurr)
.
OnPath
OnPath(caPathPiece $op)
checks the filespec in $op
to see whether it's a file or a folder (it is assumed to exist). In simplified form:
if ($op->IsFolder()) {
$this->OnFolder($op);
} else {
$this->OnFile($op);
}
...in other words: control is passed to OnFile()
or OnFolder()
depending on whether the filesystem entry (node) pointed to by the filespec is a file or a folder.
OnFolder
OnFolder(caPathNamed $op)
asks the Matcher if the folder is wanted:
if ($this->GetMatcher()->IsFolderWanted($op)) { $this->OnWantedFolder($op); }
If the Matcher declares that the folder passes muster, then:
- ask the Matcher to
HandleFolder($op)
- start a new iteration by passing control back to
OnWantedFolder()
.
OnFile
OnFile(caPathNamed $op)
asks the Matcher if the file is wanted:
if ($this->GetMatcher()->IsFileWanted($op)) { $this->GetMatcher()->HandleFile($op); }
Note the slight difference between this and OnFolder()
: because we don't need to recurse into files (at least until we support entering .tar/.zip archives), we can just pass control over to the Matcher to decide if the file is wanted and to handle it if it is.
Functions
actions
- StartSpider(caMatch $om)
- formerly DoSearch() (kept for now as an alias)
events
- OnPath(caPathPiece $op)
- OnFolder(caPathNamed $op)
- OnWantedFolder(caPathPiece $op)
- OnFile(caPathNamed $op)
state
protected function ResetCount() { $this->nFi = 0; $this->nFo = 0; }
protected function IncFiles() { $this->nFi++; }
protected function IncFolders() { $this->nFo++; }
protected function SummarizeCount() : string { ... }
: returns a string summarizing file & folder countsprotected function ShortCount() : string { ... }
: like SummarizeCount(), but shorter string ("fo:#/fi:#")
object
This pair sets and returns a Matcher object: