Merge pull request #9300 from LABCAT/patch-1

Improvement to docs for send_file function
This commit is contained in:
Robbie Averill 2019-11-14 09:08:16 -08:00 committed by GitHub
commit 77ccadd663
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -468,6 +468,8 @@ class HTTPRequest implements ArrayAccess
* Construct an HTTPResponse that will deliver a file to the client. * Construct an HTTPResponse that will deliver a file to the client.
* Caution: Since it requires $fileData to be passed as binary data (no stream support), * Caution: Since it requires $fileData to be passed as binary data (no stream support),
* it's only advisable to send small files through this method. * it's only advisable to send small files through this method.
* This function needs to be called inside the controllers response, e.g.:
* <code>$this->setResponse(HTTPRequest::send_file('the content', 'filename.txt'));</code>
* *
* @static * @static
* @param $fileData * @param $fileData