summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDries2011-10-16 12:52:19 -0400
committerDries2011-10-16 12:52:19 -0400
commit4af2c4e69bf070922b663f308636ebd048097ae6 (patch)
treefa285d1f66c30f3e4d67881051343465499e522a
parentf98273f975d4f1b17967d893c0f28ff3ef41c51a (diff)
- Patch #1307332 by pillarsdotnet: improve the docs for DrupalLocalStreamWrapper::getLocalPath() function.
-rw-r--r--includes/stream_wrappers.inc16
1 files changed, 12 insertions, 4 deletions
diff --git a/includes/stream_wrappers.inc b/includes/stream_wrappers.inc
index 9a9b061..e47668e 100644
--- a/includes/stream_wrappers.inc
+++ b/includes/stream_wrappers.inc
@@ -356,10 +356,18 @@ abstract class DrupalLocalStreamWrapper implements DrupalStreamWrapperInterface
}
/**
- * 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)) {