addAllowedExtension()
addDirectories()
addDirectory()
addFile()
addFiles()
addIgnorePattern()
debug()
dispatch()
getFiles()
getFollowSymlinks()
getIgnoreHidden()
getIgnorePatterns()
getProjectRoot()
log()
setAllowedExtensions()
setFollowSymlinks()
setIgnoreHidden()
setIgnorePatterns()
convertToPregCompliant()
getRelativeFilename()
$event_dispatcher
$allowed_extensions
$files
$follow_symlinks
$ignore_hidden
$ignore_patterns
$project_root
Files container handling directory scanning, project root detection and ignores.
| category | phpDocumentor |
|---|---|
| package | Parser |
| author | Mike van Riel |
| license | MIT |
| link | http://phpdoc.org |
addAllowedExtension(string $extension) : void
No dot is necessary and will even prevent the extension from being picked up.
stringAllowed file Extension to add (i.e. php).
addDirectories(array $paths) : void
arrayThe paths whose contents to add to the collection.
addDirectory(string $path) : void
stringA path to a folder, may be relative, absolute or even phar.
\InvalidArgumentException |
if the given path is not a folder. |
|---|
addFile(string $path) : void
stringFile location, may be absolute, relative or even phar.
addFiles(array $paths) : void
arrayFile locations, may be absolute, relative or even phar.
addIgnorePattern(string $pattern) : void
stringGlob-like pattern to filter files with.
debug(string $message) : void
| inherited_from | \phpDocumentor_Parser_Abstract::debug() |
|---|
stringThe message to log.
dispatch(string $name, \string[] $arguments) : mixed | null
This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null. By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.
| inherited_from | \phpDocumentor_Parser_Abstract::dispatch() |
|---|
stringName of the event to dispatch.
\string[]Arguments for this event.
\phpDocumentor_Parser_Exception |
if there is a dispatcher but it is not of type sfEventDispatcher |
|---|
mixednull
getFiles() : \string[]
Please note that the ignore pattern will be applied and all files are converted to absolute paths.
\string[]getFollowSymlinks() : boolean
booleangetIgnoreHidden() : boolean
booleangetIgnorePatterns() : array
arraygetProjectRoot() : string
stringlog(string $message, int $priority) : void
| inherited_from | \phpDocumentor_Parser_Abstract::log() |
|---|
stringThe message to log.
intThe logging priority, the lower, the more important. Ranges from 1 to 7
setAllowedExtensions(array $extensions) : void
arrayAn array containing extensions to match for.
setFollowSymlinks(boolean $follow_symlinks) : void
PHP version 5.2.11 is at least required since the RecursiveDirectoryIterator does not support the FOLLOW_SYMLINKS constant before that version.
boolean
\InvalidArgumentException |
|---|
setIgnoreHidden(boolean $ignore_hidden) : void
booleanif true skips hidden files and folders.
setIgnorePatterns(array $patterns) : void
arrayGlob-like patterns to filter files.
convertToPregCompliant(string $string) : void
| author | Greg Beaver |
|---|---|
| author | mike van Riel |
| see | \PhpDocumentor/phpDocumentor/Io.php |
string&$string Glob-like pattern with wildcards ? and *.
getRelativeFilename(string $filename) : string
stringThe filename to make relative.
\InvalidArgumentException |
if file is not in the project root. |
|---|
string$event_dispatcher : \sfEventDispatcher | null
| inherited_from | \phpDocumentor_Parser_Abstract::$$event_dispatcher |
|---|
$allowed_extensions : \string[]
$files : \string[]
$follow_symlinks : bool
$ignore_hidden : bool
$ignore_patterns : \array[]
Structure of this array is:
array(
0 =>
$project_root : string