API17:JFile::read

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

JFile::read

Description

Read the contents of a file.

Since

Synopsis

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

mixed Returns file contents or boolean False if failed

Defined in

libraries/joomla/filesystem/file.php (line 260)

• see source code in BitBucket

Referenced by

• JArchiveZip::_extract
• JRegistry::loadFile

See also

• JFile
• Other versions of this method

Examples

<CodeExamplesForm />