Files

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

package

Default

Methods

Initializes this configuration directive with the required files and directories.

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

Arguments

$directories

array<mixed,string>

$files

array<mixed,string>

$ignore

array<mixed,string>

$examples

array<mixed,string>

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

getDirectories() : array<mixed,\string>

Response

array<mixed,\string>

Returns all folders that may contain example files as referenced using the `@example` tag.

getExamples() : array<mixed,\string>

Response

array<mixed,\string>

Returns a list of files to parse.

getFiles() : array<mixed,\string>

Response

array<mixed,\string>

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

getIgnore() : array<mixed,\string>

Response

array<mixed,\string>

Returns whether to ignore hidden files and folders during parsing.

isIgnoreHidden() : boolean

Response

boolean

Properties

a list of directories that contain example files

examples : array<mixed,string>
var

a list of directories that contain example files

Serializer\Type

("array")

Serializer\XmlList

(inline = true, entry = "examples")

Type(s)

array<mixed,string>

a list of directories that will be recursively scanned for files to parse.

directories : array<mixed,string>
var

a list of directories that will be recursively scanned for files to parse.

Serializer\Type

("array")

Serializer\XmlList

(inline = true, entry = "directory")

Merger\Replace

Type(s)

array<mixed,string>

a list of files that will be parsed individually.

files : array<mixed,string>
var

a list of files that will be parsed individually.

Serializer\Type

("array")

Serializer\XmlList

(inline = true, entry = "file")

Merger\Replace

Type(s)

array<mixed,string>

a list of 'globs' that will determine if a file matches the expression and then will be ignored.

ignore : array<mixed,string>
var

a list of 'globs' that will determine if a file matches the expression and then will be ignored.

Serializer\Type

("array")

Serializer\XmlList

(inline = true, entry = "ignore")

Merger\Replace

Type(s)

array<mixed,string>

whether to ignore hidden files and directories.

ignoreHidden : boolean
var

whether to ignore hidden files and directories.

Serializer\Type

("boolean")

Serializer\SerializedName

("ignore-hidden")

Type(s)

boolean