\phpDocumentor\Parser\ConfigurationFiles

Represents the settings in the phpdoc.xml related to finding the files that are to be parsed.

Summary

Methods
Properties
Constants
__construct()
getDirectories()
getFiles()
getIgnore()
isIgnoreHidden()
isIgnoreSymlinks()
getExamples()
No public properties found
No constants found
No protected methods found
$examples
$directories
$files
$ignore
$ignoreHidden
$ignoreSymlinks
N/A
No private methods found
No private properties found
N/A

Properties

$examples

$examples : array<mixed,string>

Type

array<mixed,string> — a list of directories that contain example files

$directories

$directories : array<mixed,string>

Type

array<mixed,string> — a list of directories that will be recursively scanned for files to parse.

$files

$files : array<mixed,string>

Type

array<mixed,string> — a list of files that will be parsed individually.

$ignore

$ignore : array<mixed,string>

Type

array<mixed,string> — a list of 'globs' that will determine if a file matches the expression and then will be ignored.

$ignoreHidden

$ignoreHidden : boolean

Type

boolean — whether to ignore hidden files and directories.

$ignoreSymlinks

$ignoreSymlinks : boolean

Type

boolean — whether to ignore symlinks and not follow them.

Methods

__construct()

__construct(array<mixed,string>  $directories = array(), array<mixed,string>  $files = array(), array<mixed,string>  $ignore = array(), array<mixed,string>  $examples = array()) 

Initializes this configuration directive with the required files and directories.

Parameters

array<mixed,string> $directories
array<mixed,string> $files
array<mixed,string> $ignore
array<mixed,string> $examples

getDirectories()

getDirectories() : array<mixed,\string>

Returns a list of directories to recursively scan for files to be parsed.

Returns

array<mixed,\string>

getFiles()

getFiles() : array<mixed,\string>

Returns a list of files to parse.

Returns

array<mixed,\string>

getIgnore()

getIgnore() : array<mixed,\string>

Returns the 'glob' expression used to determine which files to ignore.

Returns

array<mixed,\string>

isIgnoreHidden()

isIgnoreHidden() : boolean

Returns whether to ignore hidden files and folders during parsing.

Returns

boolean

isIgnoreSymlinks()

isIgnoreSymlinks() : boolean

Returns whether to ignore symlinks and not traverse them.

Returns

boolean

getExamples()

getExamples() : array<mixed,\string>

Returns all folders that may contain example files as referenced using the [email protected]` tag.

Returns

array<mixed,\string>