Improvement to docs for send_file function

This commit is contained in:
LABCAT 2019-10-22 15:18:03 +13:00 committed by GitHub
parent bd2ccf70fa
commit 67c944c962
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.
* 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.
* this function needs to called inside the controllers response, eg
* $this->setResponse(HTTPRequest::send_file('the content', 'filename.txt'));
*
* @static
* @param $fileData