API17:JFile::read

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

Description

Read the contents of a file.

public static function 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 on line 272 of libraries/joomla/filesystem/file.php
• Since
• Referenced by
  • JArchiveZip::_extract
  • JRegistry::loadFile

See also

• JFile::read source code on BitBucket
• Class JFile
• Subpackage Filesystem
• Other versions of JFile::read

User contributed notes

<CodeExamplesForm />