Commit 4af2c4e6 authored by Dries's avatar Dries

- Patch #1307332 by pillarsdotnet: improve the docs for...

- Patch #1307332 by pillarsdotnet: improve the docs for DrupalLocalStreamWrapper::getLocalPath() function.
parent f98273f9
......@@ -356,10 +356,18 @@ function realpath() {
}
/**
* Return the local filesystem path.
*
* @param $uri
* Optional URI, supplied when doing a move or rename.
* Returns the canonical absolute path of the URI, if possible.
*
* @param string $uri
* (optional) The stream wrapper URI to be converted to a canonical
* absolute path. This may point to a directory or another type of file.
*
* @return string|false
* If $uri is not set, returns the canonical absolute path of the URI
* previously set by the DrupalStreamWrapperInterface::setUri() function.
* If $uri is set and valid for this class, returns its canonical absolute
* path, as determined by the realpath() function. If $uri is set but not
* valid, returns FALSE.
*/
protected function getLocalPath($uri = NULL) {
if (!isset($uri)) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment