From 943b74f9941f984254f52c5d32abaae4a98ddbe1 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 | 12 +++++++++--- 1 files changed, 9 insertions(+), 3 deletions(-) diff --git a/includes/stream_wrappers.inc b/includes/stream_wrappers.inc index 9a9b06171a92c73228df7c33c067a4c9e47b4237..6b73185d6664362076811e68a04b6aef28dd0678 100644 --- a/includes/stream_wrappers.inc +++ b/includes/stream_wrappers.inc @@ -356,10 +356,16 @@ abstract class DrupalLocalStreamWrapper implements DrupalStreamWrapperInterface } /** - * Return the local filesystem path. + * Returns the canonical path of the uri or file repository, 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 + * filesystem path. + * + * @return string|false + * If $uri is NULL, returns the path to the local file repository. If $uri + * is set and valid for this class, returns its canonical filesystem path. + * If $uri is not valid, returns FALSE. */ protected function getLocalPath($uri = NULL) { if (!isset($uri)) { -- 1.7.5.4