Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

doc comment change: improved comment on download_file_content to clar…

…ify $headers
  • Loading branch information...
commit 0bd80872c5dd4dfccd76dae4b0db439516a548ae 1 parent 7152a78
sam_marshall authored
Showing with 4 additions and 2 deletions.
  1. +4 −2 lib/filelib.php
View
6 lib/filelib.php
@@ -41,10 +41,12 @@ function get_file_url($path, $options=null, $type='coursefile') {
* Due to security concerns only downloads from http(s) sources are supported.
*
* @param string $url file url starting with http(s)://
- * @param array $headers http headers, null if none
+ * @param array $headers http headers, null if none. If set, should be an
+ * associative array of header name => value pairs.
* @param array $postdata array means use POST request with given parameters
* @param bool $fullresponse return headers, responses, etc in a similar way snoopy does
- * @param int $timeout timeout for complete download process including all file transfer
+ * (if false, just returns content)
+ * @param int $timeout timeout for complete download process including all file transfer
* (default 5 minutes)
* @param int $connecttimeout timeout for connection to server; this is the timeout that
* usually happens if the remote server is completely down (default 20 seconds);
Please sign in to comment.
Something went wrong with that request. Please try again.