From: Aaron Schulz <aschulz@wikimedia.org>
Date: Mon, 1 Apr 2013 23:39:36 +0000 (-0700)
Subject: [FileBackend] Clarified the noAccess/noListing docs a bit.
X-Git-Tag: 1.31.0-rc.0~20119^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/comptes/ajouter.php?a=commitdiff_plain;h=2d7fe59935a40c5d02218ca6cfaaaaa1d3728445;p=lhc%2Fweb%2Fwiklou.git

[FileBackend] Clarified the noAccess/noListing docs a bit.

Change-Id: I3f008e3d1931423fc3c73af587d657040fdffe83
---

diff --git a/includes/filebackend/FileBackend.php b/includes/filebackend/FileBackend.php
index d0020dac41..d505d6fa88 100644
--- a/includes/filebackend/FileBackend.php
+++ b/includes/filebackend/FileBackend.php
@@ -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