From c7f483067547852ad3587a78c33cba1865c54ff7 Mon Sep 17 00:00:00 2001 From: Bob Vincent Date: Thu, 13 Oct 2011 22:15:00 -0400 Subject: [PATCH] Issue #1307332 by pillarsdotnet: Improve the docs for DrupalLocalStreamWrapper::getLocalPath() function. --- includes/stream_wrappers.inc | 13 ++++++++++--- 1 files changed, 10 insertions(+), 3 deletions(-) diff --git a/includes/stream_wrappers.inc b/includes/stream_wrappers.inc index 9a9b06171a92c73228df7c33c067a4c9e47b4237..511bf273bbc5fe7ff4db192c1351b7e9c965f94e 100644 --- a/includes/stream_wrappers.inc +++ b/includes/stream_wrappers.inc @@ -356,10 +356,17 @@ abstract class DrupalLocalStreamWrapper implements DrupalStreamWrapperInterface } /** - * Return the local filesystem path. + * Returns canonical, absolute path of the URI, if possible. * - * @param $uri - * Optional URI, supplied when doing a move or rename. + * @param string $uri + * (optional) The stream wrapper URI to be converted to a canonical + * absolute path. + * + * @return string|false + * If $uri is not set, returns the path previously set by the + * DrupalStreamWrapperInterface::setUri() function. If $uri is set and valid + * for this class, returns its canonical absolute path, as returned by the + * realpath() function. If $uri is set but not valid, returns FALSE. */ protected function getLocalPath($uri = NULL) { if (!isset($uri)) { -- 1.7.5.4