getExampleFileContents()
getExampleFileContents(
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string $filename)
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: ?string[]
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:
- Iterates through all examples folders for the given filename
- Checks the source folder for the given filename
- Checks the 'examples' folder in the current working directory for examples
- Checks the path relative to the current working directory for the given filename
Parameters
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string |
$filename |
|
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Returns
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
?string[]
—