\phpDocumentor\Descriptor\ExampleFinder

find()

find(\phpDocumentor\Descriptor\Tag\ExampleDescriptor  $descriptor) : string

Attempts to find the example contents for the given descriptor.

Parameters

Returns

setSourceDirectory()

setSourceDirectory(string  $directory = '') : void

Registers the project's root directory where an 'examples' folder can be expected.

Parameters

getSourceDirectory()

getSourceDirectory() : string

Returns the project's root directory where an 'examples' folder can be expected.

Returns

setExampleDirectories()

setExampleDirectories(array<mixed,string>  $directories) 

Registers a series of directories that may contain examples.

Parameters

getExampleDirectories()

getExampleDirectories() : array<mixed,string>

Returns a series of directories that may contain examples.

Returns

getExampleFileContents()

getExampleFileContents(string  $filename) : string|null

Attempts to find the requested example file and returns its contents or null if no file was found.

This method will try several methods in search of the given example file, the first one it encounters is returned:

1. Iterates through all examples folders for the given filename
2. Checks the source folder for the given filename
3. Checks the 'examples' folder in the current working directory for examples
4. Checks the path relative to the current working directory for the given filename

Parameters

Returns

getExamplePathFromExampleDirectory()

getExamplePathFromExampleDirectory(string  $file) : string

Get example filepath based on the example directory inside your project.

Parameters

Returns

constructExamplePath()

constructExamplePath(string  $directory, string  $file) : string

Returns a path to the example file in the given directory.

.

Parameters

Returns

getExamplePathFromSource()

getExamplePathFromSource(string  $file) : string

Get example filepath based on sourcecode.

Parameters

Returns