[FileBackend] Clarified the noAccess/noListing docs a bit.
authorAaron Schulz <aschulz@wikimedia.org>
Mon, 1 Apr 2013 23:39:36 +0000 (16:39 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Mon, 1 Apr 2013 23:39:36 +0000 (16:39 -0700)
Change-Id: I3f008e3d1931423fc3c73af587d657040fdffe83

includes/filebackend/FileBackend.php

index d0020da..d505d6f 100644 (file)
@@ -682,6 +682,8 @@ abstract class FileBackend {
         * The 'noAccess' and 'noListing' parameters works the same as in secure(),
         * except they are only applied *if* the directory/container had to be created.
         * These flags should always be set for directories that have private files.
+        * However, setting them is not guaranteed to actually do anything.
+        * Additional server configuration may be needed to achieve the desired effect.
         *
         * @param array $params
         * $params include:
@@ -709,7 +711,9 @@ abstract class FileBackend {
         * the container it belongs to. FS backends might add .htaccess
         * files whereas key/value store backends might revoke container
         * access to the storage user representing end-users in web requests.
-        * This is not guaranteed to actually do anything.
+        *
+        * This is not guaranteed to actually make files or listings publically hidden.
+        * Additional server configuration may be needed to achieve the desired effect.
         *
         * @param array $params
         * $params include:
@@ -739,6 +743,9 @@ abstract class FileBackend {
         * access to the storage user representing end-users in web requests.
         * This essentially can undo the result of secure() calls.
         *
+        * This is not guaranteed to actually make files or listings publically viewable.
+        * Additional server configuration may be needed to achieve the desired effect.
+        *
         * @param array $params
         * $params include:
         *   - dir            : storage directory