JFile::read
From Joomla! Documentation
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JFile::read[edit]
Description[edit]
Read the contents of a file.
Template:Description:JFile::read [Edit Descripton]
Since[edit]
Synopsis[edit]
public static JFile::read ($filename, $incpath=false, $amount=0, $chunksize=8192, $offset=0)
Parameter | Type | Default | Description |
---|---|---|---|
$filename | string | The full file path | |
$incpath | boolean | false | Use include path |
$amount | int | 0 | Amount of file to read |
$chunksize | int | 8192 | Size of chunks to read |
$offset | int | 0 | Offset of the file |
Returns[edit]
mixed Returns file contents or boolean False if failed
Defined in[edit]
libraries/joomla/filesystem/file.php (line 260)
- see source code in BitBucket
Referenced by[edit]
See also[edit]
Examples[edit]
<CodeExamplesForm />